All Products
Search
Document Center

Database Autonomy Service:DescribeSqlLogTasks

更新時間:Dec 23, 2024

Queries the audit log tasks of a database instance.

Operation description

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

  • If you use an Alibaba Cloud SDK or a 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.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
hdm:DescribeSqlLogTaskslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

The ID of the database instance.

r-bp1nti25tc7bq5****
NodeIdstringNo

The node ID.

Note This parameter is available only for instances that are deployed in the cluster architecture. You can specify this parameter to query the tasks of a specific node. If this parameter is not specified, the tasks of the primary node are returned by default.
pi-bp1o58x3ib7e6z496
Filtersarray<object>No

The filter parameters.

ItemobjectNo
KeystringNo

The name of the filter parameter.

Note For more information about the filter parameters, see the Valid values of Key section of this topic.
delimiter
ValuestringNo

The value of the filter parameter.

,
StartTimelongNo

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
EndTimelongNo

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
PageNointegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 10.

10

Supported parameters and values for Key:

  • taskId: the task ID.
  • keyWords: the task name.
  • status: the task state. Valid values: INIT, RUNNING, FAILED, CANCELED, and COMPLETED.

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The response code.

200
Messagestring

The returned message.

Note If the request was successful, Successful is returned. If the request failed, an error message is returned.
Successful
RequestIdstring

The request ID.

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Dataobject

The data returned.

Listarray<object>

The details of the data returned.

Listobject
TaskIdstring

The task ID.

9a4f5c4494dbd6713185d87a97aa53e8
InstanceIdstring

The ID of the database instance.

rm-2zew761kf7ho18752
Namestring

The task name.

test01
Startlong

The time when the task started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1683859555482
Endlong

The time when the task ended. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1705975320000
Statusstring

The task state. 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 If a task is in the COMPLETED state, you can view the results of the task.
RUNNING
LogCountlong

The number of log records.

99999
Progressinteger

The task progress.

100
ScanFileSizelong

The number of files that are scanned.

3000
Expireboolean

Indicates whether the task expired. Valid values:

  • true
  • false
false
CreateTimelong

The time when the task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1681363254423
AnalysisTaskFinishTimelong

The time when the analysis task was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1712751923000
AnalysisTaskStatusstring

The state of the analysis task.

Note This parameter is a system parameter. You do not need to pay attention to the parameter.
SCAN_ANALYZE_COMPLETED
Resultstring

The URL that is returned if the value of TaskType is Export.

https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la
TaskTypestring

The task type. Valid values:

  • Export
  • Query
Export
Filtersarray<object>

The filter parameters.

Filterobject
Keystring

The name of the filter parameter.

Note For more information about the filter parameters, see the Valid values of Key section of this topic.
delimiter
Valuestring

The value of the filter parameter.

,
Totallong

The number of tasks.

40
PageNolong

The page number.

1
PageSizelong

The number of entries per page.

10

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "List": [
      {
        "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8",
        "InstanceId": "rm-2zew761kf7ho18752",
        "Name": "test01",
        "Start": 1683859555482,
        "End": 1705975320000,
        "Status": "RUNNING",
        "LogCount": 99999,
        "Progress": 100,
        "ScanFileSize": 3000,
        "Expire": false,
        "CreateTime": 1681363254423,
        "AnalysisTaskFinishTime": 1712751923000,
        "AnalysisTaskStatus": "SCAN_ANALYZE_COMPLETED",
        "Result": "https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la",
        "TaskType": "Export",
        "Filters": [
          {
            "Key": "delimiter",
            "Value": ","
          }
        ]
      }
    ],
    "Total": 40,
    "PageNo": 1,
    "PageSize": 10
  }
}

Error codes

HTTP status codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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