All Products
Search
Document Center

DescribeDnsGtmMonitorAvailableConfig (new)

Last Updated: Mar 04, 2021

Queries the available health check configurations for 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

DescribeDnsGtmMonitorAvailableConfig

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

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

DomainIpv4IspCityNodes

Array of DomainIpv4IspCityNode

The monitored nodes whose address pool type is public domain name with IPv4 addresses.

DomainIpv4IspCityNode

CityCode

String

503

The code of the monitored city node.

CityName

String

Zhangjiakou

The display name of the monitored city node.

DefaultSelected

Boolean

true

Indicates whether the city node was selected for health check by default.

GroupName

String

BGP nodes

The name of the node group.

GroupType

String

BGP

The type of the node group. Valid values:

  • BGP: BGP nodes

  • OVERSEAS: overseas nodes

  • ISP: Internet service provider (ISP) nodes

Ips

List

["1.1.1.1","2.2.2.2"]

Node IP List

IspCode

String

465

The code of the monitored ISP node.

IspName

String

Alibaba Cloud

The display name of the monitored ISP node.

DomainIpv6IspCityNodes

Array of DomainIpv6IspCityNode

The monitored nodes whose address pool type is public domain name with IPv6 addresses.

DomainIpv6IspCityNode

CityCode

String

503

The code of the monitored city node.

CityName

String

Zhangjiakou

The display name of the monitored city node.

DefaultSelected

Boolean

false

Indicates whether the city node was selected for health check by default.

GroupName

String

BGP nodes

The name of the node group.

GroupType

String

BGP

The type of the node group. Valid values:

  • BGP: BGP nodes

  • OVERSEAS: overseas nodes

  • ISP: ISP nodes

IspCode

String

465

The code of the monitored ISP node.

IspName

String

Alibaba Cloud

The display name of the monitored ISP node.

Ipv4IspCityNodes

Array of Ipv4IspCityNode

The monitored nodes whose address pool type is public IPv4 address.

Ipv4IspCityNode

CityCode

String

503

The code of the monitored city node.

CityName

String

Zhangjiakou

The display name of the monitored city node.

DefaultSelected

Boolean

true

Indicates whether the city node was selected for health check by default.

GroupName

String

BGP nodes

The name of the node group.

GroupType

String

BGP

The type of the node group. Valid values:

  • BGP: BGP nodes

  • OVERSEAS: overseas nodes

  • ISP: ISP nodes

Ips

List

["1.1.1.1","2.2.2.2"]

Node IP List

IspCode

String

465

The code of the monitored ISP node.

IspName

String

Alibaba Cloud

The display name of the monitored ISP node.

Ipv6IspCityNodes

Array of Ipv6IspCityNode

The monitored nodes whose address pool type is public IPv6 address.

Ipv6IspCityNode

CityCode

String

503

The code of the monitored city node.

CityName

String

Zhangjiakou

The display name of the monitored city node.

DefaultSelected

Boolean

true

Indicates whether the city node was selected for health check by default.

GroupName

String

BGP nodes

The name of the node group.

GroupType

String

BGP

The type of the node group. Valid values:

  • BGP: BGP nodes

  • OVERSEAS: overseas nodes

  • ISP: ISP nodes

IspCode

String

465

The code of the monitored ISP node.

IspName

String

Alibaba Cloud

The display name of the monitored ISP node.

RequestId

String

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

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<Ipv4IspCityNodes>
    <Ipv4IspCityNode>
        <GroupName>BGP nodes</GroupName>
        <CityCode>503</CityCode>
        <IspName>Alibaba Cloud</IspName>
        <GroupType>BGP</GroupType>
        <CityName>Zhangjiakou</CityName>
        <DefaultSelected>true</DefaultSelected>
        <Ips>
            <Ip>1.1.1.1</Ip>
            <Ip>2.2.2.2</Ip>
        </Ips>
        <IspCode>465</IspCode>
    </Ipv4IspCityNode>
</Ipv4IspCityNodes>
<DomainIpv4IspCityNodes>
    <DomainIpv4IspCityNode>
        <GroupName>BGP nodes</GroupName>
        <CityCode>503</CityCode>
        <IspName>Alibaba Cloud</IspName>
        <GroupType>BGP</GroupType>
        <CityName>Zhangjiakou</CityName>
        <DefaultSelected>true</DefaultSelected>
        <Ips>
            <Ip>1.1.1.1</Ip>
            <Ip>2.2.2.2</Ip>
        </Ips>
        <IspCode>465</IspCode>
    </DomainIpv4IspCityNode>
</DomainIpv4IspCityNodes>
<RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
<DomainIpv6IspCityNodes>
    <DomainIpv6IspCityNode>
        <GroupName>BGP nodes</GroupName>
        <CityCode>503</CityCode>
        <IspName>Alibaba Cloud</IspName>
        <GroupType>BGP</GroupType>
        <CityName>Zhangjiakou</CityName>
        <DefaultSelected>false</DefaultSelected>
        <IspCode>465</IspCode>
    </DomainIpv6IspCityNode>
</DomainIpv6IspCityNodes>
<Ipv6IspCityNodes>
    <Ipv6IspCityNode>
        <GroupName>BGP nodes</GroupName>
        <CityCode>503</CityCode>
        <IspName>Alibaba Cloud</IspName>
        <GroupType>BGP</GroupType>
        <CityName>Zhangjiakou</CityName>
        <DefaultSelected>true</DefaultSelected>
        <IspCode>465</IspCode>
    </Ipv6IspCityNode>
</Ipv6IspCityNodes>

JSON format

{
    "Ipv4IspCityNodes": {
        "Ipv4IspCityNode": [
            {
                "GroupName": "BGP nodes",
                "CityCode": "503",
                "IspName":"Alibaba Cloud",
                "GroupType": "BGP",
                "CityName":"Zhangjiakou",
                "DefaultSelected": "true",
                "Ips": ["1.1.1.1", "2.2.2.2"],
                "IspCode": "465"
            }
        ]
    },
    "DomainIpv4IspCityNodes": {
        "DomainIpv4IspCityNode": [
            {
                "GroupName": "BGP nodes",
                "CityCode": "503",
                "IspName":"Alibaba Cloud",
                "GroupType": "BGP",
                "CityName":"Zhangjiakou",
                "DefaultSelected": "true",
                "Ips": ["1.1.1.1", "2.2.2.2"],
                "IspCode": "465"
            }
        ]
    },
    "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
    "DomainIpv6IspCityNodes": {
        "DomainIpv6IspCityNode": [
            {
                "GroupName": "BGP nodes",
                "CityCode": "503",
                "IspName":"Alibaba Cloud",
                "GroupType": "BGP",
                "CityName":"Zhangjiakou",
                "DefaultSelected": "false",
                "IspCode": "465"
            }
        ]
    },
    "Ipv6IspCityNodes": {
        "Ipv6IspCityNode": [
            {
                "GroupName": "BGP nodes",
                "CityCode": "503",
                "IspName":"Alibaba Cloud",
                "GroupType": "BGP",
                "CityName":"Zhangjiakou",
                "DefaultSelected": "true",
                "IspCode": "465"
            }
        ]
    }
}

Error codes

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