ListDeployments - DataWorks - Alibaba Cloud Documentation Center

Queries a list of deployment packages. This operation is equivalent to viewing a list of deployment packages on the Deployment Packages page of the DataWorks console.

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
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.	dw_project
ProjectId	long	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.	10000
Creator	string	No	The ID of the Alibaba Cloud account used by the user who creates the deployment packages.	20030****
EndCreateTime	long	No	The time when the deployment packages to be queried are created. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593877765000
Executor	string	No	The ID of the Alibaba Cloud account used by the user who runs the deployment packages.	2003****
EndExecuteTime	long	No	The time when the deployment packages are run. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593877765000
Status	integer	No	The status of the deployment packages. Valid values: 0: The deployment packages are ready. 1: The deployment packages are deployed. 2: The deployment packages fail to be deployed. 6: The deployment packages are rejected.	1
Keyword	string	No	The keyword that is contained in the names of the deployment packages. A fuzzy search is supported. After you enter a keyword, all deployment packages whose names contain the keyword are displayed.	hello
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	20

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0000-ABCD-EFG
Data	object	The data returned.
PageNumber	long	The page number.	1
PageSize	long	The number of entries per page.	10
TotalCount	long	The total number of entries returned.	13
Deployments	array<object>	The deployment packages.
Deployment	object
Status	integer	The status of the deployment package. Valid values: 0: The deployment package is ready. 1: The deployment package is deployed. 2: The deployment package fails to be deployed. 6: The deployment package is rejected.	1
ErrorMessage	string	The error message returned when the deployment package failed.	OK
CreateTime	long	The time when the deployment package was created.	1593877765000
Executor	string	The ID of the Alibaba Cloud account used by the user who ran the deployment package.	2003****
Creator	string	The ID of the Alibaba Cloud account used by the user who created the deployment package.	2003****
ExecuteTime	long	The time when the deployment package was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593877765000
Name	string	The name of the deployment package.	auto_created
Id	long	The deployment package ID. You can call the GetDeployment operation to obtain the ID.	11111

Examples

Sample success responses

JSONformat

{
  "RequestId": "0000-ABCD-EFG",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Deployments": [
      {
        "Status": 1,
        "ErrorMessage": "OK",
        "CreateTime": 1593877765000,
        "Executor": "2003****",
        "Creator": "2003****",
        "ExecuteTime": 1593877765000,
        "Name": "auto_created",
        "Id": 11111
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
500	InternalError.System	An internal system error occurred. Try again later.	-

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

Change history

Change time	Summary of changes	Operation

No change history