DescribeInstanceSpecs - Anti-DDoS - Alibaba Cloud Documentation Center

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

Operation description

You can call the DescribeInstanceSpecs 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, and the numbers of domain names and ports that can be protected.

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

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
yundun-ddoscoo:DescribeInstanceSpecs	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	array	Yes	An array that consists of the IDs of instances to query.
	string	Yes	The ID of the instance to query. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-zvp2eibz****

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	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	4E3A9B5F-5DDB-593D-A1E6-F1F451DB5E0B
InstanceSpecs	array<object>	The details of the specifications of the instance.
InstanceSpec	object
BaseBandwidth	integer	The basic protection bandwidth. Unit: Gbit/s.	30
QpsLimit	integer	The clean QPS.	3000
BandwidthMbps	integer	The clean bandwidth. Unit: Mbit/s.	100
ElasticBw	integer	The burstable clean bandwidth. Unit: Mbit/s.	300
DefenseCount	integer	The number of available advanced mitigation sessions for this month. -1: unlimited Note This parameter is returned only when the request parameter RegionId is set to ap-southeast-1. If RegionId is set to ap-southeast-1, the specifications of Anti-DDoS Proxy (Outside Chinese Mainland) instances are queried.	2
SiteLimit	integer	The number of sites that can be protected by the instance.	5
PortLimit	integer	The number of ports that can be protected by the instance.	50
ElasticBandwidth	integer	The burstable protection bandwidth. Unit: Gbit/s.	30
FunctionVersion	string	The function plan of the instance. Valid values: default: Standard enhance: Enhanced cnhk: Chinese Mainland Acceleration (CMA) cnhk_default: Secure Chinese Mainland Acceleration (Sec-CMA) standard cnhk_enhance: Sec-CMA enhanced	default
InstanceId	string	The ID of the instance.	ddoscoo-cn-zvp2eibz****
DomainLimit	integer	The number of domain names that can be protected by the instance.	50
ElasticBwModel	string	The metering method of the burstable clean bandwidth. Valid values: day: the metering method of daily 95th percentile month: the metering method of monthly 95th percentile	day
CpsLimit	long	The specification of new connections of the instance.	5000
ConnLimit	long	The specification of concurrent connections of the instance.	100000
RealLimitBw	long	The threshold of the clean bandwidth. Valid values: 0 to 15360. The value 0 indicates that rate limiting is never triggered. Unit: Mbit/s	0
ElasticQpsMode	string	The metering method of the burstable QPS. Valid values: day: the metering method of daily 95th percentile month: the metering method of monthly 95th percentile	day
ElasticQps	long	The burstable QPS. Unit: QPS	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E3A9B5F-5DDB-593D-A1E6-F1F451DB5E0B",
  "InstanceSpecs": [
    {
      "BaseBandwidth": 30,
      "QpsLimit": 3000,
      "BandwidthMbps": 100,
      "ElasticBw": 300,
      "DefenseCount": 2,
      "SiteLimit": 5,
      "PortLimit": 50,
      "ElasticBandwidth": 30,
      "FunctionVersion": "default",
      "InstanceId": "ddoscoo-cn-zvp2eibz****",
      "DomainLimit": 50,
      "ElasticBwModel": "day",
      "CpsLimit": 5000,
      "ConnLimit": 100000,
      "RealLimitBw": 0,
      "ElasticQpsMode": "day",
      "ElasticQps": 10
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-05-17	The response structure of the API has changed	View Change Details
2023-04-04	The response structure of the API has changed	View Change Details