UpdateGtmMonitor - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Updates 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:UpdateGtmMonitor

update

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response.	en
MonitorConfigId	string	Yes	The ID of the health check configuration.	1234abc
ProtocolType	string	Yes	The health check protocol.	HTTP
Interval	integer	No	The interval between health checks. Unit: seconds. The value must be 60.	60
EvaluationCount	integer	No	The number of consecutive health checks.	3
Timeout	integer	No	The timeout period for a health check. Unit: milliseconds. Valid values: 2000, 3000, 5000, and 10000.	3000
MonitorExtendInfo	string	Yes	The extended information. The parameters vary based on the protocol. HTTP and HTTPS: port: The health check port. failureRate: The failure rate. code: The return code. A response with a status code greater than the specified value is considered abnormal. Valid values: 400 and 500. host: The host settings. path: The URL path. PING: packetNum: The number of ping packets. packetLossRate: The packet loss rate. failureRate: The failure rate. TCP: port: The health check port. failureRate: The failure rate.	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNode	array<object>	Yes	The list of monitoring nodes.
	object	No
CityCode	string	No	The city code.	572
IspCode	string	No	For more information about the valid values, see the response of the DescribeGtmMonitorAvailableConfig operation. If GroupType is set to Border Gateway Protocol (BGP) or Overseas, IspCityNode.N.IspCode is optional. The default value is 465. If GroupType is not set to BGP or Overseas, IspCityNode.N.IspCode is required. You must specify a value that matches the value of IspCityNode.N.CityCode.	465

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	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.