获取工作流列表

最近更新时间:2019-08-27 20:16:11

1. 接口描述

接口请求域名: mps.tencentcloudapi.com 。

根据工作流 ID,获取工作流详情列表。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWorkflows
Version String 公共参数,本接口取值:2019-06-12
Region String 公共参数,本接口不需要传递此参数。
WorkflowIds.N Array of Integer 工作流 ID 过滤条件,数组长度限制:100。
Status String 工作流状态,取值范围:
  • Enabled:已启用,
  • Disabled:已禁用。

  • 不填此参数,则不区分工作流状态。
    Offset Integer 分页偏移量,默认值:0。
    Limit Integer 返回记录条数,默认值:10,最大值:100。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    WorkflowInfoSet Array of WorkflowInfo 工作流信息数组。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询特定工作流

    查询 ID 为78459的工作流。

    输入示例

    https://mps.tencentcloudapi.com/?Action=DescribeWorkflows
    &WorkflowIds.0=78459
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
        "TotalCount": 1,
        "WorkflowInfoSet": [
          {
            "WorkflowId": 78459,
            "WorkflowName": "transcode-10",
            "Status": "Enabled",
            "Trigger": {
              "Type": "CosFileUpload",
              "CosFileUploadTrigger": {
                "Bucket": "TopRankVideo-125xxx88",
                "Region": "ap-chongqing",
                "Dir": "/movie/201907/"
              }
            },
            "MediaOutputInfo": null,
            "MediaProcessTask": {
              "TranscodeTaskSet": [
                {
                  "Definition": 10,
                  "WatermarkSet": [],
                  "MediaOutputInfo": null
                }
              ]
            },
            "AiContentReviewTask": null,
            "AiAnalysisTask": null,
            "AiRecognitionTask": null,
            "TaskNotifyConfig": null,
            "TaskPriority": 0,
            "CreateTime": "2019-07-18T10:00:00Z",
            "UpdateTime": "2019-07-18T11:00:03Z"
          }
        ]
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。