Deploys a file in DataStudio to the production environment. After you call the DeployFile operation, you can call the GetDeployment operation to poll the status of an asynchronous deployment task based on the value of the Data parameter in the response of the DeployFile operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeployFile

The operation that you want to perform. Set the value to DeployFile.

ProjectId Long No 10000

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.

RegionId String Yes cn-zhangjiakou

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system determines the value of this parameter based on the endpoint that is used to call the operation.

ProjectIdentifier String No dw_project

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.

FileId Long Yes 10000001

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.

Comment String No Deploy for the first time

The description of the deployment operation.

NodeId Long No 2000001

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.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

Data Long 30000001

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.

RequestId String 0000-ABCD-EFG****

The ID of the request. You can troubleshoot issues based on the ID.

ErrorMessage String The connection does not exist.

The error message returned.

Success Boolean true

Indicates whether the request is successful.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeployFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=10000001
&Comment=Deploy for the first time
&NodeId=2000001
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeployFileResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>30000001</Data>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</DeployFileResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.

For a list of error codes, visit the API Error Center.