ListTaskOperationLogs API Overview - DataWorks - Alibaba Cloud - DataWorks

Operation description

This API operation is available for all DataWorks editions.

Only operation logs generated within the previous 31 days can be queried.

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

dataworks:ListTaskOperationLogs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The task ID.	1234
Date	integer	No	The operation date, accurate to the day. The default value is the current day. You can query only the operation logs generated within the previous 31 days.	1710239005403
ProjectEnv	string	No	The environment of the workspace. Valid values: Prod: production environment Dev: development environment	Prod
PageSize	integer	No	The number of entries per page. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	The pagination information.
OperationLogs	array<object>	The operation logs.
	object
User	string	The account ID of the operator.	1000
CreateTime	integer	The time when the operation log was generated.	1710239005403
OperationSeq	integer	The serial number of the operation.	1111
OperationContent	string	The operation content.	Freeze tasks
TaskId	integer	The ID of the task on which the operation was performed.	1234
TotalCount	integer	The total number of entries returned.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Examples

Success response

JSON format

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "PagingInfo": {
    "OperationLogs": [
      {
        "User": "1000",
        "CreateTime": 1710239005403,
        "OperationSeq": 1111,
        "OperationContent": "Freeze tasks",
        "TaskId": 1234
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.