All Products
Search
Document Center

Alibaba Cloud DNS:DescribeCloudGtmGlobalAlert

Last Updated:Apr 21, 2025
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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeCloudGtmGlobalAlertget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh-CN: Chinese
  • en-US: English
en-US
ClientTokenstringNo

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

B57C121B-A45F-44D8-A9B2-13E5A5044195
AlertGrouparray

The alert contact groups.

AlertGroupstring

The alert contact group.

[\"Default\"]
AlertConfigarray<object>

The alert configurations.

AlertConfigobject

Alarm rule configuration information.

NoticeTypestring

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
SmsNoticeboolean

Indicates whether text message notifications are configured. Valid values:

  • true: Text message notifications are configured. Text messages are sent when alerts are triggered.
  • false: Text message notifications are not configured.

Only the China site (aliyun.com) supports text message notifications.

true
EmailNoticeboolean

Indicates whether email notifications are configured. Valid values:

  • true: Email notifications are configured. Emails are sent when alerts are triggered.
  • false: Email notifications are not configured.
true
DingtalkNoticeboolean

Indicates whether DingTalk notifications are configured. Valid values:

  • true: DingTalk notifications are configured. DingTalk notifications are sent when alerts are triggered.
  • false: DingTalk notifications are not configured.
false

Examples

Sample success responses

JSONformat

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AlertGroup": {
    "AlertGroup": [
      "[\\\"Default\\\"]"
    ]
  },
  "AlertConfig": {
    "AlertConfig": [
      {
        "NoticeType": "addr_alert",
        "SmsNotice": true,
        "EmailNotice": true,
        "DingtalkNotice": false
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history