UpdateCloudGtmGlobalAlert-阿里云帮助中心

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

update

*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-generated token to ensure request idempotence. This token must be unique for each request, contain only ASCII characters, and be no more than 64 characters in length.	1ae05db4-10e7-11ef-b126-00163e24**22
AlertGroup	array	No	A list of alert notification groups.
	string	No	An alert notification group. The system retrieves its configuration from Cloud Monitor.	[\"云账号报警联系人\"]
AlertConfig	array<object>	No	A list of alert configurations.
	object	No	An alert configuration.
NoticeType	string	No	The alert event type. Valid values: `addr_alert`: An address becomes unavailable. `addr_resume`: An address becomes available. `addr_pool_unavailable`: An address pool becomes unavailable. `addr_pool_available`: An address pool becomes available.	addr_alert
SmsNotice	boolean	No	Whether to send a text message notification when an alert is triggered. Valid values: `true`: A text message notification is sent. `false` or `null`: Do not send a text message notification. Text message notifications are available only on the China site.	true
EmailNotice	boolean	No	Whether to send an email notification when an alert is triggered. Valid values: `true`: An email notification is sent. `false` or `null`: Do not send an email notification.	true
DingtalkNotice	boolean	No	Whether to send a DingTalk notification when an alert is triggered. Valid values: `true`: A DingTalk notification is sent. `false`: Do not send a DingTalk notification.	false
Threshold	integer	No	The alert threshold.	100
QpsThreshold	integer	No	The alert threshold for queries per second (QPS).	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B57C121B-A45F-44D8-A9B2-13E5A5044195
Success	boolean	Indicates whether the global alert configuration was successfully updated. Valid values: `true`: The update was successful. `false`: The update failed.	true

Examples

Success response

JSON format

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.