UpdateCloudGtmInstanceConfigAlert

Updated at: 2025-03-18 07:04
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
OperationAccess levelResource typeCondition keyAssociated operation
alidns:UpdateCloudGtmInstanceConfigAlertupdate
*GtmInstance
acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh-CN: Chinese
  • en-US: English
zh-CN
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
InstanceIdstringNo

The ID of the Global Traffic Manager (GTM) 3.0 instance.

gtm-cn-zz11t58**0s
ConfigIdstringNo

The configuration ID of the access domain name. Two configuration IDs exist when an A record and an AAAA record are configured for the access domain name that is bound to the GTM instance. This ID uniquely identifies a configuration.

Config-000**11
AlertModestringNo

The alert configuration mode of the instance. Valid values:

  • global: global alert configuration
  • instance_config: custom alert configuration
global
AlertGrouparrayNo

The alert contact groups.

stringNo

The alert contact group.

[\"Default\"]
AlertConfigarray<object>No

The alert configurations.

objectNo

The alert rule configuration.

NoticeTypestringNo

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
SmsNoticebooleanNo

Specifies whether to configure text message notifications. Valid values:

  • true: configures text message notifications. Text messages are sent when alerts are triggered.
  • false: does not configure text message notifications.

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

true
EmailNoticebooleanNo

Specifies whether to configure email notifications. Valid values:

  • true: configures email notifications. Emails are sent when alerts are triggered.
  • false: does not configure email notifications.
true
DingtalkNoticebooleanNo

Specifies whether to configure DingTalk notifications. Valid values:

  • true: configures DingTalk notifications. DingTalk notifications are sent when alerts are triggered.
  • false: does not configure DingTalk notifications.
true

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

536E9CAD-DB30-4647-AC87-AA5CC38C5382
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
No change history
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare