Get Anti-DDoS Advance instance List

Last updated: 2019-05-07 10:24:37

API Description

This API (BGPIPGetServicePacks) is used to get a list of all Anti-DDoS Advanced instances owned by the user.
Protocol: HTTPS
Domain Name: bgpip.api.qcloud.com
API: BGPIPGetServicePacks

Request Parameters

The following request parameter list only provides the API-specific request parameters. Common request parameters are required when the API is called. For more information, see Common Request Parameters. The Action field of this API is BGPIPGetServicePacks.

Parameter Required Type Description
filtering. name No String Search by the name of the Anti-DDoS Advanced instance. Fuzzy search is supported.
filtering.ip No String Search by the IP of the Anti-DDoS Advance instance. Fuzzy search is supported.
line No Integer Line type
1: BGP
2: China Mobile/China Union/China Telecom
sorting.field No String Sort by field:
bandwidth: Sort by bandwidth
overloadCount: Sort by the number of times the peak value is exceeded
sorting.order No String Sort in order:
asc: Sort in ascending order
desc: Sort in descending order
paging.index Yes Integer Page index
0: page 1
paging.count Yes Integer Number of results per page
region Yes String Region availability.

gz: Guangzhou
sh: Shanghai
bj: Beijing

Response Parameters

Parameter Example Type Description
total 123 Integer Number of Anti-DDoS Advanced instances
records [obj,…] Array Instance details:
{
"id": "bgpip-00000001",
"name": "Service pack 1",
"region": "gz/sh/bj",
"line": "1/2",
"boundIP":
"10.2.3.4",
"bandwidth": 10000,
"elasticLimit" : 100000,
"overloadCount" : 100,
"status":"idle/attacking/blocking/creating",
"expire": "2016-03-02 01:23:45",
"locked": "yes/no"
"transTarget":"qcloud/nqcloud/blackstone/finance",
"transRules": "12"
}
id bgpip-000001 String Resource ID of the Anti-DDoS Advanced instance
name Service pack 1 String Name of the Anti-DDoS Advanced instance
region gz
sh
bj
String Anti-DDoS Advanced Instance location
gz: Guangzhou
sh: Shanghai
bj: Beijing
line 1
2
Integer Line type:
1: BGP
2: China Mobile/China Union/China Telecom
boundIP 10.2.3.4 String IP address of the Anti-DDoS Advanced instance
bandwidth 10000 Integer Unit: Mbps. Base protection bandwidth of the instance
elasticLimit 10000 Integer Unit: Mbps. Upper limit of the elastic protection bandwidth. The Anti-DDoS Advanced IP will be blocked when the limit is exceeded.
overloadCount 100 Integer Number of events that the peak attack volume exceeds the maximum protection bandwidth
status idle
attacking
blocking
creating
isolate
String Status of the Anti-DDoS Advanced IP:
idle: no attack
attacking: the IP is being attacked
blocking: the IP is being blocked
creating: the IP is being restored
isolate: the IP is being isolated
expire 2016-03-02
01:23:45
Time Expiration time of the Anti-DDoS Advanced instance
transTarget qcloud
nqcloud
String Forwarding target IP
qcloud: Inside Tencent Cloud
nqcloud: Outside Tencent Cloud
transRules 12 Integer Number of forwarding rules configured in the instance