查詢指定地域的健康檢查模板。
調(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)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(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)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
alb:ListHealthCheckTemplates | list |
|
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | 否 | 分批次查詢時(shí)每次顯示的條目數(shù)。取值范圍:1~100,默認(rèn)值為 20。 | 50 |
HealthCheckTemplateIds | array | 否 | 健康檢查模版 ID 列表。 | |
string | 否 | 健康檢查模版 ID。最多支持 20 個(gè)健康檢查模板 ID。如果傳入則根據(jù)模板 ID 過濾。 | hct-bp1qjwo61pqz3ahltv**** | |
HealthCheckTemplateNames | array | 否 | 健康檢查模板名稱列表。 | |
string | 否 | 健康檢查模版名稱。最多支持 10 個(gè)健康檢查模板名稱。如果傳入則根據(jù)模板名稱過濾。 | test | |
Tag | array<object> | 否 | 標(biāo)簽。 | |
object | 否 | 標(biāo)簽結(jié)構(gòu)。 | ||
Key | string | 否 | 標(biāo)簽鍵。最多支持 128 個(gè)字符,不能以 | env |
Value | string | 否 | 標(biāo)簽值。最多支持 128 個(gè)字符,不能以 | product |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"HealthCheckTemplates": [
{
"HealthCheckConnectPort": 80,
"HealthCheckHost": "$SERVER_IP",
"HealthCheckCodes": [
"http_2xx"
],
"HealthCheckHttpVersion": "HTTP 1.0",
"HealthCheckInterval": 5,
"HealthCheckMethod": "HEAD",
"HealthCheckPath": "/test/index.html",
"HealthCheckProtocol": "HTTP",
"HealthCheckTemplateId": "hct-bp1qjwo61pqz3ahltv****",
"HealthCheckTemplateName": "HealthCheckTemplate1",
"HealthCheckTimeout": 3,
"HealthyThreshold": 4,
"UnhealthyThreshold": 4,
"Tags": [
{
"Key": "env",
"Value": "product"
}
]
}
],
"MaxResults": 50,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF3******",
"TotalCount": 1000
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
403 | Forbidden.HealthCheckTemplate | Authentication has failed for HealthCheckTemplate. | 對(duì)HealthCheckTemplate鑒權(quán)失敗 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-01-17 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |