AddDnsGtmMonitor - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Creates a health check.

Operation description

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

create

*gtmInstance

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

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
AddrPoolId	string	Yes	The ID of the address pool. You can call the DescribeDnsGtmInstanceAddressPools operation to obtain the ID.	po**
ProtocolType	string	Yes	The health check protocol. Valid values: HTTP HTTPS PING TCP	TCP
Interval	integer	Yes	The health check interval. Unit: seconds.	60
EvaluationCount	integer	Yes	The number of consecutive health checks.	1
Timeout	integer	Yes	The timeout period. Unit: milliseconds.	3000
MonitorExtendInfo	string	Yes	The extended information. The parameters vary based on the protocol type. HTTP or HTTPS port: The health check port. host: The Host header. path: The URL path. code: The health check is considered abnormal if the returned HTTP status code is greater than this value. failureRate: The failure rate. sni: Specifies whether to enable Server Name Indication (SNI). This parameter is used only when the health check protocol is HTTPS. Valid values: true false nodeType: The type of the monitoring node. This parameter is used when the address pool type is DOMAIN. Valid values: IPV4 IPV6 PING failureRate: The failure rate. packetNum: The number of ping packets. packetLossRate: The packet loss rate. nodeType: The type of the monitoring node. This parameter is used when the address pool type is DOMAIN. Valid values: IPV4 IPV6 TCP port: The health check port. failureRate: The failure rate. nodeType: The type of the monitoring node. This parameter is used when the address pool type is DOMAIN. Valid values: IPV4 IPV6 Note This parameter must be a JSON string.	{"failureRate":50,"port":80}
IspCityNode	array<object>	Yes	The list of monitoring nodes.
	object	No
CityCode	string	No	The city code of the monitoring node.	123
IspCode	string	No	The carrier code of the monitoring node.	123

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
MonitorConfigId	string	The ID of the health check configuration.	Mon*******

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "MonitorConfigId": "Mon*******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.