All Products
Search
Document Center

Alibaba Cloud DNS:UpdateGtmInstanceGlobalConfig

Last Updated:Mar 15, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:UpdateGtmInstanceGlobalConfigWRITE
  • gtmInstance
    acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language.

en
InstanceIdstringYes

The ID of the GTM instance.

instance1
InstanceNamestringNo

The name of the GTM instance.

Note This parameter is required only for the first modification.
TtlintegerNo

The global time-to-live (TTL).

60
UserDomainNamestringNo

The primary domain name.

Note This parameter is required only for the first modification.
www.example.com
LbaStrategystringNo

The balancing policy. Valid values:

  • ALL_RR: load balancing
  • RATIO: weighted round-robin
Note This parameter is required only for the first modification.
RATIO
AlertGroupstringNo

The alert group. Only one alert group is supported.

Note This parameter is required only for the first modification.
CnameModestringNo

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
CnameCustomDomainNamestringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

29D0F8F8-5499-4F6C-9FDC-1EE13BF55925

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400GtmInstance.CnameModeDeny
400DnsGtmInstance.CnameModeDeny

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

Change history

Change timeSummary of changesOperation
2023-03-09The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400