ListPipelineRunItems-阿里云帮助中心

Queries the information about deployment objects by deployment process ID.

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:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console.	10001
PipelineRunId	string	Yes	The workflow task ID. To obtain the ID, see ListPipelineRuns.	097c73fe-ed6e-4fb1-b109-a5d59e46cd58
PageNumber	integer	No	The page number, for pagination.	1
PageSize	integer	No	The requested page number, used for pagination.	10

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID. You can use this ID to troubleshoot issues if errors occur.	C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490
PagingInfo	object	Pagination information.
TotalCount	integer	The total number of entries that match the conditions.	12
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
PipelineRunItems	array<object>	The list of deployments.
	object	Details of a deployment.
Version	integer	The deployment version.	1
Name	string	The deployment name.	test
CreateTime	integer	The deployment creation time.	1724984066000
ModifyTime	integer	The time when the deployment was last modified.	1724984066000
Status	string	The deployment status. Valid values: Init: Initializing Running Success Fail Termination	Running
Message	string	The error message if the deployment failed.	Error Message
Type	string	The deployment type. Valid values: Node WorkflowDefinition: Workflow definition. Resource Function: The object is a function.	Node
Spec	string	The FlowSpec information describing this deployment. For detailed specifications, see FlowSpec.	{ "version": "1.1.0", "kind": "Node", "spec": { "nodes": [ { "recurrence": "Normal", "id": "860438872620113XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "datasource": { "name": "odps_test", "type": "odps" }, "script": { "language": "odps-sql", "path": "XX/OpenAPI_Test/ODPS_SQL_Test", "runtime": { "command": "ODPS_SQL", "commandTypeId": 10 }, "content": "select now();", "id": "853573334108680XXXX" }, "trigger": { "type": "Scheduler", "id": "543680677872062XXXX", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "623731286945488XXXX", "resourceGroupId": "7201XXXX" }, "name": "ODPS_SQL_Test", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "XXXXX@test.XXX.com", "projectId": "307XXX" }, "inputs": { "nodeOutputs": [ { "data": "lwttest_standard_root", "artifactType": "NodeOutput" } ] }, "outputs": { "nodeOutputs": [ { "data": "860438872620113XXXX", "artifactType": "NodeOutput", "refTableName": "ODPS_SQL_Test", "isDefault": true } ] } } ], "flow": [ { "nodeId": "860438872620113XXXX", "depends": [ { "type": "Normal", "output": "lwttest_standard_root" } ] } ] }, "metadata": { "uuid": "860438872620113XXXX" } }
Id	string	The unique identifier of the deployment. Note Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.	860438872620113XXXX

Examples

Success response

JSON format

{
  "RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
  "PagingInfo": {
    "TotalCount": 12,
    "PageSize": 10,
    "PageNumber": 1,
    "PipelineRunItems": [
      {
        "Version": 1,
        "Name": "test",
        "CreateTime": 1724984066000,
        "ModifyTime": 1724984066000,
        "Status": "Running",
        "Message": "Error Message",
        "Type": "Node",
        "Spec": "{ \"version\": \"1.1.0\", \"kind\": \"Node\", \"spec\": { \"nodes\": [ { \"recurrence\": \"Normal\", \"id\": \"860438872620113XXXX\", \"timeout\": 0, \"instanceMode\": \"T+1\", \"rerunMode\": \"Allowed\", \"rerunTimes\": 3, \"rerunInterval\": 180000, \"datasource\": { \"name\": \"odps_test\", \"type\": \"odps\" }, \"script\": { \"language\": \"odps-sql\", \"path\": \"XX/OpenAPI_Test/ODPS_SQL_Test\", \"runtime\": { \"command\": \"ODPS_SQL\", \"commandTypeId\": 10 }, \"content\": \"select now();\", \"id\": \"853573334108680XXXX\" }, \"trigger\": { \"type\": \"Scheduler\", \"id\": \"543680677872062XXXX\", \"cron\": \"00 00 00 * * ?\", \"startTime\": \"1970-01-01 00:00:00\", \"endTime\": \"9999-01-01 00:00:00\", \"timezone\": \"Asia/Shanghai\", \"delaySeconds\": 0 }, \"runtimeResource\": { \"resourceGroup\": \"S_res_group_XXXX_XXXX\", \"id\": \"623731286945488XXXX\", \"resourceGroupId\": \"7201XXXX\" }, \"name\": \"ODPS_SQL_Test\", \"owner\": \"110755000425XXXX\", \"metadata\": { \"owner\": \"110755000425XXXX\", \"ownerName\": \"XXXXX@test.XXX.com\", \"projectId\": \"307XXX\" }, \"inputs\": { \"nodeOutputs\": [ { \"data\": \"lwttest_standard_root\", \"artifactType\": \"NodeOutput\" } ] }, \"outputs\": { \"nodeOutputs\": [ { \"data\": \"860438872620113XXXX\", \"artifactType\": \"NodeOutput\", \"refTableName\": \"ODPS_SQL_Test\", \"isDefault\": true } ] } } ], \"flow\": [ { \"nodeId\": \"860438872620113XXXX\", \"depends\": [ { \"type\": \"Normal\", \"output\": \"lwttest_standard_root\" } ] } ] }, \"metadata\": { \"uuid\": \"860438872620113XXXX\" } }",
        "Id": "860438872620113XXXX"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.