CreateHealthCheckTemplate - 建立健全狀態檢查模板 - Server Load Balancer

在指定地區建立健全狀態檢查模板。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

alb:CreateHealthCheckTemplate

create

*HealthCheckTemplate

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

無

請求參數

名稱	類型	必填	描述	樣本值
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	否	用於健全狀態檢查的網域名稱。取值： $SERVER_IP：後端伺服器的私網 IP。當指定了 IP 或該參數未指定時，負載平衡會使用後端伺服器的私網 IP 當做健全狀態檢查使用的網域名稱。 domain：網域名稱長度為 1~80 字元，只能包含字母、數字、半形句號（.）和短劃線（-）。說明只有`HealthCheckProtocol`設定為 HTTP 或 HTTPS 時該參數生效。	$SERVER_IP
HealthCheckCodes	array	否	健全狀態檢查正常的狀態代碼列表。	5
	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
HealthCheckInterval	integer	否	健全狀態檢查的時間間隔。取值範圍：1~50秒。預設值：2 秒。	2
HealthCheckTimeout	integer	否	接收來自健全狀態檢查的響應需要等待的時間。如果後端伺服器在指定的時間內沒有正確響應，則判定為健全狀態檢查失敗。取值範圍：1~300秒。預設值：5 秒。	5
HealthCheckPath	string	否	用於健全狀態檢查的 URL。長度限制為 1~80，支援使用字母、數字和短劃線（-）、正斜線（/）、半形句號（.）、百分比符號（%）、半形問號（?）、井號（#）和 and（&）以及擴充字元集`_;~!（)[]@$^:',+`。URL 必須以正斜線（/）開頭。說明只有`HealthCheckProtocol`為 HTTP* 或 HTTPS 時才有該參數。	/test/index.html
HealthCheckMethod	string	否	健全狀態檢查方法。取值： HEAD（預設值）：HTTP 和 HTTPS 監聽健全狀態檢查預設採用 HEAD 方法。 POST：gRPC 監聽健全狀態檢查預設採用 POST 方法。 GET：如果響應報文長度超過 8KB，會被截斷，但不會影響健全狀態檢查結果的判定。說明只有 HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC 時才有該參數。	HEAD
HealthCheckProtocol	string	否	健全狀態檢查採用的協議。取值： HTTP（預設值）：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。 HTTPS：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。（資料加密，相比 HTTP 更安全。） TCP：通過發送 SYN 握手報文來檢測伺服器連接埠是否存活。 gRPC：通過發送 POST 或 GET 請求來檢查伺服器應用是否健康。	HTTP
HealthCheckHttpVersion	string	否	健全狀態檢查 HTTP 協議版本。取值：HTTP 1.0或HTTP 1.1。預設值：HTTP 1.1。說明只有`HealthCheckProtocol`為 HTTP 或 HTTPS 時才有該參數。	HTTP 1.0
HealthyThreshold	integer	否	健全狀態檢查連續成功多少次後，將後端伺服器的健全狀態檢查狀態由失敗判定為成功。取值範圍：2~10。預設值：3。	4
UnhealthyThreshold	integer	否	健全狀態檢查連續失敗多少次後，將後端伺服器的健全狀態檢查狀態由成功判定為失敗。取值範圍：2~10。預設值：3。	4
DryRun	boolean	否	是否只預檢此次請求，取值： true：發送檢查請求，不會建立資源。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回http_2xx狀態代碼並直接進行操作。	true
Tag	array<object>	否	標籤。
	object	否	標籤結構。
Key	string	否	標籤鍵。最多支援 128 個字元，不能以 aliyun 或 acs:開頭，不能包含 http://或 https://。	env
Value	string	否	標籤值。最多支援 128 個字元，不能以 aliyun 或 acs:開頭，不能包含 http://或 https://。	product
ResourceGroupId	string	否	資源群組 ID	rg-atstuj3rtop****

返回參數

名稱	類型	描述	樣本值
	object	健全狀態檢查模板。
HealthCheckTemplateId	string	健全狀態檢查模板 ID。	hct-pno8sisi******
RequestId	string	請求 ID。	365F4154-92F6-4AE4-92F8-7FF34******

樣本

正常返回樣本

JSON格式

{
  "HealthCheckTemplateId": "hct-pno8sisi******",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	QuotaExceeded.HealthCheckTemplatesNum	The quota of %s is exceeded, usage %s/%s.	配額%s已超額度限制，目前已使用%s，配額為%s。
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.	對HealthCheckTemplate鑒權失敗

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

變更歷史

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