DescribeGtmMonitorConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the health check configuration of an address pool of a Global Traffic Manager (GTM) instance.

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:DescribeGtmMonitorConfig	get	gtmInstance acs:alidns::{#accountId}:gtminstance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the values of specific response parameters.	en
MonitorConfigId	string	Yes	The ID of the health check configuration.	100

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
Timeout	integer	The health check timeout period. Unit: milliseconds. Valid values: 2000, 3000, 5000, and 10000.	3000
ProtocolType	string	The protocol used for the health check.	HTTP
IspCityNodes	array<object>	The monitored nodes.
IspCityNode	object
CityCode	string	The code of the city where the monitored node is deployed.	503
CountryName	string	The display name of the country where the monitored node is deployed.	China
IspCode	string	The code of the Internet service provider (ISP) to which the monitored node belongs.	465
CityName	string	The display name of the city where the monitored node is deployed.	Zhangjiakou
CountryCode	string	The code of the country where the monitored node is deployed.	001
IspName	string	The display name of the ISP to which the monitored node belongs.	Alibaba
CreateTime	string	The time when the health check configuration was created.	2017-12-28T13:08Z
UpdateTime	string	The time when the health check configuration was last updated.	2017-12-28T13:08Z
EvaluationCount	integer	The maximum number of consecutive exceptions detected. If the number of consecutive exceptions detected reaches the maximum number, the application service is deemed abnormal.	3
UpdateTimestamp	long	The timestamp that indicates the time when the health check configuration was last updated.	1527690629357
MonitorExtendInfo	string	The extended information, that is, the parameters required for the protocol. Different protocols require different parameters: HTTP or HTTPS: port: the port to check. failureRate: the failure rate. code: the status code threshold. If the returned status code is greater than the specified threshold, the application service is deemed abnormal. Valid values: 400 and 500. host: the host configuration. path: the health check URL. PING: packetNum: the number of ping packets. packetLossRate: the loss rate of ping packets. failureRate: the failure rate. TCP: port: the port to check. failureRate: the failure rate.	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
MonitorConfigId	string	The ID of the health check configuration.	1234abc
CreateTimestamp	long	The timestamp that indicates the time when the health check configuration was created.	1527690629357
Interval	integer	The health check interval. Unit: seconds. The value is 60.	60

Examples

Sample success responses

JSONformat

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Timeout": 3000,
  "ProtocolType": "HTTP",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CityCode": "503",
        "CountryName": "China\n",
        "IspCode": "465",
        "CityName": "Zhangjiakou\n",
        "CountryCode": "001",
        "IspName": "Alibaba\n"
      }
    ]
  },
  "CreateTime": "2017-12-28T13:08Z",
  "UpdateTime": "2017-12-28T13:08Z",
  "EvaluationCount": 3,
  "UpdateTimestamp": 1527690629357,
  "MonitorExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}",
  "MonitorConfigId": "1234abc",
  "CreateTimestamp": 1527690629357,
  "Interval": 60
}

Error codes

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