All Products
Search

This Product

    DataWorks:DeployFile

    Document Center

    DataWorks:DeployFile

    Last Updated:Jan 12, 2026

    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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ProjectIdlongNo

    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
    ProjectIdentifierstringNo

    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
    FileIdlongYes

    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
    CommentstringNo

    The description of the deployment.

    		First release task
    NodeIdlongNo

    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 parameters

    ParameterTypeDescriptionExample
    object

    The response.

    HttpStatusCodeinteger

    The HTTP status code.

    		200
    Datalong

    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
    RequestIdstring

    The request ID.

    		0000-ABCD-EFG****
    ErrorMessagestring

    The error message.

    		The connection does not exist.
    Successboolean

    Indicates whether the call was successful. Valid values:

    • true: success.
    • false: failure.
    		true
    ErrorCodestring

    The error code.

    		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 codeError codeError messageDescription
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
    429Throttling.ApiThe request for this resource has exceeded your available limit.-
    429Throttling.SystemThe DataWorks system is busy. Try again later.-
    429Throttling.UserYour request is too frequent. Try again later.-
    500InternalError.SystemAn internal system error occurred. Try again later.-
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

    For a list of error codes, visit the Service error codes.