DescribeOpEntities - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the operation logs of Anti-DDoS Proxy (Chinese Mainland).

Operation description

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

You can query operations performed on Anti-DDoS Pro, such as configuring burstable protection bandwidth, deactivating blackhole filtering, configuring the Diversion from Origin Server policy, using Anti-DDoS plans, changing the IP addresses of Elastic Compute Service (ECS) instances, and clearing all logs.

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.

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-ddoscoo:DescribeOpEntities	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	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
EntityType	integer	No	The type of the operation object that you want to query. Valid values: 1: the IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance 2: Anti-DDoS plans 3: ECS instances 4: all logs	1
EntityObject	string	No	The operation object that you want to query.	203.*.*.132
StartTime	long	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: milliseconds. Note The time must be in the latest 30 days.	1582992000000
EndTime	long	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: milliseconds. Note The time must be in the latest 30 days.	1583683200000
PageNumber	integer	Yes	The number of the page to return. For example, to query the returned results on the first page, set the value to 1.	1
PageSize	integer	Yes	The number of entries to return on each page. Maximum value: 50.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of returned operation records.	1
RequestId	string	The ID of the request.	FB24D70C-71F5-4000-8CD8-22CDA0C53CD1
OpEntities	array<object>	An array that consists of the details of the operation log.
OpEntity	object
EntityType	integer	The type of the operation object. Valid values: 1: the IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance 2: Anti-DDoS plans 3: ECS instances 4: all logs	1
EntityObject	string	The operation object.	203.*.*.132
GmtCreate	long	The time when the operation was performed. The value is a UNIX timestamp. Unit: milliseconds.	1584451769000
OpAction	integer	The type of the operation. Valid values: 1: configuring burstable protection bandwidth. 5: using Anti-DDoS plans. 8: changing IP addresses of ECS instances. 9: deactivating blackhole filtering. 10: configuring the Diversion from Origin Server policy. 11: clearing all logs. 12: downgrading the specifications of instances. If the instance expires or the account has overdue payments, this operation is performed to downgrade the burstable protection bandwidth. 13: restoring the specifications of instances. If the instance is renewed or you have paid the overdue payments within your account, this operation is performed to restore the burstable protection bandwidth.	9
OpAccount	string	The ID of the Alibaba Cloud account that is used to call the API operation.	128965410602****
OpDesc	string	The details of the operation. This parameter is a JSON string. The string contains the following fields: newEntity: the values of the parameters after the operation. This field must be of the STRING type. oldEntity: the values of the parameters before the operation. This field must be of the STRING type. Both newEntity and oldEntity are JSON strings. The returned parameters vary with OpAtion. If OpAction is 1, 12, or 13, the following parameter is returned: elasticBandwidth: the burstable protection bandwidth. The value is of the INTEGER type. For example: `{"newEntity":{"elasticBandwidth":300},"oldEntity":{"elasticBandwidth":300}}` If OpAction is 5, the following parameters are returned: bandwidth: the burstable protection bandwidth. The value is of the INTEGER type. Unit: Gbit/s. count: the number of Anti-DDoS plans. The value is of the INTEGER type. deductCount: the number of used Anti-DDoS plans. The value is of the INTEGER type. expireTime: the expiration time of the Anti-DDoS plans. The value is of the LONG type. The value is a UNIX timestamp. Unit: milliseconds. instanceId: the ID of the instance. The value is of the STRING type. peakFlow: the peak throughput on the instance. The value is of the INTEGER type. Unit: bit/s. For example: `{"newEntity":{"bandwidth":100,"count":4,"deductCount":1,"expireTime":1616299196000,"instanceId":"ddoscoo-cn-v641kpmq**","peakFlow":751427000}}` If OpAction is 8, the following parameter is returned: instanceId: the ID of the ECS instance whose IP address is changed. The value is of the STRING type. For example: `{"newEntity":{"instanceId":"i-wz9h6nc313zptbqn"}}` If OpAction is 9, the following parameter is returned: actionMethod: the operation method. The value is of the STRING type. Valid value: undo, which indicates that you deactivated blackhole filtering. For example: `{"newEntity":{"actionMethod":"undo"}}` If OpAction is 10, the following parameters are returned: actionMethod: the operation method. The value is of the STRING type. Valid values: do: The Diversion from Origin Server policy is enabled. undo: The Diversion from Origin Server policy is disabled. lines: The Internet service provider (ISP) line from which the traffic is blocked. Valid values: ct: China Telecom (International) cut: China Unicom (International) For example: `{"newEntity":{"actionMethod":"undo","lines":["ct"]}}` If OpAction** is 11, no parameter is returned, and the description is empty.	{"newEntity":{"actionMethod":"undo"}}

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "FB24D70C-71F5-4000-8CD8-22CDA0C53CD1",
  "OpEntities": [
    {
      "EntityType": 1,
      "EntityObject": "203.***.***.132",
      "GmtCreate": 1584451769000,
      "OpAction": 9,
      "OpAccount": "128965410602****",
      "OpDesc": "{\"newEntity\":{\"actionMethod\":\"undo\"}}"
    }
  ]
}

Error codes

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