Use the DeployFile API to deploy a file to the production environment - DataWorks - Alibaba Cloud -

Operation description

This is an asynchronous operation. A successful call returns a deployment ID. Use this ID with the GetDeployment operation to query the execution status and final result of the deployment task.

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:*

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The ID of the DataWorks workspace. You can log in to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. You must set either this parameter or the ProjectIdentifier parameter to specify the DataWorks workspace for the API call.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace name. You must set either this parameter or the `ProjectId` parameter to specify the DataWorks workspace for this API call.	dw_project
FileId	integer	No	The ID of the file. You can call the ListFiles operation to obtain this ID. You only need to specify this parameter or the `NodeId` parameter.	10000022
Comment	string	No	Description of this deployment.	First release task
NodeId	integer	No	The ID of the task in the scheduling system for the file to be deployed. You only need to specify either this parameter or the `FileId` parameter.	2000001

Response elements

Element	Type	Description	Example
	object	Returned data structure.
HttpStatusCode	integer	HTTP status code.	200
Data	integer	The ID of the deployment package. You can then use this ID as a parameter when calling the GetDeployment API to obtain the details of the deployment.	30000001
RequestId	string	The request ID is used to troubleshoot issues when an error occurs.	0000-ABCD-EFG****
ErrorMessage	string	Error message.	The connection does not exist.
Success	boolean	Indicates whether the call was successful.	true
ErrorCode	string	Error code.	Invalid.Tenant.ConnectionNotExists

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Data": 30000001,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

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.	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.