GetDataCronClearTaskDetailList API Reference - Data Management - Alibaba Cloud - Data Management

Retrieves task details for a historical data cleansing ticket.

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

dms:GetDataCronClearTaskDetailList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ticket ID. You can obtain this ID from the response of the CreateDataCronClearOrder operation.	432532
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	20
Tid	integer	No	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 elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	C1D39814-9808-47F8-AFE0-AF167239AC9B
Success	boolean	Indicates whether the request was successful.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
DataCronClearTaskDetailList	array<object>	The list of historical data cleansing tasks.
	object	The execution details of each task.
DBTaskGroupId	integer	The ID of the SQL task group.	432523
jobStatus	string	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
ActualAffectRows	integer	The number of rows affected by the SQL task.	1
CreateTime	string	The time when the SQL task was created.	2021-01-14 10:00:00
TotalCount	integer	The total number of SQL tasks.	1

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.