DescribeDnsGtmInstance - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

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

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	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
InstanceId	string	Yes	The ID of the instance about which you want to query the information.	instance1

Response parameters

Parameter	Type	Description	Example
	object
PaymentType	string	The billing method. Valid value: Subscription: You can pay in advance for the use of resources.	Subscription
ExpireTimestamp	long	The UNIX timestamp that indicates when the instance expires.	1602656937000
RequestId	string	The ID of the request.	84314904-D047-4176-A0EC-256D7F68C7F5
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
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	resourcegroupid1
SmsQuota	integer	The total number of SMS notifications.	100
InstanceId	string	The ID of the instance.	instanceid1
VersionCode	string	The version of the instance.	versioncode1
TaskQuota	integer	The total number of detection tasks.	100
CreateTimestamp	long	The UNIX timestamp that indicates when the instance was created.	1602656937000
Config	object	The configurations of the instance.
Ttl	integer	The global time to live (TTL).	1
AlertGroup	string	The name of the alert group.	alertgroup1
PublicRr	string	The hostname corresponding to the CNAME domain name that is used to access the instance over the Internet.	test.rr
CnameType	string	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
StrategyMode	string	The type of the access policy. Valid values: LATENCY: Latency-based GEO: Geographical location-based	GEO
InstanceName	string	The name of the instance.	instancetest1
PublicCnameMode	string	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
PublicUserDomainName	string	The service domain name that is used over the Internet.	example.com
PubicZoneName	string	The domain name that is used to access the instance over the Internet.	test.rr.gtm-003.com
AlertConfig	array<object>	The alert notification method.
AlertConfig	object
SmsNotice	boolean	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
EmailNotice	boolean	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
NoticeType	string	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
UsedQuota	object	The used quota.
SmsUsedCount	integer	The total number of short messages that were sent.	123
EmailUsedCount	integer	The total number of emails that were sent.	123
TaskUsedCount	integer	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.