UpdateDnsGtmInstanceGlobalConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Modifies the configurations of a Global Traffic Manager (GTM) instance.

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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:UpdateDnsGtmInstanceGlobalConfig	update	gtmInstance acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.	en
InstanceId	string	Yes	The ID of the instance.	instance1
InstanceName	string	No	The name of the instance. This parameter is required only for the first update.	test
Ttl	integer	No	The global time to live (TTL).	1
PublicCnameMode	string	No	Specifies whether to use a custom CNAME domain name or a CNAME domain name assigned by the system to access the instance over the Internet. Valid values: SYSTEM_ASSIGN: a CNAME domain name assigned by the system CUSTOM: a custom CNAME domain name	custom
PublicUserDomainName	string	No	The service domain name that is used over the Internet.	example.com
PublicZoneName	string	No	The CNAME domain name that is used to access the instance over the Internet, which is the primary domain name. This parameter is required when the PublicCnameMode parameter is set to CUSTOM. Note You must use the primary domain name. Do not include the hostname specified by the PublicRr parameter.	gtm-003.com
AlertGroup	string	No	The name of the alert group in the JSON format.	alertGroup1
CnameType	string	No	The type of the canonical name (CNAME). Set the value to PUBLIC.	public
PublicRr	string	No	The hostname corresponding to the CNAME domain name that is used to access the instance over the Internet.	test.rr
ForceUpdate	boolean	No	Specifies whether to enable force updates. Valid values: true: enables force update without a conflict alert. false: disables force update. If a conflict occurs, the system displays an alert. null: This valid value of ForceUpdate provides the same information as the false value.	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925

Examples

Sample success responses

JSONformat

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

Error codes

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

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

Change history

Change time	Summary of changes	Operation
2023-03-21	The Error code has changed	View Change Details