CreateAdvancedQueryHistory

Updated at:

Creates an advanced query history record to save custom query condition statements for reuse and management.

Operation description

This topic provides an example of how to save a query condition statement as an advanced query history record. The query statement is used to query all AccessKey access 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 None

Request parameters

Parameter

Type

Required

Description

Example

QuerySql

string

No

The query condition statement.

You can edit the query statement based on the SQL syntax for advanced 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 you set this parameter to true, the system checks only the access links required to create the query history record and does not create the record. If you set this parameter to false or do not specify this parameter, the system creates the query history record. Default value: false.

false

Response elements

Element

Type

Description

Example

object

QueryId

string

The ID of the advanced query history record.

query-uIkIvLiVSuCKqg0yoa****

QuerySql

string

The advanced 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. This parameter is returned and set to Passed only when DryRun is set to true and the dry run is successful. 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.