接口功能介绍
该接口提供用户一台或多台云主机信息查询功能,用户可以根据此接口的返回值了解自己云主机的详细信息。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
单台查询:当前接口只能查询单台云主机信息,查询多台云主机信息请使用接口查询专属云中的云主机列表进行查询
接口约束
确保当前请求资源池下,该云主机存在(即参数instanceID与regionID对应)
URI
POST /v4/dec/instance/details
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
projectID | String | 企业项目ID | 0 | |
azName | String | 可用区名称 | az1 | |
attachedVolume | Array of Strings | 云硬盘ID列表 | ["d36d4736-0724-429e-b7b6-dca67a2a0ef5", "b484565c-b5a0-4b30-85cd-3b674991aff0"] | |
addresses | Array of Objects | 网络地址信息 | addresses | |
resourceID | String | 云主机资源ID | cde530453f204f47bf32d12e62ef3b23 | |
instanceID | String | 云主机ID | c5a7966a-88e7-362b-6e11-c2d8fbfc07ca | |
displayName | String | 云主机显示名称 | api-test01 | |
instanceName | String | 云主机名称 | api-test01 | |
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 | |
availableDay | Integer | 可用天数 | 120 | |
updatedTime | String | 更新时间 | 2022-10-19T09:37:53Z | |
createdTime | String | 创建时间 | 2022-10-19T09:37:53Z | |
zabbixName | String | 监控对象名称 | c5a7966a-88e7-362b-6e11-c2d8fbfc07ca | |
secGroupList | Array of Objects | 安全组信息 | secGroupList | |
privateIP | String | 内网IPv4地址 | 192.168.1.104 | |
privateIPv6 | String | 内网IPv6址 | 100:1:1ec:6600:fb6f:5428:c7e3:fa60 | |
networkCardList | Array of Objects | 网卡信息 | networkCardList | |
vipInfoList | Array of Objects | 虚拟IP信息列表 | vipInfoList | |
vipCount | Integer | 虚拟IP数目 | 1 | |
affinityGroup | Object | 云主机组信息 | affinityGroup | |
image | Object | 镜像信息 | image | |
flavor | Object | 云主机规格信息 | flavor | |
onDemand | Boolean | 付费方式,取值范围: true:表示按量付费; false:表示包周期 |
true | |
vpcName | String | 虚拟私有云名称 | vpc-test3 | |
vpcID | String | 虚拟私有云ID | vpc-jomc98yuqu | |
fixedIPList | Array of Strings | 内网IP列表 | ["192.168.1.104"] | |
floatingIP | String | 公网IP | 117.89.29.150 | |
subnetIDList | Array of Strings | 子网ID列表 | ["subnet-7tk4rmsj4c"] | |
keypairName | String | 密钥对名称 | kp-test2 |
表 addresses
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
vpcName | String | vpc名称 | vpc-test3 | |
addressList | Array of Objects | 网络地址列表 | addressList |
表 secGroupList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
securityGroupID | String | 安全组ID | sg-w3cn7d00a4 | |
securityGroupName | String | 安全组名称 | Default-Security-Gr |
表 networkCardList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
IPv4Address | String | IPv4地址 | 192.168.1.104 | |
IPv6Address | Array of Strings | IPv6地址列表 | ["100:1:1ec:6600:fb6f:5428:c7e3:fa60"] | |
subnetID | String | 子网ID | subnet-0yy6yy2yyy | |
subnetCidr | String | 子网网段信息 | 10.0.0.1/24 | |
isMaster | Boolean | 是否主网卡,取值范围: true:主网卡, false:扩展网卡 |
true | |
gateway | String | 网关地址 | 192.168.1.1 | |
networkCardID | String | 网卡ID | port-10s1q9v9xf | |
securityGroup | Array of Strings | 安全组ID列表 | ["sg-w3cn7d00a4"] |
表 vipInfoList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
vipID | String | 虚拟IP的ID | havip-82g6jjhebo | |
vipAddress | String | 虚拟IP地址 | 192.168.1.52 | |
vipBindNicIP | String | 虚拟IP绑定的网卡对应IPv4地址 | 192.168.1.104 | |
vipBindNicIPv6 | String | 虚拟IP绑定的网卡对应IPv6地址 | 100:1:1ec:6600:fb6f:5428:c7e3:fa60 | |
nicID | String | 网卡ID | port-10s1q9v9xf |
表 affinityGroup
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policy | String | 云主机组策略 | soft-affinity | |
affinityGroupName | String | 云主机组名称 | api-test01 | |
affinityGroupID | String | 云主机组ID | d1559aad-3932-7ded-cfa6-2871258b1bb5 |
表 image
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
imageID | String | 镜像ID | 4e5f72c9-fa16-4ae6-b60e-11287edc934c | |
imageName | String | 镜像名称 | CentOS7.9 64位 |
表 flavor
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
flavorID | String | 规格ID | c5f17f9c-5cfd-9c87-72dd-152171c9002a | |
flavorName | String | 规格名称 | s7.medium.2 | |
flavorCPU | Integer | VCPU | 1 | |
flavorRAM | Integer | 内存 | 2048 | |
gpuType | String | GPU类型,取值范围:T4、V100、V100S、A10、A100、atlas 300i pro、mlu370-s4,支持类型会随着功能升级增加 | T4 | |
gpuCount | Integer | GPU数目 | 1 | |
gpuVendor | String | GPU名称 | gpu-x | |
videoMemSize | Integer | GPU显存大小 | 2 |
表 addressList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
addr | String | IP地址 | 192.168.1.104 | |
version | Integer | IP版本 | 4 | |
type | String | 网络类型,取值范围: fixed:内网, floating:公网 |
fixed |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:查询专属于内一台云主机
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"instanceID": "2ae75564-c38a-aec3-1191-0b680a9811c1"
}
响应示例
{
"returnObj": {
"results": {
"affinityGroup": {
"policy": "soft-affinity",
"affinityGroupName": "group-10274",
"affinityGroupID": "682c01af-1eaf-400b-570f-05734a00619d"
},
"availableDay": 180,
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"addresses": [{
"vpcName": "vpc-c710",
"addressList": [{
"version": 4,
"type": "fixed",
"addr": "192.168.0.5"
}, {
"version": 6,
"type": "fixed",
"addr": "100:1:179:b400:1281:d922:16da:51a9"
}, {
"version": 4,
"type": "floating",
"addr": "100.124.3.50"
}]
}],
"projectID": "0",
"image": {
"imageName": "CentOS7.5.v1-20210303",
"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08"
},
"updatedAt": "2022-10-31T04:42:48Z",
"fixedIP": ["192.168.0.5"],
"vpcName": "vpc-c710",
"vipInfoList": [{
"vipAddress": "192.168.0.8",
"vipBindNicIPv6": "100:1:179:b400:1281:d922:16da:51a9",
"nicID": "port-8aujqrn2yv",
"vipBindNicIP": "192.168.0.5",
"vipID": "havip-tb5a8zacx6"
}],
"zabbixName": "5ae83d07-0389-22fd-def8-995090ee3d5a",
"osType": 5,
"displayName": "ecm-details",
"flavor": {
"videoMemSize": null,
"flavorCPU": 1,
"flavorRAM": 1024,
"gpuCount": null,
"flavorName": "s7.small.1",
"gpuVendor": null,
"flavorID": "5622ce59-da34-cb43-ca0d-eef2a51475b3",
"gpuType": null
},
"instanceID": "8a8fdc88-b8a8-88bb-888f-8b88888c88f8",
"createdAt": "2022-10-31T04:38:17Z",
"instanceStatus": "Stopped",
"vpcID": "vpc-ollez140q8",
"attachedVolume": ["7337e167-1f9a-4319-9c0f-3b598b85f494", "2012fece-4fd9-4195-a748-fcefc838967a"],
"instanceName": "c7-cgio",
"onDemand": true,
"floatingIP": "100.124.3.50",
"resourceID": "30e2c994bf454d2e953eed48e637df6b",
"secGroupList": [{
"securityGroupID": "sg-h2tk9njxyv",
"securityGroupName": "Default-Security-Group"
}],
"privateIP": "192.168.0.5",
"privateIPv6": "100:1:179:b400:1281:d922:16da:51a9",
"expiredTime": "2023-04-30T04:38:17Z",
"subnetIDList": ["subnet-a9f581ioqd", "subnet-a9f581ioqd"],
"vipCount": 1,
"networkCardList": [{
"IPv4Address": "192.168.0.5",
"isMaster": true,
"networkCardID": "port-8aujqrn2yv",
"IPv6Address": ["100:1:179:b400:1281:d922:16da:51a9"],
"subnetCidr": "192.168.0.0/24",
"subnetID": "subnet-a9f581ioqd",
"gateway": "192.168.0.1",
"securityGroup": ["sg-h2tk9njxyv"]
}, {
"IPv4Address": "192.168.0.6",
"isMaster": false,
"networkCardID": "port-sstlnw0s7i",
"IPv6Address": ["100:1:179:b400:45a6:63a6:d121:9767"],
"subnetCidr": "192.168.0.0/24",
"subnetID": "subnet-a9f581ioqd",
"gateway": "192.168.0.1",
"secGroupList": ["sg-h2tk9njxyv"]
}],
"keypairName": ""
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码