DescribeGtmMonitorConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the health check configuration for an address pool.

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

get

*gtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
Timeout	integer	The timeout period. Unit: milliseconds. Valid values: 2000, 3000, 5000, and 10000.	3000
ProtocolType	string	The protocol used for the health check.	HTTP
IspCityNodes	object
IspCityNode	array<object>	The monitoring nodes.
	object	A monitoring node.
CityCode	string	The city code.	503
CountryName	string	The display name of the country.	中国
IspCode	string	The carrier code.	465
CityName	string	The display name of the city.	张家口市
CountryCode	string	The country code.	001
IspName	string	The name of the carrier.	阿里巴巴
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 number of consecutive health checks.	3
UpdateTimestamp	integer	The UNIX timestamp that indicates when the health check configuration was last updated.	1527690629357
MonitorExtendInfo	string	The extended information. The parameters vary based on the protocol. For HTTP and HTTPS: port: The health check port. failureRate: The failure rate. code: The return code. A response is considered abnormal if its status code is greater than the specified value. Valid values: 400 and 500. host: The Host header of the request. path: The path of the URL. For PING: packetNum: The number of ping packets. packetLossRate: The packet loss rate. failureRate: The failure rate. For TCP: port: The health check port. failureRate: The failure rate.	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
MonitorConfigId	string	The ID of the health check configuration.	1234abc
CreateTimestamp	integer	The UNIX timestamp that indicates when the health check configuration was created.	1527690629357
Interval	integer	The health check interval. Unit: seconds. The value is 60.	60

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Timeout": 3000,
  "ProtocolType": "HTTP",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CityCode": "503",
        "CountryName": "中国",
        "IspCode": "465",
        "CityName": "张家口市",
        "CountryCode": "001",
        "IspName": "阿里巴巴"
      }
    ]
  },
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.