Queries the specifications of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.

Usage notes

You can call this operation to query the specifications of multiple Anti-DDoS Pro or Anti-DDoS Premium instances at a time. The specifications include the clean bandwidth, protection bandwidth, function plan, supported domain names, and the number of ports.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceSpecs

The operation that you want to perform. Set the value to DescribeInstanceSpecs.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: Chinese mainland, which indicates an Anti-DDoS Pro instance. This is the default value.
  • ap-southeast-1: outside the Chinese mainland, which indicates an Anti-DDoS Premium instance.
InstanceIds.N String Yes ddoscoo-cn-zvp2eibz****

The ID of the instance to query.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String 03C4A2E8-F647-5783-995C-AE49B6ACE925

The ID of the request.

InstanceSpecs Array of InstanceSpec

The details about the specifications of the instance.

BaseBandwidth Integer 30

The basic protection bandwidth. Unit: Gbit/s.

QpsLimit Integer 3000

The queries per second (QPS) of normal services.

BandwidthMbps Integer 100

The clean bandwidth. Unit: Mbit/s.

ElasticBw Integer 300

The burstable clean bandwidth. Unit: Mbit/s.

DefenseCount Integer 2

The number of available advanced mitigation sessions for this month. -1: unlimited

Note This parameter is returned only when the RegionId parameter is set to ap-southeast-1.
SiteLimit Integer 5

The number of sites that can be protected by the instance.

PortLimit Integer 50

The number of ports that can be protected by the instance.

ElasticBandwidth Integer 30

The burstable protection bandwidth. Unit: Gbit/s.

FunctionVersion String default

The function plan of the instance. Valid values:

  • default: Standard
  • enhance: Enhanced
  • cnhk: Mainland China Acceleration (MCA)
  • cnhk_default: Secure Mainland China Acceleration (Sec-MCA) standard function plan
  • cnhk_enhance: Sec-MCA enhanced function plan
InstanceId String ddoscoo-cn-zvp2eibz****

The ID of the instance.

DomainLimit Integer 50

The number of domain names that can be protected by the instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstanceSpecs
&InstanceIds=["ddoscoo-cn-zvp2eibz****"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceSpecsResponse>
    <RequestId>03C4A2E8-F647-5783-995C-AE49B6ACE925</RequestId>
    <InstanceSpecs>
        <BaseBandwidth>30</BaseBandwidth>
        <QpsLimit>3000</QpsLimit>
        <BandwidthMbps>100</BandwidthMbps>
        <ElasticBw>300</ElasticBw>
        <SiteLimit>5</SiteLimit>
        <PortLimit>50</PortLimit>
        <ElasticBandwidth>30</ElasticBandwidth>
        <FunctionVersion>default</FunctionVersion>
        <InstanceId>ddoscoo-cn-zvp2eibz****</InstanceId>
        <DomainLimit>50</DomainLimit>
    </InstanceSpecs>
</DescribeInstanceSpecsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "03C4A2E8-F647-5783-995C-AE49B6ACE925",
  "InstanceSpecs" : [ {
    "BaseBandwidth" : 30,
    "QpsLimit" : 3000,
    "BandwidthMbps" : 100,
    "ElasticBw" : 300,
    "SiteLimit" : 5,
    "PortLimit" : 50,
    "ElasticBandwidth" : 30,
    "FunctionVersion" : "default",
    "InstanceId" : "ddoscoo-cn-zvp2eibz****",
    "DomainLimit" : 50
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.