Modifies the configurations of a Global Traffic Manager (GTM) instance based on the specified parameters.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
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:
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 |
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
Examples
Sample success responses
JSON
format
{
"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 |