すべてのプロダクト
Search
ドキュメントセンター

Alibaba Cloud DNS:DescribeCloudGtmMonitorTemplate

最終更新日: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:DescribeCloudGtmMonitorTemplate

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AcceptLanguage

string

任意

レスポンスの言語。有効な値:

  • zh-CN:中国語。

  • en-US(デフォルト):英語。

zh-CN

TemplateId

string

必須

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

mtp-89518052425100****

レスポンスフィールド

フィールド

説明

object

RequestId

string

一意のリクエスト ID。

6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF

TemplateId

string

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

mtp-89518052425100****

CreateTime

string

ヘルスチェックテンプレートが作成された日時。

2024-03-23T13:09Z

CreateTimestamp

integer

ヘルスチェックテンプレートが作成された日時を示す UNIX タイムスタンプ。

1527690629357

UpdateTime

string

ヘルスチェックテンプレートが最後に変更された日時。

2024-03-29T13:20Z

UpdateTimestamp

integer

ヘルスチェックテンプレートが最後に変更された日時を示す UNIX タイムスタンプ。

1527690629357

Name

string

ヘルスチェックテンプレートの名前。テンプレートを簡単に識別するために、ヘルスチェックプロトコルを示す名前を指定します。

Ping-IPv4

IpVersion

string

検出ポイントの IP アドレスの種類:

  • IPv4:ターゲットアドレスは IPv4 アドレスです。

  • IPv6:ターゲットアドレスは IPv6 アドレスです。

IPv4

Protocol

string

ターゲット IP アドレスをプローブするために使用されるプロトコル:

  • ping

  • tcp

  • http

  • https

ping

Interval

integer

ヘルスチェックの間隔(秒)。デフォルト値は 60 です。最小間隔は 15 秒です。この機能は、Ultimate エディションインスタンスでのみ使用できます。

60

Timeout

integer

ヘルスチェックのタイムアウト期間(ミリ秒)。指定されたタイムアウト期間内にパケットが返されない場合、ヘルスチェックは失敗します。有効な値:

  • 2000

  • 3000

  • 5000

  • 10000

5000

EvaluationCount

integer

アプリケーションサービスが異常と宣言されるまでにヘルスチェックが連続して失敗する必要がある回数。これにより、ネットワークジッターなどの過渡的な問題によって引き起こされる誤ったアラームを防ぎます。有効な値:

  • 1

  • 2

  • 3

2

FailureRate

integer

失敗した検出ポイントの割合。失敗した検出ポイントの割合がこの値を超えると、エンドポイントは異常と宣言されます。有効な値:

  • 20

  • 50

  • 80

  • 100

50

ExtendInfo

string

JSON 文字列の拡張情報。パラメータはプロトコルによって異なります。

  • HTTP および HTTPS の場合:

    host:HTTP または HTTPS リクエストヘッダーの Host フィールド。このフィールドは、アクセスしたい Web サイトを識別します。デフォルト値はプライマリドメイン名です。ターゲット Web サイトに特定のホスト要件がある場合は、このパラメータを変更します。

    path:HTTP または HTTPS ヘルスチェックの URL パス。デフォルト値は / です。

    code:システムは、リターンコードに基づいて Web サーバーが期待どおりに動作しているかどうかを判断します。リターンコードが指定されたしきい値より大きい場合、アプリケーションサービスは異常と見なされます。

    • 400:不正なリクエスト。HTTP または HTTPS リクエストに不正なパラメータが含まれている場合、Web サーバーは 400 より大きいコードを返します。しきい値を 400 に設定する場合は、正確な URL パスを指定します。

    • 500:サーバーエラー。Web サーバーで例外が発生した場合、500 より大きいコードが返されます。デフォルトのしきい値は 500 です。

    sni:サーバー名表示 (SNI) を有効にするかどうかを指定します。このパラメータは、HTTPS プロトコルにのみ使用されます。SNI は、クライアントが TLS ハンドシェイクの開始時に接続したいホスト名を指定できるトランスポート層セキュリティ (TLS) 拡張機能です。これにより、サーバーはそのホスト名に対して正しい証明書を提示できます。

    • true:SNI を有効にします。

    • false:SNI を無効にします。

    followRedirect:3xx リダイレクトに従うかどうかを指定します。

    • true:検出ポイントから返された状態コードが 3xx(301、302、303、307、または 308)の場合、システムはリダイレクトに従います。

    • false:システムはリダイレクトに従いません。

  • ping の場合:

    packetNum:各 ping ヘルスチェックで送信する ICMP パケットの数。有効な値:20、50、および 100。

    packetLossRate:パケット損失率のしきい値。各 ping ヘルスチェックで、システムはパケット損失率を計算します。パケット損失率がしきい値に達すると、アラートがトリガーされます。パケット損失率 =(損失パケット数 / 送信された ICMP パケットの総数)× 100%。パケット損失率の有効な値は、10、30、40、80、90、および 100 です。

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

IspCityNodes

object

IspCityNode

array<object>

検出ポイントのリスト。詳細については、ListCloudGtmMonitorNodes 操作を呼び出してください。

object

検出ポイント。

CountryCode

string

国別コード。

001

CountryName

string

国名。

中国

CityCode

string

都市コード。

503

CityName

string

都市名。

张家口市

GroupType

string

検出ポイントのグループタイプ:

  • BGP:ボーダーゲートウェイプロトコル (BGP) ノード

  • OVERSEAS:中国本土以外のノード

  • ISP:キャリアノード

BGP

GroupName

string

検出ポイントグループの名前。

BGP节点

IspCode

string

キャリアコード。

465

IspName

string

キャリア名。

阿里巴巴

Remark

string

ヘルスチェックテンプレートに関する備考。

test

成功レスポンス

JSONJSON

{
  "RequestId": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "TemplateId": "mtp-89518052425100****",
  "CreateTime": "2024-03-23T13:09Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1527690629357,
  "Name": "Ping-IPv4",
  "IpVersion": "IPv4",
  "Protocol": "ping",
  "Interval": 60,
  "Timeout": 5000,
  "EvaluationCount": 2,
  "FailureRate": 50,
  "ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CountryCode": "001",
        "CountryName": "中国",
        "CityCode": "503",
        "CityName": "张家口市",
        "GroupType": "BGP",
        "GroupName": "BGP节点",
        "IspCode": "465",
        "IspName": "阿里巴巴"
      }
    ]
  },
  "Remark": "test"
}

エラーコード

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

変更履歴

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