DescribeCloudGtmInstanceConfigAlert - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the alert configuration for an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeCloudGtmInstanceConfigAlert

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese. en-US: English.	en-US
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests. It can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24**22
InstanceId	string	No	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-wwo3a3hbz**
ConfigId	string	No	The ID of the instance configuration. For the same access domain name and GTM instance, you can configure both A and AAAA records. This creates two instance configurations. `ConfigId` uniquely identifies an instance configuration.	Config-000**11

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	0F32959D-417B-4D66-8463-68606605E3E2
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-wwo3a3hbz**
ConfigId	string	The ID of the instance configuration. For the same access domain name and GTM instance, you can configure both A and AAAA records. This creates two instance configurations. `ConfigId` uniquely identifies an instance configuration.	Config-000**11
AlertMode	string	The alert configuration mode for the instance. global: The instance inherits the global alert configuration. instance_config: The instance uses a custom alert configuration.	global
AlertGroup	object
AlertGroup	array	The list of alert notification groups.
	string	The alert notification group.	[\"Alert group contact\"]
AlertConfig	object
AlertConfig	array<object>	The list of alert configurations.
	object	The configuration of the alert rule.
NoticeType	string	The type of the alert event. Valid values: addr_alert: An address is unavailable. addr_resume: An address becomes available. addr_pool_unavailable: An address pool is unavailable. addr_pool_available: An address pool becomes available.	addr_alert
SmsNotice	boolean	Indicates whether text message notifications are enabled. true: Enabled. A text message is sent when an alert is triggered. false: Disabled. Text message notifications are supported only on the China site (aliyun.com) and not on the international site (alibabacloud.com).	true
EmailNotice	boolean	Indicates whether email notifications are enabled. true: Enabled. An email is sent when an alert is triggered. false: Disabled.	true
DingtalkNotice	boolean	Indicates whether DingTalk notifications are enabled. true: Enabled. A DingTalk message is sent when an alert is triggered. false: Disabled.	true

Examples

Success response

JSON format

{
  "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
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.