GTM ヘルスチェックテンプレートのリスト取得 - DNS

ヘルスチェックテンプレートを検索します。

今すぐお試しください

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

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。	536E9CAD-DB30-4647-AC87-AA5CC38C5382
TotalPages	integer	総ページ数。	1
TotalItems	integer	見つかったヘルスチェックテンプレートの総数。	1
PageSize	integer	各ページに返されるエントリ数。最大値は 100 です。デフォルト値は 20 です。	20
PageNumber	integer	現在のページ番号。値は 1 から始まります。デフォルト値は 1 です。	1
Templates	object
Template	array<object>	ヘルスチェックテンプレートのリスト。
	array<object>	ヘルスチェックテンプレートに関する情報。
TemplateId	string	ヘルスチェックテンプレートの ID。この ID は、ヘルスチェックテンプレートを一意に識別します。	mtp-89518052425100**80
CreateTime	string	ヘルスチェックテンプレートの作成時刻。	2024-03-23T13:09Z
CreateTimestamp	integer	ヘルスチェックテンプレートの作成時刻を示す UNIX タイムスタンプ。	1527690629357
UpdateTime	string	ヘルスチェックテンプレートの最終更新時刻。	2024-03-29T13:20Z
UpdateTimestamp	integer	ヘルスチェックテンプレートの最終更新時刻を示す UNIX タイムスタンプ。	1527690629357
Name	string	ヘルスチェックテンプレートの名前。識別しやすくするため、ヘルスチェックプロトコルを示す名前を指定してください。	IPv4-Ping
IpVersion	string	検出ポイントの IP バージョン。有効な値は次のとおりです。 IPv4：ターゲットアドレスが IPv4 アドレスの場合に適用されます。 IPv6：ターゲットアドレスが IPv6 アドレスの場合に適用されます。	IPv4
Protocol	string	ターゲット IP アドレスのプローブに使用されるプロトコル。有効な値は次のとおりです。 ping tcp http https	ping
Interval	integer	連続するヘルスチェック間の間隔。単位は秒です。デフォルトの間隔は 1 分です。最小間隔は 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(s): host: HTTP または HTTPS ヘルスチェックを実行する際、このパラメーターは HTTP または HTTPS リクエストヘッダー内の Host フィールドを指定します。これにより、対象となる HTTP Web サイトが識別されます。デフォルト値はプライマリドメイン名です。対象 Web サイトのホストに特殊な要件がある場合は、必要に応じてこのパラメーターを変更してください。 path: HTTP または HTTPS ヘルスチェックのパス。システムはデフォルトで "/" を入力します。 code: HTTP または HTTPS ヘルスチェックを実行する際、システムは Web サーバーからのリターンコードに基づいて、Web サーバーが期待どおりに動作しているかどうかを判断します。リターンコードがアラートのしきい値を超える場合、システムはアプリケーションサービスを異常とみなします。 400: Bad Request。HTTP または HTTPS リクエストに無効なパラメーターが含まれている場合、Web サーバーは 400 を超えるリターンコードを返します。「異常コードが 400 を超える」とチェック内容を設定する場合は、URL パスパラメーターに正確な URL パスを指定してください。 500: Server Error。Web サーバーで例外が発生した場合、サーバーは 500 を超えるリターンコードを返します。システムはデフォルトで、500 を超えるリターンコードをアラートのしきい値として使用します。 sni: Server Name Indication (SNI) を有効にするかどうかを指定します。このパラメーターは HTTPS プロトコルでのみ使用されます。SNI は TLS プロトコルの拡張機能であり、クライアントが TLS ハンドシェイクを開始する際に接続先のホスト名を指定できるようにします。TLS ハンドシェイクは HTTP リクエストのデータ送信前に実行されるため、SNI を使用することで、サーバーはクライアントがアクセスしようとしているサービスを、証明書を送信する前に把握できます。これにより、サーバーはクライアントに提示する正しい証明書を選択できます。 true: SNI を有効にします。 false: SNI を無効にします。 followRedirect: 3xx 自動転送に従うかどうかを指定します。 true: 検出ポイントが 3xx 状態コード（301、302、303、307、または 308）を受信した場合、自動転送に従います。 false: 自動転送に従いません。 ping: packetNum: 各 ping ヘルスチェックで送信する ICMP パケット数。有効な値は 20、50、および 100 です。 packetLossRate: 異常状態を示すパケット損失率。各 ping ヘルスチェックで、システムは送信された ICMP パケットに基づいてパケット損失率を計算します。パケット損失率 =（失われたパケット数 / 送信された ICMP パケット総数）× 100%。パケット損失率が指定されたしきい値に達すると、アラートがトリガーされます。パケット損失率の有効な値は 10、30、40、80、90、および 100 です。	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNodes	object
IspCityNode	array<object>	検出ポイントのリスト。
	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
CloudGtmMonitorTemplateId	string		mtp-xxxx

例

成功レスポンス

JSONJSON

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "TotalPages": 1,
  "TotalItems": 1,
  "PageSize": 20,
  "PageNumber": 1,
  "Templates": {
    "Template": [
      {
        "TemplateId": "mtp-89518052425100**80",
        "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\\\"}",
        "IspCityNodes": {
          "IspCityNode": [
            {
              "CountryCode": "001",
              "CountryName": "中国",
              "CityCode": "503",
              "CityName": "张家口市",
              "GroupType": "BGP",
              "GroupName": "BGP",
              "IspCode": "465",
              "IspName": "阿里巴巴"
            }
          ]
        },
        "Remark": "test",
        "CloudGtmMonitorTemplateId": "mtp-xxxx"
      }
    ]
  }
}

エラーコード

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

変更履歴

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