DescribeDnsProductInstance - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the details about a paid Alibaba Cloud DNS instance based on the instance ID.

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:DescribeDnsProductInstance	get	instance acs:alidns::{#accountId}:instance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese en: English Default value: en	en
UserClientIp	string	No	The IP address of the client.	192.0.2.0
InstanceId	string	Yes	The instance ID. You can call the DescribeDomainInfo operation to obtain the instance ID.	i-8fxxxx

Response parameters

Parameter	Type	Description	Example
	object
MonitorNodeCount	long	The number of monitoring nodes.	5
InBlackHole	boolean	Indicates whether the Domain Name System (DNS) servers stopped responding to all DNS requests. Valid values: true: The DNS servers stopped responding to all DNS requests. false: The DNS servers did not stop responding to all DNS requests.	false
BindDomainCount	long	The number of domain names that can be bound to the paid Alibaba Cloud DNS instance. This parameter applies to Alibaba Cloud DNS instances of Personal Edition, Enterprise Standard Edition, and Enterprise Ultimate Edition.	5
RegionLines	boolean	Indicates whether the DNS request lines are regional lines. Valid values: true: The DNS request lines are regional lines. false: The DNS request lines are not regional lines.	true
BindCount	long	The number of times that you can change the domain names that are bound to the paid Alibaba Cloud DNS instance. This parameter applies to Alibaba Cloud DNS instances of the custom edition.	3
EndTime	string	The time when the instance expired. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-12T09:23Z
StartTimestamp	long	The time when the instance was purchased. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1474335170000
ISPLines	string	The ISP resolution lines. Valid values: China Telecom China Mobile China Unicom China Education and Research Network (CERNET) China Broadcasting Network (CBN) Dr Peng Telecom & Media Group
EndTimestamp	long	The time when the instance expired. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1474335170000
DnsServers	array	The DNS servers configured for the domain names.
DnsServer	string	The details about the DNS server.	{"DnsServer": ["vip1.alidns.com","vip2.alidns.com"]}
DDosDefendQuery	long	The DDoS protection frequency. Unit: 10,000 QPS. This parameter applies to Alibaba Cloud DNS instances of the custom edition.	50
DnsSecurity	string	The level of DNS protection. Valid values: no: No DNS protection is provided. basic: Basic DNS protection is provided. advanced: Advanced DNS protection is provided.	advanced
DomainType	string	The type of the instance. Valid values: PUBLIC: authoritative domain name CACHE: cache-accelerated domain name	PUBLIC
URLForwardCount	long	The number of the forwarded URLs.	20
TTLMinValue	long	The minimum time-to-live (TTL) period. Unit: seconds.	10
PaymentType	string	The billing method.	Subscription
VersionName	string	The edition of Alibaba Cloud DNS.
OverseaLine	string	The line outside the Chinese mainland.
ISPRegionLines	string	The regional ISP resolution lines. Valid values: China Telecom (province) China Mobile (province) China Unicom (province) CERNET (province)
Gslb	boolean	Indicates whether global server load balancing (GSLB) is supported. Valid values: true: GSLB is supported. false: GSLB is not supported.	true
BindUsedCount	long	The number of times that you have changed the domain names that are bound to the paid Alibaba Cloud DNS instance. This parameter applies to Alibaba Cloud DNS instances of the custom edition.	1
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
DnsSLBCount	long	The maximum number of IP addresses that are used for load balancing in a single line of a domain name.	15
InstanceId	string	The ID of the Alibaba Cloud DNS instance.	i-8fxxx
MonitorTaskCount	long	The number of monitoring tasks.	2
StartTime	string	The time when the instance was purchased. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-12T09:23Z
DDosDefendFlow	long	The DDoS protection traffic. Unit: GB.	50
MonitorFrequency	long	The interval at which the instance is monitored. Unit: minutes.	50
SearchEngineLines	string	The search engine resolution lines. Valid values: Google Baidu Bing Youdao
BindDomainUsedCount	long	The number of domain names that are bound to the paid Alibaba Cloud DNS instance. This parameter applies to Alibaba Cloud DNS instances of Personal Edition, Enterprise Standard Edition, and Enterprise Ultimate Edition.	3
VersionCode	string	The version code of Alibaba Cloud DNS.	version1
OverseaDDosDefendFlow	long	The DDoS protection traffic outside the Chinese mainland. Unit: GB.	1
InClean	boolean	Indicates whether the DNS servers stopped responding to abnormal requests sent to the domain names. true: The DNS servers stopped responding to abnormal requests sent to the domain names. false: The DNS servers did not stop responding to abnormal requests sent to the domain names.	false
SubDomainLevel	long	The number of subdomain name levels.	6
Domain	string	The domain name that is bound to the paid instance. If no value is returned for this parameter, no domain name is bound to the paid instance.	example.com
AutoRenewal	boolean	Indicates whether auto-renewal was enabled. Valid values: true: Auto-renewal was enabled. false: Auto-renewal was not enabled.	true

Examples

Sample success responses

JSONformat

{
  "MonitorNodeCount": 5,
  "InBlackHole": false,
  "BindDomainCount": 5,
  "RegionLines": true,
  "BindCount": 3,
  "EndTime": "2015-12-12T09:23Z",
  "StartTimestamp": 1474335170000,
  "ISPLines": "",
  "EndTimestamp": 1474335170000,
  "DnsServers": {
    "DnsServer": [
      "{\"DnsServer\": [\"vip1.alidns.com\",\"vip2.alidns.com\"]}"
    ]
  },
  "DDosDefendQuery": 50,
  "DnsSecurity": "advanced",
  "DomainType": "PUBLIC",
  "URLForwardCount": 20,
  "TTLMinValue": 10,
  "PaymentType": "Subscription",
  "VersionName": "",
  "OverseaLine": "",
  "ISPRegionLines": "",
  "Gslb": true,
  "BindUsedCount": 1,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "DnsSLBCount": 15,
  "InstanceId": "i-8fxxx",
  "MonitorTaskCount": 2,
  "StartTime": "2015-12-12T09:23Z",
  "DDosDefendFlow": 50,
  "MonitorFrequency": 50,
  "SearchEngineLines": "",
  "BindDomainUsedCount": 3,
  "VersionCode": "version1",
  "OverseaDDosDefendFlow": 1,
  "InClean": false,
  "SubDomainLevel": 6,
  "Domain": "example.com",
  "AutoRenewal": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-10-11	The response structure of the API has changed	View Change Details