使用說明
describeLoadBalancerPolicies主要是用於列出一組以上負載平衡的詳細資訊,適用於CaaS及CVPC負載平衡。根據request參數不同可進行下列查詢:
(1) loadBalancerId 及 orderUuid:列出所對應之負載平衡資訊。
(2) vpcBusinessServiceId 及 loadBalancerType:列出此CVPC下,指定類型之負載平衡資訊,若無loadBalancerType,則回傳進階型負載平衡設備的資訊。
(3) loadBalancerDeviceBusinessServiceId:列出此CVPC進階型負載平衡設備所對應之負載平衡規則資訊
(4) businessTag 及 loadBalancerType:列出CaaS或CVPC之所有負載平衡資訊。若為CVPC業務,會根據loadBalancerType回傳指定類型之負載平衡資訊,若無loadBalancerType,則回傳進階型負載平衡設備的資訊。
(5) 無任何參數:列出CaaS之負載平衡的資訊。
上述各類查詢並不會同時執行,若同時帶入多個request參數,則依據上方編號,由編號小的優先執行。
Request參數
參數 | 說明 | 備註 |
---|---|---|
loadBalancerId
(非必要參數) |
負載平衡服務識別碼列表 類型 : String 預設值 : 無 是否為複數型態 : 是 |
可支援多值 |
orderUuid
(非必要參數) |
訂單編號列表 類型 : String 預設值 : 無 是否為複數型態 : 是 |
可支援多值 |
vpcBusinessServiceId
(非必要參數) |
軟體資料中心服務識別碼 類型 : String 預設值 : 無 是否為複數型態 : 否 |
|
loadBalancerDeviceBusinessServiceId (非必要參數) |
負載平衡設備服務識別碼 類型 : String 預設值 : 無 是否為複數型態 : 否 |
|
businessTag |
業務類別 類型 : String 預設值 : 無 是否為複數型態 : 否 |
請參考 業務類別 |
loadBalancerType
(非必要參數) |
負載平衡類型 類型 : String 預設值 : 無 是否為複數型態 : 否 |
0: 簡易型負載平衡 1: 進階型負載平衡規則 2: 進階型負載平衡設備 |
Response參數
參數 | 說明 | 備註 |
---|---|---|
requestId
(非必要參數) |
請求識別碼 類型 : JSON value : string 是否為複數型態 : 否 |
系統自動產生 |
loadBalancerList | 負載平衡資訊列表 類型 : JSON value : array 是否為複數型態 : 是 |
對應CaaS負載平衡、CVPC進階型負載平衡設備 ServerLoadBalancerEntry列表 |
loadBalancerPolicyList | 負載平衡規則資訊列表 類型 : JSON value : array 是否為複數型態 : 是 |
對應CVPC簡易型負載平衡、進階型負載平衡規則: ServerLoadBalancerPolicyEntry列表 |
Request範例
範例1 列出所有CaaS負載平衡: https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeLoadBalancerPolicies &chtAuthType=hwspass &version=${version} &expires=${expires} &accessKey=${accessKey} &signature=${signature} 範例2 列出CVPC下所有負載平衡: https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeLoadBalancerPolicies &vpcBusinessServiceId=VV55020001IOSE &chtAuthType=hwspass &version=${version} &expires=${expires} &accessKey=${accessKey} &signature=${signature} 範例3 列出指定的負載平衡: https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeLoadBalancerPolicies &loadBalancerId=BL550100010003 &loadBalancerId=BL550100010004 &chtAuthType=hwspass &version=${version} &expires=${expires} &accessKey=${accessKey} &signature=${signature}
Response範例
{ "requestId": "xxxEXAMPLE", "loadBalancerList": [ { "applyDate": "2013-04-25T09:18:37Z", "loadBalancerId": "BL550100010507", "businessTag": "cb168f20-c515-4e41-84cd-830dedfe7f49", "endDate": null, "ip": "210.61.222.12", "orderUuid": "d044640a-f67b-44ed-88a9-9f8f5492f4c5", "provisionMessage": "provisionok", "provisionStatus": "provisionok", "startDate": "2013-04-25T09:19:00Z", "instanceIdList": [ "BV55010001000H", "BV55010001000G" ], "loadBalancerPolicyName": "TestSLB", "portList": [ 80, 443 ], "regionId": "region-tw-1" } ] "loadBalancerPolicyList":[ { "businessServiceId":"VL55020001IOSR", "economyLoadBalancerVIPRouteDirection":"0", "ipProtocolVersion":"0", "ipSubnetBusinessServiceId":"VQ55020001IOSQ", "loadBalancerDeviceBusinessServiceId":null, "loadBalancerType":"0", "orderUuid":"2fc2a227-ca28-4a73-b897-63da012eeeae", "portsInfo":["0;;1;;0;;;;0"], "provisionStatus":"setting", "realServerWeight":[], "ripTargetAdapter":null, "ripsInfo":["172.23.0.2"], "scalingGroupId":null, "userAssignIp":"210.61.223.21", "vpcBusinessServiceId":"VV55020001IOSE" } ] }