すべてのプロダクト
Search

このプロダクト

    Microservices Engine:UpdateGatewayServiceCheck

    ドキュメントセンター

    Microservices Engine:UpdateGatewayServiceCheck

    最終更新日:Dec 16, 2025

    クラウドネイティブゲートウェイ内の指定されたサービスのヘルスチェックポリシーを更新します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mse:UpdateGatewayServiceCheck

    update

    *Gateway

    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ServiceId

    string

    任意

    サービスの ID。

    12
    GatewayUniqueId

    string

    任意

    ゲートウェイの一意の ID。

    gw-8d410698bd7f4628ab76b*****72dd1d
    Check

    boolean

    任意

    ヘルスチェックを有効にするかどうかを指定します。

    true
    ExpectedStatuses

    array

    任意

    期待される状態コード。ヘルスチェックプロトコルが HTTP の場合に必須です。

    integer

    任意

    正常なヘルスチェックを示す HTTP ステータスコード。このパラメーターは、ヘルスチェックプロトコルが HTTP の場合に必須です。有効な値：

    • http_2xx: 200

    • http_3xx: 300

    • http_4xx: 400

    • http_5xx: 500

    200
    Protocol

    string

    任意

    ヘルスチェックプロトコル。有効な値：

    • HTTP

    • TCP

    HTTP
    Timeout

    integer

    任意

    ヘルスチェック応答のタイムアウト期間。単位：秒。

    5
    Interval

    integer

    任意

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

    2
    HealthyThreshold

    integer

    任意

    ヘルスチェックの正常しきい値。

    2
    UnhealthyThreshold

    integer

    任意

    ヘルスチェックの異常しきい値。

    2
    HttpPath

    string

    任意

    ヘルスチェックパス。ヘルスチェックプロトコルが HTTP の場合に必須です。

    /healthz
    HttpHost

    string

    任意

    ヘルスチェックのドメイン名。ヘルスチェックプロトコルが HTTP の場合はオプションです。

    example.com
    AcceptLanguage

    string

    任意

    結果を表示する言語。有効な値：zh および en。zh は中国語 (デフォルト値)、en は英語を示します。

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    62CBFCB8-DDC6-588C-BF1B-88828AF*****
    HttpStatusCode

    integer

    返される HTTP ステータスコード。

    200
    Message

    string

    返されるメッセージ。

    OK
    Code

    integer

    レスポンスコード。状態コード 200 はリクエストが成功したことを示します。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：true および false。

    true
    Data

    integer

    操作対象のサービス ID。

    12

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "62CBFCB8-DDC6-588C-BF1B-88828AF*****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 12
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalRequest Invalid request:%s
    400 InvalidParameter Parameter error:%s
    500 InternalError Console error. Try again later:%s
    403 NoPermission You are not authorized to perform this operation:%s
    404 NotFound Not found:%s

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

    変更履歴

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