DescribeDnsGtmInstances - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of 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:DescribeDnsGtmInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Default value: en. Valid values: en, zh, and ja.	en
PageNumber	integer	No	The number of the page to return. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 20.	1
Keyword	string	No	The keyword for the query. Fuzzy search by instance ID and instance name is supported.	test
ResourceGroupId	string	No	The ID of the resource group.	rg-testgroupid

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page. Maximum value: 100. Default value: 20.	1
RequestId	string	The unique request ID.	84314904-D047-4176-A0EC-256D7F68C7F5
PageNumber	integer	The number of the page returned. The value starts from 1. Default value: 1.	1
GtmInstances	array<object>	The list of Global Traffic Manager (GTM) instances.
	object
PaymentType	string	The billing method. Valid value: Subscription	Subscription
ExpireTime	string	The time when the instance expires.	2020-10-14T06:58Z
CreateTime	string	The time when the instance was created.	2020-10-14T06:58Z
SmsQuota	integer	The total quota of text message notifications.	1
InstanceId	string	The ID of the instance.	gtm-cn-wwo3a3hbz**
Config	object	The configuration of the instance.
Ttl	integer	The global TTL.	60
AlertGroup	string	The alert contact group. The value is a JSON-formatted list of strings.	["test1","test2"]
PublicZoneName	string	The domain name used for Internet access.	gtm-cn-wwo3a3hbz**.dns-example.top
CnameType	string	The type of the CNAME domain name used for access. Valid value: PUBLIC: for Internet access	PUBLIC
StrategyMode	string	The mode of the access policy. Valid values: LATENCY: latency-based GEO: geography-based	GEO
InstanceName	string	The name of the instance.	instanceTest
PublicCnameMode	string	The method to access the instance over the Internet using a CNAME record. Valid values: CUSTOM: custom SYSTEM_ASSIGN: system-assigned (This feature is disabled.)	CUSTOM
AlertConfig	array<object>	The alert notification methods.
	object
SmsNotice	string	Indicates whether text message notifications are configured. Valid values: true: configured false or null: not configured	true
NoticeType	string	The type of the alert event. Valid values: ADDR_ALERT: The address is unavailable. ADDR_RESUME: The address is restored. ADDR_POOL_GROUP_UNAVAILABLE: The address pool collection is unavailable. ADDR_POOL_GROUP_AVAILABLE: The address pool collection is restored. ACCESS_STRATEGY_POOL_GROUP_SWITCH: A switchover occurs between the primary and secondary address pools.	ADDR_ALERT
EmailNotice	string	Indicates whether email notifications are configured. Valid values: true: configured false or null: not configured	true
DingtalkNotice	string	Indicates whether DingTalk notifications are configured. Valid values: true: configured false or null: not configured	true
PublicUserDomainName	string	The user's service domain name that is accessible over the Internet.	dns-example.top
PublicRr	string	The hostname for Internet access.	test.rr
ExpireTimestamp	integer	The timestamp that indicates when the instance expires.	1602658709000
ResourceGroupId	string	The ID of the resource group.	resourceGroupid123
VersionCode	string	The version of the instance.	standard
UsedQuota	object	The used quota.
EmailUsedCount	integer	The total number of emails that were sent.	100
TaskUsedCount	integer	The number of health check tasks that were created.	100
SmsUsedCount	integer	The total number of text messages that were sent.	100
DingtalkUsedCount	integer	The total number of DingTalk messages that were sent.	100
TaskQuota	integer	The total number of health check tasks.	1
CreateTimestamp	integer	The timestamp that indicates when the instance was created.	1602658709000
TotalPages	integer	The total number of pages.	123
TotalItems	integer	The total number of entries.	100

Examples

Success response

JSON format

{
  "PageSize": 1,
  "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
  "PageNumber": 1,
  "GtmInstances": [
    {
      "PaymentType": "Subscription",
      "ExpireTime": "2020-10-14T06:58Z",
      "CreateTime": "2020-10-14T06:58Z",
      "SmsQuota": 1,
      "InstanceId": "gtm-cn-wwo3a3hbz**",
      "Config": {
        "Ttl": 60,
        "AlertGroup": "[\"test1\",\"test2\"]",
        "PublicZoneName": "gtm-cn-wwo3a3hbz**.dns-example.top",
        "CnameType": "PUBLIC",
        "StrategyMode": "GEO",
        "InstanceName": "instanceTest",
        "PublicCnameMode": "CUSTOM",
        "AlertConfig": [
          {
            "SmsNotice": "true",
            "NoticeType": "ADDR_ALERT",
            "EmailNotice": "true",
            "DingtalkNotice": "true"
          }
        ],
        "PublicUserDomainName": "dns-example.top",
        "PublicRr": "test.rr"
      },
      "ExpireTimestamp": 1602658709000,
      "ResourceGroupId": "resourceGroupid123",
      "VersionCode": "standard",
      "UsedQuota": {
        "EmailUsedCount": 100,
        "TaskUsedCount": 100,
        "SmsUsedCount": 100,
        "DingtalkUsedCount": 100
      },
      "TaskQuota": 1,
      "CreateTimestamp": 1602658709000
    }
  ],
  "TotalPages": 123,
  "TotalItems": 100
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.