接口功能介绍
根据云主机ID,查询云主机的用户自定义数据。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1.使用限制,本接口只支持在多可用区资源池进行公测
2.确保当前请求资源池下,该云主机存在
URI
GET /v4/ecs/userdata/details
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
userdata | String | 用户自定义数据 | Y3JlYXRlIGVjcyB0ZXN0IDA3MTk= |
枚举参数
无
请求示例
请求url
示例:查询华东1资源池1台云主机的自定义数据
GET .../v4/ecs/userdata/details?regionID=bb9fdb42056f11eda1610242ac110002&instanceID=c5a7966a-88e7-362b-6e11-c2d8fbfc07ca
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"userdata": "Y3JlYXRlIGVjcyB0ZXN0IDA3MTk="
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码