在指定地區建立伺服器組。
介面說明
CreateServerGroup 介面屬於非同步介面,即系統返回一個請求 ID,但該伺服器組尚未建立成功,系統背景建立任務仍在進行。您可以調用 ListServerGroups 查詢服務器組的建立狀態:
當伺服器組處於 Creating 狀態時,表示伺服器組正在建立中。
當伺服器組處於 Available 狀態時,表示伺服器組建立成功。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
alb:CreateServerGroup |
create |
*ServerGroup
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ServerGroupName |
string |
是 |
伺服器組名稱。長度為 2~128 個字元,必須以大小寫字母或中文開頭,可包含數字、半形句號(.)、底線(_)和短劃線(-)。 |
test |
| ServerGroupType |
string |
否 |
伺服器群組類型。取值:
|
Instance |
| VpcId |
string |
否 |
VPC 執行個體 ID。只有該 VPC 下的伺服器可以加入到該伺服器組。 說明
ServerGroupType 取值為 Instance 或 Ip 時,該參數生效。 |
vpc-bp15zdkdt37pq72zv**** |
| Scheduler |
string |
否 |
調度演算法。取值:
說明
ServerGroupType 取值為 Instance 或 Ip 時,該參數生效。 |
Wrr |
| Protocol |
string |
否 |
後端協議。取值:
說明
ServerGroupType 取值為 Fc 時,無需配置後端協議。 |
HTTP |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-atstuj3rsop**** |
| HealthCheckConfig |
object |
是 |
健全狀態檢查相關配置。 |
|
| HealthCheckConnectPort |
integer |
否 |
健全狀態檢查的後端伺服器的連接埠。 取值範圍: 0~65535。 預設值:0,表示使用後端伺服器的連接埠進行健全狀態檢查。 |
80 |
| HealthCheckEnabled |
boolean |
是 |
是否開啟健全狀態檢查,取值:
說明
ServerGroupType 取值為 Instance 或 Ip 時,預設開啟健全狀態檢查。ServerGroupType 取值為 Fc 時,預設不開啟健全狀態檢查。 |
true |
| HealthCheckHost |
string |
否 |
健全狀態檢查網域名稱。
說明
只有 HealthCheckProtocol 設定為 HTTP、HTTPS 或 gRPC 時,該參數生效。 |
www.example.com |
| HealthCheckCodes |
array |
否 |
健全狀態檢查正常的狀態代碼列表。 |
|
|
string |
否 |
健全狀態檢查正常的狀態代碼。
說明
HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC,該參數生效。 |
http_2xx |
|
| HealthCheckHttpVersion |
string |
否 |
健全狀態檢查 HTTP 協議版本,取值:HTTP1.0或HTTP1.1(預設值)。 說明
只有 HealthCheckProtocol 設定為 HTTP 或 HTTPS 時,該參數生效。 |
HTTP1.1 |
| HealthCheckInterval |
integer |
否 |
健全狀態檢查的時間間隔。單位:秒。 取值範圍:1~50。 預設值:2。 |
2 |
| HealthCheckMethod |
string |
否 |
健全狀態檢查方法,取值:
說明
只有 HealthCheckProtocol 設定為 HTTP 或 HTTPS 或 gRPC 時,該參數生效。 |
HEAD |
| HealthCheckPath |
string |
否 |
健全狀態檢查的轉寄規則路徑。 長度為 1~80 個字元,只能使用字母、數字、字元 說明
只有 HealthCheckProtocol 設定為 HTTP 或 HTTPS 時,該參數生效。 |
/test/index.html |
| HealthCheckProtocol |
string |
否 |
健全狀態檢查協議,取值:
|
HTTP |
| HealthCheckTimeout |
integer |
否 |
接收來自健全狀態檢查的響應需要等待的時間。如果後端伺服器在指定的時間內沒有正確響應,則判定為健全狀態檢查失敗。單位:秒。 取值範圍:1~300。 預設值:5。 |
5 |
| HealthyThreshold |
integer |
否 |
健全狀態檢查連續成功多少次後,將後端伺服器的健全狀態檢查狀態由失敗判定為成功。 取值範圍:2~10。 預設值:3。 |
3 |
| UnhealthyThreshold |
integer |
否 |
健全狀態檢查連續失敗多少次後,將後端伺服器的健全狀態檢查狀態由成功判定為失敗。 取值範圍:2~10。 預設值:3。 |
3 |
| StickySessionConfig |
object |
否 |
會話保持配置結構體。 說明
ServerGroupType 取值為 Instance 或 Ip 時,該參數生效。 |
|
| Cookie |
string |
否 |
伺服器上配置的 Cookie。 長度為 1~200 個字元,只能包含 ASCII 英文字母和數字字元,不能包含半形逗號(,)、半形分號(;)或空格,也不能以貨幣符號($)開頭。 說明
當 StickySessionEnabled 為 true 且 StickySessionType 為 server 時,該參數生效。 |
B490B6EBF6F3CD402E515D22BCDA**** |
| CookieTimeout |
integer |
否 |
Cookie 逾時時間。單位:秒。 取值範圍:1~86400。 預設值:1000。 說明
當 StickySessionEnabled 為 true 且 StickySessionType 為 Insert 時,該參數生效。 |
1000 |
| StickySessionEnabled |
boolean |
否 |
是否啟用會話保持,取值:
說明
ServerGroupType 取值為 Instance 或 Ip 時,該參數生效。 |
false |
| StickySessionType |
string |
否 |
Cookie 的處理方式。取值:
說明
當 StickySessionEnabled 的值為 true 時,該參數生效。 |
Insert |
| ClientToken |
string |
否 |
用戶端 Token,用於保證請求的等冪性。 從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。 |
5A2CAF0E-5718-45B5-9D4D-70B****** |
| DryRun |
boolean |
否 |
是否只預檢此次請求,取值:
|
false |
| Ipv6Enabled |
boolean |
否 |
是否開啟 Ipv6 |
|
| UpstreamKeepaliveEnabled |
boolean |
否 |
是否開啟後端長連結。
|
false |
| ServiceName |
string |
否 |
僅適用於 ALB Ingress 情境,表示伺服器組對應的 |
test |
| UchConfig |
object |
否 |
url 一致性 hash 參數配置。 |
|
| Type |
string |
是 |
參數類型。只能填 QueryString。 |
QueryString |
| Value |
string |
是 |
一致性 hash 參數值。 |
abc |
| ConnectionDrainConfig |
object |
否 |
串連優雅中斷相關配置。 開啟串連優雅中斷,在移除後端伺服器或者健全狀態檢查失敗後,負載平衡使現有串連在一定時間內正常傳輸。 說明
|
|
| ConnectionDrainEnabled |
boolean |
否 |
是否開啟串連優雅中斷。
|
false |
| ConnectionDrainTimeout |
integer |
否 |
串連優雅中斷逾時時間。 取值範圍:0~900。 預設值:300。 |
300 |
| SlowStartConfig |
object |
否 |
慢啟動相關配置。 開啟慢啟動後,將會在設定的時間段內對新添加到後端伺服器組的後端伺服器進行預熱,轉寄到該伺服器的請求數量線性增加。 說明
|
|
| SlowStartEnabled |
boolean |
否 |
是否開啟慢啟動。
|
false |
| SlowStartDuration |
integer |
否 |
慢啟動期間。 取值範圍:30~900。 預設值:30。 |
30 |
| Tag |
array<object> |
否 |
標籤。 |
|
|
object |
否 |
標籤結構。 |
||
| Key |
string |
否 |
標籤鍵。最多支援 128 個字元,不能以 |
env |
| Value |
string |
否 |
標籤值。最多支援 128 個字元,不能以 |
product |
| CrossZoneEnabled |
boolean |
否 |
伺服器組是否開啟跨 AZ 負載平衡。取值:
說明
|
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資料結構體 |
||
| JobId |
string |
非同步任務 ID。 |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
請求 ID。 |
365F4154-92F6-4AE4-92F8-7FF****** |
| ServerGroupId |
string |
伺服器組 ID。 |
sgp-8ilqs4axp6****** |
樣本
正常返回樣本
JSON格式
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
"ServerGroupId": "sgp-8ilqs4axp6******"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | QuotaExceeded.ServerGroupsNum | The quota of %s is exceeded, usage %s/%s. | 配額%s已超額度限制,目前已使用%s,配額為%s。 |
| 400 | Mismatch.LoadBalancerEditionAndSlowStartEnable | The %s and %s are mismatched. | 參數%s和%s不匹配。 |
| 400 | Mismatch.ServerGroupSchedulerAndSlowStartEnable | The %s and %s are mismatched. | 參數%s和%s不匹配。 |
| 400 | QuotaExceeded.SlowStartDuration | The quota of %s is exceeded, usage %s/%s. | 參數%s超過配額限制,當前值%s,配額值%s。 |
| 400 | UnsupportedFeature.SlowStart | The feature of %s is not supported. | 不支援%s特性。 |
| 400 | Mismatch.LoadBalancerEditionAndConnectionDrain | The %s and %s are mismatched. | 參數%s和%s不匹配。 |
| 400 | QuotaExceeded.ConnectionDrainTimeout | The quota of %s is exceeded, usage %s/%s. | 參數%s超過配額限制,當前值%s,配額值%s。 |
| 400 | UnsupportedFeature.ConnectionDrain | The feature of %s is not supported. | 不支援%s特性。 |
| 400 | NotExist.ResourceGroup | ResourceGroup does not exist. | 資源群組不存在 |
| 400 | OperationDenied.VpcNotSupportIpv6 | The operation is not allowed because of VpcNotSupportIpv6. | 不允許該操作,原因:當前VPC未開啟IPv6功能 |
| 400 | UnsupportedFeature.FcServerGroup | Server groups of type FC are not supported. | 不支援FC類型的伺服器組 |
| 404 | ResourceNotFound.Vpc | The specified resource %s is not found. | VPC不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。