UpdateGtmInstanceGlobalConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:UpdateGtmInstanceGlobalConfig

update

*gtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
InstanceId	string	Yes	The ID of the GTM instance.	gtm-cn-cs02xyk4a**
InstanceName	string	No	The name of the instance. Note This parameter is required when you update the instance for the first time. It is optional for subsequent updates.	测试实例
Ttl	integer	No	The global Time to Live (TTL).	60
UserDomainName	string	No	The primary domain name. Note This parameter is required when you update the instance for the first time. It is optional for subsequent updates.	dns-example.top
LbaStrategy	string	No	The load balancing policy. Valid values: ALL_RR: round-robin RATIO: weighted round-robin Note This parameter is required when you update the instance for the first time. It is optional for subsequent updates.	RATIO
AlertGroup	string	No	The alert contact group. Only one alert contact group is supported. Note This parameter is required when you update the instance for the first time. It is optional for subsequent updates.	[\"研发组\"]
CnameMode	string	No	The connection type. Valid values: SYSTEM_ASSIGN: system-assigned CUSTOM: custom	SYSTEM_ASSIGN
CnameCustomDomainName	string	No	This parameter is required when you set CnameMode to CUSTOM. The value must be the primary domain name.	dns-example.top

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	GtmInstance.CnameModeDeny
400	DnsGtmInstance.CnameModeDeny

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.