All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDnsGtmInstances

Last Updated:Mar 15, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeDnsGtmInstancesREAD
  • gtmInstance
    acs:alidns::{#accountId}:gtmInstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

en
PageNumberintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

1
KeywordstringNo

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

instance1
ResourceGroupIdstringNo

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

rg-testgroupid

Response parameters

ParameterTypeDescriptionExample
object
TotalPagesinteger

The total number of returned pages.

123
TotalItemsinteger

The total number of entries returned on all pages.

100
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

1
RequestIdstring

The ID of the request.

84314904-D047-4176-A0EC-256D7F68C7F5
GtmInstancesobject []

The returned instances.

PaymentTypestring

The billing method of the instance.

  • The value is set to Subscription.
Subscription
ExpireTimestamplong

The timestamp that indicates when the instance expires.

1602658709000
ExpireTimestring

The time when the instance expires.

2020-10-14T06:58Z
CreateTimestring

The time when the instance was created.

2020-10-14T06:58Z
ResourceGroupIdstring

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

resourceGroupid123
SmsQuotainteger

The total number of SMS notifications.

1
InstanceIdstring

The ID of the instance.

instance1
VersionCodestring

The version of the instance.

testVersion1
TaskQuotainteger

The total number of detection tasks.

1
CreateTimestamplong

The timestamp that indicates when the instance was created.

1602658709000
Configobject

The configurations of the instance.

Ttlinteger

The global time to live (TTL).

1
AlertGroupstring

The alert group.

testgroup
PublicZoneNamestring

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

test.rr.gtm-003.com
CnameTypestring

The access type of the CNAME domain name.

  • The value was set to PUBLIC, which indicates Internet access.
public
StrategyModestring

The type of the access policy. Valid values:

  • LATENCY: latency-based
  • GEO: geographical location-based
geo
InstanceNamestring

The name of the instance.

instanceTest
PublicCnameModestring

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
custom
PublicUserDomainNamestring

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

example.com
AlertConfigobject []

The alert notification methods.

SmsNoticestring

Indicates whether SMS notifications were configured. Valid values:

  • true: configured
  • false | null: not configured
true
EmailNoticestring

Indicates whether email notifications were configured. Valid values:

  • true: configured
  • false | null: not configured
true
NoticeTypestring

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.
ADDR_ALERT
UsedQuotaobject

The used quota.

SmsUsedCountinteger

The total number of SMS notifications that were sent.

100
EmailUsedCountinteger

The total number of email notifications that were sent.

100
TaskUsedCountinteger

The number of detection tasks that were created.

100

Examples

Sample success responses

JSONformat

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

Error codes

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