服务端 API 文档

获取任务流模板列表

最近更新时间:2020-07-13 08:59:04

1. 接口描述

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

根据任务流模板名字,获取任务流模板详情列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProcedureTemplates。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
Names.N Array of String 任务流模板名字过滤条件,数组长度限制:100。
Type String 任务流模板类型过滤条件,可选值:
  • Preset:系统预置任务流模板;
  • Custom:用户自定义任务流模板。
  • Offset Integer 分页偏移量,默认值:0。
    Limit Integer 返回记录条数,默认值:10,最大值:100。
    SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    ProcedureTemplateSet Array of ProcedureTemplate 任务流模板详情列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询指定任务流模板

    查询名为“我的任务流A”的任务流模板的详情

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeProcedureTemplates
    &Names.0=我的任务流A
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 1,
        "ProcedureTemplateSet": [
          {
            "Name": "我的任务流A",
            "Type": "Custom",
            "MediaPrcoessTask": {
              "TranscodeTaskSet": [
                {
                  "Definition": 20,
                  "WatermarkSet": null
                },
                {
                  "Definition": 30,
                  "WatermarkSet": null
                },
                {
                  "Definition": 40,
                  "WatermarkSet": null
                }
              ],
              "AnimatedGraphicTaskSet": null,
              "SnapshotByTimeOffsetTaskSet": null,
              "SampleSnapshotTaskSet": null,
              "ImageSpriteTaskSet": null,
              "CoverBySnapshotTaskSet": null
            },
            "AiContentReviewTask": null,
            "AiAnalysisTask": null,
            "AiRecognitionTask": null,
            "MiniProgramPublishTask": null
          }
        ],
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
      }
    }

    示例2 查询所有的任务流模板

    查询所有的任务流模板的详情,共查到3个任务流模板

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeProcedureTemplates
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 3,
        "ProcedureTemplateSet": [
          {
            "Name": "我的任务流A",
            "Type": "Custom",
            "MediaPrcoessTask": {
              "TranscodeTaskSet": [
                {
                  "Definition": 20,
                  "WatermarkSet": null
                },
                {
                  "Definition": 30,
                  "WatermarkSet": null
                },
                {
                  "Definition": 40,
                  "WatermarkSet": null
                }
              ],
              "AnimatedGraphicTaskSet": null,
              "SnapshotByTimeOffsetTaskSet": null,
              "SampleSnapshotTaskSet": null,
              "ImageSpriteTaskSet": null,
              "CoverBySnapshotTaskSet": null
            },
            "AiContentReviewTask": null,
            "AiAnalysisTask": null,
            "AiRecognitionTask": null,
            "MiniProgramPublishTask": null
          },
          {
            "Name": "我的任务流B",
            "Type": "Custom",
            "MediaPrcoessTask": {
              "TranscodeTaskSet": [
                {
                  "Definition": 20,
                  "WatermarkSet": [
                    {
                      "Definition": 15780,
                      "TextContent": null
                    }
                  ]
                },
                {
                  "Definition": 30,
                  "WatermarkSet": [
                    {
                      "Definition": 15780,
                      "TextContent": null
                    }
                  ]
                },
                {
                  "Definition": 40,
                  "WatermarkSet": [
                    {
                      "Definition": 15780,
                      "TextContent": null
                    }
                  ]
                }
              ],
              "AnimatedGraphicTaskSet": null,
              "SnapshotByTimeOffsetTaskSet": null,
              "SampleSnapshotTaskSet": null,
              "ImageSpriteTaskSet": null,
              "CoverBySnapshotTaskSet": null
            },
            "AiContentReviewTask": null,
            "AiAnalysisTask": null,
            "AiRecognitionTask": null,
            "MiniProgramPublishTask": null
          },
          {
            "Name": "我的任务流C",
            "Type": "Custom",
            "MediaPrcoessTask": null,
            "AiContentReviewTask": {
              "Definition": 10
            },
            "AiAnalysisTask": null,
            "AiRecognitionTask": null,
            "MiniProgramPublishTask": null
          }
        ],
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.InvalidVodUser 没有开通点播业务。
    InternalError 内部错误。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.Names Names数组中元素过多。
    InvalidParameterValue.Type Type 参数值错误。
    UnauthorizedOperation 未授权操作。
    目录