tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
数据万象
    文档
    Download PDF

    获取工作流实例详情列表

    最后更新时间：2024-01-20 16:26:09
    下载PDF

      功能描述

      获取工作流实例列表。

      请求

      请求示例

      GET /workflowexecution HTTP/1.1
      Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
      Date: <GMT Date>
      Authorization: <Auth String>
      Content-Length: <length>
      Content-Type: application/xml
      说明：
      Authorization: Auth String（详情请参见 请求签名 文档）。
      通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。

      请求头

      此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

      请求体

      该请求的请求体为空。

      请求参数

      参数名称（关键字）
      描述
      类型
      是否必选
      workflowId
      工作流 ID
      String
      是
      name
      文件名称
      String
      否
      orderByTime
      Desc 或者 Asc。默认为 Desc
      String
      否
      size
      拉取的最大任务数。默认为10。最大为100
      String
      否
      states
      工作流实例状态，以,分割支持多状态All，Success，Failed，Running，Cancel。默认为 All
      String
      否
      startCreationTime
      拉取创建时间大于等于该时间。格式为：%Y-%m-%dT%H:%m:%S%z
      String
      否
      endCreationTime
      拉取创建时间小于等于该时间。格式为：%Y-%m-%dT%H:%m:%S%z
      String
      否
      nextToken
      请求的上下文，用于翻页。下一页输入 token
      String
      否
      jobId
      批量触发工作流任务 ID，用于扫描出批量触发任务 ID 对应执行的工作流实例
      String
      否

      响应

      响应头

      此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

      响应体

      该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
      <Response>
          <RequestId>NjJmMjEyMmFfZWM0YTYyNjRfN2U2NV8yNmI0</RequestId>
          <WorkflowExecutionList>
              <RunId>i166ee19017b011eda8a5525400c540df</RunId>
              <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
              <Object>wk-test/game.mp4</Object>
              <CreateTime>2022-08-09T14:54:17+08:00</CreateTime>
              <State>Success</State>
          </WorkflowExecutionList>
          <WorkflowExecutionList>
              <RunId>i769bd26517af11ed917f525400a3c59f</RunId>
              <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
              <Object>wk-test/game.mp4</Object>
              <CreateTime>2022-08-09T14:49:49+08:00</CreateTime>
              <State>Success</State>
          </WorkflowExecutionList>
          <NextToken>115716</NextToken>
      </Response>
      具体的数据内容如下：
      节点名称（关键字）
      父节点
      描述
      类型
      Response
      无
      保存结果的容器
      Container
      Container 节点 Response 的内容：
      节点名称（关键字）
      父节点
      描述
      类型
      WorkflowExecutionList
      Response
      工作流实例详细信息
      Container
      RequestId
      Response
      请求 ID
      String
      NextToken
      Response
      翻页的上下文 Token
      String
      Container 节点 WorkflowExecutionList 的内容：
      节点名称（关键字）
      父节点
      描述
      类型
      RunId
      Response.WorkflowExecutionList
      工作流实例 ID
      String
      WorkflowId
      Response.WorkflowExecutionList
      工作流 ID
      String
      State
      Response.WorkflowExecutionList
      工作流实例状态
      String
      CreateTime
      Response.WorkflowExecutionList
      创建时间
      String
      Object
      Response.WorkflowExecutionList
      COS 对象地址
      String

      错误码

      该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

      实际案例

      请求

      GET /workflowexecution?workflowId=web6ac56c1ef54dbfa44d7f4103203be9 HTTP/1.1
      Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
      Host: test-1234567890.ci.ap-chongqing.myqcloud.com
      

      响应

      HTTP/1.1 200 OK
      Content-Type: application/xml
      Content-Length: 666
      Connection: keep-alive
      Date: Thu, 09 Aug 2022 16:23:12 GMT
      Server: tencent-ci
      x-ci-request-id: NjJmMjEyMmFfZWM0YTYyNjRfN2U2NV8yNmI0
      
      <Response>
          <RequestId>NjJmMjEyMmFfZWM0YTYyNjRfN2U2NV8yNmI0</RequestId>
          <WorkflowExecutionList>
              <RunId>i166ee19017b011eda8a5525400c540df</RunId>
              <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
              <Object>wk-test/game.mp4</Object>
              <CreateTime>2022-08-09T14:54:17+08:00</CreateTime>
              <State>Success</State>
          </WorkflowExecutionList>
          <WorkflowExecutionList>
              <RunId>i769bd26517af11ed917f525400a3c59f</RunId>
              <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
              <Object>wk-test/game.mp4</Object>
              <CreateTime>2022-08-09T14:49:49+08:00</CreateTime>
              <State>Success</State>
          </WorkflowExecutionList>
          <NextToken>115716</NextToken>
      </Response>
      
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款