DescribeDnsGtmMonitorConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the health check configuration of an address pool.

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:
- The required resource types are displayed in bold characters.
- 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:DescribeDnsGtmMonitorConfig	get	gtmInstance acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.	en
MonitorConfigId	string	Yes	The ID of the health check task.	MonitorConfigId1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
Timeout	integer	The timeout period. Unit: milliseconds.	3000
ProtocolType	string	The health check protocol. Valid values: HTTP HTTPS PING TCP	http
IspCityNodes	array<object>	The health check nodes.
IspCityNode	object
CityCode	string	The city code.	572
CountryName	string	The display name of the country or region.	China
IspCode	string	The Internet service provider (ISP) code.	123
CityName	string	The display name of the city.	Qingdao
CountryCode	string	The code of the country or region.	001
IspName	string	The display name of the ISP.	Alibaba
CreateTime	string	The time when the health check configuration was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2017-12-28T13:08Z
UpdateTime	string	The time when the health check configuration was updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2018-01-03T08:57Z
EvaluationCount	integer	The number of consecutive failures.	1
UpdateTimestamp	long	The time when the health check configuration was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1527690629357
MonitorExtendInfo	string	The extended information. The required parameters vary based on the value of ProtocolType. HTTP or HTTPS port: the port that you want to check host: the host settings path: the URL path code: the response code. The health check result is deemed abnormal if the returned value is greater than the specified value. failureRate: the failure rate sni: specifies whether to enable server name indication (SNI). This parameter is available only when ProtocolType is set to HTTPS. Valid values: true: enables SNI. false: disables SNI. nodeType: the type of the node for monitoring when the address pool type is domain name. Valid values: IPV4 IPV6 PING: failureRate: the failure rate packetNum: the number of ping packets packetLossRate: the loss rate of ping packets nodeType: the type of the node for monitoring when the address pool type is domain name. Valid values: IPV4 IPV6 TCP port: the port that you want to check failureRate: the failure rate nodeType: the type of the node for monitoring when the address pool type is domain name. Valid values: IPV4 IPV6	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
MonitorConfigId	string	The ID of the health check configuration.	MonitorConfigId1
CreateTimestamp	long	The time when the health check configuration was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1527690629357
Interval	integer	The health check interval. Unit: seconds.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Timeout": 3000,
  "ProtocolType": "http",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CityCode": "572",
        "CountryName": "China\n",
        "IspCode": "123",
        "CityName": "Qingdao\n",
        "CountryCode": "001",
        "IspName": "Alibaba\n"
      }
    ]
  },
  "CreateTime": "2017-12-28T13:08Z",
  "UpdateTime": "2018-01-03T08:57Z",
  "EvaluationCount": 1,
  "UpdateTimestamp": 1527690629357,
  "MonitorExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}",
  "MonitorConfigId": "MonitorConfigId1",
  "CreateTimestamp": 1527690629357,
  "Interval": 1
}

Error codes

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