All Products
Search
Document Center

Alibaba Cloud DNS:UpdateCloudGtmInstanceConfigAlert

Last Updated:Sep 09, 2025

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

update

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

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

zh-CN

ClientToken

string

No

A client-generated token that ensures the idempotence of the request. The client must generate a unique value for this parameter. The token can contain a maximum of 64 ASCII characters.

1ae05db4-10e7-11ef-b126-00163e24**22

InstanceId

string

No

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

gtm-cn-zz11t58**0s

ConfigId

string

No

The ID of the domain name instance configuration. A GTM instance can have two configurations for the same access domain name if you configure both A and AAAA records. The ConfigId uniquely identifies a configuration.

Config-000**11

AlertMode

string

No

The alert configuration mode for the instance. Valid values:

  • global: The instance inherits the global alert configuration.

  • instance_config: The instance uses a custom alert configuration.

global

AlertGroup

array

No

A list of alert notification groups.

string

No

The alert notification group.

[\"云账号报警联系人\"]

AlertConfig

array<object>

No

A list of alert configurations.

object

No

The alert rule configuration.

NoticeType

string

No

The type of alert event. Valid values:

  • addr_alert: The address is unavailable.

  • addr_resume: The address has recovered.

  • addr_pool_unavailable: The address pool is unavailable.

  • addr_pool_available: The address pool has recovered.

addr_alert

SmsNotice

boolean

No

Specifies whether to enable text message notifications. Valid values:

  • true: Enabled. When an alert is triggered, a text message is sent.

  • false: Disabled.

Note: Text message notifications are supported only on the China site (aliyun.com).

true

EmailNotice

boolean

No

Specifies whether to enable email notifications. Valid values:

  • true: Enabled. When an alert is triggered, an email is sent.

  • false: Disabled.

true

DingtalkNotice

boolean

No

Specifies whether to enable DingTalk notifications. Valid values:

  • true: Enabled. When an alert is triggered, a DingTalk message is sent.

  • false: Disabled.

true

Response elements

Element

Type

Description

Example

object

RequestId

string

The unique request ID.

536E9CAD-DB30-4647-AC87-AA5CC38C5382

Success

boolean

Indicates whether the operation was successful. Valid values:

  • true: The operation was successful.

  • false: The operation failed.

true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.