All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDnsGtmInstance

Last Updated:Mar 15, 2024

Queries detailed information about a Global Traffic Manager (GTM) instance.

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:DescribeDnsGtmInstanceREAD
  • gtmInstance
    acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language in which you want the values of some response parameters to be returned. These response parameters support multiple languages. Default value: en. Valid values: en, zh, and ja.

en
InstanceIdstringYes

The ID of the instance about which you want to query the information.

instance1

Response parameters

ParameterTypeDescriptionExample
object
PaymentTypestring

The billing method. Valid value:

  • Subscription: You can pay in advance for the use of resources.
Subscription
ExpireTimestamplong

The UNIX timestamp that indicates when the instance expires.

1602656937000
RequestIdstring

The ID of the request.

84314904-D047-4176-A0EC-256D7F68C7F5
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.

resourcegroupid1
SmsQuotainteger

The total number of SMS notifications.

100
InstanceIdstring

The ID of the instance.

instanceid1
VersionCodestring

The version of the instance.

versioncode1
TaskQuotainteger

The total number of detection tasks.

100
CreateTimestamplong

The UNIX timestamp that indicates when the instance was created.

1602656937000
Configobject

The configurations of the instance.

Ttlinteger

The global time to live (TTL).

1
AlertGroupstring

The name of the alert group.

alertgroup1
PublicRrstring

The hostname corresponding to the CNAME domain name that is used to access the instance over the Internet.

test.rr
CnameTypestring

The type of the CNAME domain name that is used to access the instance. Valid value:

  • PUBLIC: The CNAME domain name is used to access the instance over the Internet.
public
StrategyModestring

The type of the access policy. Valid values:

  • LATENCY: Latency-based
  • GEO: Geographical location-based
GEO
InstanceNamestring

The name of the instance.

instancetest1
PublicCnameModestring

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

  • CUSTOM: A custom CNAME domain name is used.
  • SYSTEM_ASSIGN: A CNAME domain name assigned by the system is used.
custom
PublicUserDomainNamestring

The service domain name that is used over the Internet.

example.com
PubicZoneNamestring

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

test.rr.gtm-003.com
AlertConfigobject []

The alert notification method.

SmsNoticeboolean

Indicates whether SMS notification is configured. Valid values:

  • true: SMS notification is configured.
  • false: SMS notification is not configured. null: SMS notification is not configured.
true
EmailNoticeboolean

Indicates whether email notification is configured. Valid values:

  • true: Email notification is configured.
  • false: Email notification is not configured. null: Email notification is 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.
  • MONITOR_NODE_IP_CHANGE: The IP address of the monitoring node has changed.
ADDR_ALERT
UsedQuotaobject

The used quota.

SmsUsedCountinteger

The total number of short messages that were sent.

123
EmailUsedCountinteger

The total number of emails that were sent.

123
TaskUsedCountinteger

The number of detection tasks that were created.

123

Examples

Sample success responses

JSONformat

{
  "PaymentType": "Subscription",
  "ExpireTimestamp": 1602656937000,
  "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
  "ExpireTime": "2020-10-14T06:58Z",
  "CreateTime": "2020-10-14T06:58Z",
  "ResourceGroupId": "resourcegroupid1",
  "SmsQuota": 100,
  "InstanceId": "instanceid1",
  "VersionCode": "versioncode1",
  "TaskQuota": 100,
  "CreateTimestamp": 1602656937000,
  "Config": {
    "Ttl": 1,
    "AlertGroup": "alertgroup1",
    "PublicRr": "test.rr",
    "CnameType": "public",
    "StrategyMode": "GEO",
    "InstanceName": "instancetest1",
    "PublicCnameMode": "custom",
    "PublicUserDomainName": "example.com",
    "PubicZoneName": "test.rr.gtm-003.com",
    "AlertConfig": {
      "AlertConfig": [
        {
          "SmsNotice": true,
          "EmailNotice": true,
          "NoticeType": "ADDR_ALERT"
        }
      ]
    }
  },
  "UsedQuota": {
    "SmsUsedCount": 123,
    "EmailUsedCount": 123,
    "TaskUsedCount": 123
  }
}

Error codes

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