DeployFile - DataWorks - Alibaba Cloud Documentation Center

Deploys a file to the production environment.

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 ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.	dw_project
FileId	long	Yes	The ID of the file. You can call the ListFiles operation to query the ID. You must configure either the FileId parameter or the NodeId parameter.	10000001
Comment	string	No	The description of the deployment operation.
NodeId	long	No	The ID of the node in the scheduling system that corresponds to the file that you want to deploy. You must configure either the NodeId parameter or the FileId parameter.	2000001

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	200
Data	long	The ID of the deployment task. The ID is used as the value of a specific request parameter when you call the GetDeployment operation to query the details of the deployment task.	30000001
RequestId	string	The ID of the request. You can troubleshoot issues based on the ID.	0000-ABCD-EFG****
ErrorMessage	string	The error message returned.	The connection does not exist.
Success	boolean	Indicates whether the request is successful.	true
ErrorCode	string	The error code returned.	Invalid.Tenant.ConnectionNotExists

Examples

Sample success responses

JSONformat

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

Change history

Change time	Summary of changes	Operation

No change history