ListDBTaskSQLJobDetail - Data Management - Alibaba Cloud Documentation Center

Queries the details of an SQL task.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListDBTaskSQLJobDetail	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobId	long	Yes	The ID of the SQL task. You can call the ListDBTaskSQLJob operation to query the SQL task ID.	1276****
PageNumber	long	No	The number of the page to return.	1
PageSize	long	No	The number of entries to return on each page.	20
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	3F044E33-FE09-58F1-8C61-A0F612EC****
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
ErrorMessage	string	The error message that is returned.	JobId is mandatory for this action.
ErrorCode	string	The error code that is returned.	MissingJobId
DBTaskSQLJobDetailList	object []	The details of SQL tasks.
JobDetailId	long	The ID of the details of the SQL task.	24723****
CurrentSql	string	The SQL statement that was executed in the SQL task.	update a set id = 1 where id = 1;
ExecuteCount	long	The number of times that the SQL statement was executed.	1
JobId	long	The ID of the SQL task.	1276****
DbId	long	The ID of the physical database.	1988****
Logic	boolean	Indicates whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is a physical database.	false
Skip	boolean	Indicates whether the SQL statement was skipped. Valid values: true: The SQL statement was skipped. false: The SQL statement was not skipped.	false
SqlType	string	The type of the SQL statement, such as DELETE, UPDATE, or ALTER_TABLE.	CREATE_TABLE
Status	string	The status 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
Log	string	The details of the operational log.	log_info
StartTime	string	The point in time when the SQL task started.	2021-12-16 00:00:00
EndTime	string	The point in time when the SQL task ended.	2021-12-16 00:00:01
TimeDelay	long	The duration of the SQL task. Unit: milliseconds.	38
AffectRows	long	The number of rows affected by the SQL task.	0
TotalCount	long	The total number of SQL tasks.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "3F044E33-FE09-58F1-8C61-A0F612EC****",
  "Success": true,
  "ErrorMessage": "JobId is mandatory for this action.",
  "ErrorCode": "MissingJobId",
  "DBTaskSQLJobDetailList": [
    {
      "JobDetailId": 0,
      "CurrentSql": "update a set id = 1 where id  = 1;",
      "ExecuteCount": 1,
      "JobId": 0,
      "DbId": 0,
      "Logic": false,
      "Skip": false,
      "SqlType": "CREATE_TABLE",
      "Status": "SUCCESS",
      "Log": "log_info",
      "StartTime": "2021-12-16 00:00:00",
      "EndTime": "2021-12-16 00:00:01",
      "TimeDelay": 38,
      "AffectRows": 0
    }
  ],
  "TotalCount": 1
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history