调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListDeployments |
要执行的操作。 |
| 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 |
发布包当前的状态。取值如下：
|
| Keyword | String | 否 | hello |
发布包名称的关键字。DataWorks支持模糊匹配，即输入关键字，即可查询包含该关键字的发布包。 |
| PageNumber | Integer | 否 | 1 |
请求的数据页数，用于翻页。 |
| PageSize | Integer | 否 | 20 |
每页显示的条数，默认为10条，最大为100条。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 0000-ABCD-EFG |
请求ID。用于出现错误后排查问题。 |
| Data | Object |
满足查询条件的发布包列表数据。 |
|
| PageNumber | Long | 1 |
请求的数据页数，用于翻页。 |
| PageSize | Long | 10 |
每页显示的数据条数。 |
| TotalCount | Long | 13 |
满足条件的数据总条数。 |
| Deployments | Array of Deployment |
返回的发布包列表。 |
|
| Status | Integer | 1 |
发布包当前的状态。取值如下：
|
| 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
0000-ABCD-EFG
1
10
13
1
OK
1593877765000
2003****
2003****
1593877765000
auto_created
11111
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 系统内部错误，请稍后再试。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/171087.html
