文档中心

云服务器

请输入

实例

DescribeUserData - 查询实例自定义数据

调用 DescribeUserData 接口查询一台云服务器实例的自定义数据。

使用说明

返回的实例自定义数据为Base64编码形式。

如果实例未设置自定义数据，则返回空值。

如何设置实例自定义数据，请参见设置自定义数据。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeUserData

要执行的操作，取值：DescribeUserData。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

ScheduledInstanceId string 可选示例值：esi-ycvye5a380l8j1ld****

弹性预约单ID。

InstanceId string 必选示例值：i-l8j0j2jynelea7nu****

要查询的实例ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：i-l8j0j2jynelea7nu****

实例ID。

ScheduledInstanceId string 示例值：esi-ycvye5a380l8j1ld****

弹性预约单ID。

UserData string 示例值：IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******

实例的自定义数据。

请求示例

GET /?Action=DescribeUserData&Version=2020-04-01&InstanceId=i-l8j0j2jynelea7nu**** HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2021110417394001022514606307D7****",​
        "Action": "DescribeUserData",​
        "Version": "2020-04-01",​
        "Service": "ecs",​
        "Region": "cn-beijing"​
    },​
    "Result":{​
        "InstanceId":"i-l8j0j2jynelea7nu****",​
        "UserData":"IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******"​
      }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.InstanceId	The required parameter InstanceId is not supplied.	参数实例ID不能为空。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.04.08 10:02:16

这个页面对您有帮助吗？

有用

无用