Server Load Balancer: CreateHealthCheckTemplate - SLB - Alibaba Cloud - Server Load Balancer

指定のリージョンにヘルスチェックテンプレートを作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:CreateHealthCheckTemplate

create

*HealthCheckTemplate

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用するクライアントトークンです。このトークンはクライアント側で生成できますが、リクエスト間で一意であることを保証する必要があります。このトークンに含められるのは ASCII 文字のみです。説明このパラメータを指定しない場合、システムはリクエストの `RequestId` をクライアントトークンとして使用します。各 API リクエストには一意の `RequestId` があります。	5A2CFF0E-5718-45B5-9D4D-70B******
HealthCheckTemplateName	string	必須	ヘルスチェックテンプレートの名前です。名前の長さは 2～128 文字である必要があります。先頭は英字、数字、または漢字で始める必要があります。また、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-)、およびスペースを含めることができます。	HealthCheckTemplate1
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用するポートです。有効な値：0～65535。デフォルト値：0。この値は、バックエンドサーバーのポートがヘルスチェックに使用されることを意味します。	80
HealthCheckHost	string	任意	ヘルスチェックに使用するドメイン名です。有効な値： $SERVER_IP：バックエンドサーバーのプライベート IP アドレス。このパラメータを `$SERVER_IP` に設定するか空のままにすると、ロードバランサーはバックエンドサーバーのプライベート IP アドレスをヘルスチェックのドメイン名として使用します。 domain：ドメイン名の長さは 1～80 文字である必要があります。英字、数字、ピリオド (.)、およびハイフン (-) を含めることができます。説明このパラメータは、`HealthCheckProtocol` パラメータが HTTP または HTTPS に設定されている場合にのみ有効です。	$SERVER_IP
HealthCheckCodes	array	任意	ヘルスチェックの成功を示す HTTP ステータスコードです。	5
	string	任意	ヘルスチェックの成功を示す HTTP ステータスコードです。 HealthCheckProtocol が HTTP または HTTPS に設定されている場合、http_2xx (デフォルト)、http_3xx、http_4xx、および http_5xx を指定できます。複数の HTTP ステータスコードを指定でき、カンマ (,) で区切ります。 HealthCheckProtocol が gRPC に設定されている場合、有効なステータスコードは 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 です。 URL の長さは 1～80 文字である必要があります。先頭はスラッシュ (/) で始める必要があります。また、英字、数字、および次の特殊文字を含めることができます：`- / . % ? # & _;~!()[]@$^:',+`。説明このパラメータは、`HealthCheckProtocol` パラメータが HTTP* または HTTPS に設定されている場合にのみ有効です。	/test/index.html
HealthCheckMethod	string	任意	ヘルスチェックに使用するメソッドです。有効な値： HEAD (デフォルト)：HTTP および HTTPS リスナーの場合、デフォルトのヘルスチェックメソッドは HEAD です。 POST：gRPC リスナーの場合、デフォルトのヘルスチェックメソッドは POST です。 GET：応答ボディが 8 KB を超える場合、切り捨てられます。これはヘルスチェック結果に影響しません。説明このパラメータは、`HealthCheckProtocol` パラメータが HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	HEAD
HealthCheckProtocol	string	任意	ヘルスチェックに使用するプロトコルです。有効な値： HTTP (デフォルト)：HEAD または GET リクエストを送信してブラウザアクセスをシミュレートし、サーバーアプリケーションが正常かどうかを確認します。 HTTPS：HEAD または GET リクエストを送信してブラウザアクセスをシミュレートし、サーバーアプリケーションが正常かどうかを確認します。HTTPS はデータ伝送を暗号化するため、HTTP より安全です。 TCP：SYN パケットを送信して、サーバーポートが応答するかどうかを確認します。 gRPC：POST または GET リクエストを送信して、サーバーアプリケーションが正常かどうかを確認します。	HTTP
HealthCheckHttpVersion	string	任意	ヘルスチェックに使用する HTTP プロトコルのバージョンです。有効な値：HTTP1.0 および HTTP1.1。デフォルト値：HTTP1.1。説明このパラメータは、`HealthCheckProtocol` パラメータが HTTP または HTTPS に設定されている場合にのみ有効です。	HTTP 1.0
HealthyThreshold	integer	任意	バックエンドサーバーのヘルスステータスを異常から正常に変更するために必要な、連続したヘルスチェック成功回数です。有効な値：2～10。デフォルト値：3。	4
UnhealthyThreshold	integer	任意	バックエンドサーバーのヘルスステータスを正常から異常に変更するために必要な、連続したヘルスチェック失敗回数です。有効な値：2～10。デフォルト値：3。	4
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行します。システムは、必須パラメータの不足、リクエスト構文の誤り、サービス制限など、潜在的な問題がないかリクエストを確認します。リクエストがドライランに失敗した場合はエラーメッセージが返されます。リクエストがドライランに合格した場合は、`DryRunOperation` エラーコードが返されます。リソースは作成されません。 false (デフォルト)：通常のリクエストを送信します。リクエストが有効な場合、2xx の HTTP ステータスコードが返され、ヘルスチェックテンプレートが作成されます。	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******

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	QuotaExceeded.HealthCheckTemplatesNum	The quota of %s is exceeded, usage %s/%s.
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。