查詢專屬云內云主機詳細信息
更新時間 2025-04-02 09:54:17
最近更新時間: 2025-04-02 09:54:17
分享文章
接口功能介紹
該接口提供用戶一臺或多臺云主機信息查詢功能，用戶可以根據此接口的返回值了解自己云主機的詳細信息
準備工作：
??構造請求：在調用前需要了解如何構造請求，詳情查看
??認證鑒權：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 | 操作系統類型，詳見枚舉值表格 | 5 | |
| instanceStatus | String | 云主機狀態，請通過狀態枚舉值查看云主機使用狀態 | 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 |
枚舉參數
參數名 osType
| 枚舉值 | 類型 | 說明 |
|---|---|---|
| 1 | Integer | linux |
| 2 | Integer | windows |
| 3 | Integer | redhat |
| 4 | Integer | ubuntu |
| 5 | Integer | centos |
| 6 | Integer | oracle |
請求示例
請求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
}
狀態碼
請參考
錯誤碼
請參考
