DeployFile

Operation description

This operation is asynchronous. After a successful call, use the returned deployment ID with the GetDeployment operation to check the deployment status and result.

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 DataWorks workspace ID. You can find this on the workspace configuration page in the DataWorks console. Specify either this parameter or ProjectIdentifier.	10000
ProjectIdentifier	string	No	The DataWorks workspace name. You can find this on the workspace configuration page in the DataWorks console. Specify either this parameter or `ProjectId`.	dw_project
FileId	integer	No	The file ID. Call the ListFiles operation to obtain this ID. Specify either this parameter or `NodeId`.	10000022
Comment	string	No	Description of this deployment.	First release task
NodeId	integer	No	The scheduling task ID of the file to deploy. Specify either this parameter or `FileId`.	2000001

Response elements

Element	Type	Description	Example
	object	The response object.
HttpStatusCode	integer	HTTP status code.	200
Data	integer	The deployment package ID. Pass this ID to the GetDeployment operation to query deployment details.	30000001
RequestId	string	The request ID. Use this for troubleshooting.	0000-ABCD-EFG****
ErrorMessage	string	Error message.	The connection does not exist.
Success	boolean	Whether the request 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.