ListHealthCheckTemplates - 查詢健全狀態檢查模板 - Server Load Balancer

查詢指定地區的健全狀態檢查模板。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

alb:ListHealthCheckTemplates

list

*HealthCheckTemplate

acs:alb:{#regionId}:{#accountId}:healthchecktemplate/*

無

請求參數

名稱	類型	必填	描述	樣本值
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查詢時每次顯示的條目數。取值範圍：1~100，預設值為 20。	50
HealthCheckTemplateIds	array	否	健全狀態檢查模版 ID 列表。
	string	否	健全狀態檢查模版 ID。最多支援 20 個健全狀態檢查模板 ID。如果傳入則根據模板 ID 過濾。	hct-bp1qjwo61pqz3ahltv****
HealthCheckTemplateNames	array	否	健全狀態檢查模板名稱列表。
	string	否	健全狀態檢查模版名稱。最多支援 10 個健全狀態檢查模板名稱。如果傳入則根據模板名稱過濾。	test
Tag	array<object>	否	標籤。
	object	否	標籤結構。
Key	string	否	標籤鍵。最多支援 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。	env
Value	string	否	標籤值。最多支援 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。	product
ResourceGroupId	string	否	資源群組 ID，根據設定的資源群組 ID 來過濾。	rg-atstuj3rtop****

返回參數

名稱	類型	描述	樣本值
	object	健全狀態檢查模板資訊。
HealthCheckTemplates	array<object>	健全狀態檢查模板列表。
	array<object>	健全狀態檢查模板結構。
HealthCheckConnectPort	integer	健全狀態檢查使用的連接埠。取值： 0~65535。預設值：0，表示使用後端伺服器的連接埠進行健全狀態檢查。	80
HealthCheckHost	string	用於健全狀態檢查的網域名稱，取值： $SERVER_IP（預設值）：後端伺服器的私網 IP。當指定了 IP 或該參數未指定時，負載平衡會使用各後端伺服器的私網 IP 當做健全狀態檢查使用的網域名稱。 domain：網域名稱長度為 1~80 字元，只能包含字母、數字、半形句號（.）和短劃線（-）。說明只有`HealthCheckProtocol`為 HTTP 或 HTTPS 時才有效。	$SERVER_IP
HealthCheckCodes	array	健全狀態檢查正常的狀態代碼列表。
	string	健全狀態檢查正常的 HTTP 狀態代碼。當 HealthCheckProtocol 取值為 HTTP 或 HTTPS 時，HealthCheckCodes 可以選擇http_2xx（預設值）、 http_3xx、http_4xx和http_5xx，多個狀態代碼用半形逗號（,）分隔。當 HealthCheckProtocol 取值為 gRPC 時，HealthCheckCodes 狀態代碼範圍：0~99，預設值：0。支援範圍輸入，最多支援 20 個範圍值，多個範圍值使用半形逗號（,）隔開。說明只有 HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC 時才有該參數。	http_2xx
HealthCheckHttpVersion	string	健全狀態檢查 HTTP 協議版本。取值：HTTP 1.0或HTTP 1.1。預設值：HTTP 1.1。說明只有`HealthCheckProtocol`為 HTTP 或 HTTPS 時才有效。	HTTP 1.0
HealthCheckInterval	integer	健全狀態檢查的時間間隔。單位：秒。取值範圍：1~50。預設值：2 秒。	5
HealthCheckMethod	string	健全狀態檢查方法。取值： HEAD（預設值）：HTTP 和 HTTPS 監聽健全狀態檢查預設採用 HEAD 方法。 GET：如果響應報文長度超過 8K，會被截斷，但不會影響健全狀態檢查結果的判定。 POST：gRPC 監聽健全狀態檢查預設採用 POST 方法。說明只有 HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC 時才有效。	HEAD
HealthCheckPath	string	用於健全狀態檢查的 URL。長度限制為 1~80，只能使用字母、數字和短劃線（-）、正斜線（/）、半形句號（.）、百分比符號（%）、半形問號（?）、井號（#）、and（&）這些字元以及擴充字元集`_;~!（)*[]@$^:',+`。URL 必須以正斜線（/）開頭。	/test/index.html
HealthCheckProtocol	string	健全狀態檢查採用的協議。取值： HTTP（預設值）：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。 HTTPS：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。（資料加密，相比 HTTP 更安全。） TCP：通過發送 SYN 握手報文來檢測伺服器連接埠是否存活。 gRPC：通過發送 POST 或 GET 請求來檢查伺服器應用是否健康。	HTTP
HealthCheckTemplateId	string	健全狀態檢查模板 ID。	hct-bp1qjwo61pqz3ahltv****
HealthCheckTemplateName	string	健全狀態檢查模板名稱。長度為 2~128 個英文或中文字元，必須以大小字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-）。	HealthCheckTemplate1
HealthCheckTimeout	integer	接收來自健全狀態檢查的響應需要等待的時間。如果後端 ECS 在指定的時間內沒有正確響應，則判定為健全狀態檢查失敗。取值：1~300秒。預設值：5 秒。	3
HealthyThreshold	integer	健全狀態檢查連續成功多少次後，將後端伺服器的健全狀態檢查狀態由失敗判定為成功。取值：2~10。預設值：3。	4
UnhealthyThreshold	integer	健全狀態檢查連續失敗多少次後，將後端伺服器的健全狀態檢查狀態由成功判定為失敗。取值：2~10。預設值：3。	4
Tags	array<object>	標籤。
	object	標籤結構。
Key	string	標籤鍵。最多支援 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。	env
Value	string	標籤值。最多支援 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。	product
ResourceGroupId	string	資源群組 ID。	rg-atstuj3rtop****
MaxResults	integer	分批次查詢時每次顯示的條目數。取值範圍：1~100，預設值為 20。	50
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	請求 ID。	365F4154-92F6-4AE4-92F8-7FF3******
TotalCount	integer	本次請求條件下返回的總資料記錄數。	1000

樣本

正常返回樣本

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"
        }
      ],
      "ResourceGroupId": "rg-atstuj3rtop****"
    }
  ],
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******",
  "TotalCount": 1000
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.	對HealthCheckTemplate鑒權失敗

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

變更歷史

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