All Products
Search

This Product

    DataWorks:GetPipelineRun

    Document Center

    DataWorks:GetPipelineRun

    Last Updated:Mar 30, 2026

    Gets the details of a Deployment Process.

    Operation description

    Important For earlier SDK versions that do not include this API, use the GetDeployment API with the same parameters described in this document.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProjectId

    integer

    Yes

    The ID of the DataWorks workspace. You can find this ID on the Workspace Management page in the DataWorks console.

    This parameter specifies the DataWorks workspace for the API call.

    10000
    Id

    string

    Yes

    The unique identifier of the Publishing Pipeline.

    a7ef0634-20ec-4a7c-a214-54020f****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response schema.

    RequestId

    string

    The ID of the request. You can use this ID to locate logs and troubleshoot issues.

    08468352-032C-5262-AEDC-68C9FA05XXXX
    Pipeline

    object

    The details of the pipeline run.

    Id

    string

    The ID of the pipeline run.

    a7ef0634-20ec-4a7c-a214-54020f91XXXX

    ProjectId

    integer

    The ID of the DataWorks workspace.

    56160
    CreateTime

    integer

    The time when the pipeline run was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1724984066000
    ModifyTime

    integer

    The time when the pipeline run was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1724984066000
    Creator

    string

    The ID of the user who created the pipeline run.

    137946317766XXXX
    Status

    string

    The status of the pipeline run.

    Valid values:

    • Init: The pipeline run is being initialized.

    • Running: The pipeline run is in progress.

    • Success: The pipeline run succeeded.

    • Fail: The pipeline run failed.

    • Terminated: The pipeline run was terminated.

    • Canceled: The pipeline run was canceled.

    Running
    Message

    string

    The error message returned if the pipeline run fails.

    Error message
    Stages

    array<object>

    The stages in the pipeline run.

    array<object>

    The details of a stage.

    Code

    string

    The code that identifies the stage.

    DEV_CHECK
    Step

    integer

    The sequence number of the stage within the pipeline.

    1
    Type

    string

    The type of the stage.

    Valid values:

    • Deploy: A deployment operation.

    • Check: A check operation.

    • Offline: An offline operation.

    • Build: A build operation.

    • Delete: A delete operation.

    Valid values:

    • Delete :

    • Build :

    • Check :

    • Offline :

    • Deploy :

    Check
    Name

    string

    The name of the stage.

    Publish package build
    Description

    string

    The description of the stage.

    Phase description
    Message

    string

    The exception message returned if the stage fails.

    Exception information XXX
    Status

    string

    The status of the stage.

    Valid values:

    • Init: The stage is being initialized.

    • Running: The stage is in progress.

    • Success: The stage succeeded.

    • Fail: The stage failed.

    • Terminated: The stage was terminated.

    • Canceled: The stage was canceled.

    Valid values:

    • Init :

    • Cancel :

    • Running :

    • Termination :

    • Success :

    • Fail :

    Running
    Detail

    object

    Detailed information about the stage.

    any

    Additional key-value pairs that provide more information about the stage.

    "checkerList": [ { "code": "BuildPackageChecker", "name": "Build_Package_Checker" }, { "code": "NodeParentDependency", "name": "Downstream_Dependency_Checker" }, { "code": "NodeInProcess", "name": "Decommissioning_Process_Checker" } ]

    Description

    string

    The description of the pipeline run.

    Description of the pipeline run

    Examples

    Success response

    JSON format

    {
  "RequestId": "08468352-032C-5262-AEDC-68C9FA05XXXX",
  "Pipeline": {
    "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n",
    "ProjectId": 56160,
    "CreateTime": 1724984066000,
    "ModifyTime": 1724984066000,
    "Creator": "137946317766XXXX",
    "Status": "Running",
    "Message": "Error message",
    "Stages": [
      {
        "Code": "DEV_CHECK",
        "Step": 1,
        "Type": "Check",
        "Name": "Publish package build",
        "Description": "Phase description",
        "Message": "Exception information XXX",
        "Status": "Running",
        "Detail": {
          "key": "\"checkerList\": [\n    {\n        \"code\": \"BuildPackageChecker\",\n        \"name\": \"Build_Package_Checker\"\n    },\n    {\n        \"code\": \"NodeParentDependency\",\n        \"name\": \"Downstream_Dependency_Checker\"\n    },\n    {\n        \"code\": \"NodeInProcess\",\n        \"name\": \"Decommissioning_Process_Checker\"\n    }\n]\n"
        }
      }
    ],
    "Description": "Description of the pipeline run"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.