ListDeployments - 查询发布包列表信息 - 大数据开发治理平台 DataWorks

查询发布包列表信息。该功能与DataWorks控制台任务发布页面的发布包列表功能对应。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectIdentifier	string	否	DataWorks 工作空间的名称。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间名称。该参数与 ProjectId 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。	dw_project
ProjectId	long	否	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。	10000
Creator	string	否	发布包创建者的阿里云用户 ID。	20030****
EndCreateTime	long	否	生成发布包的最大毫秒时间戳。	1593877765000
Executor	string	否	发布包执行者的阿里云用户 ID。	2003****
EndExecuteTime	long	否	发布包开始执行的最大毫秒时间戳。	1593877765000
Status	integer	否	发布包当前的状态。取值如下： 0：发布包已准备就绪。 1：发布包发布成功。 2：发布包发布失败。 6：发布包被驳回。	1
Keyword	string	否	发布包名称的关键字。DataWorks 支持模糊匹配，即输入关键字，即可查询包含该关键字的发布包。	hello
PageNumber	integer	否	请求的数据页数，用于翻页。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大为 100 条。	20

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于出现错误后排查问题。	0000-ABCD-EFG
Data	object	满足查询条件的发布包列表数据。
PageNumber	long	请求的数据页数，用于翻页。	1
PageSize	long	每页显示的数据条数。	10
TotalCount	long	满足条件的数据总条数。	13
Deployments	array<object>	返回的发布包列表。
Deployment	object	发布包的详细信息。
Status	integer	发布包当前的状态。取值如下： 0：发布包已准备就绪。 1：发布包发布成功。 2：发布包发布失败。 6：发布包被驳回。	1
ErrorMessage	string	当发布包执行失败，该参数用于记录错误信息。	OK
CreateTime	long	发布包创建的时间戳。	1593877765000
Executor	string	发布包执行者的阿里云用户 ID。	2003****
Creator	string	发布包创建者的阿里云用户 ID。	2003****
ExecuteTime	long	执行发布包的时间戳。	1593877765000
Name	string	发布包的名称。	auto_created
Id	long	发布包的 ID，您可以根据此 ID 调用 GetDeployment 接口，获取发布包详情。	11111

示例

正常返回示例

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

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	没有权限，请授权
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.	系统内部错误，请稍后再试。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史