使用說明
describeInstances主要是用於列出一組以上雲伺服器的詳細資訊。 若沒有instanceId或orderUuid的參數，則會列出所有雲伺服器的資訊。 關於雲伺服器的預設帳號密碼，請在進入用戶入口後，點選 "下載 vm 列表預設密碼"，此壓縮檔的密碼為證號後四碼。
Request參數
| 參數 | 說明 | 備註 |
|---|---|---|
| instanceId
(非必要參數) |
主機服務識別碼列表 類型 : String 預設值 : 無 是否為複數型態 : 是 |
可支援多值 |
| orderUuid
(非必要參數) |
訂單編號列表 類型 : String 預設值 : 無 是否為複數型態 : 是 |
可支援多值 |
|
businessTag (非必要參數) |
業務類別 類型 : String 預設值 : 無 是否為複數型態 : 否 |
請參考 業務類別 |
|
vpcBusinessServiceId (非必要參數) |
軟體資料中心服務識別碼 類型 : String 預設值 : 無 是否為複數型態 : 否 |
Response參數
| 參數 | 說明 | 備註 |
|---|---|---|
| requestId
(非必要參數) |
請求識別碼 類型 : JSON value : string 是否為複數型態 : 否 |
系統自動產生 |
| instanceList | 雲伺服器資訊 類型 : JSON value : array 是否為複數型態 : 是(List) |
VirtualMachineEntry列表 |
Request範例
範例1:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeInstances
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
範例2:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeInstances
&instanceId=BV550100010003
&instanceId=BV550100010004
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
Response範例
[
"requestId":"xxxEXAMPLE",
{
"orderUuid": "75cee802-1ed4-4a2a-8078-ca0a29deeff0",
"instanceId": "BV550100010003",
"applyDate": "2012-01-01T01:01:01Z",
"startDate": "2012-01-01T01:01:01Z",
"endDate": null,
"name": "myVm01",
"operationStatus": "vmStart",
"provisionStatus": "provisioning",
"provisionMessage": null,
"ipForNat": "172.10.10.1",
"ipForVm": "192.168.150.1",
"businessTag": "cb168f20-c515-4e41-84cd-830dedfe7f49",
"regionId": "region-tw-1"
},
{
"orderUuid": "0762e00f-df4b-48d0-93bd-4f355c85b2d8",
"instanceId": "BV550100010004",
"applyDate": "2012-01-01T01:01:01Z",
"startDate": "2012-01-01T01:01:01Z",
"endDate": null,
"name": "myVm01",
"operationStatus": "vmStart",
"provisionStatus": "provisioning",
"provisionMessage": null,
"ipForNat": "172.10.10.1",
"ipForVm": "192.168.150.1",
"businessTag": "cb168f20-c515-4e41-84cd-830dedfe7f49",
"regionId": "region-tw-1"
}
]