You need to enable JavaScript to run this app.
导航
DescribeUserData - 查询实例自定义数据
最近更新时间:2024.10.28 17:36:25首次发布时间:2021.12.29 11:18:50

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

使用说明

  • 返回的实例自定义数据为Base64编码形式。
  • 如果实例未设置自定义数据,则返回空值。
  • 如何设置实例自定义数据,请参见设置自定义数据

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

DescribeUserData

要执行的操作,取值:DescribeUserData。

Version
String

2020-04-01

API的版本,取值:2020-04-01。

InstanceId
String

i-l8j0j2jynelea7nu****

要查询的实例ID。

返回参数

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

参数
类型
示例值
描述
InstanceId
String

i-l8j0j2jynelea7nu****

实例ID。

UserData
String

IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******

实例的自定义数据。

请求示例

GET /?Action=DescribeUserData&Version=2020-04-01&InstanceId=i-l8j0j2jynelea7nu**** HTTP/1.1
Host: open.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.

内部错误,请重试。如果多次尝试失败,请提交工单。