DescribeInstanceSpecs - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the specifications of a specific Anti-DDoS Origin Enterprise instance.

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.

debugging

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-antiddosbag:DescribeInstanceSpecs	Read	DdosBgp acs:yundun-antiddosbag:{#regionId}:{#accountId}:*	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceIdList	string	Yes	The ID of the Anti-DDoS Origin Enterprise instance. This parameter value is a string consisting of JSON arrays. Each element in a JSON array indicates an instance ID. If you want to query more than one instance, separate instance IDs with commas (,). Note You can call the DescribeInstanceList operation to query the IDs of all Anti-DDoS Origin Enterprise instances in a specific region.	["ddosbgp-cn-n6w1r7nz****"]
RegionId	string	No	The region ID of the Anti-DDoS Origin Enterprise instance. Default value: cn-hangzhou, which indicates the China (Hangzhou) region. Note If your instance does not reside in the China (Hangzhou) region, you must specify this parameter to the region ID of your instance. You can call the DescribeRegions operation to query the regions of cloud assets that are supported by an Anti-DDoS Origin instance.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS Origin Enterprise instance belongs in Resource Management. This parameter is empty by default, which indicates that the Anti-DDoS Origin Enterprise instance belongs to the default resource group. For more information about resource groups, see Create a resource group.	rg-acfm2pz25js****

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.	5840AB9F-1419-4620-807D-5EA476090247
InstanceSpecs	object []	The specifications of the Anti-DDoS Origin Enterprise instance, including whether the unlimited protection feature is enabled, and the numbers of times that the unlimited protection feature can be enabled and has been enabled.
IsFullDefenseMode	integer	Indicates whether the unlimited protection feature is enabled. Valid values: 0: The unlimited protection feature is disabled. 1: The unlimited protection feature is enabled.	1
Region	string	The region ID of the Anti-DDoS Origin Enterprise instance. Note You can call the DescribeRegions operation to query the name of the region.	cn-hangzhou
AvailableDefenseTimes	integer	The number of times that the unlimited protection feature can be enabled.	2
TotalDefenseTimes	integer	The number of times that the unlimited protection feature can be enabled.	2
AvailableDeleteBlackholeCount	string	The number of times that blackhole filtering can be deactivated.	100
InstanceId	string	The ID of the Anti-DDoS Origin Enterprise instance.	ddosbgp-cn-n6w1r7nz****
PackConfig	object	The configurations of the Anti-DDoS Origin Enterprise instance, including the number of protected IP addresses and protection bandwidth.
PackBasicThre	integer	The basic protection bandwidth of the Anti-DDoS Origin Enterprise instance. Unit: Gbit/s.	20
BindIpCount	integer	The number of IP addresses that are protected by the Anti-DDoS Origin Enterprise instance.	0
PackAdvThre	integer	The burstable protection bandwidth of the Anti-DDoS Origin Enterprise instance. Unit: Gbit/s.	300
NormalBandwidth	integer	The normal clean bandwidth. Unit: Mbit/s.	200
IpBasicThre	integer	The basic bandwidth of each protected IP address. Unit: Gbit/s.	20
IpAdvanceThre	integer	The burstable bandwidth of each protected IP address. Unit: Gbit/s.	300
IpSpec	integer	The number of IP addresses that can be protected by the Anti-DDoS Origin Enterprise instance.	100
Bandwidth	long	The bandwidth of the package configuration.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "5840AB9F-1419-4620-807D-5EA476090247",
  "InstanceSpecs": [
    {
      "IsFullDefenseMode": 1,
      "Region": "cn-hangzhou",
      "AvailableDefenseTimes": 2,
      "TotalDefenseTimes": 2,
      "AvailableDeleteBlackholeCount": "100",
      "InstanceId": "ddosbgp-cn-n6w1r7nz****",
      "PackConfig": {
        "PackBasicThre": 20,
        "BindIpCount": 0,
        "PackAdvThre": 300,
        "NormalBandwidth": 200,
        "IpBasicThre": 20,
        "IpAdvanceThre": 300,
        "IpSpec": 100,
        "Bandwidth": 2
      }
    }
  ]
}

Error codes

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