UpdateDnsGtmMonitor - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Modifies a health check configuration.

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

update

*MonitorConfig

acs:alidns:*:{#accountId}:gtminstance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Default value: en. Valid values: en, zh, and ja.	en
MonitorConfigId	string	Yes	The ID of the health check configuration. You can call the DescribeDnsGtmInstanceAddressPool operation to obtain the ID.	Monito******
ProtocolType	string	Yes	The health check protocol. Valid values: HTTP HTTPS PING TCP	http
Interval	integer	No	The health check interval. Unit: seconds.	60
EvaluationCount	integer	No	The number of consecutive health checks.	2
Timeout	integer	No	The timeout period for a health check. Unit: milliseconds.	3000
MonitorExtendInfo	string	Yes	The extended information. The required parameters vary based on the health check protocol. HTTP(S): port: The port for the health check. host: The Host header. path: The URL path. code: The health check is considered abnormal if the returned status code is greater than the specified value. For example, if you set this parameter to 400, a returned status code of 404 is considered abnormal. failureRate: The failure rate. sni: Specifies whether to enable Server Name Indication (SNI). This parameter is available only for the HTTPS protocol. true: Enable SNI. false: Disable SNI. nodeType: The type of the node for health checks when the address pool type is DOMAIN. IPV4 IPV6 PING: failureRate: The failure rate. packetNum: The number of ping packets. packetLossRate: The packet loss rate. nodeType: The type of the node for health checks when the address pool type is DOMAIN. IPV4 IPV6 TCP: port: The port for the health check. failureRate: The failure rate. nodeType: The type of the node for health checks when the address pool type is DOMAIN. IPV4 IPV6	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNode	array<object>	Yes	The list of city nodes for health checks.
	object	No
CityCode	string	No	The city code of the health check node.	123
IspCode	string	No	The carrier code of the health check node.	123

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.