GetDeployment - Query deployment package details | DataWorks API - DataWorks

Queries the details of a deployment package.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The DataWorks workspace ID. Available on the Workspace Management page in DataStudio.	10000
ProjectIdentifier	string	No	The DataWorks workspace GUID, displayed at the top of the DataStudio page. Specify either this parameter or ProjectId.	dw_project
DeploymentId	integer	Yes	The deployment task ID, generated when you call the SubmitFile or DeployFile operation.	3000001

Response elements

Element	Type	Description	Example
	object	The returned data.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID for troubleshooting.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Whether the request was successful.	true
Data	object	The details of the deployment package.
Deployment	object	The details of the deployment package.
Status	integer	The deployment task status. Valid values: 0 (ready), 1 (successful), 2 (failed).	1
ErrorMessage	string	The error message returned if deployment fails (Status is 2).	Success
FromEnvironment	integer	The source environment. Valid values: 0 (on-premises), 1 (development).	0
ToEnvironment	integer	The target environment. Valid values: 1 (development), 2 (production).	1
CheckingStatus	integer	The file check status. When ToEnvironment is 1, files can be deployed to production only if Status is 1 and CheckingStatus is empty. Valid values: 7: Check failed. 8: Check in progress.	7
CreateTime	integer	When the deployment task was created. UNIX timestamp in milliseconds.	1593877765000
HandlerId	string	The Alibaba Cloud account ID of the user who executed the deployment task.	2003****
CreatorId	string	The Alibaba Cloud account ID of the user who created the deployment task.	20030****
ExecuteTime	integer	When the deployment task was executed. UNIX timestamp in milliseconds.	1593877765000
Name	string	The deployment task name shown on the Release Package page in the Deploy module.	ods_user_info_d-2020-07-04_20030****
DeployedItems	array<object>	The deployed items.
	object	The details of the deployed item.
FileId	integer	The file ID.	5076****
FileVersion	integer	The file version.	7
Status	integer	0 (UNPUBLISHED): Not published. 1 (SUCCESS): Published. 2 (ERROR): Publishing failed. 3 (CLONED): Successfully cloned. 4 (DEPLOY_ERROR): Publishing failed. 5 (CLONING): Cloning in progress. 6 (REJECT): Release rejected.	1

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "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
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Insufficient permissions. Activate DataWorks Enterprise Edition or Flagship Edition.
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.