Queries the download link to the traffic data that is captured when a DDoS attack event occurs.
Usage notes
You can call the DescribeCap operation to query the download link to the traffic data that is captured when a DDoS attack event occurs. You can download the traffic data from the download link and use the data as evidence.
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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCap |
The operation that you want to perform. Set the value to DescribeCap. |
DdosRegionId | String | Yes | cn-hangzhou |
The region ID of the asset that is under DDoS attacks. The asset can be an elastic IP address (EIP). The asset can also be an Elastic Compute Service (ECS) instance or Server Load Balancer (SLB) instance that is assigned a public IP address. Note You can call the DescribeRegions operation to query the most recent region list.
|
InstanceType | String | Yes | ecs |
The type of the asset that is under DDoS attacks. Valid values:
|
InstanceId | String | Yes | i-bp10bclrt56fblts**** |
The ID of the asset that is under DDoS attacks.. Note You can call the DescribeInstance operation to query the IDs of ECS instances, SLB instances, and EIPs within the current
Alibaba Cloud account.
|
BegTime | Long | Yes | 1637812279000 |
The start time of the DDoS attack event. This value is a UNIX timestamp. Unit: milliseconds. Note You can call the DescribeDdosEventList operation to query the start time of each DDoS attack event that occurred on an asset.
|
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 | 57CD0774-47FE-52C4-866D-1E65122662BF |
The ID of the request. |
CapUrl | Object |
The download link to the traffic data that is captured when a DDoS attack event occurs.. |
|
Url | String | http://beaver-pack****.oss-cn-hangzhou.aliyuncs.com/ddos-2021112511-121.89.XX.XX.cap?Expires=1637824408&OSSAccessKeyId=LTAIXu2lJhw3****&Signature=KKSzOMSUajtwcqfqxkU1nK69d4**** |
The download link to the traffic data. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeCap
&DdosRegionId=cn-hangzhou
&InstanceType=ecs
&InstanceId=i-bp10bclrt56fblts****
&BegTime=1637812279000
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeCapResponse>
<RequestId>57CD0774-47FE-52C4-866D-1E65122662BF</RequestId>
<CapUrl>
<Url>http://beaver-pack****.oss-cn-hangzhou.aliyuncs.com/ddos-2021112511-121.89.XX.XX.cap?Expires=1637824408&OSSAccessKeyId=LTAIXu2lJhw3****&Signature=KKSzOMSUajtwcqfqxkU1nK69d4****</Url>
</CapUrl>
</DescribeCapResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "57CD0774-47FE-52C4-866D-1E65122662BF",
"CapUrl" : {
"Url" : "http://beaver-pack****.oss-cn-hangzhou.aliyuncs.com/ddos-2021112511-121.89.XX.XX.cap?Expires=1637824408&OSSAccessKeyId=LTAIXu2lJhw3****&Signature=KKSzOMSUajtwcqfqxkU1nK69d4****"
}
}
Error codes
For a list of error codes, visit the API Error Center.