Queries the details of a deployment package.

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 Required GetDeployment

The operation that you want to perform.

DeploymentId Long Yes 3000001

The ID of the release package. A corresponding publishing package ID is generated when the SubmitFile and DeployFile operations are executed.

ProjectId Long Yes 10000

Dataworks workspace ID and click the workspace manage icon in the upper-right corner to view the workspace information.

RegionId String Required cn-zhangjiakou

The list of regions where the services are located.

ProjectIdentifier String No dw_project

Dataworks unique identifier of the workspace, that is, the name of the workspace at the top of the data Development page.

You must specify either this parameter or the ProjectId parameter to determine the Dataworks workspace for the current API call.

Response parameters

Parameter Type Example Description
Data Struct

The details of the release package.

Deployment Struct

The details of the release package.

CreateTime Long 1593877765000

The timestamp generated for publishing the package. Unit: milliseconds.

CreatorId String 20030****

The ID of the Alibaba Cloud user who publishes the package.

ErrorMessage String Succeed

This parameter is used to record the specific error message when the execution of the release package fails (status is 2).

ExecuteTime Long 1593877765000

The timestamp when the package execution starts.

FromEnvironment Integer 0

The environment in which the publish operation is performed, including 0 (local) and 1 (Development Environment).

HandlerId String 2003****

The ID of the Alibaba Cloud user who executes the release package.

Name String ods_user_info_d-2020-07-04_20030****

The name of the release package. You can choose deploy> release package list in the left-side navigation pane.

Status Integer 1

The current state of the publishing package, including 0 (ready), 1 (success) and 2 (failure).

ToEnvironment Integer 1

The environment in which the file information is published. Valid values: 1 (Development Environment) and 2 (production environment).

ErrorCode String 0

The error code.

ErrorMessage String Success

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

The unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetDeployment
&DeploymentId=3000001
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Deployment>
        <Status>1</Status>
        <HandlerId>2003****</HandlerId>
        <ExecuteTime>1593877765000</ExecuteTime>
        <CreatorId>20030****</CreatorId>
        <CreateTime>1593877765000</CreateTime>
        <ToEnvironment>1</ToEnvironment>
        <FromEnvironment>0</FromEnvironment>
        <ErrorMessage> success </ErrorMessage>
        <Name>ods_user_info_d-2020-07-04_20030****</Name>
    </Deployment>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>Success</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "Deployment": {
            "Status": 1,
            "HandlerId": "2003****",
            "ExecuteTime": 1593877765000,
            "CreatorId": "20030****",
            "CreateTime": 1593877765000,
            "ToEnvironment": 1,
            "FromEnvironment": 0,
            "ErrorMessage": "success",
            "Name": "ods_user_info_d-2020-07-04_20030****"
        }
    },
    "ErrorCode": 0,
    "ErrorMessage": "Success",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.

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