DescribeDnsGtmInstances - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of instances.

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:DescribeDnsGtmInstances	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the values for specific response parameters. Default value: en. Valid values: en, zh, and ja.	en
PageNumber	integer	No	The page number. Pages start from page 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 that you use for the query. Fuzzy search by instance ID or instance name is supported.	instance1
ResourceGroupId	string	No	The resource group ID.	rg-testgroupid

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries per page. Maximum value: 100. Default value: 20.	1
RequestId	string	The request ID.	84314904-D047-4176-A0EC-256D7F68C7F5
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
GtmInstances	array<object>	The Global Traffic Manager (GTM) instances.
GtmInstance	object
PaymentType	string	The billing method of the GTM instance. Valid value: Subscription.	Subscription
ExpireTime	string	The time when the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-10-14T06:58Z
CreateTime	string	The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-10-14T06:58Z
SmsQuota	integer	The total number of Short Message Service (SMS) notifications.	1
InstanceId	string	The instance ID.	instance1
Config	object	The configurations of the instance.
Ttl	integer	The global time to live (TTL).	1
AlertGroup	string	The alert contact groups. The value is in the JSON format.	testgroup
PublicZoneName	string	The canonical name (CNAME) that is used to access GTM over the Internet.	test.rr.gtm-003.com
CnameType	string	The type of the CNAME. Valid value: PUBLIC	public
StrategyMode	string	The type of the access policy. Valid values: LATENCY: latency-based access policy GEO: geographical location-based access policy	geo
InstanceName	string	The name of the instance.	instanceTest
PublicCnameMode	string	Specifies whether to use a custom CNAME or a system-assigned CNAME to access GTM over the Internet. Valid values: CUSTOM: a custom CNAME SYSTEM_ASSIGN: a system-assigned CNAME. You cannot set PublicCnameMode to this value.	custom
AlertConfig	array<object>	The alert notification method.
AlertConfig	object
SmsNotice	string	Indicates whether SMS notifications are configured. Valid values: true false \| null	true
NoticeType	string	The type of the alert event. Valid values: ADDR_ALERT: The address is unavailable. ADDR_RESUME: The address becomes available. ADDR_POOL_GROUP_UNAVAILABLE: The address pool set is unavailable. ADDR_POOL_GROUP_AVAILABLE: The address pool set becomes available. ACCESS_STRATEGY_POOL_GROUP_SWITCH: Switchover is triggered between the primary and secondary address pools.	ADDR_ALERT
EmailNotice	string	Indicates whether email notifications are configured. Valid values: true false \| null	true
DingtalkNotice	string	Indicates whether DingTalk alert notifications are configured. Valid values: true false \| null	true
PublicUserDomainName	string	The domain name that is used to access GTM over the Internet.	example.com
PublicRr	string	The hostname of the domain name that is used to access GTM over the Internet.	test.rr
ExpireTimestamp	long	The time when the instance expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1602658709000
ResourceGroupId	string	The ID of the resource group.	resourceGroupid123
VersionCode	string	The version of the instance.	testVersion1
UsedQuota	object	The used quota.
EmailUsedCount	integer	The total number of sent email notifications.	100
TaskUsedCount	integer	The number of created detection tasks.	100
SmsUsedCount	integer	The total number of sent SMS notifications.	100
DingtalkUsedCount	integer	The total number of sent DingTalk notifications.	100
TaskQuota	integer	The total number of detection tasks.	1
CreateTimestamp	long	The time when the instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1602658709000
TotalPages	integer	The total number of pages returned.	123
TotalItems	integer	The total number of entries returned.	100

Examples

Sample success responses

JSONformat

{
  "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": "instance1",
      "Config": {
        "Ttl": 1,
        "AlertGroup": "testgroup",
        "PublicZoneName": "test.rr.gtm-003.com",
        "CnameType": "public",
        "StrategyMode": "geo",
        "InstanceName": "instanceTest",
        "PublicCnameMode": "custom",
        "AlertConfig": [
          {
            "SmsNotice": "true",
            "NoticeType": "ADDR_ALERT",
            "EmailNotice": "true",
            "DingtalkNotice": "true"
          }
        ],
        "PublicUserDomainName": "example.com",
        "PublicRr": "test.rr"
      },
      "ExpireTimestamp": 1602658709000,
      "ResourceGroupId": "resourceGroupid123",
      "VersionCode": "testVersion1",
      "UsedQuota": {
        "EmailUsedCount": 100,
        "TaskUsedCount": 100,
        "SmsUsedCount": 100,
        "DingtalkUsedCount": 100
      },
      "TaskQuota": 1,
      "CreateTimestamp": 1602658709000
    }
  ],
  "TotalPages": 123,
  "TotalItems": 100
}

Error codes

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