All Products
Search
Document Center

Anti-DDoS:DescribeDefenseRecords

Last Updated:Oct 23, 2024

Queries the advanced mitigation logs of Anti-DDoS Premium.

Operation description

Note This operation is suitable only for Anti-DDoS Premium.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-ddoscoo:DescribeDefenseRecordsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

default
InstanceIdstringNo

The ID of the instance.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
ddoscoo-cn-mp91j1ao****
StartTimelongYes

The beginning of the time range to query. This value is a UNIX timestamp. Units: miliseconds.

Note The time must be in the latest 90 days.
1582992000000
EndTimelongYes

The end of the time range to query. This value is a UNIX timestamp. Units: miliseconds.

Note The time must be in the latest 90 days.
1583683200000
PageNumberintegerYes

The number of the page to return. For example, to query the returned results on the first page, set the value to 1.

1
PageSizeintegerYes

The number of entries to return on each page. Maximum value: 50.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountlong

The total number of advanced mitigation sessions.

1
RequestIdstring

The ID of the request.

0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc
DefenseRecordsarray<object>

An array that consists of details of the log of an advanced mitigation session.

DefenseRecordobject
EndTimelong

The end time of the advanced mitigation session. This value is a UNIX timestamp. Units: miliseconds.

1583683200000
Statusinteger

The status of the advanced mitigation session. Valid values:

  • 0: The advanced mitigation session is being used.
  • 1: The advanced mitigation session is used.
0
StartTimelong

The start time of the advanced mitigation session. This value is a UNIX timestamp. Units: miliseconds.

1582992000000
EventCountinteger

The number of attacks.

2
InstanceIdstring

The ID of the instance.

ddoscoo-cn-mp91j1ao****
AttackPeaklong

The peak attack traffic. Unit: bit/s.

6584186000

Examples

Sample success responses

JSONformat

{
  "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

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