GetDeploymentPackage - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a deployment package.

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	long	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID. This parameter identifies the DataWorks workspace for this API call.	10000
ProjectIdentifier	string	No	The unique identifier of the DataWorks workspace. This is the identifier shown in the workspace switcher at the top of the Data Studio page. Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.	dw_project
DeploymentId	long	Yes	The deployment package ID. This ID is generated when you call SubmitFile or DeployFile .	1000000001

Response parameters

Parameter	Type	Description	Example
	object	The response.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	You have no permission.
RequestId	string	The request ID. Use this ID to locate logs and troubleshoot issues.	0bc1ec92159376****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the call succeeded. Valid values: true false	true
Data	object	The deployment package details.
Deployment	object	The deployment package details.
Status	integer	The current status of the deployment package. Valid values: 0 (ready), 1 (succeeded), and 2 (failed).	1
ErrorMessage	string	The detailed error message when the deployment package fails (status is 2).	Success
FromEnvironment	integer	The environment where the deployment is executed. Valid values: 0 (local) and 1 (development).	0
ToEnvironment	integer	The target environment for the deployment. Valid values: 1 (development) and 2 (production).	1
CheckingStatus	integer	The validation status of nodes in the deployment package. For packages deployed to the development environment (toEnviroment=1), you can only proceed to deploy to production if the package Status is 1 (succeeded) and CheckingStatus is empty (validation complete). 7: Validation failed 8: Validation in progress	7
CreateTime	long	The timestamp (in milliseconds) when the deployment package was created.	1593877765000
HandlerId	string	The Alibaba Cloud account ID of the user who executed the deployment.	2003****
CreatorId	string	The Alibaba Cloud account ID of the user who created the deployment package.	20030****
ExecuteTime	long	The timestamp (in milliseconds) when the deployment started.	1593877765000
Name	string	The deployment package name, displayed on the Deploy Center > Deployment Packages page.	ods_user_info_d-2020-07-04_20030****
DeployedItems	array<object>	The deployment item details.
DeployedItem	object	The deployment item details.
FileId	long	The file ID.	5076****
FileVersion	long	The file version.	7
Status	integer	UNPUBLISHED(0) SUCCESS(1) ERROR(2) CLONED(3) DEPLOY_ERROR(4) CLONING(5) REJECT(6)	1

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "You have no permission.",
  "RequestId": "0bc1ec92159376****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Deployment": {
      "Status": 1,
      "ErrorMessage": "Success",
      "FromEnvironment": 0,
      "ToEnvironment": 1,
      "CheckingStatus": 7,
      "CreateTime": 1593877765000,
      "HandlerId": "2003****",
      "CreatorId": "20030****",
      "ExecuteTime": 1593877765000,
      "Name": "ods_user_info_d-2020-07-04_20030****"
    },
    "DeployedItems": [
      {
        "FileId": 0,
        "FileVersion": 7,
        "Status": 1
      }
    ]
  }
}

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.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

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