文档

SearchMediaWorkflow - 搜索媒体工作流

更新时间:

搜索媒体工作流。

接口说明

本接口通过指定工作流状态搜索工作流,如果不指定则默认搜索全部状态的工作流。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mts:SearchMediaWorkflow
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageSizelong

分查询时设置的每页大小。

  • 上限值:100

  • 默认值:10

10
PageNumberlong

当前页号。 默认值:1

1
StateListstring

媒体工作流状态列表。 可多选,用半角逗号(,)分隔。默认值:“Inactive,Active,Deleted”(搜索全部)。取值范围:

  • Inactive:已停用。

  • Active:已启用。

  • Deleted:已删除。

Inactive,Active,Deleted

返回参数

名称类型描述示例值
object

返回参数。

TotalCountlong

总条数。

1
MediaWorkflowListarray<object>

媒体工作流列表。

object

媒体工作流详细信息。

CreationTimestring

创建时间。

2016-04-01T05:38:41Z
MediaWorkflowIdstring

媒体工作流 ID。

88c6ca184c0e4578645b665e2a12****
Statestring

状态。可取值:

  • Inactive:已停用。

  • Active:已启用。

  • Deleted:已删除。

Active
TriggerModestring

触发模式。可取值:

  • OssAutoTrigger:自动触发。

  • NotInAuto:不自动触发。

OssAutoTrigger
Namestring

媒体工作流名称。

example-mediaworkflow-****
Topologystring

媒体工作流拓扑结构。

{"MediaWorkflowList":{"MediaWorkflow":[{"CreationTime":"2016-04-01T05:29:38Z","Name":"example-mediaworkflow-****","State":"Active","Topology":"{\"Activities\":{\"Act-Start\":{\"Parameters\":{\"PipelineId\":\"130266f58161436a80bf07cb12c8****\",\"InputFile\":\"{\\\"Bucket\\\": \\\"example-bucket-****\\\",\\\"Location\\\": \\\"example-location\\\"}\"},\"Type\":\"Start\"},\"Act-Report\":{\"Parameters\":{},\"Type\":\"Report\"},\"Act-Transcode-M3U8\":{\"Parameters\":{\"Outputs\":\"[{\\\"Object\\\":\\\"transcode/{ObjectPrefix}{FileName}\\\",\\\"TemplateId\\\": \\\"957d1719ee85ed6527b90cf62726****\\\"}]\",\"OutputBucket\":\"example-bucket-****\",\"OutputLocation\":\"example-location\"},\"Type\":\"Transcode\"}},\"Dependencies\":{\"Act-Start\":[\"Act-Transcode-M3U8\"],\"Act-Report\":[],\"Act-Transcode-M3U8\":[\"Act-Report\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}
PageSizelong

分查询时设置的每页大小。

10
RequestIdstring

请求 ID。

16CD0CDD-457E-420D-9755-8385075A1234
PageNumberlong

当前页号。

1

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "MediaWorkflowList": {
    "MediaWorkflow": [
      {
        "CreationTime": "2016-04-01T05:38:41Z",
        "MediaWorkflowId": "88c6ca184c0e4578645b665e2a12****",
        "State": "Active",
        "TriggerMode": "OssAutoTrigger",
        "Name": "example-mediaworkflow-****",
        "Topology": "{\"MediaWorkflowList\":{\"MediaWorkflow\":[{\"CreationTime\":\"2016-04-01T05:29:38Z\",\"Name\":\"example-mediaworkflow-****\",\"State\":\"Active\",\"Topology\":\"{\\\"Activities\\\":{\\\"Act-Start\\\":{\\\"Parameters\\\":{\\\"PipelineId\\\":\\\"130266f58161436a80bf07cb12c8****\\\",\\\"InputFile\\\":\\\"{\\\\\\\"Bucket\\\\\\\": \\\\\\\"example-bucket-****\\\\\\\",\\\\\\\"Location\\\\\\\": \\\\\\\"example-location\\\\\\\"}\\\"},\\\"Type\\\":\\\"Start\\\"},\\\"Act-Report\\\":{\\\"Parameters\\\":{},\\\"Type\\\":\\\"Report\\\"},\\\"Act-Transcode-M3U8\\\":{\\\"Parameters\\\":{\\\"Outputs\\\":\\\"[{\\\\\\\"Object\\\\\\\":\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\",\\\\\\\"TemplateId\\\\\\\": \\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\"}]\\\",\\\"OutputBucket\\\":\\\"example-bucket-****\\\",\\\"OutputLocation\\\":\\\"example-location\\\"},\\\"Type\\\":\\\"Transcode\\\"}},\\\"Dependencies\\\":{\\\"Act-Start\\\":[\\\"Act-Transcode-M3U8\\\"],\\\"Act-Report\\\":[],\\\"Act-Transcode-M3U8\\\":[\\\"Act-Report\\\"]}}\",\"MediaWorkflowId\":\"93ab850b4f6f44eab54b6e91d24d****\"}]},\"RequestId\":\"16CD0CDD-457E-420D-9755-8385075A1234\"}"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "16CD0CDD-457E-420D-9755-8385075A1234",
  "PageNumber": 1
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史