ListDeployments - 获取发布流程列表 - 大数据开发治理平台 DataWorks

分页获取发布流程列表，也可以使用筛选条件对发布流程进行筛选。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	10000
Creator	string	否	筛选条件：发布流程的创建者	110755000425XXXX
Status	string	否	筛选条件：发布流程的当前状态可选值： Init 初始化 Running 运行中 Success 运行成功 Fail 运行失败 Termination 被终止 Cancel 被取消	Running
PageNumber	integer	否	页码，从 1 开始，默认值为 1。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大 100 条。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求的 id。用于定位日志，排查问题。	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfo	object	分页信息
TotalCount	string	满足条件的数据总条数。	2524
PageSize	string	每页显示的条数	10
PageNumber	string	查询分页的页码。	1
Deployments	array<object>	发布流程信息列表。
deloyment	object	发布流程列表元素
Id	string	发布流程 Id	ddf354a5-03df-48fc-94c1-cc973f79XXXX
ProjectId	string	DataWorks 工作空间的 ID。	44683
CreateTime	long	发布流程创建时间戳	1702736654000
ModifyTime	long	发布流程修改时间戳。	1702736654000
Creator	string	发布流程创建者 ID	110755000425XXXX
Status	string	发布流程状态可选值 Init 初始化 Running 运行中 Success 运行成功 Fail 运行失败 Termination 被终止 Cancel 被取消	Running
Message	string	发布流程失败的错误信息	错误信息
Stages	array<object>	发布阶段列表
stage	object	发布阶段列表元素
Code	string	发布阶段代号	DEV_CHECK
Step	integer	发布阶段步骤编号	1
Type	string	发布阶段类型，是该发布阶段操作类型的一个分类。可选值 Deploy 发布操作 Check 检查操作 Offline 下线操作 Build 构建操作 Delete 删除操作	Check
Name	string	阶段名称	上线到开发前检查
Description	string	阶段描述	上线到开发前检查
Message	string	发布阶段发生错误时的错误信息	错误信息
Status	string	发布阶段状态可选值 Init 初始化 Running 运行中 Success 运行成功 Fail 运行失败 Termination 被终止 Cancel 被取消	Running
Detail	object	发布阶段的其他补充信息
	any	补充信息	"checkerList": [ { "code": "BuildPackageChecker", "name": "打包检查" }, { "code": "NodeParentDependency", "name": "下游依赖检查" }, { "code": "NodeInProcess", "name": "下线中流程检查" } ]

示例

正常返回示例

JSON格式

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "PagingInfo": {
    "TotalCount": "2524",
    "PageSize": "10",
    "PageNumber": "1",
    "Deployments": [
      {
        "Id": "ddf354a5-03df-48fc-94c1-cc973f79XXXX\n",
        "ProjectId": "44683",
        "CreateTime": 1702736654000,
        "ModifyTime": 1702736654000,
        "Creator": "110755000425XXXX",
        "Status": "Running",
        "Message": "错误信息",
        "Stages": [
          {
            "Code": "DEV_CHECK",
            "Step": 1,
            "Type": "Check",
            "Name": "上线到开发前检查",
            "Description": "上线到开发前检查",
            "Message": "错误信息",
            "Status": "Running",
            "Detail": {
              "key": "\"checkerList\": [\n                {\n                  \"code\": \"BuildPackageChecker\",\n                  \"name\": \"打包检查\"\n                },\n                {\n                  \"code\": \"NodeParentDependency\",\n                  \"name\": \"下游依赖检查\"\n                },\n                {\n                  \"code\": \"NodeInProcess\",\n                  \"name\": \"下线中流程检查\"\n                }\n              ]"
            }
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

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

暂无变更历史