DescribeDnsProductInstance - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the details of a paid Alibaba Cloud DNS instance by its 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:DescribeDnsProductInstance

get

*instance

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

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
MonitorNodeCount	integer	The number of monitoring nodes.	5
InBlackHole	boolean	Indicates whether the domain name is in a blackhole filtering status. true: The domain name is in a blackhole filtering status. false: The domain name is not in a blackhole filtering status.	false
BindDomainCount	integer	The number of domain names that can be attached to the paid DNS instance. This parameter is available for the Personal and Ultimate editions.	5
RegionLines	boolean	Indicates whether regional lines are used. true: Regional lines are used. false: Regional lines are not used.	true
BindCount	integer	The number of times the domain name can be changed for the paid DNS instance. This parameter is available for the Custom Edition.	3
EndTime	string	The time when the instance expires.	2015-12-12T09:23Z
StartTimestamp	integer	The time when the instance was purchased. This is a UNIX timestamp.	1474335170000
ISPLines	string	The carrier line from which the DNS request was initiated. Valid values: China Telecom China Mobile China Unicom China Education and Research Network China Broadcasting Network Dr. Peng Group	中国电信
EndTimestamp	integer	The time when the instance expires. This is a UNIX timestamp.	1474335170000
DnsServers	object
DnsServer	array	The list of DNS servers that are currently set for the domain name.
	string	The DNS server.	{"DnsServer": ["vip1.alidns.com","vip2.alidns.com"]}
DDosDefendQuery	integer	The DDoS protection capacity in queries per second (QPS). The unit is 10,000 QPS. This parameter is available for the Custom Edition.	50
DnsSecurity	string	The DNS security level. Valid values: no: Not required basic: Basic DNS attack protection advanced: Advanced DNS attack protection	advanced
DomainType	string	The type of the instance: PUBLIC: An instance for an authoritative domain name. CACHE: An instance for a recursive DNS proxy.	PUBLIC
URLForwardCount	integer	The number of URL forwards.	20
TTLMinValue	integer	The minimum Time to Live (TTL) value. Unit: seconds.	10
PaymentType	string	The billing method.	Subscription
VersionName	string	The name of the Alibaba Cloud DNS edition.	企业旗舰版
OverseaLine	string	The line for regions outside China.	海外大洲
ISPRegionLines	string	The carrier line and province from which the DNS request was initiated. Valid values: China Telecom (by province) China Mobile (by province) China Unicom (by province) China Education and Research Network (by province)	电信_浙江
Gslb	boolean	Indicates whether Global Server Load Balancer (GSLB) is allowed. true: Allowed false: Not allowed	true
BindUsedCount	integer	The number of times the domain name has been changed for the paid DNS instance. This parameter is available for the Custom Edition.	1
RequestId	string	The unique ID of the request.	536E9CAD-DB30-4647-AC87-xxxxxxx
DnsSLBCount	integer	The Server Load Balancer (SLB) capacity. This is the number of IP addresses that can be configured for a domain name on a single line.	15
InstanceId	string	The ID of the Alibaba Cloud DNS instance.	i-8fxxx
MonitorTaskCount	integer	The number of monitoring jobs.	2
StartTime	string	The time when the instance was purchased.	2015-12-12T09:23Z
DDosDefendFlow	integer	The DDoS protection bandwidth. Unit: Gbit/s.	50
MonitorFrequency	integer	The monitoring frequency. Unit: minutes.	50
SearchEngineLines	string	The search engine line. Valid values: Google Baidu Bing Youdao	谷歌
BindDomainUsedCount	integer	The number of domain names that are attached to the paid DNS instance. This parameter is available for the Personal and Ultimate editions.	3
VersionCode	string	The code of the Alibaba Cloud DNS edition.	version1
OverseaDDosDefendFlow	integer	The DDoS protection bandwidth for regions outside China. Unit: Gbit/s.	1
InClean	boolean	Indicates whether the domain name is undergoing traffic scrubbing. true: Traffic scrubbing is in progress. false: Traffic scrubbing is not in progress.	false
SubDomainLevel	integer	The number of subdomain levels.	6
Domain	string	The attached domain name. If this parameter is empty, no domain name is attached.	example.com
AutoRenewal	boolean	Indicates whether auto-renewal is enabled for the instance. true: Auto-renewal is enabled. false: Auto-renewal is disabled.	true

Examples

Success response

JSON format

{
  "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-xxxxxxx",
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.