DescribeDnsGtmInstance - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the details of an instance based on the specified instance ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeDnsGtmInstance

get

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Default: en. Valid values: en, zh, and ja.	en
InstanceId	string	Yes	The ID of the instance. For more information, see DescribeDnsGtmInstances.	gtm-cn-wwo3a3hbz**

Response elements

Element	Type	Description	Example
	object
ExpireTimestamp	integer	The UNIX timestamp when the instance expires.	1602656937000
RequestId	string	The unique request ID.	84314904-D047-4176-A0EC-256D7F68C7F5
ResourceGroupId	string	The ID of the resource group.	resourc*****
InstanceId	string	The ID of the instance.	gtm-cn-wwo3a3hbz**
TaskQuota	integer	The quota on the number of health check tasks.	100
Config	object	The instance configuration.
Ttl	integer	The global TTL.	60
AlertGroup	string	The alert contact group. The value is a `List<string>` in JSON format.	["test1","test2"]
CnameType	string	The type of the CNAME domain name used for access. PUBLIC: Internet-facing	PUBLIC
StrategyMode	string	The access policy mode. LATENCY: latency-based GEO: geography-based	GEO
InstanceName	string	The name of the instance.	test
PublicCnameMode	string	The access method for the public CNAME. CUSTOM: custom SYSTEM_ASSIGN: system-assigned. This feature is disabled.	CUSTOM
AlertConfig	object
AlertConfig	array<object>	The alert notification methods.
	object
SmsNotice	boolean	Indicates whether text message notifications are enabled. true: enabled false or null: disabled	true
NoticeType	string	The type of the alert event. ADDR_ALERT: An address is unavailable. ADDR_RESUME: An address is restored. ADDR_POOL_GROUP_UNAVAILABLE: An address pool group is unavailable. ADDR_POOL_GROUP_AVAILABLE: An address pool group is restored. ACCESS_STRATEGY_POOL_GROUP_SWITCH: A switchover occurs between the primary and secondary address pools. MONITOR_NODE_IP_CHANGE: The IP address of a monitoring node changes.	ADDR_ALERT
EmailNotice	boolean	Indicates whether email notifications are enabled. true: enabled false or null: disabled	true
DingtalkNotice	boolean	Indicates whether DingTalk notifications are enabled. true: enabled false or null: disabled	true
PublicUserDomainName	string	The user's public service domain name.	example.com
PubicZoneName	string	The public access domain name.	gtm-cn-wwo3a3hbz**.example.com
PublicRr	string	The hostname for public access.	test.rr
CreateTime	string	The time when the instance was created.	2020-10-14T06:58Z
SmsQuota	integer	The quota on the number of text message notifications.	100
VersionCode	string	The version of the instance.	standard
PaymentType	string	The billing method. Subscription: subscription	Subscription
ExpireTime	string	The expiration date.	2020-10-14T06:58Z
CreateTimestamp	integer	The UNIX timestamp when the instance was created.	1602656937000
UsedQuota	object	The used quota.
EmailUsedCount	integer	The number of email notifications that were sent.	123
TaskUsedCount	integer	The number of health check tasks that were created.	123
SmsUsedCount	integer	The number of text messages that were sent.	123
DingtalkUsedCount	integer	The number of DingTalk notifications that were sent.	123

Examples

Success response

JSON format

{
  "ExpireTimestamp": 1602656937000,
  "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
  "ResourceGroupId": "resourc*****",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "TaskQuota": 100,
  "Config": {
    "Ttl": 60,
    "AlertGroup": "[\"test1\",\"test2\"]",
    "CnameType": "PUBLIC",
    "StrategyMode": "GEO",
    "InstanceName": "test",
    "PublicCnameMode": "CUSTOM",
    "AlertConfig": {
      "AlertConfig": [
        {
          "SmsNotice": true,
          "NoticeType": "ADDR_ALERT",
          "EmailNotice": true,
          "DingtalkNotice": true
        }
      ]
    },
    "PublicUserDomainName": "example.com",
    "PubicZoneName": "\ngtm-cn-wwo3a3hbz**.example.com",
    "PublicRr": "test.rr"
  },
  "CreateTime": "2020-10-14T06:58Z",
  "SmsQuota": 100,
  "VersionCode": "standard",
  "PaymentType": "Subscription",
  "ExpireTime": "2020-10-14T06:58Z",
  "CreateTimestamp": 1602656937000,
  "UsedQuota": {
    "EmailUsedCount": 123,
    "TaskUsedCount": 123,
    "SmsUsedCount": 123,
    "DingtalkUsedCount": 123
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.