ListCrawlerRuns-DataWorks(DataWorks)-阿里云帮助中心

Operation description

Scenarios

Queries the run records of a specified metadata crawler within the last 30 days by paging, with optional filtering by run start time and status.

Recommended workflow

Invoke ListCrawlers to obtain the crawler ID.
Invoke this operation to query run records and node instance IDs.
For asynchronous operations such as running or stopping, use the final status returned by this operation as the source of truth.

Edition requirements

DataWorks Basic Edition or a higher edition is required.

Precautions

If no time range is specified, the system queries records from the last 30 days by default.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the metadata crawler. You can call ListCrawlers to obtain the ID.	1234
StartTimeFrom	integer	No	The lower bound of the run start time, in millisecond-level UNIX timestamp. The value must be within the last 30 days. If not specified, the default value is 30 days before the current time.	1710239005403
StartTimeTo	integer	No	The upper bound of the run start time, in millisecond-level UNIX timestamp. The value must be within the last 30 days. If not specified, the default value is the current time.	1710325405403
Status	string	No	The run status. Valid values: WAITING, RUNNING, SUCCESS, ERROR, SHUTDOWN.	SUCCESS
PageNumber	integer	No	The page number. Pages start from 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 100.	20

StartTimeFrom and StartTimeTo use millisecond-level UNIX timestamps. Both must be within the last 30 days, and StartTimeFrom cannot be later than StartTimeTo.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. Used for locating logs and troubleshooting issues.	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	Indicates whether the request was successful.
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of records that meet the query conditions.	1
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20
CrawlerRuns	array<object>	The list of metadata crawler run records.
	object	A single metadata crawler run record.
Status	string		SUCCESS
TaskInstanceId	integer		1234
StartedTime	integer		1710239005403
FinishedTime	integer		1710239065403
Duration	number		60
TotalTableCount	integer		42

CrawlerRuns returns the run records on the current page. You can use TaskInstanceId to associate a specific run.

Examples

Success response

JSON format

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 20,
    "CrawlerRuns": [
      {
        "Status": "SUCCESS",
        "TaskInstanceId": 1234,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239065403,
        "Duration": 60,
        "TotalTableCount": 42
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.