DescribeCloudGtmInstanceConfigAlert - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeCloudGtmInstanceConfigAlert	get	All Resources ``	none	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	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	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 configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.	Config-000**11

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0F32959D-417B-4D66-8463-68606605E3E2
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-wwo3a3hbz**
ConfigId	string	The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.	Config-000**11
AlertMode	string	The alert configuration mode of the instance. Valid values: global: global alert configuration instance_config: custom alert configuration	global
AlertGroup	array	The alert contact groups.
AlertGroup	string	The alert contact group.	[\"Default Contact Group\"]
AlertConfig	array<object>	The alert configurations.
AlertConfig	object	Alert rule configuration information.
NoticeType	string	The type of the alert event. Valid values: addr_alert: The address is unavailable. addr_resume: The address becomes available. addr_pool_unavailable: The address pool is unavailable. addr_pool_available: The address pool becomes available.	addr_alert
SmsNotice	boolean	Indicates whether text message notifications are configured. Valid values: true: Text message notifications are configured. Text messages are sent after alerts are triggered. false: Text message notifications are not configured. Only the China site (aliyun.com) supports text message notifications.	true
EmailNotice	boolean	Indicates whether email notifications are configured. Valid values: true: Email notifications are configured. Emails are sent after alerts are triggered. false: Email notifications are not configured.	true
DingtalkNotice	boolean	Indicates whether DingTalk notifications are configured. Valid values: true: DingTalk notifications are configured. DingTalk notifications are sent after alerts are triggered. false: DingTalk notifications are not configured.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "0F32959D-417B-4D66-8463-68606605E3E2",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "ConfigId": "Config-000**11\n",
  "AlertMode": "global",
  "AlertGroup": {
    "AlertGroup": [
      "[\\\"Default Contact Group\\\"]"
    ]
  },
  "AlertConfig": {
    "AlertConfig": [
      {
        "NoticeType": "addr_alert",
        "SmsNotice": true,
        "EmailNotice": true,
        "DingtalkNotice": true
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history