DescribeCloudGtmGlobalAlert - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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:DescribeCloudGtmGlobalAlert

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 used to ensure the idempotence of the request. Generate a unique token for each request. The token can contain up to 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24**22

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	B57C121B-A45F-44D8-A9B2-13E5A5044195
AlertGroup	object
AlertGroup	array	The list of alert notification groups.
	string	The alert notification group.	[\"Alert 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: 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 sent when an alert event occurs. false: Text message notifications are not configured. Text message notifications are supported only on the China site (aliyun.com). They are not supported on the international site (alibabacloud.com).	true
EmailNotice	boolean	Indicates whether email notifications are configured. Valid values: true: Email notifications are sent when an alert event occurs. false: Email notifications are not configured.	true
DingtalkNotice	boolean	Indicates whether DingTalk notifications are configured. Valid values: true: DingTalk notifications are sent when an alert event occurs. false: DingTalk notifications are not configured.	false

Examples

Success response

JSON format

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AlertGroup": {
    "AlertGroup": [
      "[\\\"云账号报警联系人\\\"]"
    ]
  },
  "AlertConfig": {
    "AlertConfig": [
      {
        "NoticeType": "addr_alert",
        "SmsNotice": true,
        "EmailNotice": true,
        "DingtalkNotice": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.