All Products
Search
Document Center

Alibaba Cloud DNS:UpdateDnsGtmInstanceGlobalConfig

Last Updated:Mar 15, 2024

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

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:UpdateDnsGtmInstanceGlobalConfigREAD
  • gtmInstance
    acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.

en
InstanceIdstringYes

The ID of the instance.

instance1
InstanceNamestringNo

The name of the instance. This parameter is required only for the first update.

test
TtlintegerNo

The global time to live (TTL).

1
PublicCnameModestringNo

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
PublicUserDomainNamestringNo

The service domain name that is used over the Internet.

example.com
PublicZoneNamestringNo

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
AlertGroupstringNo

The name of the alert group in the JSON format.

alertGroup1
CnameTypestringNo

The type of the canonical name (CNAME).

  • Set the value to PUBLIC.
public
PublicRrstringNo

The hostname corresponding to the CNAME domain name that is used to access the instance over the Internet.

test.rr
ForceUpdatebooleanNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400DnsGtmInstance.PublicRrDuplicate.OtherUserInstance
400GtmInstance.CnameModeDeny
400DnsGtmInstance.CnameModeDeny
400DnsGtmSystemBusyness

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

Change history

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