DescribeGtmMonitorAvailableConfig - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the available configurations for health checks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeGtmMonitorAvailableConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response.	en

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	6856BCF6-11D6-4D7E-AC53-FD579933522B
IspCityNodes	object
IspCityNode	array<object>	A list of monitoring nodes.
	object	A monitoring node.
CityCode	string	The city code.	503
Mainland	boolean	Indicates whether the node is in the Chinese mainland.	true
GroupName	string	The name of the node group.	International node
IspCode	string	The carrier code. If GroupType is set to BGP or OVERSEAS, this parameter is optional and defaults to 465. If GroupType is not set to BGP or OVERSEAS, this parameter is required and must be used with CityCode.	465
CityName	string	The display name of the city.	Zhangjiakou
IspName	string	The display name of the carrier. Currently, only Alibaba is supported.	Alibaba
GroupType	string	The type of the node group. Valid values: BGP: Border Gateway Protocol (BGP) nodes. OVERSEAS: nodes outside the Chinese mainland. ISP: carrier nodes.	OVERSEAS
DefaultSelected	boolean	Indicates whether the node is selected by default.	true

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CityCode": "503",
        "Mainland": true,
        "GroupName": "国际节点",
        "IspCode": "465",
        "CityName": "张家口市",
        "IspName": "阿里巴巴",
        "GroupType": "OVERSEAS",
        "DefaultSelected": true
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.