UpdateGtmInstanceGlobalConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Modifies the configurations of a Global Traffic Manager (GTM) instance based on the specified parameters.

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:UpdateGtmInstanceGlobalConfig	update	gtmInstance acs:alidns::{#accountId}:gtminstance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
InstanceId	string	Yes	The ID of the GTM instance.	instance1
InstanceName	string	No	The name of the GTM instance. Note This parameter is required only for the first modification.
Ttl	integer	No	The global time-to-live (TTL).	60
UserDomainName	string	No	The primary domain name. Note This parameter is required only for the first modification.	www.example.com
LbaStrategy	string	No	The balancing policy. Valid values: ALL_RR: load balancing RATIO: weighted round-robin Note This parameter is required only for the first modification.	RATIO
AlertGroup	string	No	The alert group. Only one alert group is supported. Note This parameter is required only for the first modification.
CnameMode	string	No	Specifies whether to use a system-assigned canonical name (CNAME) or a custom CNAME to access GTM. Valid values: SYSTEM_ASSIGN: system-assigned CNAME CUSTOM: custom CNAME	SYSTEM_ASSIGN
CnameCustomDomainName	string	No	If you set CnameMode to CUSTOM, you must specify the CnameCustomDomainName parameter, which must be set to a primary domain name.	www.example.com

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	GtmInstance.CnameModeDeny
400	DnsGtmInstance.CnameModeDeny

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

Change history

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