You can call this operation to query the available health check configurations for an address pool of a Global Traffic Manager (GTM) instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeGtmMonitorAvailableConfig |
The operation that you want to perform. Set the value to DescribeGtmMonitorAvailableConfig. |
Lang | String | No | en |
The language used by the user. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
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. |
DefaultSelected | Boolean | true |
Indicates whether the city node is selected for health check by default. |
GroupName | String | Overseas node |
The name of the node group. Value values: such as overseas node and BGP node. |
GroupType | String | OVERSEAS |
The type of the node group. Value values: such as BGP and OVERSEAS. |
IspCode | String | 465 |
The Internet service provider (ISP) code. Currently, only 465 is available. |
IspName | String | Alibaba |
The display name of the ISP. |
Mainland | Boolean | true |
Indicates whether the city node is in the Chinese mainland. |
RequestId | String | 6856BCF6-11D6-4D7E-AC53-FD579933522B |
The ID of the request. |
Examples
Sample requests
http(s)://alidns.aliyuncs.com/? Action=DescribeGtmMonitorAvailableConfig
&<Common request parameters>
Sample success responses
XML
format
<DescribeGtmMonitorAvailableConfigResponse>
<RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
<IspCityNodes>
<IspName>Alibaba</IspName>
<IspCode>465</IspCode>
<City>Zhangjiakou</City>
<CityCode>503</CityCode>
<DefaultSelected>true</DefaultSelected>
<Mainland>true</Mainland>
</IspCityNodes>
<IspCityNodes>
<IspName>Alibaba</IspName>
<IspCode>465</IspCode>
<City>Qingdao</City>
<CityCode>572</CityCode>
<DefaultSelected>false</DefaultSelected>
<Mainland>true</Mainland>
</IspCityNodes>
</DescribeGtmMonitorAvailableConfigResponse>
JSON
format
{
"RequestId":"6856BCF6-11D6-4D7E-AC53-FD579933522B",
"IspCityNodes":[
{
"Mainland":true,
"IspName":"Alibaba",
"IspCode":"465",
"DefaultSelected":true,
"CityCode":"503",
"City":"Zhangjiakou"
},
{
"Mainland":true,
"IspName":"Alibaba",
"IspCode":"465",
"DefaultSelected":false,
"CityCode":"572",
"City":"Qingdao"
}
]
}
Error codes
For a list of error codes, visit the API Error Center.