GTM インスタンスアラート設定 API リファレンス (DescribeCloudGtmInstanceConfigAlert) - Alibaba Cloud DNS (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:DescribeCloudGtmInstanceConfigAlert

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AcceptLanguage	string	任意	レスポンスの言語。有効な値： zh-CN：中国語。 en-US：英語。	en-US
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントはこの値を生成します。値は異なるリクエスト間で一意である必要があります。最大 64 ASCII 文字で、非 ASCII 文字を含めることはできません。	1ae05db4-10e7-11ef-b126-00163e24**22
InstanceId	string	任意	Global Traffic Manager (GTM) 3.0 インスタンスの ID。	gtm-cn-wwo3a3hbz**
ConfigId	string	任意	インスタンス構成の ID。同じアクセスドメイン名と GTM インスタンスに対して、A レコードと AAAA レコードの両方を構成できます。これにより、2 つのインスタンス構成が作成されます。 `ConfigId` はインスタンス構成を一意に識別します。	Config-000**11

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの一意の ID。	0F32959D-417B-4D66-8463-68606605E3E2
InstanceId	string	GTM 3.0 インスタンスの ID。	gtm-cn-wwo3a3hbz**
ConfigId	string	インスタンス構成の ID。同じアクセスドメイン名と GTM インスタンスに対して、A レコードと AAAA レコードの両方を構成できます。これにより、2 つのインスタンス構成が作成されます。 `ConfigId` はインスタンス構成を一意に識別します。	Config-000**11
AlertMode	string	インスタンスのアラート構成モード。 global：インスタンスはグローバルアラート構成を継承します。 instance_config：インスタンスはカスタムアラート構成を使用します。	global
AlertGroup	object
AlertGroup	array	アラート通知グループのリスト。
	string	アラート通知グループ。	[\"云账号报警联系人\"]
AlertConfig	object
AlertConfig	array<object>	アラート構成のリスト。
	object	アラートルールの構成。
NoticeType	string	アラートイベントの種類。有効な値： addr_alert：アドレスが利用できません。 addr_resume：アドレスが利用可能になります。 addr_pool_unavailable：アドレスプールが利用できません。 addr_pool_available：アドレスプールが利用可能になります。	addr_alert
SmsNotice	boolean	ショートメッセージ通知が有効かどうかを示します。 true：有効。アラートがトリガーされると、ショートメッセージが送信されます。 false：無効。ショートメッセージ通知は、中国サイト (aliyun.com) でのみサポートされており、国際サイト (alibabacloud.com) ではサポートされていません。	true
EmailNotice	boolean	メール通知が有効かどうかを示します。 true：有効。アラートがトリガーされると、メールが送信されます。 false：無効。	true
DingtalkNotice	boolean	DingTalk 通知が有効かどうかを示します。 true：有効。アラートがトリガーされると、DingTalk メッセージが送信されます。 false：無効。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "0F32959D-417B-4D66-8463-68606605E3E2",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "ConfigId": "Config-000**11\n",
  "AlertMode": "global",
  "AlertGroup": {
    "AlertGroup": [
      "[\\\"云账号报警联系人\\\"]"
    ]
  },
  "AlertConfig": {
    "AlertConfig": [
      {
        "NoticeType": "addr_alert",
        "SmsNotice": true,
        "EmailNotice": true,
        "DingtalkNotice": true
      }
    ]
  }
}

エラーコード

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

変更履歴

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