Queries the specifications of Anti-DDoS Origin Enterprise instances.

Note Anti-DDoS Origin API operations are available for only Anti-DDoS Origin Enterprise users.

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.

InstanceIdList String Yes ["ddosbgp-cn-x1","ddosbgp-cn-x2"]

The IDs of Anti-DDoS instances to query. If you want to query multiple instances, separate the IDs with commas (,). The parameter must be passed to the API operation in the JSON format, for example, ["ddosbgp-cn-x1","ddosbgp-cn-x2"].

DdosRegionId String No cn-hangzhou

The ID of the region where Anti-DDoS Origin Enterprise instances reside.

ResourceGroupId String No test

The ID of the resource group.

Response parameters

Parameter Type Example Description
InstanceSpecs

The list of Anti-DDoS Origin Enterprise instances and the specifications of each instance.

AvailableDeleteBlackholeCount String 100

The number of times that you can deactivate a black hole.

InstanceId String ddosbgp-cn-x1

The ID of an Anti-DDoS Origin Enterprise instance.

PackConfig

The configuration information of the Anti-DDoS Origin Enterprise instance.

BindIpCount Integer 0

The number of IP addresses that are protected by the Anti-DDoS Origin Enterprise instance.

IpAdvanceThre Integer 101

The threshold of elastic protection for the specified IP addresses. Unit: Gbit/s.

IpBasicThre Integer 20

The threshold of basic protection for the specified IP addresses. Unit: Gbit/s.

IpSpec Integer 100

The maximum number of IP addresses that you can add to the Anti-DDoS Origin Enterprise instance.

PackAdvThre Integer 100

The bandwidth of elastic protection. Unit: Gbit/s.

PackBasicThre Integer 200

The bandwidth of basic protection. Unit: Gbit/s.

Region String cn-hangzhou

The ID of the region where the Anti-DDoS Origin Enterprise instance resides.

RequestId String CEB7F4F5-1DA8-41ED-A9C4-E0F0033E9E1F

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeInstanceSpecs
&InstanceIdList=["ddosbgp-cn-x1","ddosbgp-cn-x2"]
& <Common request parameters>

Sample success responses

XML format

<DescribeInstanceSpecsResponse>
     <InstanceSpecs>
           <InstanceSpec>
                 <Region>cn-hangzhou</Region>
                 <InstanceId>ddosbgp-cn-x1</InstanceId>
                 <AvailableDeleteBlackholeCount>100</AvailableDeleteBlackholeCount>
                 <PackConfig>
                       <IpBasicThre>20</IpBasicThre>
                       <BindIpCount>0</BindIpCount>
                       <PackBasicThre>20</PackBasicThre>
                       <IpAdvanceThre>101</IpAdvanceThre>
                       <IpSpec>100</IpSpec>
                       <PackAdvThre>101</PackAdvThre>
                 </PackConfig>
           </InstanceSpec>
     </InstanceSpecs>
     <RequestId>CEB7F4F5-1DA8-41ED-A9C4-E0F0033E9E1F</RequestId>
</DescribeInstanceSpecsResponse>

JSON format

{
	"InstanceSpecs":[
		{
			"Region":"cn-hangzhou",
			"AvailableDeleteBlackholeCount":100,
			"InstanceId":"ddosbgp-cn-x1",
			"PackConfig":{
				"IpBasicThre":20,
				"BindIpCount":0,
				"PackBasicThre":20,
				"IpAdvanceThre":100,
				"PackAdvThre":101,
				"IpSpec":100
			}
		}
	],
	"RequestId":"D8D786F2-2008-4280-B9AB-8E6C4E8C2A16"
}

Error codes

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