查询轻量型主机详细信息
接口功能介绍
该接口提供用户轻量型云主机信息查询功能，用户可以根据此接口的返回值了解自己轻量型云主机的详细信息。
URI
GET /v4/ecs/lite/details
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 | 888888c8888888e8a8888888ac888888 | |
| instanceID | 是 | String | 云主机ID | 88f888ea-88ff-88ec-a8bc-888888888fe8 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resourceID | String | 云主机资源ID | f88bc88a88a888e8a88bf88888888888 | |
| instanceID | String | 云主机ID | 88f888ea-88ff-88ec-a8bc-888888888fe8 | |
| displayName | String | 云主机显示名称 | ecs-8888 | |
| instanceName | String | 云主机名称 | ecs-8888 | |
| osType | Integer | 操作系统类型，取值范围：1: linux，2: windows，3: redhat，4: ubuntu，5: centos，6: oracle | 5 | |
| instanceStatus | String | 云主机状态，取值范围：backingup: 备份中，creating: 创建中，expired: 已到期，freezing: 冻结中，rebuild: 重装，restarting: 重启中，running: 运行中，starting: 开机中，stopped: 已关机，stopping: 关机中，error: 错误，snapshotting: 快照创建中 | running | |
| expiredTime | String | 到期时间 | 2023-04-19T09:37:53Z | |
| updatedTime | String | 更新时间 | 2022-10-19T09:37:53Z | |
| createdTime | String | 创建时间 | 2022-10-19T09:37:53Z | |
| attachedVolume | Array of Strings | 附加卷 | ["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"] | |
| addresses | Object | 网络地址信息 | addresses | |
| secGroupList | Array of Objects | 安全组信息 | securityGroup | |
| networkCardList | Array of Objects | 网卡信息 | networkCard | |
| image | Object | 镜像信息 | image | |
| flavor | Object | 规格信息 | flavor | |
| vpcID | String | vpc ID | b1a5ff70-cdd1-4295-8a17-07b7e53c5759 | |
| vpcName | String | vpc名称 | liteecs_network | |
| zabbixName | String | 监控对象名称 | 8a8fdc88-b8a8-88bb-888f-8b88888c88f8 | |
| bandwidth | Integer | 带宽 | 2 | |
| bootDiskSize | Integer | 系统盘大小 | 40 |
表 addresses
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| addressList | Array of Objects | 网络地址列表 | addressList |
表 securityGroup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupID | String | 安全组ID | c6e1d96a-cff8-45c0-97db-91fca62b5f26 | |
| securityGroupName | String | 安全组名称 | VM-79ab13b6 |
表 networkCard
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| IPv4Address | String | IPv4地址 | 10.0.0.1 | |
| subnetID | String | 所处的子网ID | f24f5695-6eaa-4ff9-b986-fb8f33a7fad4 |
表 image
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| imageID | String | 镜像ID | b88888b8-ff88-8888-b88f-8c8fbc888b88 | |
| imageName | String | 镜像名称 | CentOS7.5.v1-20210303 |
表 flavor
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| flavorID | String | 规格ID | 8f8ba888-88e8-ea88-ea8b-888888dded88 | |
| flavorName | String | 规格名称 | s7.medium.2 | |
| flavorCPU | Integer | VCPU | 1 | |
| flavorRAM | Integer | 内存 | 2048 |
表 addressList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| addr | String | 地址 | 192.168.0.62 | |
| version | Integer | IP版本 | 4 | |
| type | String | 网络类型 | fixed |
请求示例
GET .../v4/ecs/lite/details?regionID=41f64827f25f468595ffa3a5deb5d15d&instanceID=7a9acf36-ed22-49e4-8ca2-a9ab6021e8a2
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"instanceStatus": "running",
"secGroupList": [{
"securityGroupID": "c6e1d96a-cff8-45c0-97db-91fca62b5f26",
"securityGroupName": "VM-79ab13b6"
}],
"vpcID": "b1a5ff70-cdd1-4295-8a17-07b7e53c5759",
"displayName": "LiteECS-cafd",
"addresses": {
"addressList": [{
"version": 4,
"type": "fixed",
"addr": "172.31.1.8"
}, {
"version": 4,
"type": "floating",
"addr": "100.127.12.88"
}]
},
"updatedTime": "2023-07-07T09:45:12Z",
"instanceID": "7a9acf36-ed22-49e4-8ca2-a9ab6021e8a2",
"resourceID": "ad2ba3d200e54e00850f7f7f9f35205c",
"image": {
"imageName": "CentOS7.6.v1-20020301",
"imageID": "dca942b0-e934-4bd5-b5c1-4f5e1aad56a6"
},
"vpcName": "liteecs_network",
"createdTime": "2023-07-03T06:47:04Z",
"bandwidth": 10,
"expiredTime": "2023-10-03T06:47:04Z",
"bootDiskSize": 80,
"zabbixName": "7a9acf36-ed22-49e4-8ca2-a9ab6021e8a2",
"osType": 5,
"attachedVolume": ["3163fc5e-70ed-4341-8d68-ffd3b3d48379"],
"flavor": {
"flavorCPU": 4,
"flavorID": "6c76c383-586c-4302-aeff-2f891734e8e4",
"flavorRAM": 8192,
"flavorName": "lite1.band.xlarge.2"
},
"networkCardList": [{
"subnetID": "f24f5695-6eaa-4ff9-b986-fb8f33a7fad4",
"IPv4Address": "172.31.1.8"
}],
"instanceName": "VM-79ab13b6"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| LiteEcs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionVersion.NotSupport | 当前API不支持该资源池，请切换资源池重试 |
| Openapi.EcsWorkorder.AccessFailed | 查询云主机失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.NotFound | 云主机不存在，请确认云主机ID是否有效 |
| Openapi.EcsFormat.FormatError | 查询云主机信息格式错误，请重试。如果多次尝试失败，请提交工单 |
