ListDeployments

Queries deployment packages. This operation corresponds to the deployment package list on the Deployment Packages page in the DataWorks console.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectIdentifier	string	No	The DataWorks workspace name. Log on to the DataWorks console and go to the Workspace page to view the name. Either this parameter or ProjectId is required to specify the target workspace.	dw_project
ProjectId	integer	No	The DataWorks workspace ID. Log on to the DataWorks console and go to the Workspace page to view the ID. Either this parameter or ProjectIdentifier is required to specify the target workspace.	10000
Creator	string	No	The Alibaba Cloud account ID of the user who created the deployment packages.	20030****
EndCreateTime	integer	No	The creation time of the deployment packages to query. UNIX timestamp in milliseconds.	1593877765000
Executor	string	No	The Alibaba Cloud account ID of the user who runs the deployment packages.	2003****
EndExecuteTime	integer	No	The execution time of the deployment packages. UNIX timestamp in milliseconds.	1593877765000
Status	integer	No	The status of the deployment packages. Valid values: 0: Ready. 1: Deployed. 2: Failed. 6: Rejected.	1
Keyword	string	No	The keyword to filter deployment packages by name. Fuzzy match is supported.	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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0000-ABCD-EFG
Data	object	The data returned.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	13
Deployments	array<object>	The deployment packages.
	object
Status	integer	The status of the deployment package. Valid values: 0: Ready. 1: Deployed. 2: Failed. 6: Rejected.	1
ErrorMessage	string	The error message returned if the deployment failed.	OK
CreateTime	integer	The time when the deployment package was created.	1593877765000
Executor	string	The Alibaba Cloud account ID of the user who ran the deployment package.	2003****
Creator	string	The Alibaba Cloud account ID of the user who created the deployment package.	2003****
ExecuteTime	integer	The time when the deployment package was run. UNIX timestamp in milliseconds.	1593877765000
Name	string	The name of the deployment package.	auto_created
Id	integer	The deployment package ID. Call the GetDeployment operation to query the ID.	11111

Examples

Success response

JSON format

{
  "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
500	InternalError.System	An internal system error occurred. Try again later.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.