全部產品
Search

搜尋本產品

    ：CreateServerGroup - 建立伺服器組

    文件中心

    ：CreateServerGroup - 建立伺服器組

    更新時間：Dec 10, 2025

    在指定地區建立伺服器組。

    介面說明

    CreateServerGroup 介面屬於非同步介面，即系統返回一個請求 ID，但該網路型負載平衡的伺服器組尚未建立成功，系統背景建立任務仍在進行。您可以調用 GetJobStatus 查詢服務器組的建立狀態：

    • 當任務狀態處於 Succeeded 時，表示伺服器組建立成功。

    • 當任務狀態處於 Processing 時，表示伺服器組正在建立中，在該狀態下，您只能執行查詢操作，不能執行其他動作。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    nlb:CreateServerGroup

    create

    *ServerGroup

    acs:nlb:{#regionId}:{#accountId}:servergroup/*

    *VPC

    acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ServerGroupType

    string

    否

    伺服器群組類型。取值：

    • Instance（預設值）：伺服器類型，該類型伺服器組支援添加 Ecs、Eni、Eci 類型執行個體。

    • Ip：IP 位址類型，該類型伺服器組支援直接添加 IP 位址類型的後端伺服器。

    Instance
    ServerGroupName

    string

    是

    伺服器組名稱。

    長度為 2~128 個字元，必須以大小寫字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-）。

    NLB_ServerGroup
    AddressIPVersion

    string

    否

    協議版本。取值：

    • ipv4（預設值）：IPv4 類型。

    • DualStack：雙棧類型。

    ipv4
    Protocol

    string

    否

    轉寄到後端伺服器使用的通訊協定。取值：

    • TCP（預設值）

    • UDP

    • TCP_UDP

    說明

    • 當該參數取值為 UDP 時，該伺服器組只支援關聯 UDP 監聽。

    • 當該參數取值為 TCP 且 PreserveClientIpEnabled 取值為 true 時，該伺服器組只支援關聯 TCP 監聽。

    • 當該參數取值為 TCP 且 PreserveClientIpEnabled 取值為 false 時，該伺服器組支援關聯 TCPSSL 監聽和 TCP 監聽。

    • 當該參數取值為TCP_UDP時，該伺服器組支援關聯 TCP 監聽和 UDP 監聽。

    TCP
    VpcId

    string

    是

    伺服器組所在 VPC 的 ID。

    說明

    如果 ServerGroupType 取值為 Instance 時，只有該 VPC 下的伺服器可以加入到該伺服器組。

    vpc-bp15zckdt37pq72zv****
    AnyPortEnabled

    boolean

    否

    是否開啟全連接埠轉寄。取值：

    • true：開啟。

    • false（預設值）：關閉。

    false
    ConnectionDrainEnabled

    boolean

    否

    是否開啟串連優雅中斷。取值：

    • true：開啟。

    • false（預設值）：關閉。

    false
    ConnectionDrainTimeout

    integer

    否

    設定串連優雅中斷逾時時間。單位：秒。 取值範圍：0~900。

    10
    Scheduler

    string

    否

    調度演算法。取值：

    • Wrr（預設值）：加權輪詢，權重值越高的後端伺服器，被輪詢到的機率也越高。

    • Wlc：加權最小串連數，除了根據每台後端伺服器設定的權重值來進行輪詢，同時還考慮後端伺服器的實際負載（即串連數）。當權重值相同時，當前串連數越小的後端伺服器被輪詢到的機率也越高。

    • rr：輪詢，按照訪問順序依次將外部請求分發到後端伺服器。

    • sch：源 IP 雜湊：相同的源地址會調度到相同的後端伺服器。

    • tch：四元組雜湊，基於四元組（源 IP、目的 IP、源連接埠和目的連接埠）的一致性雜湊，相同的流會調度到相同的後端伺服器。

    • qch：QUIC ID 雜湊，支援將同一個 QUIC ID 的請求雜湊到同一台後端伺服器上。

    說明

    僅後端協議為 UDP 時，支援選擇 QUIC ID 雜湊。

    Wrr
    PreserveClientIpEnabled

    boolean

    否

    是否開啟用戶端地址保持功能。取值：

    • true（預設值）：開啟。

    • false：關閉。

    說明

    當 Protocol 取值為 TCP 且該參數取值為 true 時，該伺服器組不支援關聯 TCPSSL 監聽。

    true
    HealthCheckConfig

    object

    否

    健全狀態檢查相關配置。

    HealthCheckEnabled

    boolean

    否

    是否開啟健全狀態檢查，取值：

    • true（預設值）：開啟。

    • false：關閉。

    true
    HealthCheckType

    string

    否

    健全狀態檢查協議。取值：

    • TCP

    • HTTP

    • UDP

    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

    • HealthCheckType 為 TCP 或者 HTTP 時，取值範圍為：1~50。

    • HealthCheckType 為 UDP 時，取值範圍為：1~300，您需要設定間隔時間>=響應逾時時間，以確保 UDP 探測回包不會因為逾時而被誤判為未響應。

    5
    HealthCheckDomain

    string

    否

    用於健全狀態檢查的網域名稱。取值：

    • $SERVER_IP：使用後端伺服器內網 IP。

    • domain：指定特定網域名稱。長度限制 1~80 個字元，只能使用大小寫字母、數字、短劃線（-）、半形句號（.）。

    說明

    僅 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 時，該參數生效。

    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
    HealthCheckHttpVersion

    string

    否

    健全狀態檢查 HTTP 協議版本，取值：HTTP1.0（預設值）或HTTP1.1。

    說明

    僅 HealthCheckType 為 HTTP 時，該參數生效。

    HTTP1.0
    ResourceGroupId

    string

    否

    伺服器組所屬的資源群組 ID。

    rg-atstuj3rtop****
    DryRun

    boolean

    否

    是否只預檢此次請求。取值：

    • true：發送檢查請求，不會建立伺服器組。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼DryRunOperation。

    • false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。

    true
    ClientToken

    string

    否

    用戶端 Token，用於保證請求的等冪性。

    從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

    說明

    若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

    123e4567-e89b-12d3-a456-426655440000
    RegionId

    string

    否

    網路型Server Load Balancer執行個體所在的地區 ID。

    您可以通過調用 DescribeRegions 介面擷取地區 ID。

    cn-hangzhou
    Tag

    array<object>

    否

    標籤列表。

    object

    否

    標籤。

    Key

    string

    否

    標籤鍵。最多支援 64 個字元，不能以aliyun或acs:開頭，不能包含http://或https://。支援字元包括字母、數字、底線 (_)、點 (.)、冒號 (:)、斜線 (/)、等號 (=)、加號 (+)、減號 (-)、@符號 (@) 。

    一次調用最多支援添加 20 個標籤。

    env
    Value

    string

    否

    標籤值。最多支援 128 個字元，不能以aliyun或acs:開頭，不能包含http://或https://。支援字元包括字母、數字、底線 (_)、點 (.)、冒號 (:)、斜線 (/)、等號 (=)、加號 (+)、減號 (-)、@符號 (@) 。

    一次調用最多支援添加 20 個標籤。

    product

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    建立伺服器組。

    RequestId

    string

    請求 ID。

    54B48E3D-DF70-471B-AA93-08E683A1B45
    ServerGroupId

    string

    伺服器組 ID。

    sgp-atstuj3rtoptyui****
    JobId

    string

    非同步任務 ID。

    72dcd26b-f12d-4c27-b3af-18f6aed5****

    樣本

    正常返回樣本

    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.
    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. 資源群組不存在。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。