CaaS / CVPC API 開發者中心

負載平衡

使用說明

createLoadBalancerPolicy主要是用於建立負載平衡服務，根據參數之不同，可建立以下幾項服務：

(1) CaaS負載平衡：建立使用於CaaS之負載平衡服務

(2) CVPC簡易型負載平衡：建立使用於CVPC平台之簡易型負載平衡服務

(3) CVPC進階型負載平衡設備：建立使用於CVPC平台之進階型負載平衡服務

(4) CVPC進階型負載平衡規則：建立CVPC進階型負載平衡所使用之負載平衡規則

以下分別針對上述之不同務服項目，進行說明。

CaaS 負載平衡 Request參數

參數 說明 備註
instanceId 主機服務識別碼列表
類型 : String
預設值 : 無
是否為複數型態 : 是
 可支援多值
port 外部服務埠號列表
類型 : Integer
預設值 : 無
是否為複數型態 : 是

loadBalancerPolicyName

(非必要參數)

 負載平衡服務名稱
類型 : String
預設值 : 無
是否為複數型態 : 否

regionId

 區域機房代碼
類型 : String
預設值 : 無
是否為複數型態 : 否
 "region-tw-1": 第一區域

CVPC 簡易型負載平衡 Request參數

參數 說明 備註
economyLoadBalancerVIPRouteDirection 外部服務IP路由方向
類型 : String
預設值 : 無
是否為複數型態 : 否
 0: Outside 1: Intranet
ipSubnetBusinessServiceId 子網段服務識別碼
類型 : String
預設值 : 無
是否為複數型態 : 否

loadBalancerType

 負載平衡類型
類型 : String
預設值 : 無
是否為複數型態 : 否
 0: 簡易型負載平衡

portsInfo

 埠設定
類型 : String
預設值 : 無
是否為複數型態 : 是
 可支援多值
簡易型負載平衡格式如下：
協定;;埠;;負載平衡規則;;;;健康度檢查方式
協定: 0: TCP 1: UDP
負載平衡規則: 0: Least Session 1: Round Robin 2: Ratio
健康度檢查方式: 0: TCP + port 1: TCP + ICMP

ripsInfo

 rip位址
類型 : String
預設值 : 無
是否為複數型態 : 是
 可支援多值
為IP格式

realServerWeight

(非必要參數)

 負載平衡分流權重
類型 : String
預設值 : 無
是否為複數型態 : 是
 portsInfo選擇 Ratio時為必要參數
格式：IP位址;;權重
IP位址: 雲伺服器IP
權重: 數值越大，被指配的連線越多，最小值為0

userAssignIp

 外部服務VIP位址
類型 : String
預設值 : 無
是否為複數型態 : 否
 路由方向為OutSide，選擇一組既有的Public IP位址 (需先申請「網際網路連線」)
路由方向為Intranet，選擇子網段內第四碼介於201~250的一組IP(需先申請「內網接取服務」)

vpcBusinessServiceId

 軟體資料中心服務識別碼
類型 : String
預設值 : 無
是否為複數型態 : 否

CVPC 進階型負載平衡設備 Request參數

參數 說明 備註

loadBalancerPolicyName

(非必要參數)

 負載平衡服務名稱
類型 : String
預設值 : 無
是否為複數型態 : 否

loadBalancerType

 負載平衡類型
類型 : String
預設值 : 無
是否為複數型態 : 否
 2: 進階型負載平衡設備

vpcBusinessServiceId

 軟體資料中心服務識別碼
類型 : String
預設值 : 無
是否為複數型態 : 否
ipSubnetBusinessServiceId 子網段服務識別碼
類型 : String
預設值 : 無
是否為複數型態 : 否

CVPC 進階型負載平衡規則 Request參數

參數 說明 備註
economyLoadBalancerVIPRouteDirection 外部服務IP路由方向
類型 : String
預設值 : 無
是否為複數型態 : 否
 0: Outside 1: Intranet

loadBalancerDeviceBusinessServiceId

(非必要參數)

 負載平衡設備服務識別碼
類型 : String
預設值 : 無
是否為複數型態 : 否

loadBalancerType

 負載平衡類型
類型 : String
預設值 : 無
是否為複數型態 : 否
 1: 進階型負載平衡規則

portsInfo

 埠設定
類型 : String
預設值 : 無
是否為複數型態 : 是
 可支援多值
進階型負載平衡格式如下：
協定;;埠;;負載平衡規則;;持續性方式;;健康度檢查方式
協定: 0: TCP 1: UDP
負載平衡規則: 0: Least Session 1: Round Robin 2: Ratio
持續性方式: 0: Cookie 2: Source Address 3: SSL 4: None
健康度檢查方式: 0: ICMP 1: TCP 2: TCP String 3: UDP 4: UDP String 5: HTTP File 6: HTTPs File

ripsInfo

 rip位址
類型 : String
預設值 : 無
是否為複數型態 : 是
 可支援多值
為IP格式

realServerWeight

(非必要參數)

 負載平衡分流權重
類型 : String
預設值 : 無
是否為複數型態 : 是
 portsInfo選擇 Ratio時為必要參數
格式：IP位址;;權重
IP位址: 雲伺服器IP
權重: 數值越大，被指配的連線越多，最小值為0

userAssignIp

 外部服務VIP位址
類型 : String
預設值 : 無
是否為複數型態 : 否
 路由方向為OutSide，選擇一組既有的Public IP位址 (需先申請「網際網路連線」)
路由方向為Intranet，選擇子網段內第四碼介於201~250的一組IP(需先申請「內網接取服務」)

Response參數

參數 說明 備註

requestId

(非必要參數)

 請求識別碼
類型 : JSON value : string
是否為複數型態 : 否 		系統自動產生
orderUuidList 訂單編號列表
類型 :JSON value : array
是否為複數型態 : 是
 string列表

Request範例

範例 1 (CaaS負載平衡):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=createLoadBalancerPolicy
&instanceId=BV550100010003
&instanceId=BV550100010004
&port=80
&port=81
&loadBalancerPolicyName=slbName
®ionId=${regionId}
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

範例 2 (CVPC簡易型負載平衡):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=createLoadBalancerPolicy
&economyLoadBalancerVIPRouteDirection=0
&ipSubnetBusinessServiceId=VQ55020001IOSQ
&loadBalancerType=0
&portsInfo=0;;53;;0;;;;0
&ripsInfo=10.27.1.1
&userAssignIp=210.61.223.21
&vpcBusinessServiceId=VV55020001IOSE
&chtAuthType=hwspass
&version=${version}
&accessKey=${accessKey}
&expires=${expires}
&signature=${signature}

範例 3 (CVPC進階型負載平衡設備(IPV4))):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=createLoadBalancerPolicy
&ipSubnetBusinessServiceId=VQ55020001IOSQ
&loadBalancerType=2
&vpcBusinessServiceId=VV55020001IOSE
&chtAuthType=hwspass
&version=${version}
&accessKey=${accessKey}
&expires=${expires}
&signature=${signature}


範例 4 (CVPC進階型負載平衡設備IPV6):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=createLoadBalancerPolicy
&ipSubnetBusinessServiceId=VQ55020001IOSH
&loadBalancerType=2
&vpcBusinessServiceId=VV55020001IOSE
&loadBalancerPolicyName=ipv6test
&description=testipv6
&chtAuthType=hwspass
&version=${version}
&accessKey=${accessKey}
&expires=${expires}
&signature=${signature}


範例 5 (CVPC進階型負載平衡規則 ipv4):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=createLoadBalancerPolicy
&loadBalancerDeviceBusinessServiceId=VE55020001IOSA
&loadBalancerType=1
&economyLoadBalancerVIPRouteDirection=1
&portsInfo=0;;5;;0;;4;;1
&userAssignIp=ripsInfo=172.30.10.1&172.30.10.201
&chtAuthType=hwspass
&version=${version}
&accessKey=${accessKey}
&expires=${expires}
&signature=${signature}


範例 6 (CVPC進階型負載平衡規則 ipv6):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=createLoadBalancerPolicy
&loadBalancerDeviceBusinessServiceId=VE55020001IOSC
&loadBalancerType=1
&economyLoadBalancerVIPRouteDirection=1
&portsInfo=0;;53;;0;;4;;1
&ripsInfo=2001:B034:2000:F224:250:56EF:FE8D:E55/128
&chtAuthType=hwspass
&version=${version}
&accessKey=${accessKey}
&expires=${expires}
&signature=${signature}

Response範例

{
	"requestId":"xxxEXAMPLE",
	"orderUuidList": ["609b609d-9ed3-464a-ace8-f2573e6d1263"]
}

相關連結

deleteLoadBalancerPolicy
describeLoadBalancerPolicies
replaceLoadBalancerPolicy
querySlbVIPHealthStatus

錯誤訊息

IncorrectOrderProcessResultCode
InvalidParameterValue
OrderProcessFail
客服專線：0800-080-365　　聯絡我們：hicloud@cht.com.tw
中華電信版權所有 © 2011 Chunghwa Telecom All Rights Reserved. 隱私權保護