Queries deployment tasks.

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 ListDeployments

The operation that you want to perform.

Region String No cn-zhangjiakou

The ID of the region in which the DataWorks workspace resides. This parameter is deprecated. Do not use this parameter.

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 view the workspace name.

You must specify one of the ProjectId and ProjectIdentifier parameters to determine the DataWorks workspace to which the operation is applied.

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 view the workspace ID.

You must specify one of the ProjectId and ProjectIdentifier parameters to determine the DataWorks workspace to which the operation is applied.

Creator String No 20030****

The ID of the Alibaba Cloud account used by the user who created the deployment tasks.

EndCreateTime Long No 1593877765000

The time when the deployment tasks to be queried were created. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

Executor String No 2003****

The ID of the Alibaba Cloud account used by the user who runs the deployment tasks.

EndExecuteTime Long No 1593877765000

The time when the deployment tasks were run. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

Status Integer No 1

The status of the deployment tasks. Valid values:

  • 0: The deployment tasks are ready.
  • 1: The deployment tasks are successful.
  • 2: The deployment tasks fail.
  • 6: The deployment tasks are rejected.
Keyword String No hello

The keyword that is contained in the names of the deployment tasks. The keyword is used to search for deployment tasks in fuzzy mode.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 20

The number of entries to return per page. Default value: 10. The number cannot exceed 100.

RegionId String Yes cn-zhangjiakou

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

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-EFG

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

Data Object

The return results.

PageNumber Long 1

The page number of the returned page.

PageSize Long 10

The number of entries returned per page.

TotalCount Long 13

The total number of entries returned.

Deployments Array of Deployment

The information about the deployment tasks.

Status Integer 1

The status of the deployment tasks. Valid values:

  • 0: The deployment tasks are ready.
  • 1: The deployment tasks are successful.
  • 2: The deployment tasks fail.
  • 6: The deployment tasks are rejected.
ErrorMessage String OK

The error message returned when the deployment task failed.

CreateTime Long 1593877765000

The time when the deployment task was created.

Executor String 2003****

The ID of the Alibaba Cloud account used by the user who ran the deployment tasks.

Creator String 2003****

The ID of the Alibaba Cloud account used by the user who created the deployment tasks.

ExecuteTime Long 1593877765000

The time when the deployment task was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

Name String auto_created

The name of the deployment task.

Id Long 11111

The ID of the deployment task. You can call the GetDeployment operation to query the details of the deployment task based on the ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDeployments
&ProjectIdentifier=dw_project
&ProjectId=10000
&Creator=20030****
&EndCreateTime=1593877765000
&Executor=2003****
&EndExecuteTime=1593877765000
&Status=1
&Keyword=hello
&PageNumber=1
&PageSize=20
&<Common request parameters>

Sample success responses

XML format

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

<ListDeploymentsResponse>
    <RequestId>0000-ABCD-EFG</RequestId>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>13</TotalCount>
        <Deployments>
            <Status>1</Status>
            <ErrorMessage>OK</ErrorMessage>
            <CreateTime>1593877765000</CreateTime>
            <Executor>2003****</Executor>
            <Creator>2003****</Creator>
            <ExecuteTime>1593877765000</ExecuteTime>
            <Name>auto_created</Name>
            <Id>11111</Id>
        </Deployments>
    </Data>
</ListDeploymentsResponse>

JSON format

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

{
  "RequestId" : "0000-ABCD-EFG",
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 13,
    "Deployments" : {
      "Status" : 1,
      "ErrorMessage" : "OK",
      "CreateTime" : 1593877765000,
      "Executor" : "2003****",
      "Creator" : "2003****",
      "ExecuteTime" : 1593877765000,
      "Name" : "auto_created",
      "Id" : 11111
    }
  }
}

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 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.

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