DescribeDefenseRecords - Anti-DDoS - Alibaba Cloud Documentation Center

Operation description

Note

This API operation is available only for the Anti-DDoS Premium service.

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-ddoscoo:DescribeDefenseRecords

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS instance belongs. If you leave this parameter empty, the instance belongs to the default resource group.	default
InstanceId	string	No	The ID of the Anti-DDoS instance. Note Call DescribeInstanceIds to query the IDs of all Anti-DDoS instances.	ddoscoo-cn-mp91j1ao****
StartTime	integer	Yes	The beginning of the time range to query. This is a UNIX timestamp. Unit: milliseconds. Note The time span of the query cannot exceed 90 days.	1582992000000
EndTime	integer	Yes	The end of the time range to query. This is a UNIX timestamp. Unit: milliseconds. Note The time span of the query cannot exceed 90 days.	1583683200000
PageNumber	integer	Yes	The number of the page to return. For example, to query the first page, set this parameter to 1.	1
PageSize	integer	Yes	The number of entries to return on each page. Maximum value: 50.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of advanced mitigation records.	1
RequestId	string	The ID of the request.	0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc
DefenseRecords	array<object>	The advanced mitigation logs.
	object
EndTime	integer	The end time of the mitigation. This is a UNIX timestamp. Unit: milliseconds.	1583683200000
Status	integer	The status of advanced mitigation. Valid values: 0: in use 1: ended	0
StartTime	integer	The start time of the mitigation. This is a UNIX timestamp. Unit: milliseconds.	1582992000000
EventCount	integer	The number of attacks.	2
InstanceId	string	The ID of the Anti-DDoS instance.	ddoscoo-cn-mp91j1ao****
AttackPeak	integer	The peak attack throughput. Unit: bps.	6584186000

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
  "DefenseRecords": [
    {
      "EndTime": 1583683200000,
      "Status": 0,
      "StartTime": 1582992000000,
      "EventCount": 2,
      "InstanceId": "ddoscoo-cn-mp91j1ao****",
      "AttackPeak": 6584186000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.