すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud DNS:AddGtmMonitor

    ドキュメントセンター

    Alibaba Cloud DNS:AddGtmMonitor

    最終更新日:Sep 09, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    alidns:AddGtmMonitor

    create

    *gtminstance

    acs:alidns::{#accountId}:gtminstance/{#gtminstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Lang

    string

    任意

    言語。

    en
    AddrPoolId

    string

    必須

    アドレスプールの ID。

    xxxx
    ProtocolType

    string

    必須

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

    • HTTP

    • HTTPS

    • PING

    • TCP

    HTTP
    Interval

    integer

    必須

    ヘルスチェックの間隔。単位：秒。値は 60 でなければなりません。

    60
    EvaluationCount

    integer

    必須

    連続して失敗したヘルスチェックの数。

    3
    Timeout

    integer

    必須

    タイムアウト期間。単位：ミリ秒。有効な値：2000、3000、5000、および 10000。

    3000
    MonitorExtendInfo

    string

    必須

    拡張情報。 ProtocolType の値に基づいてパラメーターを渡す必要があります。

    HTTP および HTTPS の場合：

    • port：ヘルスチェックポート。

    • failureRate：失敗率。

    • code：リターンコード。この値よりも大きい状態コードを持つ応答は異常と見なされます。有効な値：400 および 500。

    • host：ホスト設定。

    • path：URL パス。

    PING の場合：

    • packetNum：ping パケットの数。

    • packetLossRate：パケット損失率。

    • failureRate：失敗率。

    TCP の場合：

    • port：ヘルスチェックポート。

    • failureRate：失敗率。

    {\"code\":200,\"path\":\"/index.htm\",\"host\":\"aliyun.com\"}
    IspCityNode

    array<object>

    必須

    監視ノードのリスト。

    object

    任意

    監視ノード。

    CityCode

    string

    任意

    都市コード。

    有効な値の詳細については、DescribeGtmMonitorAvailableConfig 操作のレスポンスを参照してください。

    503
    IspCode

    string

    任意

    有効な値の詳細については、DescribeGtmMonitorAvailableConfig 操作のレスポンスを参照してください。

    • GroupType が ボーダーゲートウェイプロトコル (BGP) または 海外 に設定されている場合、IspCityNode.N.IspCode を指定する必要はありません。デフォルト値は 465 です。

    • GroupType が BGP または 海外 に設定されていない場合、IspCityNode.N.IspCode を指定する必要があります。 IspCityNode.N.IspCode の値は、IspCityNode.N.CityCode の値と一致している必要があります。

    465

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    6856BCF6-11D6-4D7E-AC53-FD579933522B
    MonitorConfigId

    string

    ヘルスチェック構成の ID。

    1234abc

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "MonitorConfigId": "1234abc"
}

    エラーコード

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

    変更履歴

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