ListDeployments - DataWorks - Alibaba Cloud Documentation Center

Queries a list of processes that are used to deploy or undeploy entities in DataStudio. You can also specify filter conditions to query specific processes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	10000
Creator	string	No	The ID of the user who creates the processes. This parameter specifies a filter condition.	110755000425XXXX
Status	string	No	The status of the processes. This parameter specifies a filter condition. Valid values: INIT RUNNING SUCCESS FAIL TERMINATION CANCEL Enumeration Value: Init: Init. Cancel: Cancel. Running: Running. Termination: Termination. Success: Success. Fail: Fail.	RUNNING
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfo	object	The pagination information.
TotalCount	string	The total number of entries returned.	2524
PageSize	string	The number of entries per page.	10
PageNumber	string	The page number.	1
Deployments	array<object>	The deployment processes.
deloyment	object	The information about the process.
Id	string	The process ID.	ddf354a5-03df-48fc-94c1-cc973f79XXXX
ProjectId	string	The DataWorks workspace ID.	44683
CreateTime	long	The time when the process was created. This value is a UNIX timestamp.	1702736654000
ModifyTime	long	The time when the process was last modified. This value is a UNIX timestamp.	1702736654000
Creator	string	The ID of the user who creates the process.	110755000425XXXX
Status	string	The status of the process. Valid values: Init Running Success Fail Termination Cancel	RUNNING
Message	string	The error message returned if the process fails.
Stages	array<object>	The stages of the process.
stage	object	The information about the stage.
Code	string	The code of the stage.	DEV_CHECK
Step	integer	The step number of the stage.	1
Type	string	The type of the stage. This parameter indicates the operation type in the stage. Valid values: Deploy Check Offline Build Delete	CHECK
Name	string	The name of the stage.
Description	string	The description of the stage.
Message	string	The error message returned during the stage.
Status	string	The status of the stage. Valid values: Init Running Success Fail Termination Cancel	RUNNING
Detail	object	The additional information about the stage.
	any	The additional information.

Examples

Sample success responses

JSONformat

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "PagingInfo": {
    "TotalCount": "2524",
    "PageSize": "10",
    "PageNumber": "1",
    "Deployments": [
      {
        "Id": "ddf354a5-03df-48fc-94c1-cc973f79XXXX\n",
        "ProjectId": "44683",
        "CreateTime": 1702736654000,
        "ModifyTime": 1702736654000,
        "Creator": "110755000425XXXX",
        "Status": "RUNNING",
        "Message": "",
        "Stages": [
          {
            "Code": "DEV_CHECK",
            "Step": 1,
            "Type": "CHECK",
            "Name": "",
            "Description": "",
            "Message": "",
            "Status": "RUNNING",
            "Detail": {
              "key": ""
            }
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history