All Products
Search
Document Center

Data Management:GetDataCronClearTaskDetailList

Last Updated:Apr 18, 2024

Queries the details of a historical data cleansing ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
dms:GetDataCronClearTaskDetailListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ID of the ticket. You can query the ticket ID from the response parameters of the CreateDataCronClearOrder operation.

432532
PageNumberlongNo

The number of the page to return.

1
PageSizelongNo

The number of entries to return on each page.

20
TidlongNo

The ID of the tenant.

Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the Manage DMS tenants topic.
12345

Response parameters

ParameterTypeDescriptionExample
object

The object of the response.

RequestIdstring

The ID of the request.

C1D39814-9808-47F8-AFE0-AF167239AC9B
Successboolean

Indicates whether the request was successful.

true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
DataCronClearTaskDetailListobject []

The historical data cleansing tasks

DBTaskGroupIdlong

The ID of the SQL task group.

432523
jobStatusstring

The state of the SQL task. Valid values:

  • INIT: The SQL task was initialized.
  • PENDING: The SQL task waited to be run.
  • BE_SCHEDULED: The SQL task waited to be scheduled.
  • FAIL: The SQL task failed.
  • SUCCESS: The SQL task was successful.
  • PAUSE: The SQL task was paused.
  • DELETE: The SQL task was deleted.
  • RUNNING: The SQL task was being run.
SUCCESS
ActualAffectRowslong

The number of rows affected by the SQL task.

1
CreateTimestring

The time when the SQL task was created.

2021-01-14 10:00:00
TotalCountlong

The total number of SQL tasks.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "C1D39814-9808-47F8-AFE0-AF167239AC9B",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DataCronClearTaskDetailList": [
    {
      "DBTaskGroupId": 432523,
      "jobStatus": "SUCCESS",
      "ActualAffectRows": 1,
      "CreateTime": "2021-01-14 10:00:00"
    }
  ],
  "TotalCount": 1
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history