更新健康檢查模板的屬性,如名稱、健康檢查協議等。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
alb:UpdateHealthCheckTemplateAttribute | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 5A2CFF0E-5718-45B5-9D4D-70B****** |
HealthCheckTemplateName | string | 否 | 健康檢查模板名稱。 長度為 2~128 個英文或中文字符,必須以大小字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 | HealthCheckTemplate1 |
HealthCheckConnectPort | integer | 否 | 健康檢查使用的端口。取值范圍: 0~65535。 默認值:0,表示使用后端服務器的端口進行健康檢查。 | 80 |
HealthCheckHost | string | 否 | 用于健康檢查的域名。取值:
說明
只有 HealthCheckProtocol 設置為 HTTP 或 HTTPS 時才有該參數。
| $SERVER_IP |
HealthCheckCodes | array | 否 | 健康檢查正常的狀態碼列表。 | |
string | 否 | 健康檢查正常的 HTTP 狀態碼。
說明
只有 HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC 時才有該參數。
| http_2xx | |
HealthCheckInterval | integer | 否 | 健康檢查的時間間隔。單位:秒。取值范圍:1~50。默認值:2 秒。 | 5 |
HealthCheckTimeout | integer | 否 | 接收來自運行狀況檢查的響應需要等待的時間。如果后端服務器在指定的時間內沒有正確響應,則判定為健康檢查失敗。 單位:秒。取值范圍:1~300。默認值:5 秒。 | 3 |
HealthCheckPath | string | 否 | 用于健康檢查的 URL。 長度限制為 1~80,只能使用字母、數字和短劃線(-)、正斜線(/)、半角句號點(.)、百分號(%)、半角問號(?)、井號(#)、and(&)這些字符以及擴展字符集 URL 必須以正斜線(/)開頭。 說明
只有 HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC 時才有該參數。
| /test/index.html |
HealthCheckMethod | string | 否 | 健康檢查方法。取值:
說明
只有 HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC 時才有該參數。
| HEAD |
HealthCheckProtocol | string | 否 | 健康檢查采用的協議。取值:
| HTTP |
HealthCheckHttpVersion | string | 否 | 健康檢查 HTTP 協議版本。 取值:HTTP1.0或HTTP1.1。 默認值:HTTP1.1。 說明
只有 HealthCheckProtocol 為 HTTP 或 HTTPS 時才有該參數。
| HTTP1.0 |
HealthyThreshold | integer | 否 | 健康檢查連續成功多少次后,將后端服務器的健康檢查狀態由失敗判定為成功。 取值范圍:2~10。 默認值:3。 | 4 |
UnhealthyThreshold | integer | 否 | 健康檢查連續失敗多少次后,將后端服務器的健康檢查狀態由成功判定為失敗。 取值范圍:2~10。 默認值:3。 | 4 |
DryRun | boolean | 否 | 是否只預檢此次請求,取值:
| true |
HealthCheckTemplateId | string | 是 | 模板 ID。 | hct-bp1qjwo61****** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "365F4154-92F6-4AE4-92F8-7FF3******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IncorrectStatus.HealthCheckTemplate | The status of %s [%s] is incorrect. | 資源%s [%s]的狀態無效。 |
403 | Forbidden.HealthCheckTemplate | Authentication is failed for %s. | 健康檢查模版操作鑒權失敗。 |
404 | ResourceNotFound.HealthCheckTemplate | The specified resource %s is not found. | 資源%s不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-01-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |