All Products
Search
Document Center

DescribeDnsGtmMonitorConfig (new)

Last Updated: Feb 07, 2021

Queries 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

DescribeDnsGtmMonitorConfig

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

MonitorConfigId

String

Yes

MonitorConfigId1

The ID of the health check task.

Lang

String

No

en

The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.

Response parameters

Parameter

Type

Example

Description

CreateTime

String

2017-12-28T13:08Z

The time when the health check task was created.

CreateTimestamp

Long

1527690629357

The timestamp that indicates when the health check task was created.

EvaluationCount

Integer

1

The number of consecutive times of failed health check attempts.

Interval

Integer

1

The health check interval. Unit: seconds.

IspCityNodes

Array of IspCityNode

The monitored node.

IspCityNode

CityCode

String

572

The code of the monitored city node.

CityName

String

Qingdao

The display name of the monitored city node.

CountryCode

String

001

The code of the country/region.

CountryName

String

China

The display name of the country/region.

IspCode

String

123

The code of the monitored Internet service provider (ISP) node.

IspName

String

Alibaba Cloud

The name of the monitored ISP node.

MonitorConfigId

String

MonitorConfigId1

The ID of the health check task.

MonitorExtendInfo

String

{"port":80,"host":"example.com","path":"/","code":"400","failureRate":"50","packetNum":"20","packetLossRate":"10","sni":true,"nodeType":"IPV6"}

The extendedinformation. The following parameters are required for different health checkprotocols:

  • HTTP or HTTPS:

    • port: the check port.

    • path: the URL.

    • code: the return code greater thanwhich indicates that an error has occurred.

    • failureRate: the failure rate.

    • sni: specifies whether to enable server name indication (SNI). Thisparameter is used only for the HTTPS protocol. Valid values:

      • false:disabled

      • true: enabled

    • nodeType: the type of the node tomonitor when the address pool type is DOMAIN. 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 to monitor when the address pool type is DOMAIN. Valid values:

      • IPV4

      • IPV6

  • TCP:

    • port: the check port.

    • failureRate: the failure rate.

    • nodeType: the type of the node to monitor when the address pool type is DOMAIN. Valid values:

      • IPV4

      • IPV6

ProtocolType

String

http

The health check protocol. Valid values:

  • HTTP

  • HTTPS

  • PING

  • TCP

RequestId

String

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

The ID of the request.

Timeout

Integer

3000

The timeout period. Unit: milliseconds.

UpdateTime

String

2018-01-03T08:57Z

The time when the health check task was updated.

UpdateTimestamp

Long

1527690629357

The time when the health check task was updated.

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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

Error codes

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