DeployFile-阿里云帮助中心

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.	dw_project
FileId	integer	No	The file ID. You can call the ListFiles operation to obtain the ID. You need to configure either this parameter or the NodeId parameter.	10000001
Comment	string	No	The description of the deployment.	First release task
NodeId	integer	No	The task ID of the file to be deployed in the scheduling system. You need to configure either this parameter or the FileId parameter.	2000001

Response elements

Element	Type	Description	Example
	object	The response.
HttpStatusCode	integer	The HTTP status code.	200
Data	integer	The deployment package ID. You must specify this ID as a parameter when you call the GetDeployment operation to query the details of the deployment.	30000001
RequestId	string	The request ID.	0000-ABCD-EFG****
ErrorMessage	string	The error message.	The connection does not exist.
Success	boolean	Indicates whether the call was successful. Valid values: true: success. false: failure.	true
ErrorCode	string	The 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.