All Products
Search
Document Center

Anti-DDoS:DescribeOpEntities

Last Updated:Jan 06, 2025

Queries the operation logs of an Anti-DDoS Origin instance.

Operation description

You can call the DescribeOpEntities operation to query the operation logs of an instance by page.

Limit

You can call this operation up to 10 times per second per account. If the number of 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

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-antiddosbag:DescribeOpEntitiesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page. Maximum value: 50.

10
StartTimelongYes

The start time. Operation logs that were generated after this time are queried.**** The value is a UNIX timestamp. Unit: milliseconds.

1609430400000
EndTimelongYes

The end time. Operation logs that were generated before this time are queried.**** The value is a UNIX timestamp. Unit: milliseconds.

1640880000000
OrderBystringNo

The sorting method of operation logs. Set the value to opdate, which indicates sorting based on the operation time.

opdate
OrderDirstringNo

The sort order of operation logs. Valid values:

  • ASC: the ascending order.
  • DESC: the descending order.

Default value: DESC.

ASC
InstanceIdstringNo

The ID of the instance to query.

Note You can call the DescribeInstanceList operation to query the IDs of all instances.
ddosbgp-cn-n6w1r7nz****
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs in Resource Management.

If you do not specify this parameter, the instance belongs to the default resource group.

rg-acfm2pz25js****
RegionIdstringNo

The ID of the region where the instance resides.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
OpActionintegerNo

The type of the operation. Valid values:

  • 3: Add an IP address to the instance.
  • 4: Remove an IP address from the instance.
  • 5: Downgrade the instance.
  • 6: Deactivate blackhole filtering.
  • 7: Reset the number of times that you can deactivate blackhole filtering.
  • 8: Restore the mitigation capability.
  • 9: Add an asset group.
  • 10: Remove an asset group.
  • 11: Enable the metering method of daily 95th percentile for the burstable clean bandwidth feature.
  • 12: Enable the metering method of monthly 95th percentile for the burstable clean bandwidth feature.
  • 13: Periodically switch between the metering methods of daily 95th percentile and monthly 95th percentile for the burstable clean bandwidth feature.
  • 14: Disable the metering method of daily 95th percentile for the burstable clean bandwidth feature.
  • 15: Disable the metering method of monthly 95th percentile for the burstable clean bandwidth feature.
  • 16: Disable burstable clean bandwidth due to overdue payments.
  • 17: Disable burstable clean bandwidth due to instance expiration.
3

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

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of operation logs.

1
RequestIdstring

The ID of the request.

52C8ECB0-0B1A-4E66-A31C-B6A855120E82
OpEntitiesarray<object>

The details of the operation log.

OpEntityobject

The operation object.

EntityTypeinteger

The type of the operation object. The value is fixed as 1, which indicates Anti-DDoS Origin instances.

1
EntityObjectstring

The operation object, which is the ID of the instance.

ddosbgp-cn-n6w1r7nz****
OpActioninteger

The type of operation. Valid values:

  • 3: indicates an operation to add an IP address to the Anti-DDoS Origin instance for protection.
  • 4: indicates an operation to remove a protected IP address from the Anti-DDoS Origin instance.
  • 5: indicates an operation to downgrade the Anti-DDoS Origin instance.
  • 6: indicates an operation to deactivate blackhole filtering for an IP address.
  • 7: indicates an operation to reset the number of times that you can deactivate blackhole filtering.
  • 8: indicates an operation to enable burstable protection.
8
GmtCreatelong

The time when the log was generated. The value is a UNIX timestamp. Unit: milliseconds.

1635818114000
OpAccountstring

The ID of the Alibaba Cloud account that performs the operation.

Note If the value is system, the operation is performed by Anti-DDoS Origin.
171986973287****
OpDescstring

The details of the operation. The value is a string that consists of a JSON struct. The JSON struct contains the following fields:

  • entity: the operation object. Data type: object. The fields that are included in the value of the entity parameter vary based on the value of the OpAction parameter. Valid values:

    • If the value of the OpAction parameter is 3, the value of the entity parameter consists of the following field:

      • ips: the public IP addresses that are protected by the Anti-DDoS Origin instance. Data type: array
    • If the value of the OpAction parameter is 4, the value of the entity parameter consists of the following field:

      • ips: the public IP addresses that are no longer protected by the Anti-DDoS Origin instance. Data type: array.
    • If the value of the OpAction parameter is 5, the value of the entity parameter consists of the following fields:

      • baseBandwidth: the basic protection bandwidth. Unit: Gbit/s. Data type: integer.
      • elasticBandwidth: the burstable protection bandwidth. Unit: Gbit/s. Data type: integer.
      • opSource: the source of the operation. The value is fixed as 1, indicating that the operation is performed by Anti-DDoS Origin. Data type: integer.
    • If the value of the OpAction parameter is 6, the value of the entity parameter consists of the following field:

      • ips: the public IP addresses for which to deactivate blackhole filtering. Data type: array.
    • If the value of the OpAction parameter is 7, the entity parameter is not returned.

    • If the value of the OpAction parameter is 8, the value of the entity parameter consists of the following fields:

      • baseBandwidth: the basic protection bandwidth. Unit: Gbit/s. Data type: integer.
      • elasticBandwidth: the burstable protection bandwidth. Unit: Gbit/s. Data type: integer.
{"entity":{"baseBandwidth":20,"elasticBandwidth":20}}

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "52C8ECB0-0B1A-4E66-A31C-B6A855120E82",
  "OpEntities": [
    {
      "EntityType": 1,
      "EntityObject": "ddosbgp-cn-n6w1r7nz****",
      "OpAction": 8,
      "GmtCreate": 1635818114000,
      "OpAccount": "171986973287****",
      "OpDesc": "{\"entity\":{\"baseBandwidth\":20,\"elasticBandwidth\":20}}"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-12-11API Description UpdateView Change Details
2024-11-14The request parameters of the API has changedView Change Details