ListHealthCheckTemplates - - 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:ListHealthCheckTemplates

list

*HealthCheckTemplate

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	次回の呼び出しで新しい結果ページを取得するために使用されるページネーショントークンです。有効値：初回のリクエストでは、このパラメーターを指定する必要はありません。前回のクエリで取得したトークンを 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 文字までで、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	env
Value	string	任意	タグ値。タグ値の長さは 128 文字までで、`acs:` または `aliyun` で始めることはできません。`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 アドレスが指定されている場合、またはこのパラメーターが指定されていない場合、ALB インスタンスは各バックエンドサーバーのプライベート IP アドレスをヘルスチェックのドメイン名として使用します。 domain：ドメイン名は 1～80 文字で、英字、数字、ピリオド (.)、ハイフン (-) を使用できます。説明このパラメーターは、`HealthCheckProtocol` を HTTP または HTTPS に設定した場合にのみ有効です。	$_ip
HealthCheckCodes	array	正常なバックエンドサーバーを示す HTTP ステータスコード。
	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
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	ヘルスチェックに使用される HTTP メソッド。有効値： HEAD (デフォルト)：デフォルトでは、HTTP および HTTPS ヘルスチェックは HEAD メソッドを使用します。 GET：応答の長さが 8 KB を超える場合、応答は切り捨てられます。ただし、ヘルスチェックの結果には影響しません。 POST：gRPC ヘルスチェックは、デフォルトで POST メソッドを使用します。説明このパラメーターは、HealthCheckProtocol を HTTP、HTTPS、または gRPC に設定した場合にのみ有効です。	HEAD
HealthCheckPath	string	ヘルスチェックに使用する URL パス。 URL は 1～80 文字で、英字、数字、および次の特殊文字を含めることができます：- / . % ? # &。また、次の拡張文字も使用できます：`_ ; ~ ! ( ) * [ ] @ $ ^ : ' , +`。URL はスラッシュ (/) で始まる必要があります。	/test/index.html
HealthCheckProtocol	string	ヘルスチェックに使用されるプロトコル。有効値： HTTP (デフォルト)：ALB インスタンスは HEAD または GET リクエストを送信し、ブラウザのリクエストをシミュレートして、バックエンドサーバーが正常かどうかを確認します。 HTTPS：HTTPS ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を調査することにより、ブラウザの動作をシミュレートします。HTTPS はデータ暗号化をサポートするため、より高いセキュリティを提供します。 TCP：TCP ヘルスチェックは、TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーのポートに到達可能かどうかを確認します。 gRPC：gRPC ヘルスチェックは、POST または GET リクエストをバックエンドサーバーに送信して、バックエンドサーバーが正常かどうかを確認します。	HTTP
HealthCheckTemplateId	string	ヘルスチェックテンプレートの ID。	hct-bp1qjwo61pqz3ahltv****
HealthCheckTemplateName	string	ヘルスチェックテンプレートの名前。名前は 2～128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字である必要があります。	HealthCheckTemplate1
HealthCheckTimeout	integer	ヘルスチェック応答のタイムアウト期間。バックエンドの Elastic Compute Service (ECS) インスタンスが指定されたタイムアウト期間内に応答しない場合、ECS インスタンスはヘルスチェックに失敗します。有効値：1～300。単位：秒。デフォルト値：5。	3
HealthyThreshold	integer	異常なバックエンドサーバーが正常と判断されるまでに連続してヘルスチェックに合格する必要がある回数。この場合、ヘルスステータスは fail から success に変わります。有効値：2～10。デフォルト値：3。	4
UnhealthyThreshold	integer	正常なバックエンドサーバーが異常と判断されるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、ヘルスステータスは success から fail に変わります。有効値：2～10。デフォルト値：3。	4
Tags	array<object>	タグ。
	object	タグ。
Key	string	タグキー。タグキーの長さは 128 文字までで、`http://` または `https://` を含めることはできません。タグキーは `acs:` または `aliyun` で始めることはできません。	env
Value	string	タグ値。タグ値の長さは 128 文字までで、`http://` または `https://` を含めることはできません。タグ値は `acs:` または `aliyun` で始めることはできません。	product
ResourceGroupId	string	リソースグループ ID。	rg-atstuj3rtop****
MaxResults	integer	ページごとに返されるエントリ数。有効値：1～100。デフォルト値：20。	50
NextToken	string	返された NextToken の値はページネーショントークンであり、次のリクエストで新しい結果ページを取得するために使用できます。有効値： NextToken が空の場合、次のページはありません。前回のクエリで NextToken の値が返された場合は、その値を指定して次の結果セットを取得します。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCount	integer	返されたエントリの総数。	1000

例

成功レスポンス

JSONJSON

{
  "HealthCheckTemplates": [
    {
      "HealthCheckConnectPort": 80,
      "HealthCheckHost": "$_ip",
      "HealthCheckCodes": [
        "http_2xx,http_3xx"
      ],
      "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-7FF34B540710",
  "TotalCount": 1000
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.

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

変更履歴

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