All Products
Search
Document Center

UpdateDnsGtmInstanceGlobalConfig (new)

Last Updated: Mar 04, 2021

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

UpdateDnsGtmInstanceGlobalConfig

The operation that you want to perform. Set the value to UpdateDnsGtmInstanceGlobalConfig.

InstanceId

String

Yes

instance1

The ID of the instance.

Lang

String

No

en

The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.

InstanceName

String

No

test

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

Ttl

Integer

No

1

The global time to live (TTL).

PublicCnameMode

String

No

custom

Specifies whether to use a custom CNAME domain name or a CNAME domain name assigned by the system to access GTM over the Internet. Valid values:

  • SYSTEM_ASSIGN: a CNAME domain name assigned by the system

  • CUSTOM: a custom CNAME domain name

PublicUserDomainName

String

No

example.com

The website domain name that the user uses on the Internet.

PublicZoneName

String

No

gtminstance.example.com

The CNAME domain name that is used to access GTM over the Internet. This parameter is required when PublicCnameMode is set to CUSTOM.

AlertGroup

String

No

alertGroup1

The

alert group

, which must be in the List<String> JSON format

.

CnameType

String

No

public

The access type of the CNAME domain name.

  • Set the value to PUBLIC, which indicates Internet access.

AlertConfig.N.NoticeType

String

No

ADDR_ALERT

The type of the alert event. Valid values:

  • ADDR_ALERT: The address is unavailable.

  • ADDR_RESUME: The address is restored and becomes available.

  • ADDR_POOL_GROUP_UNAVAILABLE: The address pool group is unavailable.

  • ADDR_POOL_GROUP_AVAILABLE: The address pool group is restored and becomes available.

  • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Switchover is triggered between the primary and secondary address pools.

  • MONITOR_NODE_IP_CHANGE: Monitor node IP address changes

AlertConfig.N.SmsNotice

Boolean

No

true

Specifies whether to configure SMS notifications. Valid values:

  • true: configured

  • false | null: not configured

AlertConfig.N.EmailNotice

Boolean

No

true

Specifies whether to configure email notifications. Valid values:

  • true: configured

  • false | null: not configured

Response parameters

Parameter

Type

Example

Description

RequestId

String

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

The ID of the request.

Examples

Sample requests

http(s)://alidns.aliyuncs.com/? Action=UpdateDnsGtmInstanceGlobalConfig
&InstanceId=instance1
&<Common request parameters>

Sample success responses

XML format

<RequestId>29D0F8F8-5499-4F6C-9FDC-1EE13BF55925</RequestId>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.