UpdateDnsGtmInstanceGlobalConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Updates the configuration of a Global Traffic Manager (GTM) instance.

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

update

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: en, zh, and ja. The default value is en.	en
InstanceId	string	Yes	The ID of the GTM instance. To obtain the instance ID, call the DescribeDnsGtmInstances operation.	gtm-cn-wwo3a3hbz**
InstanceName	string	No	The name of the instance. This parameter is required when you update the instance for the first time. It is optional for subsequent updates.	test-1
Ttl	integer	No	The global time to live (TTL).	60
PublicCnameMode	string	No	The method used to access the instance over the Internet. Valid values: SYSTEM_ASSIGN: The system assigns a canonical name (CNAME) record. This option is disabled. CUSTOM: You specify a CNAME record.	CUSTOM
PublicUserDomainName	string	No	The service domain name that is accessed over the Internet.	example.com
PublicZoneName	string	No	The primary domain name that is used to access the instance over the Internet using a CNAME record. This parameter is required if you set PublicCnameMode to CUSTOM. Note Enter the primary domain name. Do not include the hostname specified by the PublicRr parameter.	www.example.com
AlertGroup	string	No	The alert contact group. The value is a JSON-formatted `List<string>`.	["test1","test2"]
CnameType	string	No	The type of the CNAME record. Valid value: PUBLIC: The CNAME record is used for Internet access.	PUBLIC
AlertConfig	array<object>	No	The alert configurations.
	object	No
SmsNotice	boolean	No	Specifies whether to send alerts through text messages. Valid values: true: yes false or null: no	true
NoticeType	string	No	The type of the alert event. Valid values: ADDR_ALERT: An address becomes unavailable. ADDR_RESUME: An address becomes available. ADDR_POOL_GROUP_UNAVAILABLE: An address pool group becomes unavailable. ADDR_POOL_GROUP_AVAILABLE: An address pool group becomes available. ACCESS_STRATEGY_POOL_GROUP_SWITCH: A switchover occurs between the primary and secondary address pools. MONITOR_NODE_IP_CHANGE: The IP address of a monitoring node changes.	ADDR_ALERT
EmailNotice	boolean	No	Specifies whether to send alerts by email. Valid values: true: yes false or null: no	true
DingtalkNotice	boolean	No	Specifies whether to send alerts through DingTalk. Valid values: true: yes false: no	true
PublicRr	string	No	The hostname of the CNAME record that is used for Internet access.	test.rr
ForceUpdate	boolean	No	Specifies whether to forcefully update the instance. Valid values: true: Forcefully updates the instance without checking for conflicts. false or null: Does not forcefully update the instance. The system checks for conflicts before the update.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	29D0F8F8-5499-4F6C-9FDC-1EE13BF559**

Examples

Success response

JSON format

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF559**"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DnsGtmInstance.PublicRrDuplicate.OtherUserInstance
400	GtmInstance.CnameModeDeny
400	DnsGtmInstance.CnameModeDeny
400	DnsGtmSystemBusyness

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.