媒体处理
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 媒体处理 > API 文档 > 工作流管理相关接口 > 获取工作流列表

获取工作流列表

最近更新时间：2024-03-12 01:41:30

我的收藏

本页目录：

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

    • 不填此参数，则不区分工作流状态。
    示例值：“”
    Offset 否 Integer 分页偏移量，默认值：0。
    示例值：0
    Limit 否 Integer 返回记录条数，默认值：10，最大值：100。
    示例值：0

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    示例值：1
    WorkflowInfoSet Array of WorkflowInfo 工作流信息数组。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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/"
                    }
                },
                "OutputStorage": {
                    "Type": "COS",
                    "CosOutputStorage": {
                        "Bucket": "TopRankVideo-125xxx88",
                        "Region": "ap-chongqing"
                    }
                },
                "MediaProcessTask": {
                    "TranscodeTaskSet": [
                        {
                            "Definition": 10,
                            "WatermarkSet": []
                        }
                    ]
                },
                "OutputDir": "/movie/201907/",
                "AiContentReviewTask": null,
                "AiRecognitionTask": null,
                "AiAnalysisTask": null,
                "TaskNotifyConfig": null,
                "TaskPriority": 0,
                "CreateTime": "2019-07-18T10:00:00Z",
                "UpdateTime": "2019-07-18T11:00:03Z"
            }
        ]
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

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