ListDeploymentPackages - DataWorks - Alibaba Cloud Documentation Center

Queries a list of deployment packages.

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 unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces. Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.	dw_project
ProjectId	long	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.	10003
Creator	string	No	The Alibaba Cloud account ID of the deployment package creator.	110755000425****
EndCreateTime	long	No	The maximum millisecond timestamp for when the deployment package was created.	1593877765000
Executor	string	No	The Alibaba Cloud account ID of the deployment package executor.	2003****
EndExecuteTime	long	No	The maximum millisecond timestamp for when the deployment package started executing.	1593877765000
Status	integer	No	The status of the deployment package. Valid values: 0: It is ready. 1: It was successfully deployed. 2: It failed to be deployed. 6: It was rejected.	1
Keyword	string	No	The keyword in the deployment package name. DataWorks supports fuzzy matching, meaning you can enter a keyword to query for deployment packages that contain it.	abc
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of records per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	952795279527ab****
Data	object	The list of deployment packages that meet the query conditions.
PageNumber	long	The page number.	1
PageSize	long	The number of records per page.	10
TotalCount	long	The total number of records that meet the conditions.	20
Deployments	array<object>	The returned list of deployment packages.
Deployment	object	The detailed information of the deployment package.
Status	integer	The status of the deployment package. Valid values: 0: It is ready. 1: It was successfully deployed. 2: It failed to be deployed. 6: It was rejected.	1
ErrorMessage	string	When the deployment package fails to execute, this parameter is used to record the error message.	OK
CreateTime	long	The timestamp when the deployment package was created.	1593877765000
Executor	string	The Alibaba Cloud account ID of the deployment package executor.	2003****
Creator	string	The Alibaba Cloud account ID of the deployment package creator.	2003****
ExecuteTime	long	The timestamp when the deployment package was executed.	1593877765000
Name	string	The name of the deployment package.	auto_created
Id	long	The ID of the deployment package. You can use this ID to call the GetDeployment operation to get the deployment package details.	11111

Examples

Sample success responses

JSONformat

{
  "RequestId": "952795279527ab****",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20,
    "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.