You can call this operation to query the health check configurations of an address pool of a Global Traffic Manager (GTM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGtmMonitorConfig

The operation that you want to perform. Set the value to DescribeGtmMonitorConfig.

MonitorConfigId String Yes 100

The health check ID.

Lang String No en

The language used by the user.

Response parameters

Parameter Type Example Description
CreateTime String 2017-12-28T13:08Z

The time when the health check was created.

CreateTimeStamp Long 1527690629357

A timestamp that indicates the time when the health check was created.

EvaluationCount Integer 3

The number of consecutive failed health check attempts.

Interval Integer 60

The interval between health checks.

IspCityNodes Array

The returned list of monitored city nodes.

IspCityNode

The details about a monitored city node.

CityCode String 503

The code of the monitored city node.

CityName String Zhangjiakou

The display name of the city.

CountryCode String 001

The country/region code.

CountryName String Mainland China

The display name of the country/region.

IspCode String 465

The Internet service provider (ISP) code.

IspName String Alibaba

The ISP name.

MonitorConfigId String 1234abc

The health check ID.

MonitorExtendInfo String {\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}

The extended information of health check.

ProtocolType String HTTP

The protocol that you want to use for health check.

RequestId String 6856BCF6-11D6-4D7E-AC53-FD579933522B

The ID of the request.

Timeout Integer 3000

The time-out period set for health check.

UpdateTime String 2017-12-28T13:08Z

The last time when the health check configurations were updated.

UpdateTimestamp Long 1527690629357

A timestamp that indicates the last time when the health check configurations were updated.

Examples

Sample requests


http(s)://alidns.aliyuncs.com/? Action=DescribeGtmMonitorConfig
&MonitorConfigId=100
&<Common request parameters>

Sample success responses

XML format

<DescribeGtmMonitorConfigResponse>
  <RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
	  <MonitorConfigId>1234abc</MonitorConfigId>
	  <CreateTime>2017-12-28T13:08Z</CreateTime>
	  <CreateTimestamp>1527690629357</CreateTimestamp>
	  <UpdateTime>2018-01-03T08:57Z</UpdateTime>
	  <UpdateTimestamp>1527690629357</UpdateTimestamp>
	  <ProtocolType>HTTP</ProtocolType>
	  <Interval>60</Interval>
	  <EvaluationCount>3</EvaluationCount>
	  <Timeout>3000</Timeout>
	  <MonitorExtendInfo>{"code":200,"path":"\index.htm","host":"aliyun.com"}</MonitorExtendInfo>
	  <IspCityNodes>
		    <CountryName>Mainland China</CountryName>
		    <CountryCode>001</CountryCode>
		    <City>Zhangjiakou</City>
		    <CityCode>503</CityCode>
	  </IspCityNodes>
	  <IspCityNodes>
		    <CountryName>Mainland China</CountryName>
		    <CountryCode>001</CountryCode>
		    <City>Qingdao</City>
		    <CityCode>572</CityCode>
	  </IspCityNodes>
</DescribeGtmMonitorConfigResponse>

JSON format

{
	"Timeout":3000,
	"Interval":60,
	"CreateTimestamp":1527690629357,
	"ProtocolType":"HTTP",
	"MonitorConfigId":"1234abc",
	"UpdateTimestamp":1527690629357,
	"CreateTime":"2017-12-28T13:08Z",
	"RequestId":"6856BCF6-11D6-4D7E-AC53-FD579933522B",
	"UpdateTime":"2018-01-03T08:57Z",
	"IspCityNodes":[
		{
			"CountryName":"Mainland China",
			"CityCode":"503",
			"CountryCode":"001",
			"City":"Zhangjiakou"
		},
		{
			"CountryName":"Mainland China",
			"CityCode":"572",
			"CountryCode":"001",
			"City":"Qingdao"
		}
	],
	"MonitorExtendInfo":"{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}",
	"EvaluationCount":3
}

Error codes

For a list of error codes, visit the API Error Center.