在指定地域創建服務器組。
接口說明
CreateServerGroup 接口屬于異步接口，即系統返回一個請求 ID，但該網絡型負載均衡的服務器組尚未創建成功，系統后臺的創建任務仍在進行。您可以調用 GetJobStatus 查詢服務器組的創建狀態：
- 當任務狀態處于 Succeeded 時，表示服務器組創建成功。
- 當任務狀態處于 Processing 時，表示服務器組正在創建中，在該狀態下，您只能執行查詢操作，不能執行其他操作。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| nlb:CreateServerGroup | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ServerGroupType | string | 否 | 服務器組類型。取值：
| Instance |
| ServerGroupName | string | 是 | 服務器組名稱。 長度為 2~128 個字符，必須以大小寫字母或中文開頭，可包含數字、半角句號（.）、下劃線（_）和短劃線（-）。 | NLB_ServerGroup |
| AddressIPVersion | string | 否 | 協議版本。取值：
| ipv4 |
| Protocol | string | 否 | 轉發到后端服務器使用的通信協議。取值：
說明
| TCP |
| VpcId | string | 是 | 服務器組所在 VPC 的 ID。 說明
如果 ServerGroupType 取值為 Instance 時，只有該 VPC 下的服務器可以加入到該服務器組。
| vpc-bp15zckdt37pq72zv**** |
| AnyPortEnabled | boolean | 否 | 是否開啟全端口轉發。取值：
| false |
| ConnectionDrainEnabled | boolean | 否 | 是否開啟連接優雅中斷。取值：
| false |
| ConnectionDrainTimeout | integer | 否 | 設置連接優雅中斷超時時間。單位：秒。 取值范圍：0~900。 | 10 |
| Scheduler | string | 否 | 調度算法。取值：
說明
僅后端協議為 UDP 時，支持選擇 QUIC ID 哈希。
| Wrr |
| PreserveClientIpEnabled | boolean | 否 | 是否開啟客戶端地址保持功能。取值：
說明
當 Protocol 取值為 TCP 且該參數取值為 true 時，該服務器組不支持關聯 TCPSSL 監聽。
| true |
| HealthCheckConfig | object | 否 | 健康檢查相關配置。 | |
| HealthCheckEnabled | boolean | 否 | 是否開啟健康檢查，取值：
| true |
| HealthCheckType | string | 否 | 健康檢查協議。取值：
| TCP |
| HealthCheckConnectPort | integer | 否 | 健康檢查的后端服務器的端口。 取值范圍： 0~65535。 默認值：0，表示使用后端服務器的端口進行健康檢查。 | 0 |
| HealthyThreshold | integer | 否 | 健康檢查連續成功多少次后，將后端服務器的健康檢查狀態由失敗判定為成功。 取值范圍：2~10。 默認值：2。 | 2 |
| UnhealthyThreshold | integer | 否 | 健康檢查連續失敗多少次后，將后端服務器的健康檢查狀態由成功判定為失敗。 取值范圍：2~10。 默認值：2。 | 2 |
| HealthCheckConnectTimeout | integer | 否 | 健康檢查響應的最大超時時間。單位：秒。 取值范圍：1~300。 默認值：5。 | 5 |
| HealthCheckInterval | integer | 否 | 健康檢查的時間間隔。單位：秒。默認值：5
| 5 |
| HealthCheckDomain | string | 否 | 用于健康檢查的域名。取值：
說明
僅 HealthCheckType 為 HTTP 時，該參數生效。
| $SERVER_IP |
| HealthCheckUrl | string | 否 | 健康檢查路徑。 長度為 1~80 個字符，只能使用大小寫英文字母、數字、字符 說明
僅 HealthCheckType 為 HTTP 時，該參數生效。
| /test/index.html |
| HealthCheckHttpCode | array | 否 | 健康狀態返回碼，多個狀態碼用半角逗號（,）分隔。 取值：http_2xx（默認值）、http_3xx、http_4xx和http_5xx。 說明
僅 HealthCheckType 為 HTTP 時，該參數生效。
| |
| HealthCheckHttpCode | string | 否 | 健康狀態返回碼，多個狀態碼用半角逗號（,）分隔。 取值：http_2xx（默認值）、http_3xx、http_4xx和http_5xx。 說明
僅 HealthCheckType 為 HTTP 時，該參數生效。
| http_2xx |
| HttpCheckMethod | string | 否 | 健康檢查方法，取值：GET（默認值）或 HEAD。 說明
僅 HealthCheckType 為 HTTP 時，該參數生效。
| GET |
| HealthCheckReq | string | 否 | UDP 監聽健康檢查的請求字符串，只允許包含字母、數字，最大長度限制為 512 個字符。 | hello |
| HealthCheckExp | string | 否 | UDP 監聽健康檢查的請求字符串，只允許包含字母、數字，最大長度限制為 512 個字符。 | ok |
| ResourceGroupId | string | 否 | 服務器組所屬的資源組 ID。 | rg-atstuj3rtop**** |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| true |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
| RegionId | string | 否 | 網絡型負載均衡實例所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| Tag | array<object> | 否 | 標簽列表。 | |
| object | 否 | 標簽。 | ||
| Key | string | 否 | 標簽鍵。最多支持 64 個字符，不能以 一次調用最多支持添加 20 個標簽。 | env |
| Value | string | 否 | 標簽值。最多支持 128 個字符，不能以 一次調用最多支持添加 20 個標簽。 | product |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"ServerGroupId": "sgp-atstuj3rtoptyui****",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig | The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal. | 服務器組的配置與健康檢查設置沖突。請檢查配置參數。 |
| 400 | IllegalParamFormat.ParseCreateRsPoolRequestFailed | The param format of CreateRsPoolRequest is illegal. | CreateRsPoolRequestFailed的參數格式不合法，請參考OpenAPI文檔檢查請求參數。 |
| 400 | IllegalParam.PreserveClientIpSwitch | The param of PreserveClientIpSwitch is illegal. | - |
| 400 | OperationDenied.VpcNotSupportIpv6 | The operation is not allowed because of VpcNotSupportIpv6. | 使用的VPC不支持Ipv6。 |
| 400 | IllegalParam.healthCheckDomain | The parameter of healthCheckConfig.healthCheckDomain is illegal. | 健康檢查配置中的healthCheckDomain非法，請檢查輸入參數。 |
| 400 | OperationDenied.UidNotAllowQuic29 | The operation is not allowed because of uid not allow quic29 version. | 用戶ID不支持Quic29，請聯系客戶經理加白。 |
| 400 | IlleagalParam.healthCheckUrl | The parameter of healthCheckUrl in healthCheckConfig is illegal. | 健康檢查設置中使用的健康檢查的URL不合法。 |
| 400 | IllegalParam.ServerGroupName | The param of ServerGroupName is illegal. | 傳入的ServerGroupName參數非法 |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | dryRun請求驗證已通過。 |
| 400 | MissingParam.%s | The parameter of %s is missing. | 參數%s缺失，請檢查輸入參數。 |
| 400 | IllegalParam.ConnectionDrainTimeout | The param of ConnectionDrainTimeout is illegal. | 參數ConnectionDrainTimeout非法，請檢查輸入參數。 |
| 400 | IllegalParam | The param of %s is illegal. | 輸入的參數有值非法，請檢查輸入。 |
| 400 | SystemBusy | System is busy, please try again later. | 系統繁忙，請稍后重試 |
| 400 | QuotaExceeded.QuotaInsufficient | The quota of %s is exceeded, usage %s/%s. | 配額不足，已使用%s/%s。請在配額中心中修改配額大小。 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因為賬號沒有權限，所以鑒權失敗。 |
| 404 | ResourceNotFound.Vpc | The specified resource of Vpc is not found. | 找不到指定的VPC資源，請檢查輸入參數。 |
| 404 | ResourceNotFound.ResourceGroup | The param of resourceGroup not existed. | 資源組不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-06-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-02-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-02-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-02-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-01-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-12-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-07 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-09-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-18 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-09-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-08-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-06-30 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2023-06-29 | OpenAPI 入參發生變更 | 查看變更詳情 |