API文件>雲主機>雲主機相關>查詢雲主機
  • 介面說明
  • 介面除錯

查詢雲主機

更新時間：2018-09-28 11:47:22

描述

查詢雲主機，可查詢一條或多條記錄，可根據名稱等多個查詢條件查詢。

請求引數

引數名引數型別是否必填引數說明
Region String 是

機房標識，取值參見地域列表
Action String 是

操作方法
EndTime String 否

建立結束時間 格式yyyy-MM-dd HH:mm:ss
DueStartTime String 否

到期開始時間 格式yyyy-MM-dd HH:mm:ss
DueEndTime String 否

到期結束時間 格式yyyy-MM-dd HH:mm:ss
ProductStatus String 否

產品狀態，取值範圍：

  • NORMAL：正常
  • OVERTIMER：過期
  • ARREARAGE：欠費
PayType String 否

付費型別，取值範圍：

  • PREPAID：包年包月
  • PROBATION：試用
ImageId String 否

映象Id
Offset Integer 否

記錄偏移量，不指定取0
Count Integer 否

記錄數量，不指定為全部
InstanceSeries String 否

主機系列，取值範圍：

  • SERIES_STANDARD：普通型
  • SERIES_SUPERCOMPUTER：計算增強型
Id.N String 否

雲主機Id，支援多個查詢，如Id.0=aa&Id.1=bb
Name String 否

雲主機名稱
Status String 否

雲主機執行狀態，取值範圍：

  • 開機：START
  • 關機：STOP
  • 異常：ERROR
  • 建立中：CREATING
  • 開機中：STARTING
  • 關機中：STOPING
  • 暫停中：PAUSING
  • 已暫停：PAUSED
  • 取消暫停中：UNPAUSING
  • 重啟中：REBOOTING
  • 修改配置中:RESIZING
  • 遷移中：MIGRATE
  • 刪除中：DELETING
  • 刪除錯誤：DELETE_ERROR
  • 重灌中：REBUILDING
  • 建立失敗：CREATE_ERROR
  • 快照還原中：ROLLING_BACK
FirewallId.N String 否

防火牆Id，支援多個查詢，如FirewallId.0=aa&FirewallId.1=bb
StartTime String 否

建立開始時間 格式yyyy-MM-dd HH:mm:ss

返回引數

名稱 型別 說明
Action String 執行的操作
TaskId String 請求標識
TotalCount Integer 記錄總數量
InstanceSet InstanceItemType 由InstanceItemType組成的陣列格式，返回例項資訊

InstanceItemType 節點

例項資訊的資料型別

名稱 型別 說明
Id String 例項標識
Name String 名稱
Status Integer 例項狀態
ProductStatus String 產品狀態。取值範圍：NORMAL-正常; OVERTIMER-過期; ARREARAGE-欠費
PayType String 支付型別 ONDEMAND：按量付費；PREPAID：包年包月。臨時例項忽略此引數
Task String 任務號
ProductModelId String 產品型號ID
Cpu Integer CPU 核數
Memory String 記憶體大小，單位是 GB
Password String 密碼
InitPassword String 初始密碼
KeyPair String 金鑰對ID
KeyPairName String 金鑰對名稱
CreateTime String 建立時間
DueTime String 到期時間
FirewallId String 防火牆ID
FirewallName String 防火牆名稱
ImageId String 映象ID
ImageName String 映象名稱
InstanceSeries String 主機系列
InterfaceSet InterfaceSetItemType 由InterfaceSetItemType組成的陣列格式，返回私有網路的資訊
Internet InternetItemType 由InternetItemType組成的陣列格式，返回公網IP的資訊
VolumeSet VolumeSetItemType 由VolumeSetItemType組成的陣列格式，返回雲硬碟的資訊

InterfaceSetItemType 節點

私有網路資訊的資料型別

名稱 型別 說明
Id String 網絡卡標識
NetworkId String 網路標識
NetworkName String 網路名稱
MacAddress String 網絡卡地址
IpAddress String IP 地址
Status String 狀態
Uuid String 網絡卡UUID

InternetItemType 節點

公網IP資訊的資料型別

Id String 網絡卡標識
Id String IP標識
IpAddress String IP地址
Bandwidth Integer IP頻寬,單位：Mbps
PayType String 支付型別 ONDEMAND：按量付費；PREPAID：包年包月；PROBATION 試用。
DueTime String 到期時間
AllocateTime String 購買時間
ProductStatus String 產品狀態
ProductModelId String 產品型號ID
ProductType String 產品型別

VolumeSetItemType 節點

雲硬碟資訊的資料型別

Id String 雲硬碟標識
Id Integer 雲硬碟標識
Name String 名稱
Size String 大小，單位GiB
Uuid String 雲硬碟UUID
Index String 掛載位置，0 標識系統盤，其它標識資料盤
PayType String 支付型別 ONDEMAND：按量付費；PREPAID：包年包月；PROBATION 試用。
DueTime String 到期時間
CreateTime String 建立時間
ProductStatus String NORMAL-正常，OVERTIMER-過期，ARREARAGE-欠費

請求示例

https://api.chinac.com/?Action=DescribeInstances
&Region=cn-wuxi
&Id.0=xxx
&<公共請求引數>

返回示例

{
    "code": 10000,
    "message": "",
    "data": {
        "TaskId": "az020160902171445364",
        "Action": "DescribeInstances",
        "TotalCount": 1,
        "InstanceSet": [{
        "Id": "i-t79ih48g8r64s",
            "Name": "cec170508g9cG",
            "Status": "START",
            "Task": "NONE",
            "ProductStatus": "NORMAL",
            "PayType": "PREPAID",
            "ProductModelId": "402124",
            "ProductType": "2核8G_SERIES_STANDARD",
            "Cpu": 2,
            "Memory": 8.0,
            "Password": "oA87A6bXvm6yAz+/uauEuA==",
            "KeyPair": null,
            "CreateTime": "2017-05-08T16:44:27 +0800",
            "DueTime": "2017-06-08T16:44:27 +0800",
            "CloseTime": "2017-06-08T17:44:27 +0800",
            "InterfaceSet": [{
                "Id": "p-lx9ih48g8l8b",
                "InstanceId": "i-t79ih48g8r64s",
                "NetworkId": "n-8q9ih3ka70250",
                "SubnetId": "s-qy9ih3ka7027r",
                "MacAddress": "fa:16:3e:fc:a9:ad",
                "IpAddress": "10.10.10.12",
                "Status": "ON_LINE",
                "Uuid": "385689f0-1dd6-4695-a2ca-09b9e0210e64",
                "Type": "CUSTOMER"
            }],
            "Internet": null,
            "VolumeSet": [{
                "Id": "v-379ih48g919j",
                "Name": "cec170508g9cGdata1",
                "Type": "normal",
                "PayType": "PREPAID",
                "Size": 20,
                "Index": 1,
                "DueTime": "2017-06-08T16:45:01 +0800",
                "CloseTime": "2017-06-08T17:45:01 +0800",
                "CreateTime": "2017-05-08T16:45:01 +0800",
                "Uuid": "f06894e9-fb18-4d01-8d92-178df43c1fb4",
                "ProductStatus": "NORMAL"
            },
            {
                "Id": "v-yr9ih48g8k95l",
                "Name": "cec170508g9cGsys",
                "Type": "normal",
                "PayType": "PREPAID",
                "Size": 40,
                "Index": 0,
                "DueTime": "2017-06-08T16:44:27 +0800",
                "CloseTime": null,
                "CreateTime": "2017-05-08T16:44:56 +0800",
                "Uuid": "15c6439c-57c8-4567-8fa4-5ec62d886e16",
                "ProductStatus": "NORMAL"
            }],
            "Uuid": "3e542822-7130-45d3-8af4-4a75dd6cebb1",
            "OwnerId": "18359229",
            "FirewallId": "f-um9ih3ka7i4",
            "ImageId": "t-189ih18e5t42t",
            "OsName": "Windows",
            "OsVersion": "2008",
            "OsBit": "64",
            "InitPassword": "qiCx9VopYs",
            "UserId": "18359229",
            "Locked": false,
            "IdLong": "i-t79ih48g8r64s-3e542822-7130-45d3-8af4-4a75dd6cebb1",
            "HostName": "controller",
            "InstanceSeries": "SERIES_STANDARD",
            "SeriesName": "普通型"
        }]
    }
}
*
*