UpdateCloudGtmAddress - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Modifies the condition for determining the health status of a specified address.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:UpdateCloudGtmAddress	update	All Resources ``	none	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	The 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 token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	1ae05db4-10e7-11ef-b126-00163e24**22
AddressId	string	Yes	The ID of the address. This ID uniquely identifies the address.	addr-89518218114368**92
Name	string	No	The name of the address.	Address-1
Address	string	No	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	No	Address Attribution information.	This parameter is not supported in the current version and does not need to be input.
HealthJudgement	string	No	The new condition for determining the health state of the address. Valid values: any_ok: The health check results of at least one health check template are normal. p30_ok: The health check results of at least 30% of health check templates are normal. p50_ok: The health check results of at least 50% of health check templates are normal. p70_ok: The health check results of at least 70% of health check templates are normal. all_ok: The health check results of all health check templates are normal.	p50_ok
HealthTasks	array<object>	No	The health check tasks.
HealthTask	object	No	The health check task referenced by the address.
Port	integer	No	The service port of the address on which health check tasks are performed. If the ping protocol is used for health checks, the configuration of the service port is not supported. If you leave this parameter empty, the existing service port is deleted. If you specify this parameter, the existing service port is updated based on the value of this parameter.	80
TemplateId	string	No	The ID of the health check template that is associated with the address. This parameter is required if you specify a service port of the address for health check tasks. If you leave this parameter empty, the associated health check template is disassociated from the address. If you specify this parameter, the associated health check template is updated based on the value of this parameter.	mtp-89518052425100**80

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	6856BCF6-11D6-4D7E-AC53-FD579933522B
Success	boolean	Modify address base configuration operation status: true: Operation was successful false: Operation was failed	true

Examples

Sample success responses

JSONformat

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

Error codes

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