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

get

*HealthCheckTemplate

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
HealthCheckTemplateId	string	必須	ヘルスチェックテンプレートの ID。	hct-x4jazoyi6tvsq9****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
HealthCheckConnectPort	integer	ヘルスチェックに使用されるポート。有効値：0～65535。	80
HealthCheckHost	string	ヘルスチェックに使用されるドメイン名。有効値： $SERVER_IP：バックエンドサーバーのプライベート IP アドレス。IP アドレスを指定した場合、またはこのパラメーターを指定しない場合、ALB インスタンスはバックエンドサーバーのプライベート IP アドレスをヘルスチェックのドメイン名として使用します。 domain：ドメイン名は 1～80 文字で、英字、数字、ピリオド (.)、ハイフン (-) を使用できます。説明このパラメーターは、`HealthCheckProtocol` が HTTP または HTTPS に設定されている場合にのみ有効です。	$SERVER_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 バージョン。有効値：HTTP1.0 および HTTP1.1。説明このパラメーターは、`HealthCheckProtocol` を HTTP または HTTPS に設定した場合にのみ有効です。	HTTP1.0
HealthCheckTemplateId	string	ヘルスチェックテンプレートの ID。	hct-x4jazoyi6tvsq9****
HealthCheckInterval	integer	ヘルスチェックが実行される間隔。単位：秒。有効値：1～50。	3
HealthCheckMethod	string	ヘルスチェックに使用される HTTP メソッド。有効値： HEAD (デフォルト)：デフォルトでは、HTTP および HTTPS ヘルスチェックは HEAD メソッドを使用します。 GET：応答の長さが 8 KB を超える場合、応答は切り捨てられます。ただし、ヘルスチェックの結果には影響しません。 POST：gRPC ヘルスチェックは、デフォルトで POST メソッドを使用します。説明このパラメーターは、HealthCheckProtocol を HTTP、HTTPS、または gRPC に設定した場合にのみ有効です。	GET
HealthCheckPath	string	ヘルスチェックに使用される URL。 URL は 1～80 文字で、英字、数字、および次の特殊文字を含めることができます：- / . % ? # &。また、次の拡張文字も使用できます：`_ ; ~ ! ( ) * [ ] @ $ ^ : ' , +`。URL はスラッシュ (/) で始まる必要があります。説明このパラメーターは、HealthCheckProtocol を HTTP、HTTPS、または gRPC に設定した場合にのみ有効です。	/test/index.html
HealthCheckProtocol	string	ヘルスチェックに使用されるプロトコル。有効値： HTTP (デフォルト)：HTTP ヘルスチェックは、HEAD または GET リクエストを送信してブラウザの動作をシミュレートし、バックエンドサーバーの可用性を確認します。 HTTPS：ALB インスタンスは、ブラウザのリクエストをシミュレートする HEAD または GET リクエストを送信して、バックエンドサーバーが正常であるかどうかを確認します。HTTPS は暗号化をサポートし、HTTP よりも高いセキュリティを提供します。 TCP：TCP ヘルスチェックは、TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーの可用性を確認します。 gRPC：gRPC ヘルスチェックは、POST または GET リクエストをバックエンドサーバーに送信して、バックエンドサーバーの可用性を確認します。	HTTP
HealthCheckTemplateName	string	ヘルスチェックテンプレートの名前。名前は 2～128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。名前は英字で始まる必要があります。	HealthCheckTemplate1
HealthCheckTimeout	integer	ヘルスチェック応答のタイムアウト期間。バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、バックエンドサーバーは異常と見なされます。単位：秒。有効値：1～300。	200
HealthyThreshold	integer	異常なバックエンドサーバーが正常と見なされるまでに連続してヘルスチェックに合格する必要がある回数。この場合、ヘルスステータスは「異常」から「正常」に変わります。有効値：2～10。	5
RequestId	string	リクエスト ID。	DB1AFC33-DAE8-528E-AA4D-4A6AABE71945
UnhealthyThreshold	integer	正常なバックエンドサーバーが異常と見なされるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、ヘルスステータスは「正常」から「異常」に変わります。有効値：2～10。	5
Tags	array<object>	タグ。
	object	タグ。
Key	string	タグキー。タグキーは最大 128 文字で、`http://` または `https://` を含めることはできません。タグキーを `acs:` または `aliyun` で始めることはできません。	env
Value	string	タグ値。タグ値は最大 128 文字で、`acs:` で始めることはできません。タグ値に `http://` または `https://` を含めることはできません。	product
ResourceGroupId	string	リソースグループ ID。	rg-atstuj3rtop****

例

成功レスポンス

JSONJSON

{
  "HealthCheckConnectPort": 80,
  "HealthCheckHost": "$SERVER_IP",
  "HealthCheckCodes": [
    "http_2xx,http_3xx"
  ],
  "HealthCheckHttpVersion": "HTTP1.0",
  "HealthCheckTemplateId": "hct-x4jazoyi6tvsq9****",
  "HealthCheckInterval": 3,
  "HealthCheckMethod": "GET",
  "HealthCheckPath": "/test/index.html",
  "HealthCheckProtocol": "HTTP",
  "HealthCheckTemplateName": "HealthCheckTemplate1",
  "HealthCheckTimeout": 200,
  "HealthyThreshold": 5,
  "RequestId": "DB1AFC33-DAE8-528E-AA4D-4A6AABE71945",
  "UnhealthyThreshold": 5,
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ],
  "ResourceGroupId": "rg-atstuj3rtop****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.
404	ResourceNotFound.HealthCheckTemplate	The specified resource %s is not found.

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

変更履歴

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