DescribeGtmInstances - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries Global Traffic Manager (GTM) instances.

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:DescribeGtmInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
PageNumber	integer	No	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. The maximum value is 100. The default value is 20.	20
Keyword	string	No	The keyword for an exact match search by instance ID or instance name.	test
ResourceGroupId	string	No	The ID of the resource group.	rg-xxxxx
NeedDetailAttributes	boolean	No	Specifies whether to return detailed information. The default value is false.	false

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned on each page.	20
RequestId	string	The unique ID of the request.	193B0163-7F93-42DF-AB05-ACEEB7D22707
PageNumber	integer	The page number of the returned page.	1
GtmInstances	object
GtmInstance	array<object>	The list of GTM instances.
	object
ExpireTime	string	The time when the instance expires.	2018-06-06T11:34Z
AccessStrategyNum	integer	The number of access policies.	5
CreateTime	string	The time when the instance was created.	2018-06-06T11:34Z
CnameMode	string	The connection type. Valid values: SYSTEM_ASSIGN: System-assigned CUSTOM: Custom	CUSTOM
InstanceId	string	The ID of the instance.	gtm-cn-wwo3a3hbz**
ExpireTimestamp	integer	The UNIX timestamp that indicates when the instance expires.	1528284856000
Ttl	integer	The global TTL.	60
AlertGroup	string	The alert contact group.	[\"R&D Group\"]
AddressPoolNum	integer	The number of address pools.	5
InstanceName	string	The name of the instance.	test
LbaStrategy	string	The load balancing policy. ALL_RR: Round-robin RATIO: Weighted round-robin	RATIO
Cname	string	The CNAME for instance access.	gtm-cn-wwo3a3hbz**.dns-example.top
VersionCode	string	The version code.	biaozhun
UserDomainName	string	The custom domain name.	dns-example.top
CreateTimestamp	integer	The UNIX timestamp that indicates when the instance was created.	1528284856000
ResourceGroupId	string	The ID of the resource group.	rg-acfm2q2jqpjh***
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of items.	1

Examples

Success response

JSON format

{
  "PageSize": 20,
  "RequestId": "193B0163-7F93-42DF-AB05-ACEEB7D22707",
  "PageNumber": 1,
  "GtmInstances": {
    "GtmInstance": [
      {
        "ExpireTime": "2018-06-06T11:34Z",
        "AccessStrategyNum": 5,
        "CreateTime": "2018-06-06T11:34Z",
        "CnameMode": "CUSTOM",
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "ExpireTimestamp": 1528284856000,
        "Ttl": 60,
        "AlertGroup": "[\\\"研发组\\\"]",
        "AddressPoolNum": 5,
        "InstanceName": "test",
        "LbaStrategy": "RATIO",
        "Cname": "gtm-cn-wwo3a3hbz**.dns-example.top\n",
        "VersionCode": "biaozhun",
        "UserDomainName": "dns-example.top",
        "CreateTimestamp": 1528284856000,
        "ResourceGroupId": "rg-acfm2q2jqpjh***"
      }
    ]
  },
  "TotalPages": 1,
  "TotalItems": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.