使用說明
describeSubnets用於列出一組以上子網段的詳細資訊，有以下幾種方式：
1.不帶任何參數：查詢所有CaaS subnet，如範例1。注意：此查詢方式不會回傳subnet,subnetType。
2.帶多個subnetBusinessServiceId或orderUuid(可混合同時帶入)：查詢這兩個參數對應之subnet(無視其他參數)，如範例2~4。 注意：此查詢方式不會回傳description,gatewayIp,subnet,subnetType。
3.帶businessTag、vpcBusinessServiceId：當subnetBusinessServiceId及orderUuid均為空時，才使用此二參數，可能的組合如下：
(1)null + null：效果同CaaS + null，查詢所有CaaS subnet(同規則1)，如範例5。
(2)null + vpcBusinessServiceId：效果同CVPC + vpcBusinessServiceId，查詢指定軟體資料中心下的subnet，如範例6。 注意：此查詢方式不會回傳zoneId。
(3)CVPC + null：不支援此查詢方式，不會回傳任何資料。
(4)CaaS + vpcBusinessServiceId：不支援此查詢方式，不會回傳任何資料。
Request參數
| 參數 | 說明 | 備註 |
|---|---|---|
| subnetBusinessServiceId (非必要參數) |
子網段服務識別碼列表 類型 : String 預設值 : 無 是否為複數型態 : 是 |
可支援多值 |
| orderUuid (非必要參數) |
訂單編號 類型 : String 預設值 : 無 是否為複數型態 : 是 |
可支援多值 |
| businessTag (非必要參數) |
業務類別 類型 : String 預設值 : 無 是否為複數型態 : 否 |
請參考 業務類別 |
| vpcBusinessServiceId (非必要參數) |
軟體資料中心服務識別碼 類型 : String 預設值 : 無 是否為複數型態 : 否 |
Response參數
| 參數 | 說明 | 備註 |
|---|---|---|
requestId (非必要參數) |
請求識別碼 類型 : JSON value : string 是否為複數型態 : 否 |
系統自動產生 |
| subnetList |
子網段資訊列表 類型 : JSON value : array 是否為複數型態 : 是 |
SubnetEntry列表 |
Request範例
範例 1:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
範例 2:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&subnetBusinessServiceId=VQ55020001IOSQ
&subnetBusinessServiceId=VQ55020001IOSS
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
範例 3:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&orderUuid=31c2540b-e3dc-4aa2-a0f8-282270da268f
&orderUuid=9e20419a-f148-4124-829f-5670b6bb1289
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
範例 4:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&subnetBusinessServiceId=VQ55020001IOSQ
&orderUuid=9e20419a-f148-4124-829f-5670b6bb1289
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
範例 5：
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&businessTag=cb168f20-c515-4e41-84cd-830dedfe7f49
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
範例 6:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeSubnets
&businessTag=a2931aa4-8751-4f09-8df3-bcc0d18f8b75
&vpcBusinessServiceId=VV55020001IOSE
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
Response範例
{
"requestId": "xxxEXAMPLE",
"subnetList": [
{
"applyDate": "2016-10-01T01:01:01Z",
"businessTag": "a2931aa4-8751-4f09-8df3-bcc0d18f8b75",
"description": "myDescription1",
"endDate": null,
"gatewayIp": "172.23.0.254",
"name": "myName1",
"orderUuid": "31c2540b-e3dc-4aa2-a0f8-282270da268f",
"provisionMessage": "PROVISION_SUCCESS",
"provisionStatus": "provisionok",
"regionId": "region-tw-1",
"startDate": "2016-10-01T01:01:01Z",
"subnet": "172.23.0.0/24",
"subnetBusinessServiceId": "VQ55020001IOSQ",
"subnetType": "VM",
"zoneId": null
},
{
"applyDate": "2016-10-01T01:01:01Z",
"businessTag": "a2931aa4-8751-4f09-8df3-bcc0d18f8b75",
"description": myDescription2,
"endDate": null,
"gatewayIp": "192.168.88.254",
"name": "myName2",
"orderUuid": "9e20419a-f148-4124-829f-5670b6bb1289",
"provisionMessage": "PROVISION_SUCCESS",
"provisionStatus": "provisionok",
"regionId": "region-tw-1",
"startDate": "2016-10-01T01:01:01Z",
"subnet": "192.168.88.0/24",
"subnetBusinessServiceId": "VQ55020001IOSS",
"subnetType": "VM",
"zoneId": null
}
]
}