すべてのプロダクト
Search

このプロダクト

    Server Load Balancer:UpdateHealthCheckTemplateAttribute

    ドキュメントセンター

    Server Load Balancer:UpdateHealthCheckTemplateAttribute

    最終更新日:May 30, 2026

    このオペレーションは、ヘルスチェックテンプレートの属性 (名前やヘルスチェックプロトコルなど) を更新します。

    今すぐお試しください

    この 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:UpdateHealthCheckTemplateAttribute

    update

    *HealthCheckTemplate

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用するクライアントトークンです。

    リクエストごとに、クライアント側で一意の値を生成する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。

    説明

    このパラメータを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。各リクエストの RequestId は一意です。

    5A2CFF0E-5718-45B5-9D4D-70B******
    HealthCheckTemplateName

    string

    任意

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

    名前は 2～128 文字で、先頭は英字、漢字、または数字で始まる必要があります。英字、漢字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-)、およびスペースを使用できます。

    HealthCheckTemplate1
    HealthCheckConnectPort

    integer

    任意

    ヘルスチェックに使用するポートです。有効な値：0～65535。 デフォルト値は 0 です。この場合、ヘルスチェックではバックエンドサーバーのポートが使用されます。

    80
    HealthCheckHost

    string

    任意

    ヘルスチェックに使用するドメイン名です。有効な値：

    • $SERVER_IP (デフォルト)：バックエンドサーバーのプライベート IP アドレスです。この値を指定するか、またはパラメータを空のままにした場合、負荷分散サービスはヘルスチェックにバックエンドサーバーのプライベート IP アドレスを使用します。

    • domain：英字、数字、ピリオド (.)、およびハイフン (-) を含む、1～80 文字のドメイン名です。

    説明

    このパラメータは、HealthCheckProtocol パラメータを HTTP または HTTPS に設定した場合にのみ有効です。

    $SERVER_IP
    HealthCheckCodes

    array

    任意

    正常状態を示すステータスコードのリストです。

    5

    string

    任意

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

    • HealthCheckProtocol を HTTP または HTTPS に設定した場合、次の値を 1 つ以上指定します：http_2xx (デフォルト)、http_3xx、http_4xx、http_5xx。複数の値はカンマで区切ります。

    • HealthCheckProtocol を gRPC に設定した場合、有効なステータスコードは 0～99 の範囲です。デフォルト値は 0 です。最大 20 個の範囲を指定できます。複数の範囲はカンマで区切ります。

    説明

    このパラメータは、HealthCheckProtocol パラメータを HTTP、HTTPS、または gRPC に設定した場合にのみ有効です。

    http_2xx
    HealthCheckInterval

    integer

    任意

    ヘルスチェック間隔 (秒) です。有効な値：1～50。デフォルト値：2。

    5
    HealthCheckTimeout

    integer

    任意

    ヘルスチェック応答のタイムアウト時間 (秒) です。この時間内にバックエンドサーバーが応答しない場合、ヘルスチェックは失敗します。

    有効な値：1～300。デフォルト値：5。

    3
    HealthCheckPath

    string

    任意

    ヘルスチェックに使用する URL です。

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

    URL はスラッシュ (/) で始まる必要があります。

    説明

    このパラメータは、HealthCheckProtocol パラメータを HTTP、HTTPS、または gRPC に設定した場合にのみ有効です。

    /test/index.html
    HealthCheckMethod

    string

    任意

    ヘルスチェックに使用するメソッドです。有効な値：

    • HEAD (デフォルト)：HTTP および HTTPS リスナーのヘルスチェックのデフォルトメソッドです。

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

    • POST：gRPC リスナーのヘルスチェックのデフォルトメソッドです。

    説明

    このパラメータは、HealthCheckProtocol パラメータを HTTP、HTTPS、または gRPC に設定した場合にのみ有効です。

    HEAD
    HealthCheckProtocol

    string

    任意

    ヘルスチェックに使用するプロトコルです。有効な値：

    • HTTP (デフォルト)：HTTP の HEAD リクエストまたは GET リクエストを送信して、バックエンドサーバーの正常性をチェックします。

    • HTTPS：HTTPS の HEAD リクエストまたは GET リクエストを送信して、バックエンドサーバーの正常性をチェックします。HTTPS はデータを暗号化するため、HTTP よりも安全です。

    • TCP：TCP SYN パケットを送信して、バックエンドサーバーのポートに到達可能かどうかをチェックします。

    • gRPC：POST リクエストまたは GET リクエストを送信して、バックエンドサーバーの正常性をチェックします。

    HTTP
    HealthCheckHttpVersion

    string

    任意

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

    有効な値：HTTP1.0 および HTTP1.1。

    デフォルト値：HTTP1.1。

    説明

    このパラメータは、HealthCheckProtocol パラメータを HTTP または HTTPS に設定した場合にのみ有効です。

    HTTP1.0
    HealthyThreshold

    integer

    任意

    バックエンドサーバーのステータスを 非正常 から 正常 に変更するために必要な、連続したヘルスチェック成功回数です。

    有効な値：2～10。

    デフォルト値：3。

    4
    UnhealthyThreshold

    integer

    任意

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

    有効な値：2～10。

    デフォルト値：3。

    4
    DryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。有効な値：

    • true：ドライランを実行して、リクエストを確認します。オペレーションを実行せずに、必須パラメータ、リクエスト構文、およびビジネス制約を確認します。リクエストが無効な場合はエラーが返されます。リクエストが有効な場合は、DryRunOperation エラーコードが返されます。

    • false (デフォルト)：通常のリクエストを送信します。リクエストが有効な場合、2xx HTTP ステータスコードが返され、オペレーションが実行されます。

    true
    HealthCheckTemplateId

    string

    必須

    ヘルスチェックテンプレート ID です。

    hct-bp1qjwo61******

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    更新リクエストに対するレスポンス。

    RequestId

    string

    リクエスト ID。

    365F4154-92F6-4AE4-92F8-7FF3******

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IncorrectStatus.HealthCheckTemplate The status of %s [%s] is incorrect.
    403 Forbidden.HealthCheckTemplate Authentication is failed for %s.
    404 ResourceNotFound.HealthCheckTemplate The specified resource %s is not found.

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

    変更履歴

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