查询一台云主机的自定义数据
接口功能介绍
根据云主机ID,查询云主机的用户自定义数据。
接口约束
无
URI
GET /v4/ecs/userdata/details
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID | c5a7966a-88e7-362b-6e11-c2d8fbfc07ca |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
userdata | String | 用户自定义数据 | Y3JlYXRlIGVjcyB0ZXN0IDA3MTk= |
请求示例
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "c5a7966a-88e7-362b-6e11-c2d8fbfc07ca"
}
响应示例
{
"returnObj": {
"userdata": "Y3JlYXRlIGVjcyB0ZXN0IDA3MTk="
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |