接口功能介紹

該接口提供用戶多臺云主機信息查詢功能，用戶可以根據此接口的返回值得到多臺云主機的部分信息
準備工作：
??構造請求：在調用前需要了解如何構造請求，詳情查看
??認證鑒權：openapi請求需要進行加密調用，詳細查看
注意事項：
??分頁查詢：當前查詢結果以分頁形式進行展示，單次查詢最多顯示50條數據

 ??匹配查找：可以通過部分字段進行匹配篩選數據，無符合條件的為空，在指定多臺云主機ID的情況下，只返回匹配到的云主機信息。推薦每次使用單個條件查找

接口約束

無

URI

POST /v4/dec/instance/list

路徑參數
無

Query參數
無

請求參數

請求頭header參數
無

請求體body參數

響應參數

表 returnObj

表 results

表 addresses

表 secGroupList

表 networkCardList

表 vipInfoList

表 affinityGroup

表 image

表 flavor

表 addressList

枚舉參數

參數名 osType

請求示例

請求url

無

請求頭header

無

請求體body

示例1：指定每頁記錄數目，查詢指定頁云主機信息
專屬云內指定每頁記錄數目為3，查看第2頁云主機信息
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "pageNo": 2,
    "pageSize": 3
}
示例2：在多可用區類型資源池，查看單個可用區下的云主機信息
專屬云內指定每頁記錄數目為5，查看第3頁的云主機信息
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "azName": "cn-huadong1-jsnj3A-public-ctcloud",
    "pageNo": 3,
    "pageSize": 5
}
示例3：查看指定名稱的云主機
專屬云內查詢云主機名稱為api-test01的云主機信息
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "instanceName": "api-test01"
}
示例4：篩選云主機狀態查詢云主機列表
查看專屬云內中開機的云主機
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "state": "api-test01"
}
示例5：查看指定云主機ID的多個云主機
查看專屬云內查找ID為c5a7966a-88e7-362b-6e11-c2d8fbfc07ca和adc614e0-e838-d73f-0618-a6d51d09070a的云主機信息
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "instanceIDList": "c5a7966a-88e7-362b-6e11-c2d8fbfc07ca,adc614e0-e838-d73f-0618-a6d51d09070a"
}
示例6：查找使用指定安全組的云主機
查找專屬云內使用安全組ID為sg-tolywxbe1f的云主機（注：多可用區類型資源池中的securityGroupID通常為sg-開頭，而非多可用類型資源池不是）
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "securityGroupID": "sg-tolywxbe1f"
}
示例7：查找使用指定虛擬私有云的云主機
查找專屬云內使用vpcID為vpc-euu7edo58k的云主機（注：多可用區類型資源池中的vpcID通常為vpc-開頭，而非多可用類型資源池不是）
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "vpcID": "vpc-euu7edo58k"
}
示例8：查找“創建一臺按量付費或包年包月的云主機”接口所對應的云主機
查找在專屬云內創建一臺云主機后，得到的masterResourceID為9178e00c6fd148a88d4307950a9468df的云主機信息
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "resourceID": "9178e00c6fd148a88d4307950a9468df"
}
示例9：查找指定企業項目下的云主機信息
查找在專屬云內資源池下，企業項目ID為6732237e53bc4591b0e67d750030ebe3的云主機信息
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "projectID": "6732237e53bc4591b0e67d750030ebe3"
}
示例10：指定關鍵字查找
查找在專屬云內下關鍵字為test的云主機信息
{
    "regionID": "a39b0db2989140c79e6de8c21d50f132",
    "keyword": "test"
}

響應示例

{
    "returnObj": {
        "currentCount": 4, 
        "totalCount": 4, 
        "totalPage": 1, 
        "results": [
            {
                "azName": "az2", 
                "resourceID": "dad4a88983b741a3bb7a40cc7080204e", 
                "expiredTime": null, 
                "createdTime": "2022-11-28T07:35:49Z", 
                "updatedTime": "2022-12-27T14:12:45Z", 
                "projectID": "0", 
                "attachedVolume": [
                    "52d7a0c9-4015-4ee3-97a3-2ea52de9337b", 
                    "9678565c-b115-4b8e-8ee5-50393b40b816"
                ], 
                "instanceID": "73dc7707-a03a-dc96-31c1-5842dbe5f44e", 
                "displayName": "S1-2-8-0002", 
                "instanceName": "S1-2-8-0002", 
                "osType": 5, 
                "instanceStatus": "stopped", 
                "availableDay": 0, 
                "zabbixName": "73dc7707-a03a-dc96-31c1-5842dbe5f44e", 
                "privateIP": "192.168.0.18", 
                "privateIPv6": "", 
                "vipCount": 0, 
                "onDemand": true, 
                "vpcID": "vpc-v0uqqxq1kv", 
                "vpcName": "vpc-zzzz", 
                "subnetIDList": [
                    "subnet-bzdqf5ujby"
                ], 
                "fixedIPList": [
                    "192.168.0.18"
                ], 
                "floatingIP": null, 
                "keypairName": "", 
                "addresses": [
                    {
                        "vpcName": "vpc-zzzz", 
                        "addressList": [
                            {
                                "addr": "192.168.0.18", 
                                "version": 4, 
                                "type": "fixed"
                            }
                        ]
                    }
                ], 
                "secGroupList": [
                    {
                        "securityGroupName": "Default-Security-Group", 
                        "securityGroupID": "sg-mu39b23x9z"
                    }
                ], 
                "networkCardList": null, 
                "vipInfoList": null, 
                "affinityGroup": null, 
                "image": {
                    "imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08", 
                    "imageName": "CentOS7.5.v1-20210303"
                }, 
                "flavor": {
                    "flavorID": "affc0d2a-d24b-0f96-1ea4-843c05fa4abe", 
                    "flavorName": "c6.4xlarge.4", 
                    "flavorCPU": 16, 
                    "flavorRAM": 65536, 
                    "gpuType": null, 
                    "gpuCount": null, 
                    "gpuVendor": null, 
                    "videoMemSize": null
                }
            }
        ]
    }, 
    "message": "SUCCESS", 
    "description": "成功", 
    "statusCode": 800
}

狀態碼

請參考

錯誤碼

請參考