Queries Global Traffic Manager (GTM) instances in a resource group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDnsGtmInstances

The operation that you want to perform. Set the value to DescribeDnsGtmInstances.

Lang String No en

The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 1

The number of entries to return on each page.

Keyword String No instance1

The keyword that you use for query. Fuzzy search by instance ID or instance name is supported.

ResourceGroupId String No rg-testgroupid

The ID of the resource group where you want to query instances.

Response parameters

Parameter Type Example Description
GtmInstances Array of GtmInstance

The returned instances.

Config Struct

The configurations of the instance.

AlertConfig Array of AlertConfig

The alert notification methods.

EmailNotice String true

Indicates whether email notifications were configured. Valid values:

  • true: configured
  • false | null: not configured
NoticeType String ADDR_ALERT

The type of the alert event. Valid values:

  • ADDR_ALERT: The address is unavailable.
  • ADDR_RESUME: The address is restored and becomes available.
  • ADDR_POOL_GROUP_UNAVAILABLE: The address pool group is unavailable.
  • ADDR_POOL_GROUP_AVAILABLE: The address pool group is restored and becomes available.
  • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Switchover is triggered between the primary and secondary address pools.
SmsNotice String true

Indicates whether SMS notifications were configured. Valid values:

  • true: configured
  • false | null: not configured
AlertGroup String testgroup

The alert group.

CnameType String public

The access type of the CNAME domain name.

  • The value was set to PUBLIC, which indicates Internet access.
InstanceName String instanceTest

The name of the instance.

PublicCnameMode String custom

Indicates whether a custom CNAME domain name or a CNAME domain name assigned by the system is used to access GTM over the Internet. Valid values:

  • CUSTOM: a custom CNAME domain name
  • SYSTEM_ASSIGN: a CNAME domain name assigned by the system
PublicUserDomainName String example.com

The website domain name that the user uses on the Internet.

PublicZoneName String gtminstance.example.com

The domain name that is used to access GTM over the Internet.

StrategyMode String geo

The type of the access policy. Valid values:

  • LATENCY: latency-based
  • GEO: geographical location-based
Ttl Integer 1

The global time to live (TTL).

CreateTime String 2020-10-14T06:58Z

The time when the instance was created.

CreateTimestamp Long 1602658709000

The timestamp that indicates when the instance was created.

ExpireTime String 2020-10-14T06:58Z

The time when the instance expires.

ExpireTimestamp Long 1602658709000

The timestamp that indicates when the instance expires.

InstanceId String instance1

The ID of the instance.

PaymentType String Subscription

The billing method of the instance.

  • The value is set to Subscription.
ResourceGroupId String resourceGroupid123

The ID of the resource group to which the instance belongs.

SmsQuota Integer 1

The total number of SMS notifications.

TaskQuota Integer 1

The total number of detection tasks.

UsedQuota Struct

The used quota.

EmailUsedCount Integer 100

The total number of email notifications that were sent.

SmsUsedCount Integer 100

The total number of SMS notifications that were sent.

TaskUsedCount Integer 100

The number of detection tasks that were created.

VersionCode String testVersion1

The version of the instance.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned per page.

RequestId String 84314904-D047-4176-A0EC-256D7F68C7F5

The ID of the request.

TotalItems Integer 100

The total number of entries returned on all pages.

TotalPages Integer 123

The total number of returned pages.

Examples

Sample requests

http(s)://alidns.aliyuncs.com/? Action=DescribeDnsGtmInstances
&<Common request parameters>

Sample success responses

XML format

<PageSize>1</PageSize>
<RequestId>84314904-D047-4176-A0EC-256D7F68C7F5</RequestId>
<PageNumber>1</PageNumber>
<GtmInstances>
    <ExpireTimestamp>1602658709000</ExpireTimestamp>
    <VersionCode>testVersion1</VersionCode>
    <ResourceGroupId>resourceGroupid123</ResourceGroupId>
    <InstanceId>instance1</InstanceId>
    <PaymentType>Subscription</PaymentType>
    <TaskQuota>1</TaskQuota>
    <CreateTime>2020-10-14T06:58Z</CreateTime>
    <ExpireTime>2020-10-14T06:58Z</ExpireTime>
    <CreateTimestamp>1602658709000</CreateTimestamp>
    <SmsQuota>1</SmsQuota>
    <UsedQuota>
        <TaskUsedCount>100</TaskUsedCount>
        <SmsUsedCount>100</SmsUsedCount>
        <EmailUsedCount>100</EmailUsedCount>
    </UsedQuota>
    <Config>
        <InstanceName>instanceTest</InstanceName>
        <AlertGroup>testgroup</AlertGroup>
        <AlertConfig>
            <SmsNotice>true</SmsNotice>
            <NoticeType>ADDR_ALERT</NoticeType>
            <EmailNotice>true</EmailNotice>
        </AlertConfig>
        <CnameType>public</CnameType>
        <PublicUserDomainName>example.com</PublicUserDomainName>
        <PublicZoneName>gtminstance.example.com</PublicZoneName>
        <StrategyMode>geo</StrategyMode>
        <Ttl>1</Ttl>
        <PublicCnameMode>custom</PublicCnameMode>
    </Config>
</GtmInstances>
<TotalPages>123</TotalPages>
<TotalItems>100</TotalItems>

JSON format

{
	"PageSize": "1",
	"RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
	"PageNumber": "1",
	"GtmInstances": [{
		"ExpireTimestamp": "1602658709000",
		"VersionCode": "testVersion1",
		"ResourceGroupId": "resourceGroupid123",
		"InstanceId": "instance1",
		"PaymentType": "Subscription",
		"TaskQuota": "1",
		"CreateTime": "2020-10-14T06:58Z",
		"ExpireTime": "2020-10-14T06:58Z",
		"CreateTimestamp": "1602658709000",
		"SmsQuota": "1",
		"UsedQuota": {
			"TaskUsedCount": "100",
			"SmsUsedCount": "100",
			"EmailUsedCount": "100"
		},
		"Config": {
			"InstanceName": "instanceTest",
			"AlertGroup": "testgroup",
			"AlertConfig": [{
				"SmsNotice": "true",
				"NoticeType": "ADDR_ALERT",
				"EmailNotice": "true"
			}],
			"CnameType": "public",
			"PublicUserDomainName": "example.com",
			"PublicZoneName": "gtminstance.example.com",
			"StrategyMode": "geo",
			"Ttl": "1",
			"PublicCnameMode": "custom"
		}
	}],
	"TotalPages": "123",
	"TotalItems": "100"
}

Error codes

For a list of error codes, visit the API Error Center.