DescribeDnsProductInstances - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Calls the DescribeDnsProductInstances operation to query the list of paid Alibaba Cloud DNS instances based on input parameters.

Operation description

Note If the response parameters of an Alibaba Cloud DNS instance do not contain domain names, no domain names are bound to the 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:DescribeDnsProductInstances	get	Instance acs:alidns::{#accountId}:instance/	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
PageNumber	long	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	long	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
VersionCode	string	No	The version code of the Alibaba Cloud DNS instance.	version1
DomainType	string	No	The type of the domain name. Valid values: PUBLIC (default): hosted public domain name CACHE: cached public domain name	PUBLIC
OrderBy	string	No	The method that is used to sort returned entries. Valid values: createDate: sorts returned entries by creation time. If this parameter is left empty, returned entries are sorted by creation time by default. expireDate: sorts returned entries by expiration time.	createDate
Direction	string	No	The order in which you want to sort returned entries. Valid values: DESC: Returned entries are sorted in descending order. If this parameter is left empty, returned entries are sorted in descending order by default. ASC: Returned entries are sorted in ascending order.	DESC

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of domain names.	2
DomainType	string	The type of the domain name. Valid values: PUBLIC (default): hosted public domain name CACHE: cached public domain name	PUBLIC
PageSize	long	The number of entries returned per page.	2
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	long	The page number of the returned page.	1
DnsProducts	array<object>	The paid Alibaba Cloud DNS instances.
DnsProduct	object
OverseaLine	string	The type of the overseas line.	Countries
PaymentType	string	The billing method.	Subscription
MonitorNodeCount	long	The number of monitored nodes.	5
InBlackHole	boolean	Indicates whether the Domain Name System (DNS) servers stopped responding to all requests. Valid values: true: The DNS servers stopped responding to all requests. false: The DNS servers did not stop responding to all requests.	false
BindDomainUsedCount	long	The number of domain names that have been bound to the DNS instance.	3
ISPRegionLines	string	The regional ISP resolution lines. Valid values: China Telecom (province) China Mobile (province) China Unicom (province) China Education and Research Network (CERNET) (province)	Telecom (Province), Mobile (Province), Unicom (Province), Education Network (Province)
TTLMinValue	long	The minimum TTL. Unit: seconds.	10
ISPLines	string	The ISP resolution lines. China Telecom China Mobile China Unicom CERNET China Broadcasting Network (CBN) Dr Peng Telecom & Media Group	China Mobile,China Unicom,China Telecom,China Edu
SearchEngineLines	string	The search engine resolution lines. Valid values: Google Baidu Bing Youdao	Search Engine Robots,Google Robots,Baidu Robots,Bing Robots
EndTimestamp	long	The UNIX timestamp representing the expiration time of the instance.	1474335170000
VersionName	string	The version name of the Alibaba Cloud DNS instance.	Alibaba Cloud DNS
VersionCode	string	The version code of the Alibaba Cloud DNS instance.	version1
MonitorTaskCount	long	The number of monitoring tasks.	2
BindUsedCount	long	The number of times you have changed domain names that are bound to the DNS instance. It can be specified by the user who uses Alibaba Cloud DNS of the custom version.	1
Domain	string	The bound domain name.	example.com
MonitorFrequency	long	The monitoring frequency. Unit: minutes.	50
InClean	boolean	Indicates whether the request for domain name resolution was being cleared.	false
URLForwardCount	long	The URL forwarding quantity.	20
StartTimestamp	long	The UNIX timestamp representing when the DNS instance was purchased.	1474335170000
DDosDefendQuery	long	The DDoS protection frequency. Unit: 10,000 QPS.	50
InstanceId	string	The ID of the Alibaba Cloud DNS instance.	i-8fj
DDosDefendFlow	long	The DDoS protection traffic. Unit: GB.	50
BindCount	long	The number of times you can change domain names that are bound to the DNS instance. It can be specified by the user who uses Alibaba Cloud DNS of the custom version.	3
SubDomainLevel	long	The number of subdomain name levels.	6
BindDomainCount	long	The number of domain names that can be bound to the DNS instance.	5
EndTime	string	The time at which the instance expired.	2015-12-12T00:00Z
StartTime	string	The time when the DNS instance was purchased.	2015-11-12T09:23Z
OverseaDDosDefendFlow	long	DDoS protection traffic outside China. Unit: GB.	1
RegionLines	boolean	Indicates whether the DNS request lines are regional lines. true: The DNS request lines are regional lines. false: The DNS request lines are not regional lines.	true
Gslb	boolean	Indicates whether global server load balancing (GSLB) is supported. true: GSLB is supported. false: GSLB is not supported.	true
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.	no
DnsSLBCount	long	The number of IP addresses supported by a domain name or line.	15
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

{
  "TotalCount": 2,
  "DomainType": "PUBLIC",
  "PageSize": 2,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "DnsProducts": {
    "DnsProduct": [
      {
        "OverseaLine": "Countries",
        "PaymentType": "Subscription",
        "MonitorNodeCount": 5,
        "InBlackHole": false,
        "BindDomainUsedCount": 3,
        "ISPRegionLines": "Telecom (Province), Mobile (Province), Unicom (Province), Education Network (Province)",
        "TTLMinValue": 10,
        "ISPLines": "China Mobile,China Unicom,China Telecom,China Edu",
        "SearchEngineLines": "Search Engine Robots,Google Robots,Baidu Robots,Bing Robots",
        "EndTimestamp": 1474335170000,
        "VersionName": "Alibaba Cloud DNS",
        "VersionCode": "version1",
        "MonitorTaskCount": 2,
        "BindUsedCount": 1,
        "Domain": "example.com",
        "MonitorFrequency": 50,
        "InClean": false,
        "URLForwardCount": 20,
        "StartTimestamp": 1474335170000,
        "DDosDefendQuery": 50,
        "InstanceId": "i-8fj",
        "DDosDefendFlow": 50,
        "BindCount": 3,
        "SubDomainLevel": 6,
        "BindDomainCount": 5,
        "EndTime": "2015-12-12T00:00Z",
        "StartTime": "2015-11-12T09:23Z",
        "OverseaDDosDefendFlow": 1,
        "RegionLines": true,
        "Gslb": true,
        "DnsSecurity": "no",
        "DnsSLBCount": 15,
        "AutoRenewal": true
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-09-20	API Description Update. The response structure of the API has changed	View Change Details
2023-05-11	The request parameters of the API has changed	View Change Details