All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDnsProductInstance

Last Updated:Mar 15, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeDnsProductInstanceRead
  • instance
    acs:alidns::{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language.

en
UserClientIpstringNo

The IP address of the client.

192.0.2.0
InstanceIdstringYes

The instance ID. You can call the DescribeDomainInfo operation to obtain the instance ID.

i-8fxxxx

Response parameters

ParameterTypeDescriptionExample
object
MonitorNodeCountlong

The number of monitoring nodes.

5
InBlackHoleboolean

Indicates whether the Domain Name System (DNS) servers stopped responding to all requests sent to the domain names.

false
BindDomainCountlong

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
RegionLinesboolean

Indicates whether regional lines are supported.

true
BindCountlong

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
EndTimestring

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
StartTimestamplong

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
ISPLinesstring

The Internet service provider (ISP) lines for DNS resolution.

EndTimestamplong

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
DnsServersarray

The DNS servers configured for the domain names.

string

The details about the DNS server.

{"DnsServer": ["vip1.alidns.com","vip2.alidns.com"]}
DDosDefendQuerylong

The DDoS protection frequency. Unit: 10,000 QPS. This parameter applies to Alibaba Cloud DNS instances of the custom edition.

50
DnsSecuritystring

The DNS protection level. Valid values:

  • no: DNS protection is not provided.
  • basic: Basic DNS attack defense is provided.
  • advanced: Advanced DNS attack defense is provided.
advanced
DomainTypestring

The type of the instance. Valid values:

  • PUBLIC: authoritative domain name
  • CACHE: cache-accelerated domain name
PUBLIC
URLForwardCountlong

The number of the forwarded URLs.

20
TTLMinValuelong

The minimum time-to-live (TTL) period. Unit: seconds.

10
PaymentTypestring

The billing method.

Subscription
VersionNamestring

The edition of Alibaba Cloud DNS.

OverseaLinestring

The line outside the Chinese mainland.

ISPRegionLinesstring

The regional ISP lines for DNS resolution.

Gslbboolean

Indicates whether global server load balancing (GSLB) is supported.

true
BindUsedCountlong

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
RequestIdstring

The request ID.

536E9CAD-DB30-4647-AC87-AA5CC38C5382
DnsSLBCountlong

The maximum number of IP addresses that are used for load balancing in a single line of a domain name.

15
InstanceIdstring

The ID of the Alibaba Cloud DNS instance.

i-8fxxx
MonitorTaskCountlong

The number of monitoring tasks.

2
StartTimestring

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
DDosDefendFlowlong

The DDoS protection traffic. Unit: GB.

50
MonitorFrequencylong

The interval at which the instance is monitored. Unit: minutes.

50
SearchEngineLinesstring

The search engine lines for DNS resolution.

BindDomainUsedCountlong

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
VersionCodestring

The version code of Alibaba Cloud DNS.

version1
OverseaDDosDefendFlowlong

The DDoS protection traffic outside the Chinese mainland. Unit: GB.

1
InCleanboolean

Indicates whether the DNS servers stopped responding to abnormal requests sent to the domain names.

false
SubDomainLevellong

The number of subdomain name levels.

6
Domainstring

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
AutoRenewalboolean

The auto-renewal status of the instance. Valid values:

  • true: Auto-renewal is enabled.
  • false: Auto-renewal is disabled.
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 timeSummary of changesOperation
2023-10-11The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.