更新NLB服務(wù)器組的配置信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫(xiě)入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
nlb:UpdateServerGroupAttribute | update |
|
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServerGroupId | string | 是 | 服務(wù)器組 ID。 | sgp-atstuj3rtoptyui**** |
ServerGroupName | string | 否 | 修改后的服務(wù)器組名稱。 長(zhǎng)度為 2~128 個(gè)字符,必須以大小寫(xiě)字母或中文開(kāi)頭,可包含數(shù)字、半角句號(hào)(.)、下劃線(_)和短劃線(-)。 | NLB_ServerGroup1 |
ConnectionDrainEnabled | boolean | 否 | 是否開(kāi)啟連接優(yōu)雅中斷。取值:
| false |
ConnectionDrainTimeout | integer | 否 | 設(shè)置連接優(yōu)雅中斷超時(shí)時(shí)間。單位:秒。取值范圍:0~900。 | 10 |
Scheduler | string | 否 | 調(diào)度算法。取值:
說(shuō)明
僅后端協(xié)議為 UDP 時(shí),支持選擇 QUIC ID 哈希。
| Wrr |
PreserveClientIpEnabled | boolean | 否 | 是否開(kāi)啟客戶端地址保持功能。取值:
說(shuō)明
當(dāng) PreserveClientIpEnabled 參數(shù)取值為 false 且服務(wù)器組已關(guān)聯(lián) TCPSSL 監(jiān)聽(tīng)時(shí),不支持將該參數(shù)的值修改為 true。
| false |
HealthCheckConfig | object | 否 | 健康檢查相關(guān)配置。 | |
HealthCheckEnabled | boolean | 否 | 是否開(kāi)啟健康檢查,取值:
| false |
HealthCheckType | string | 否 | 健康檢查協(xié)議。取值:
| TCP |
HealthCheckConnectPort | integer | 否 | 健康檢查的后端服務(wù)器的端口。取值范圍:0~65535。0 表示使用后端服務(wù)器的端口進(jìn)行健康檢查。 | 0 |
HealthyThreshold | integer | 否 | 健康檢查連續(xù)成功多少次后,將后端服務(wù)器的健康檢查狀態(tài)由失敗判定為成功。取值范圍:2~10。 | 3 |
UnhealthyThreshold | integer | 否 | 健康檢查連續(xù)失敗多少次后,將后端服務(wù)器的健康檢查狀態(tài)由成功判定為失敗。取值范圍:2~10。 | 3 |
HealthCheckConnectTimeout | integer | 否 | 健康檢查響應(yīng)的最大超時(shí)時(shí)間。單位:秒。 取值范圍:1~300。 默認(rèn)值:5。 | 100 |
HealthCheckInterval | integer | 否 | 健康檢查的時(shí)間間隔。單位:秒,默認(rèn)值:5。
| 5 |
HealthCheckDomain | string | 否 | 用于健康檢查的域名。取值:
說(shuō)明
僅 HealthCheckType 為 HTTP 時(shí),該參數(shù)生效。
| $SERVER_IP |
HealthCheckUrl | string | 否 | 健康檢查路徑。 長(zhǎng)度為 1~80 個(gè)字符,只能使用字母、數(shù)字、字符 說(shuō)明
僅 HealthCheckType 為 HTTP 時(shí),該參數(shù)生效。
| /test/index.html |
HealthCheckHttpCode | array | 否 | 健康狀態(tài)返回碼,多個(gè)狀態(tài)碼用半角逗號(hào)(,)分隔。 取值:http_2xx(默認(rèn)值)、http_3xx、http_4xx和http_5xx。 說(shuō)明
僅 HealthCheckType 為 HTTP 時(shí),該參數(shù)生效。
| |
HealthCheckHttpCode | string | 否 | 健康狀態(tài)返回碼,多個(gè)狀態(tài)碼用半角逗號(hào)(,)分隔。 取值:http_2xx(默認(rèn)值)、http_3xx、http_4xx和http_5xx。 說(shuō)明
僅 HealthCheckType 為 HTTP 時(shí),該參數(shù)生效。
| http_2xx |
HttpCheckMethod | string | 否 | 健康檢查方法,取值:GET 或 HEAD。 說(shuō)明
僅 HealthCheckType 為 HTTP 時(shí),該參數(shù)生效。
| GET |
HealthCheckReq | string | 否 | UDP 監(jiān)聽(tīng)健康檢查的請(qǐng)求串。只允許包含字母、數(shù)字,最大長(zhǎng)度限制為 512 個(gè)字符。 | hello |
HealthCheckExp | string | 否 | UDP 監(jiān)聽(tīng)健康檢查的響應(yīng)串。只允許包含字母、數(shù)字,最大長(zhǎng)度限制為 512 個(gè)字符。 | ok |
RegionId | string | 否 | 網(wǎng)絡(luò)型負(fù)載均衡實(shí)例所在的地域 ID。 您可以通過(guò)調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求。取值:
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值,確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說(shuō)明
若您未指定,則系統(tǒng)自動(dòng)使用 API 請(qǐng)求的 RequestId 作為 ClientToken 標(biāo)識(shí)。每次 API 請(qǐng)求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"ServerGroupId": "sgp-atstuj3rtoptyui****",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.%s | The param of %s is illegal. | 參數(shù)%s非法 |
400 | SystemBusy | System is busy, please try again later. | 系統(tǒng)繁忙,請(qǐng)稍后重試 |
400 | IllegalParam.healthCheckDomain | The parameter of healthCheckConfig.healthCheckDomain is illegal. | 健康檢查配置中的healthCheckDomain非法,請(qǐng)檢查輸入?yún)?shù)。 |
400 | IlleagalParam.healthCheckUrl | The parameter of healthCheckUrl in healthCheckConfig is illegal. | 健康檢查設(shè)置中使用的健康檢查的URL不合法。 |
400 | OperationDenied.UidNotAllowQuic29 | The operation is not allowed because of uid not allow quic29 version. | 用戶ID不支持Quic29,請(qǐng)聯(lián)系客戶經(jīng)理加白。 |
400 | IllegalParam | The param of %s is illegal. | 輸入的參數(shù)有值非法,請(qǐng)檢查輸入。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | dryRun請(qǐng)求驗(yàn)證已通過(guò)。 |
400 | IllegalParam.ServerGroupName | The param of ServerGroupName is illegal. | 傳入的ServerGroupName參數(shù)非法 |
400 | IllegalParam.PreserveClientIpSwitch | The server group associated with the tcpssl listener does not support enabling PreserveClientIp. | tcpssl監(jiān)聽(tīng)關(guān)聯(lián)的服務(wù)器組不支持開(kāi)啟客戶端ip保持功能 |
403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因?yàn)橘~號(hào)沒(méi)有權(quán)限,所以鑒權(quán)失敗。 |
404 | ResourceNotFound.serverGroup | The specified resource of serverGroup is not found. | 找不到指定的服務(wù)器組資源,請(qǐng)檢查輸入?yún)?shù)。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-06-25 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2024-03-14 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-12-28 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-12-18 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-10-09 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-10-07 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-09-27 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-09-26 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-09-18 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |