Use CreateSqlLogTask to create an offline task for SQL logs - Database Autonomy Service

Creates an offline task for Database Autonomy Service (DAS) Enterprise Edition.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or DAS SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.
You can create an offline task only for database instances for which DAS Enterprise Edition V2 or V3 is enabled. For more information about the databases and regions that are supported by various versions of DAS Enterprise Edition, see Editions and supported features.

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

hdm:CreateSqlLogTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the database instance.	pc-2ze8g2am97624****
NodeId	string	No	The node ID. Note This parameter is available only for instances that run in a cluster architecture. You can specify this parameter to query the offline tasks of a specific node. By default, if this parameter is not specified, the information about the offline tasks of the primary node is returned.	pi-uf6k5f6g3912i****
Type	string	No	The type of the task. Valid values: Export Query Insight	Export
Name	string	No	The name of the task.	SQL审计导出1
Filters	array<object>	No	The filter conditions.
	object	No
Key	string	No	The name of the filter parameter. Note For more information about the supported filter parameters and their valid values, see the following supplement about the Key parameter.	KeyWords
Value	string	No	The value of the filter parameter.	select
StartTime	integer	No	The beginning of the time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds.	1596177993000
EndTime	integer	No	The end of the time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds.	1608888296000
Role	string	No	The role of the node of the PolarDB-X 2.0 database instance. Valid values: polarx_cn: compute node polarx_dn: data node	polarx_cn

The following list describes the filter parameters that can be used as Key and their valid values:

KeyWords: the keywords. You can specify multiple keywords that are separated by spaces.
LogicalOperator: the logical operation between keywords. Valid values: and and or.
AccountName: the username.
DBName: the database name.
HostAddress: the IP address of the client.
MaxConsume: the maximum amount of time that is consumed. Unit: milliseconds.
MinConsume: the minimum amount of time that is consumed. Unit: milliseconds.
MaxScanRows: the maximum number of rows that are scanned.
MinScanRows: the minimum number of rows that are scanned.
SqlType: the type of the SQL statement. Valid values: select, update, insert, and delete.
State: the execution result. Valid values: 0 and 1. A value of 0 indicates that the SQL statement execution is successful. A value of 1 indicates that the SQL statement fails to be executed.
ThreadId: the thread ID.
SortKey: the name of the column that is used for sorting. Valid values: ScanRows, UpdateRows, Consume, ExecuteTime, ReturnRows, LockTime, Frows, Scnt, CpuTime, and PhysicalRead. A value of ScanRows indicates the number of rows that are scanned. A value of UpdateRows indicates the number of rows that are updated. A value of Consume indicates the duration of the query. A value of ExecuteTime indicates the time when the query was performed. A value of ReturnRows indicates the number of rows that are returned. A value of LockTime indicates the lock wait duration. A value of Frows indicates the number of rows that are pulled by the compute nodes of the PolarDB-X 2.0 database instance. A value of Scnt indicates the number of requests that are sent to the data nodes by the compute nodes of the PolarDB-X 2.0 database instance. A value of CpuTime indicates the CPU execution duration. A value of PhysicalRead indicates the number of physical reads.
SortMethod: the order in which the queried logs are sorted. Valid values: DESC and ASC. A value of DESC indicates the descending order. A value of ASC indicates the ascending order. Default value: DESC.
TraceId: the trace ID of the PolarDB-X 2.0 database instance.
MinRows: the minimum number of rows that are updated.
MaxRows: the maximum number of rows that are updated.
MinScnt: the minimum number of requests that are sent to the data nodes by the compute nodes of the PolarDB-X 2.0 database instance.
MaxScnt: the maximum number of requests that are sent to the data nodes by the compute nodes of the PolarDB-X 2.0 database instance.
TrxId: the transaction ID.
Fail: the error code.
sqlId: the SQL statement ID.
JobId: the ID of the asynchronous task. This parameter is required for querying the return result if DAS Enterprise Edition V0 or V1 is enabled for your database instance.

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, error information such as an error code is returned.	Successful
RequestId	string	The request ID.	83D9D59B-057A-54A9-BFF9-CF2B42F05645
Success	string	Indicates whether the request was successful. Valid values: true false	true
Data	object	The returned data.
TaskId	string	The task ID.	54f8041743ca3a9ac5cb9342d050527c
InstanceId	string	The ID of the database instance.	pc-2ze8g2am97624****
Name	string	The name of the task.	Export_test
Start	integer	The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1596177993000
End	integer	The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1608888296000
Status	string	The state of the task. Valid values: INIT: The task is to be scheduled. RUNNING: The task is running. FAILED: The task failed. CANCELED: The task is canceled. COMPLETED: The task is complete. Note You can view the result of a task that is in the COMPLETED state.	COMPLETED
CreateTime	integer	The time when the task was created. This value is a UNIX timestamp. Unit: milliseconds.	1681363254423

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "83D9D59B-057A-54A9-BFF9-CF2B42F05645",
  "Success": "true",
  "Data": {
    "TaskId": "54f8041743ca3a9ac5cb9342d050527c",
    "InstanceId": "pc-2ze8g2am97624****",
    "Name": "Export_test",
    "Start": 1596177993000,
    "End": 1608888296000,
    "Status": "COMPLETED",
    "CreateTime": 1681363254423
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.