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

:UpdateDnsGtmMonitor

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

update

*MonitorConfig

acs:alidns:*:{#accountId}:gtminstance/{#InstanceId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

レスポンスの言語。デフォルト値:en。有効な値:en、zh、ja。

en

MonitorConfigId

string

必須

ヘルスチェック構成のID。DescribeDnsGtmInstanceAddressPool 操作を呼び出して ID を取得できます。

Monito******

ProtocolType

string

必須

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

  • HTTP

  • HTTPS

  • PING

  • TCP

http

Interval

integer

任意

ヘルスチェックの間隔。単位:秒。

60

EvaluationCount

integer

任意

連続ヘルスチェックの数。

2

Timeout

integer

任意

ヘルスチェックのタイムアウト期間。単位:ミリ秒。

3000

MonitorExtendInfo

string

必須

拡張情報。必須パラメーターは、ヘルスチェックプロトコルによって異なります。

  • HTTP(S):

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

    • host:ホストヘッダー。

    • path:URL パス。

    • code:返された状態コードが指定された値より大きい場合、ヘルスチェックは異常と見なされます。たとえば、このパラメーターを 400 に設定すると、返された状態コード 404 は異常と見なされます。

    • failureRate:失敗率。

    • sni:サーバ名表示 ( SNI ) を有効にするかどうかを指定します。このパラメーターは、HTTPS プロトコルでのみ使用できます。
      • true:SNI を有効にします。

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

    • nodeType:アドレスプールタイプが DOMAIN の場合のヘルスチェックのノードタイプ。
      • IPV4

      • IPV6

  • PING:

    • failureRate:失敗率。

    • packetNum:ping パケットの数。

    • packetLossRate:パケット損失率。

    • nodeType:アドレスプールタイプが DOMAIN の場合のヘルスチェックのノードタイプ。
      • IPV4

      • IPV6

  • TCP:

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

    • failureRate:失敗率。

    • nodeType:アドレスプールタイプが DOMAIN の場合のヘルスチェックのノードタイプ。
      • IPV4

      • IPV6

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

IspCityNode

array<object>

必須

ヘルスチェックの都市ノードのリスト。

object

任意

CityCode

string

任意

ヘルスチェックノードの都市コード。

123

IspCode

string

任意

ヘルスチェックノードのキャリアコード。

123

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエストID。

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

成功レスポンス

JSONJSON

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B"
}

エラーコード

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

変更履歴

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