CreateHealthCheckTemplate - - Alibaba Cloud ドキュメントセンター

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

今すぐお試しください

この 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 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
HealthCheckTemplateName	string	必須	ヘルスチェックテンプレートの名前です。名前は 2～128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。名前は英字で始まる必要があります。	HealthCheckTemplate1
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用されるポートです。有効値：0～65535。デフォルト値：0。値を 0 に設定した場合、バックエンドサーバーのポートがヘルスチェックに使用されます。	80
HealthCheckHost	string	任意	ヘルスチェックに使用されるドメイン名です。有効値： $SERVER_IP：バックエンドサーバーのプライベート IP アドレス。IP アドレスが指定されている場合、またはこのパラメーターが指定されていない場合、ALB インスタンスはバックエンドサーバーのプライベート IP アドレスをヘルスチェックのドメイン名として使用します。 domain：ドメイン名は 1～80 文字で、英字、数字、ピリオド (.)、ハイフン (-) を使用できます。説明このパラメーターは、`HealthCheckProtocol` が HTTP または HTTPS に設定されている場合にのみ有効です。	$_ip
HealthCheckCodes	array	任意	バックエンドサーバーが正常であることを示す HTTP ステータスコードです。	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,http_3xx
HealthCheckInterval	integer	任意	ヘルスチェックが実行される間隔です。有効値：1～50。デフォルト値：2。	2
HealthCheckTimeout	integer	任意	ヘルスチェック応答のタイムアウト期間です。バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、バックエンドサーバーは異常と判断されます。有効値：1～300。単位：秒。デフォルト値：5。	5
HealthCheckPath	string	任意	ヘルスチェックに使用される URL です。 URL は 1～80 文字で、英字、数字、および次の特殊文字を含めることができます：- / . % ? # &。また、次の拡張文字も使用できます：`_ ; ~ ! ( ) * [ ] @ $ ^ : ' , +`。URL はスラッシュ (/) で始まる必要があります。説明このパラメーターは、`HealthCheckProtocol` が HTTP または HTTPS に設定されている場合にのみ使用できます。	/test/index.html
HealthCheckMethod	string	任意	ヘルスチェックに使用される HTTP メソッドです。有効値： HEAD (デフォルト)：デフォルトでは、HTTP および HTTPS のヘルスチェックは HEAD メソッドを使用します。 POST：gRPC のヘルスチェックはデフォルトで POST メソッドを使用します。 GET：応答の長さが 8 KB を超える場合、応答は切り捨てられます。ただし、ヘルスチェックの結果には影響しません。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ使用できます。	HEAD
HealthCheckProtocol	string	任意	ヘルスチェックに使用されるプロトコルです。有効値： HTTP (デフォルト)：HTTP ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を確認することで、ブラウザの動作をシミュレートします。 HTTPS：ALB インスタンスは、ブラウザのリクエストをシミュレートする HEAD または GET リクエストを送信して、バックエンドサーバーが正常であるかどうかを確認します。HTTPS は暗号化をサポートし、HTTP よりも高いセキュリティを提供します。 TCP：TCP ヘルスチェックは、TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーのポートに到達可能かどうかを確認します。 gRPC：gRPC ヘルスチェックは、POST または GET リクエストをバックエンドサーバーに送信して、バックエンドサーバーが正常であるかどうかを確認します。	HTTP
HealthCheckHttpVersion	string	任意	ヘルスチェックの HTTP バージョンです。有効値：HTTP 1.0 および HTTP 1.1。デフォルト値：HTTP 1.1。説明このパラメーターは、`HealthCheckProtocol` が HTTP または HTTPS に設定されている場合にのみ使用できます。	HTTP 1.0
HealthyThreshold	integer	任意	異常なバックエンドサーバーが正常と判断されるまでに連続してヘルスチェックに合格する必要がある回数です。この場合、ヘルスステータスは fail から success に変更されます。有効値：2～10。デフォルト値：3。	4
UnhealthyThreshold	integer	任意	正常なバックエンドサーバーが異常と判断されるまでに連続してヘルスチェックに失敗する必要がある回数です。この場合、ヘルスステータスは success から fail に変更されます。有効値：2～10。デフォルト値：3。	4
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効値： true：ドライランのみを実行します。システムは、パラメーター値の欠落、不正なリクエスト構文、サービスの制限など、リクエストに潜在的な問題がないかチェックします。リクエストがドライランに失敗した場合、エラーコードが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに合格した場合、2xx HTTP ステータスコードが返され、操作が実行されます。	true
Tag	array<object>	任意	タグです。
	object	任意	タグです。
Key	string	任意	タグキー。タグキーは最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	env
Value	string	任意	タグ値。タグ値は最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	product
ResourceGroupId	string	任意	リソースグループ ID です。	rg-atstuj3rtop****

レスポンスフィールド

フィールド	型	説明	例
	object	ヘルスチェックテンプレートです。
HealthCheckTemplateId	string	ヘルスチェックテンプレートの ID です。	hct-1224334
RequestId	string	リクエスト ID です。	365F4154-92F6-4AE4-92F8-7FF34B540710

例

成功レスポンス

JSONJSON

{
  "HealthCheckTemplateId": "hct-1224334",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

エラーコード

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

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

変更履歴

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