すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ALB::HealthCheckTemplate

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ALB::HealthCheckTemplate

    最終更新日:Feb 27, 2026

    ALIYUN::ALB::HealthCheckTemplate リソースタイプは、ヘルスチェックテンプレートを作成します。

    構文

    {
  "Type": "ALIYUN::ALB::HealthCheckTemplate",
  "Properties": {
    "HealthCheckInterval": Integer,
    "HealthCheckConnectPort": Integer,
    "HealthCheckCodes": List,
    "UnhealthyThreshold": Integer,
    "HealthCheckMethod": String,
    "HealthCheckPath": String,
    "HealthCheckTemplateName": String,
    "HealthCheckHost": String,
    "HealthyThreshold": Integer,
    "HealthCheckProtocol": String,
    "HealthCheckTimeout": Integer,
    "HealthCheckHttpVersion": String,
    "ResourceGroupId": String
  }
}

    プロパティ

    プロパティ名

    タイプ

    必須

    更新可能

    説明

    制約

    HealthCheckTemplateName

    String

    Yes

    Yes

    ヘルスチェックテンプレートの名前。

    名前は 2～128 文字の長さで、英字または漢字で始まる必要があります。英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。

    HealthCheckCodes

    List

    No

    Yes

    正常なバックエンドサーバーを示す HTTP ステータスコード。

    有効値：

    • HealthCheckProtocol が HTTP の場合、有効値は http_2xx (デフォルト)、http_3xx、http_4xx、http_5xx です。複数の状態コードはコンマ (,) で区切ります。

    • HealthCheckProtocol が gRPC の場合、有効値は 0～99 の整数です。デフォルト値は 0 です。最大 20 の範囲を指定できます。複数の範囲はコンマ (,) で区切ります。

    説明

    このプロパティは、HealthCheckProtocol が HTTP または gRPC の場合にのみ有効になります。

    HealthCheckConnectPort

    Integer

    No

    Yes

    ヘルスチェックに使用されるポート。

    有効値: 0～65535。デフォルト値: 0。これは、ヘルスチェックがバックエンドサーバーのポートを使用することを意味します。

    HealthCheckHost

    String

    No

    Yes

    ヘルスチェックに使用されるドメイン名。

    デフォルト値： $SERVER_IP。

    ドメイン名は 1～80 文字の長さで、次の要件を満たす必要があります。

    • 有効な文字は、小文字の英字、数字、ハイフン (-)、ピリオド (.) です。

    • 少なくとも 1 つのピリオド (.) を含める必要があります。ピリオドは先頭または末尾に配置できません。

    • 最も右のラベルには英字のみを含める必要があります。数字やハイフン (-) を含めることはできません。

    • その他のラベルでは、ハイフン (-) を先頭または末尾に配置できません。

    説明

    このプロパティは、HealthCheckProtocol が HTTP の場合にのみ有効になります。

    HealthCheckHttpVersion

    String

    No

    No

    ヘルスチェックに使用される HTTP バージョン。

    有効値：

    • HTTP1.0

    • HTTP1.1

    HealthCheckInterval

    Integer

    No

    Yes

    ヘルスチェック間の間隔。

    有効値: 1～50。

    デフォルト値: 2。

    単位： 秒。

    HealthCheckMethod

    String

    No

    Yes

    ヘルスチェックに使用されるメソッド。

    有効値：

    • HEAD (デフォルト)： HTTP リスナーのデフォルトとして使用されます。

    • POST： gRPC リスナーのデフォルトとして使用されます。

    • GET： 応答メッセージが 8 KB を超える場合、切り捨てられます。これはヘルスチェック結果に影響しません。

    説明

    このプロパティは、HealthCheckProtocol が HTTP または gRPC の場合にのみ有効になります。

    HealthCheckPath

    String

    No

    Yes

    ヘルスチェックに使用される URL。

    URL は 1～80 文字の長さである必要があります。有効な文字には、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、パーセント記号 (%)、疑問符 (?)、シャープ記号 (#)、アンパサンド (&)、および _;~!() *[]@$^:',+ などの拡張文字が含まれます。URL はスラッシュ (/) で始まる必要があります。

    説明

    このプロパティは、HealthCheckProtocol が HTTP の場合にのみ有効になります。

    HealthCheckProtocol

    String

    No

    Yes

    ヘルスチェックに使用されるプロトコル。

    有効値：

    • HTTP (デフォルト)： HEAD または GET リクエストを送信してブラウザアクセスをシミュレートし、サーバーアプリケーションが正常であるかを確認します。

    • TCP： SYN ハンドシェイクメッセージを送信して、サーバーポートがアクティブであるかを確認します。

    • gRPC： POST または GET リクエストを送信して、サーバーアプリケーションが正常であるかを確認します。

    HealthCheckTimeout

    Integer

    No

    Yes

    ヘルスチェックからの応答を待機する時間。

    バックエンドサーバーがこの時間内に正しく応答しない場合、ヘルスチェックは失敗します。

    有効値: 1～300。

    デフォルト値: 5。

    単位： 秒。

    説明

    HealthCheckTimeout が HealthCheckInterval より短い場合、HealthCheckTimeout は無視されます。タイムアウトは HealthCheckInterval に設定されます。

    HealthyThreshold

    Integer

    No

    Yes

    バックエンドサーバーのヘルスチェックステータスが失敗から正常に変わるために必要な、連続して成功したヘルスチェックの回数。

    有効値: 2～10。

    デフォルト値: 3。

    ResourceGroupId

    String

    No

    No

    リソースグループの ID。

    なし。

    UnhealthyThreshold

    Integer

    No

    Yes

    バックエンドサーバーのヘルスチェックステータスが正常から異常に変わるために必要な、連続して失敗したヘルスチェックの回数。

    有効値: 2～10。

    デフォルト値: 3。

    戻り値

    Fn::GetAtt

    HealthCheckTemplateId： ヘルスチェックテンプレートの ID。

    例

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HealthCheckTemplateName:
    Type: String
    Description: |-
      ヘルスチェックテンプレートの名前。
      名前は 2～128 文字の長さで、英字、数字、ピリオド
      (.)、アンダースコア (_)、ハイフン (-) を含めることができます。名前は英字で始まる必要があります。
Resources:
  HealthCheckTemplate:
    Type: ALIYUN::ALB::HealthCheckTemplate
    Properties:
      HealthCheckTemplateName:
        Ref: HealthCheckTemplateName
Outputs:
  HealthCheckTemplateId:
    Description: ヘルスチェックテンプレートの ID。
    Value:
      Fn::GetAtt:
        - HealthCheckTemplate
        - HealthCheckTemplateId
    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HealthCheckTemplateName": {
      "Type": "String",
      "Description": "ヘルスチェックテンプレートの名前。\n名前は 2～128 文字の長さで、英字、数字、ピリオド\n(.)、アンダースコア (_)、ハイフン (-) を含めることができます。名前は英字で始まる必要があります。"
    }
  },
  "Resources": {
    "HealthCheckTemplate": {
      "Type": "ALIYUN::ALB::HealthCheckTemplate",
      "Properties": {
        "HealthCheckTemplateName": {
          "Ref": "HealthCheckTemplateName"
        }
      }
    }
  },
  "Outputs": {
    "HealthCheckTemplateId": {
      "Description": "ヘルスチェックテンプレートの ID。",
      "Value": {
        "Fn::GetAtt": [
          "HealthCheckTemplate",
          "HealthCheckTemplateId"
        ]
      }
    }
  }
}