DescribeDnsProductInstances - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves a list of paid DNS product instances that match the specified parameters.

Operation description

Note

If the response does not contain a domain name, the Alibaba Cloud DNS instance is not associated with any domain names.

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:DescribeDnsProductInstances

get

*Instance

acs:alidns:*:{#accountId}:instance/*

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 client's IP address.	192.0.2.0
PageNumber	integer	No	The page number. Pages start from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
VersionCode	string	No	The edition code of the Alibaba Cloud DNS instance.	version1
DomainType	string	No	The type of the domain name. This parameter is not case-sensitive. Valid values: PUBLIC: authoritative domain name (default) CACHE: authoritative proxy domain name	PUBLIC
OrderBy	string	No	The field to sort the results by. Valid values: createDate: Sorts the results by creation time. This is the default value. expireDate: Sorts the results by expiration time.	createDate
Direction	string	No	The sorting order. Valid values: DESC: Descending order. This is the default value. ASC: Ascending order.	DESC

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of instances that match the query.	2
DomainType	string	The type of the domain name. Valid values: PUBLIC: authoritative domain name (default) CACHE: authoritative proxy domain name	PUBLIC
PageSize	integer	The number of entries on the current page.	2
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38xxxxx
PageNumber	integer	The page number.	1
DnsProducts	object
DnsProduct	array<object>	The list of Alibaba Cloud DNS instances.
	object
OverseaLine	string	The DNS resolution line for regions outside mainland China.	Overseas
PaymentType	string	The billing method.	Subscription
MonitorNodeCount	integer	The number of monitoring nodes.	5
InBlackHole	boolean	Indicates whether the domain name is in a blackhole filtering state. true: The domain name is in a blackhole filtering state. false: The domain name is not in a blackhole filtering state.	false
BindDomainUsedCount	integer	The number of domain names that are associated with the instance. This parameter applies to the Personal and Ultimate editions.	3
ISPRegionLines	string	The ISP resolution lines by province. China Telecom (province) China Mobile (province) China Unicom (province) China Education and Research Network (province)	China Telecom-Zhejiang
TTLMinValue	integer	The minimum time to live (TTL) value, in seconds.	10
ISPLines	string	The ISP resolution lines. China Telecom China Mobile China Unicom China Education and Research Network China Broadcasting Network Dr. Peng	China Telecom
SearchEngineLines	string	The search engine resolution lines. Google Baidu Bing Youdao	Google
EndTimestamp	integer	The expiration time of the instance, as a UNIX timestamp.	1474335170000
VersionName	string	The edition name of the Alibaba Cloud DNS instance.	Enterprise Ultimate
VersionCode	string	The edition code of the Alibaba Cloud DNS instance.	version1
MonitorTaskCount	integer	The number of monitoring jobs.	2
BindUsedCount	integer	The number of times the domain name has been changed for the instance. This parameter applies to the Custom Edition.	1
Domain	string	The associated domain name.	example.com
MonitorFrequency	integer	The monitoring frequency, in minutes.	50
InClean	boolean	Indicates whether the domain name is in a traffic scrubbing state.	false
URLForwardCount	integer	The number of URL forwarding rules.	20
StartTimestamp	integer	The purchase time of the instance, as a UNIX timestamp.	1474335170000
DDosDefendQuery	integer	The DDoS protection capacity in queries per second (QPS). The value is in units of 10,000. This parameter applies to the Custom Edition.	50
InstanceId	string	The instance ID.	i-8fj
DDosDefendFlow	integer	The DDoS protection bandwidth, in GB.	50
BindCount	integer	The number of times the domain name can be changed for the instance. This parameter applies to the Custom Edition.	3
SubDomainLevel	integer	The number of supported subdomain levels.	6
BindDomainCount	integer	The number of domain names that can be associated with the instance. This parameter applies to the Personal and Ultimate editions.	5
EndTime	string	The expiration time of the instance.	2015-12-12T00:00Z
StartTime	string	The purchase time of the instance.	2015-11-12T09:23Z
OverseaDDosDefendFlow	integer	The DDoS protection bandwidth for traffic from outside mainland China, in GB.	1
RegionLines	boolean	Indicates whether regional resolution lines are supported. true: Regional resolution lines are supported. false: Regional resolution lines are not supported.	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 DNS security level. Valid values: no: not required basic: basic DNS attack protection advanced: advanced DNS attack protection	no
DnsSLBCount	integer	The Server Load Balancer (SLB) capacity. This is the number of IP addresses that can be configured for a single domain name on a single resolution line.	15
AutoRenewal	boolean	The auto-renewal status. true: Auto-renewal is enabled. false: Auto-renewal is disabled.	true

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "DomainType": "PUBLIC",
  "PageSize": 2,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38xxxxx",
  "PageNumber": 1,
  "DnsProducts": {
    "DnsProduct": [
      {
        "OverseaLine": "海外大洲",
        "PaymentType": "Subscription",
        "MonitorNodeCount": 5,
        "InBlackHole": false,
        "BindDomainUsedCount": 3,
        "ISPRegionLines": "电信_浙江",
        "TTLMinValue": 10,
        "ISPLines": "中国电信",
        "SearchEngineLines": "谷歌",
        "EndTimestamp": 1474335170000,
        "VersionName": "企业旗舰版",
        "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.