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

Usage notes

You can call the DescribeOpEntities operation to query the operation logs of an Anti-DDoS Origin instance by page.

Limits

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeOpEntities

The operation that you want to perform. Set the value to DescribeOpEntities.

CurrentPage Integer Yes 1

The page number of the returned page.

PageSize Integer Yes 10

The number of entries to return on each page.

StartTime Long Yes 1609430400000

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

EndTime Long Yes 1640880000000

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

OrderBy String No opdate

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

OrderDir String No ASC

The sort order of operation logs. Valid values:

  • ASC: the ascending order.
  • DESC: the descending order.
InstanceId String No ddosbgp-cn-n6w1r7nz****

The ID of the Anti-DDoS Origin instance to query.

Note You can call the DescribeInstanceList operation to query the IDs of all Anti-DDoS Origin instances.
ResourceGroupId String No rg-acfm2pz25js****

The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management.

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

RegionId String No cn-hangzhou

The ID of the region where the Anti-DDoS Origin instance resides.

Note You can call the DescribeRegions operation to query the most recent region list.

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
TotalCount Integer 1

The total number of operation logs.

RequestId String 52C8ECB0-0B1A-4E66-A31C-B6A855120E82

The ID of the request.

OpEntities Array of OpEntity

The details of the operation log.

EntityType Integer 1

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

EntityObject String ddosbgp-cn-n6w1r7nz****

The operation object, which is the ID of the Anti-DDoS Origin instance.

OpAction Integer 8

The type of the 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.
GmtCreate Long 1635818114000

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

OpAccount String 171986973287****

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.
OpDesc String {"entity":{"baseBandwidth":20,"elasticBandwidth":20}}

The details about 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. Take note of the following items:
    • 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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeOpEntities
&CurrentPage=1
&PageSize=10
&StartTime=1609430400000
&EndTime=1640880000000
&OrderBy=opdate
&OrderDir=ASC
&InstanceId=ddosbgp-cn-n6w1r7nz****
&ResourceGroupId=rg-acfm2pz25js****
&RegionId=cn-hangzhou
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 Error Center.