DescribeCap - Anti-DDoS - Alibaba Cloud Documentation Center

Operation description

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-ddos:DescribeCap

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DdosRegionId	string	Yes	The region ID of the asset that is under DDoS attacks. The asset is assigned a public IP address. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
InstanceType	string	Yes	The type of the asset that is under DDoS attacks. The asset is assigned a public IP address. Valid values: ecs: an Elastic Compute Service (ECS) instance. slb: a Server Load Balancer (SLB) instance. eip: an elastic IP address (EIP). ipv6: an IPv6 gateway. swas: a simple application server. waf: a Web Application Firewall (WAF) instance of the Exclusive edition. ga_basic: a Global Accelerator (GA) instance.	ecs
InstanceId	string	Yes	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.	i-bp10bclrt56fblts****
BegTime	integer	Yes	The start time of the DDoS attack event. The 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.	1637812279000
InternetIp	string	No	The public IP address of the asset that is under DDoS attacks.	121.199.XX.XX

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	C728D7E9-9A39-52E0-966B-5C33118BDBB0
CapUrl	object	The download link to the traffic data that is captured when a DDoS attack event occurs.
Url	string	The download link to the traffic data.	http://beaver-pack**.oss-cn-hangzhou.aliyuncs.com/ddos-2021-121.89.XX.XX.cap?Expires=1637&OSSAccessKeyId=LTAI************&Signature=****

Examples

Success response

JSON format

{
  "RequestId": "C728D7E9-9A39-52E0-966B-5C33118BDBB0",
  "CapUrl": {
    "Url": "http://beaver-pack****.oss-cn-hangzhou.aliyuncs.com/ddos-2021****-121.89.XX.XX.cap?Expires=1637****&OSSAccessKeyId=LTAI****************&Signature=******"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.