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

Alibaba Cloud DNS:CreateCloudGtmMonitorTemplate

最終更新日:Mar 26, 2026

指定されたパラメーターに基づいてヘルスチェックテンプレートを作成します。

今すぐお試しください

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

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AcceptLanguage

string

任意

応答の言語。有効な値:

  • zh-CN:中国語

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

en-US

ClientToken

string

任意

リクエストのべき等性を保証するためのクライアントトークンです。各リクエストでトークンが一意であることを確認してください。トークンは最大 64 文字の ASCII 文字で構成できます。

1ae05db4-10e7-11ef-b126-00163e24****

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(s):

    host:HTTP または HTTPS リクエストのヘッダー内の Host フィールドです。アクセス対象の Web サイトを特定するために使用されます。デフォルト値はプライマリドメイン名です。宛先 Web サイトが特定のホストを使用している場合は、必要に応じてこの値を変更してください。

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

    code:HTTP または HTTPS ヘルスチェックにおいて、Web サーバーの正常動作をリターンコードに基づいて判定します。リターンコードがこのしきい値より大きい場合、アプリケーションサービスは「不健全」と見なされます。

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

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

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

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

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

    followRedirect:3xx のリダイレクトを追跡するかどうかを指定します。

    • true:検出ポイントが 301、302、303、307、308 などの 3xx ステータスコードを受信した場合、リダイレクトを追跡します。

    • 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

array<object>

必須

検出ポイントのリストです。詳細については、「ListCloudGtmMonitorNodes」をご参照ください。

object

任意

検出ポイントです。

CityCode

string

任意

検出ポイントの都市コードです。

503

IspCode

string

任意

検出ポイントの ISP コードです。

465

レスポンスフィールド

フィールド

説明

object

RequestId

string

一意のリクエスト ID です。

B57C121B-A45F-44D8-A9B2-13E5A5044195

Success

boolean

操作が成功したかどうかを示します。

  • true:操作が成功しました。

  • false:操作が失敗しました。

true

TemplateId

string

ヘルスチェックテンプレートの ID です。これはテンプレートを一意に識別する識別子です。

mtp-89518052425100****

成功レスポンス

JSONJSON

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "Success": true,
  "TemplateId": "mtp-89518052425100****"
}

エラーコード

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

変更履歴

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