DescribeOpEntities - Anti-DDoS - Alibaba Cloud Documentation Center

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

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-antiddosbag:DescribeOpEntities	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	Yes	The operation that you want to perform. Set the value to DescribeOpEntities.	1
PageSize	integer	Yes	The type of the operation object. The value is fixed as 1, which indicates Anti-DDoS Origin instances.	10
StartTime	long	Yes	The sorting method of operation logs. Set the value to opdate, which indicates sorting based on the operation time.	1609430400000
EndTime	long	Yes	The details of the operation log.	1640880000000
OrderBy	string	No	The sort order of operation logs. Valid values: ASC: the ascending order. DESC: the descending order.	opdate
OrderDir	string	No	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.	ASC
InstanceId	string	No	The page number of the returned page.	ddosbgp-cn-n6w1r7nz****
ResourceGroupId	string	No	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.	rg-acfm2pz25js****
RegionId	string	No	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.	cn-hangzhou

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.

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The time when the log was generated. This value is a UNIX timestamp. Unit: milliseconds.	1
RequestId	string	The end time. Operation logs that were generated before this time are queried.**** This value is a UNIX timestamp. Unit: milliseconds.	52C8ECB0-0B1A-4E66-A31C-B6A855120E82
OpEntities	object []	The ID of the request.
EntityType	integer	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.	1
EntityObject	string	Queries the operation logs of an Anti-DDoS Origin instance.	ddosbgp-cn-n6w1r7nz****
OpAction	integer	DescribeOpEntities	8
GmtCreate	long	WB01342967	1635818114000

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.