调用ListDeployments查询发布包列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListDeployments

要执行的操作。

Region String cn-zhangjiakou

地域信息,通常为服务所在的地域。该字段已废弃,请勿使用。

ProjectIdentifier String dw_project

DataWorks工作空间的名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。

该参数与ProjectId参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

ProjectId Long 10000

DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间ID。

该参数与ProjectIdentifier参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

Creator String 20030****

发布包创建者的阿里云用户ID。

EndCreateTime Long 1593877765000

生成发布包的最大毫秒时间戳。

Executor String 2003****

发布包执行者的阿里云用户ID。

EndExecuteTime Long 1593877765000

发布包开始执行的最大毫秒时间戳。

Status Integer 1

发布包当前的状态。取值如下:

  • 0:发布包已准备就绪。
  • 1:发布包发布成功。
  • 2:发布包发布失败。
  • 6:发布包被驳回。
Keyword String hello

发布包名称的关键字。DataWorks支持模糊匹配,即输入关键字,即可查询包含该关键字的发布包。

PageNumber Integer 1

请求的数据页数,用于翻页。

PageSize Integer 20

每页显示的条数,默认为10条,最大为100条。

RegionId String cn-zhangjiakou

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

返回数据

名称 类型 示例值 描述
RequestId String 0000-ABCD-EFG

请求ID。用于出现错误后排查问题。

Data Object

满足查询条件的发布包列表数据。

PageNumber Long 1

请求的数据页数,用于翻页。

PageSize Long 10

每页显示的数据条数。

TotalCount Long 13

满足条件的数据总条数。

Deployments Array of Deployment

返回的发布包列表。

Status Integer 1

发布包当前的状态。取值如下:

  • 0:发布包已准备就绪。
  • 1:发布包发布成功。
  • 2:发布包发布失败。
  • 6:发布包被驳回。
ErrorMessage String OK

当发布包执行失败,该参数用于记录错误信息。

CreateTime Long 1593877765000

发布包创建的时间戳。

Executor String 2003****

发布包执行者的阿里云用户ID。

Creator String 2003****

发布包创建者的阿里云用户ID。

ExecuteTime Long 1593877765000

执行发布包的时间戳。

Name String auto_created

发布包的名称。

Id Long 11111

发布包的ID,您可以根据此ID调用GetDeployment接口,获取发布包详情。

示例

请求示例

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
&公共请求参数

正常返回示例

XML格式

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格式

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

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 您被限制访问,请开通DataWorks企业版或旗舰版。
429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。

访问错误中心查看更多错误码。