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.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| hdm:CreateSqlLogTask | create | *All Resources * |
| 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-uf6k5f6g3912i0dqz |
| Type | string | No | The type of the task. Valid values:
| Export |
| Name | string | No | The name of the task. | test01 |
| Filters | array<object> | No | The filter conditions. | |
| Item | 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 | long | No | The beginning of the time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds. | 1596177993000 |
| EndTime | long | 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 |
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 parameters
Examples
Sample success responses
JSONformat
{
"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 |
|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. |
| 403 | NoPermission | You are not authorized to do this action. |
For a list of error codes, visit the Service error codes.