UpdateCloudGtmAddress - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

This operation modifies the basic configurations of a specified address.

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:UpdateCloudGtmAddress

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese en-US (default): English	en-US
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. You can specify a custom value for this parameter, but you must make sure that the value is unique among different requests. The value can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	Yes	The unique ID of the address.	addr-89518218114368****
Name	string	No	The updated name of the address.	Address-1
Address	string	No	The updated IP address or domain name.	223.5.XX.XX
AttributeInfo	string	No	The attribution information of the address.	当前版本不支持此参数，不需要传入此参数。
HealthJudgement	string	No	The updated condition for determining the health status of the address: any_ok: At least one probe is normal for all health check templates. p30_ok: At least 30% of the probes are normal for all health check templates. p50_ok: At least 50% of the probes are normal for all health check templates. p70_ok: At least 70% of the probes are normal for all health check templates. all_ok: All probes are normal for all health check templates.	p50_ok
HealthTasks	array<object>	No	The list of health check tasks.
	object	No	The list of health check tasks associated with the address.
Port	integer	No	The service port of the target address for the health check. You cannot configure a service port if the health check uses the ping protocol. If you leave this parameter empty, the currently configured port is deleted. If you specify a value for this parameter, the port is updated to the specified value.	80
TemplateId	string	No	The ID of the health check template associated with the address. This parameter is required if you configure a health check port. If you leave this parameter empty, the currently configured health check template is deleted. If you specify a value for this parameter, the health check template is updated to the specified value.	mtp-89518052425100****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
Success	boolean	Indicates whether the operation was successful. true: The operation was successful. false: The operation failed.	true

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.