Save Advanced Query Records with CreateAdvancedQueryHistory - ActionTrail - Alibaba Cloud - ActionTrail

Operation description

This topic provides a demo of how to save a query conditional statement as an advanced event query history record. The query statement is used to query all AccessKey access management events in logs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

actiontrail:CreateAdvancedQueryHistory

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QuerySql	string	No	The query conditional statement. You can edit the query statement based on the SQL syntax for advanced event queries.	event.userIdentity.accessKeyId: *
SimpleQuery	boolean	Yes	Specifies whether to enable the simple query mode.	false
DryRun	boolean	No	Specifies whether to perform only a dry run. If this parameter is set to true, the system only checks the access link required for creating the query history record without actually creating it. If this parameter is set to false or is not specified, the query history record is created. Default value: false.	false

Response elements

Element	Type	Description	Example
	object
QueryId	string	The ID of the advanced event query record.	query-uIkIvLiVSuCKqg0yoa****
QuerySql	string	The advanced event query statement.	event.userIdentity.accessKeyId: *
RequestId	string	The request ID.	D0227506-AA8C-5998-8A62-74769106****
SimpleQuery	boolean	Specifies whether to enable the simple query mode.	false
DryRunResult	string	The dry run result. The value Passed is returned only when DryRun is set to true and the dry run passes. This parameter is not returned when a query history record is created.	Passed

Examples

Success response

JSON format

{
  "QueryId": "query-uIkIvLiVSuCKqg0yoa****",
  "QuerySql": "event.userIdentity.accessKeyId: *",
  "RequestId": "D0227506-AA8C-5998-8A62-74769106****",
  "SimpleQuery": false,
  "DryRunResult": "Passed"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.