DescribeDnsGtmMonitorAvailableConfig - Alibaba Cloud DNS

Queries the configuration items that can be set for a health check task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeDnsGtmMonitorAvailableConfig	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.	en

Response parameters

Parameter	Type	Description	Example
	object
Ipv4IspCityNodes	array<object>	The nodes that perform health checks on public IPv4 addresses.
Ipv4IspCityNode	object	The node that performs health checks on public IPv4 addresses.
CityCode	string	The city code.	503
GroupName	string	The name of the node group.	BGP Nodes
IspCode	string	The Internet service provider (ISP) code.	465
CityName	string	The display name of the city.	Zhangjiakou
IspName	string	The display name of the ISP.	Alibaba
GroupType	string	The type of the node group. Valid values: BGP: Border Gateway Protocol (BGP) node OVERSEAS: node outside the Chinese mainland ISP: ISP node	BGP
DefaultSelected	boolean	Indicates whether the health check node is selected by default.	true
Ips	array	The IP addresses of the health check nodes.
Ip	string	The IP address of the health check node.	["1.1.1.1","2.2.2.2"]
DomainIpv4IspCityNodes	array<object>	The nodes that perform health checks on domain names that use public IPv4 addresses.
DomainIpv4IspCityNode	object	The node that performs health checks on domain names that use public IPv4 addresses.
CityCode	string	The city code.	503
GroupName	string	The name of the node group.	BGP Nodes
IspCode	string	The ISP code.	465
CityName	string	The display name of the city.	Zhangjiakou
IspName	string	The display name of the ISP.	Alibaba
GroupType	string	The type of the node group. Valid values: BGP: BGP node OVERSEAS: node outside the Chinese mainland ISP: ISP node	BGP
DefaultSelected	boolean	Indicates whether the health check node is selected by default.	true
Ips	array	The IP addresses of the health check nodes.
Ip	string	The IP address of the node.	["1.1.1.1","2.2.2.2"]
RequestId	string	The request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
DomainIpv6IspCityNodes	array<object>	The nodes that perform health checks on domain names that use public IPv6 addresses.
DomainIpv6IspCityNode	object	The node that performs health checks on domain names that use public IPv6 addresses.
CityCode	string	The city code.	503
GroupName	string	The name of the node group.	BGP Nodes
IspCode	string	The ISP code.	465
CityName	string	The display name of the city.	Zhangjiakou
IspName	string	The display name of the ISP.	Alibaba
GroupType	string	The type of the node group. Valid values: BGP: BGP node OVERSEAS: node outside the Chinese mainland ISP: ISP node	BGP
DefaultSelected	boolean	Indicates whether the health check node is selected by default.	false
Ips	array	This parameter is not returned.
Ip	string	This parameter is not returned.	-
Ipv6IspCityNodes	array<object>	The nodes that perform health checks on public IPv6 addresses.
Ipv6IspCityNode	object	The node that performs health checks on public IPv6 addresses.
CityCode	string	The city code.	503
GroupName	string	The name of the node group.	BGP Nodes
IspCode	string	The ISP code.	465
CityName	string	The display name of the city.	Zhangjiakou
IspName	string	The display name of the ISP.	Alibaba
GroupType	string	The type of the node group. Valid values: BGP: BGP node OVERSEAS: node outside the Chinese mainland ISP: ISP node	BGP
DefaultSelected	boolean	Indicates whether the health check node is selected by default.	true
Ips	array	This parameter is not returned.
Ip	string	This parameter is not returned.	-

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history