All Products
Search
Document Center

DataWorks:ExecDeploymentStage

Last Updated:Dec 05, 2024

Executes a stage in a process.

Operation description

Note The stages in a process are sequential. For more information, see the GetDeployment operation. Skipping or repeating a stage is not allowed.
Note The execution of a stage is asynchronous. The response of this operation indicates only whether a stage is triggered but does not indicate whether the execution of the stage is successful. You can call the GetDeployment operation to check whether the execution is successful.

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
ProjectIdstringYes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.

You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.

10000
IdstringYes

The ID of the process.

a7ef0634-20ec-4a7c-a214-54020f91XXXX
CodestringYes

The code of the stage in the process. You can call the GetDeployment operation to query the code.

DEV_CHECK

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

AFBB799F-8578-51C5-A766-E922EDB8XXXX
Successboolean

Indicates whether the request was successful. Valid values:

  • true

  • false

    **

    Note: The value of this parameter indicates only whether the stage is triggered but does not indicate whether the execution of the stage is successful.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "AFBB799F-8578-51C5-A766-E922EDB8XXXX",
  "Success": true
}

Error codes

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