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

Alibaba Cloud DNS:ListCloudGtmMonitorTemplates

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

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AcceptLanguage

string

任意

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

  • zh-CN:中国語。

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

zh-CN

PageNumber

integer

必須

ページ番号。値は 1 から始まります。デフォルト値は 1 です。

1

PageSize

integer

必須

各ページに返すエントリの数。最大値:100。デフォルト値:20。

20

Name

string

任意

ヘルスチェックテンプレートの名前。異なるヘルスチェックプロトコルを区別しやすいようにテンプレートに名前を付けます。

IPv4-Ping

IpVersion

string

任意

検出ポイントの IP バージョン。

  • IPv4:宛先アドレスは IPv4 アドレスです。

  • IPv6:宛先アドレスは IPv6 アドレスです。

IPv4

Protocol

string

任意

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

  • ping

  • tcp

  • http

  • https

ping

レスポンスフィールド

フィールド

説明

object

RequestId

string

一意のリクエスト ID。

75446CC1-FC9A-4595-8D96-089D73D7A63D

TotalPages

integer

返されるページの総数。

2

TotalItems

integer

ヘルスチェックテンプレートの総数。

30

PageSize

integer

各ページに返されるエントリの数。最大値:100。デフォルト値:20。

20

PageNumber

integer

返されたページの番号。ページは 1 から始まります。デフォルト値:1。

1

Templates

object

Template

array<object>

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

object

ヘルスチェックテンプレートの詳細。

TemplateId

string

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

mtp-89518052425100****

CreateTime

string

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

2024-03-23T13:09Z

CreateTimestamp

integer

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

1527690629357

UpdateTime

string

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

2024-03-29T13:20Z

UpdateTimestamp

integer

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

1527690629357

Name

string

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

IPv4-Ping

IpVersion

string

検出ポイントの IP バージョン。

  • IPv4:宛先アドレスは IPv4 アドレスです。

  • IPv6:宛先アドレスは IPv6 アドレスです。

IPv4

Protocol

string

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

  • 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 ヘルスチェックのパス。デフォルトのパスは / です。

    code:HTTP ステータスコードのしきい値。HTTP または HTTPS ヘルスチェック中に、システムは返されたステータスコードをチェックします。コードが指定された値よりも大きい場合、アプリケーションサービスは異常とみなされます。

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

    • 500:サーバーエラー。サーバー側の例外が発生した場合、Web サーバーは 500 より大きいステータスコードを返します。デフォルトでは、システムはしきい値として 500 を使用します。

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

    • true:有効

    • false:無効

    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": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "TotalPages": 2,
  "TotalItems": 30,
  "PageSize": 20,
  "PageNumber": 1,
  "Templates": {
    "Template": [
      {
        "TemplateId": "mtp-89518052425100****",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "IPv4-Ping",
        "IpVersion": "IPv4",
        "Protocol": "ping",
        "Interval": 60,
        "Timeout": 5000,
        "EvaluationCount": 2,
        "FailureRate": 50,
        "ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}\n",
        "IspCityNodes": {
          "IspCityNode": [
            {
              "CountryCode": "001",
              "CountryName": "中国",
              "CityCode": "503",
              "CityName": "张家口市",
              "GroupType": "BGP",
              "GroupName": "BGP节点",
              "IspCode": "465",
              "IspName": "阿里巴巴"
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

エラーコード

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

変更履歴

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