功能描述
查询工作流。
授权说明
授权策略中 action 设置为 ci:DescribeMediaWorkflows
。查看所有 action。
服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
请求
请求示例
GET /workflow HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
说明Authorization: Auth String(详情请参见 请求签名 文档)。通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。
请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
请求体
该请求的请求体为空。
请求参数
参数名称(关键字) | 描述 | 类型 | 是否必选 |
ids | 工作流 ID,以, 符号分割字符串 |
string | 否 |
name | 工作流名称 | string | 否 |
pageNumber | 第几页 | string | 否 |
pageSize | 每页个数 | string | 否 |
响应
响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response> <RequestId>NjJmMWZiZTFfOTBmYTUwNjRfNjVmNl8x</RequestId> <TotalCount>2</TotalCount> <PageNumber>1</PageNumber> <PageSize>10</PageSize> <MediaWorkflowList> <Name>workflow-1</Name> <State>Active</State> <WorkflowId>wc666d0b9f9dd47ae9137a096252d49f7</WorkflowId> <BucketId>test-1234567890</BucketId> <CreateTime>2022-06-29T14:37:44+0800</CreateTime> <UpdateTime>2022-06-29T14:37:44+0800</UpdateTime> <Topology> <Dependencies> <Start>Snapshot_1581665960536,Transcode_1581665960538</Start> <Snapshot_1581665960536>End</Snapshot_1581665960536> <Transcode_1581665960538>Segment_15816659605667,SmartCover_1581665960539</Transcode_1581665960538> <Segment_15816659605667>End</Segment_15816659605667> <SmartCover_1581665960539>PicProcess_15816659605668</SmartCover_1581665960539> <PicProcess_15816659605668>End</PicProcess_15816659605668> </Dependencies> <Nodes> <Start> <Type>Start</Type> <Input> <QueueId>p09d709939fef48a0a5c247ef39d90cec</QueueId> <PicProcessQueueId>p2911917386e148639319e13c285cc774</PicProcessQueueId> <ObjectPrefix>input/workflow-1</ObjectPrefix> <NotifyConfig> <State>On</State> <Url>http://www.callback.com</Url> <Event>TaskFinish,WorkflowFinish,WorkflowStart</Event> <Type>Url</Type> <ResultFormat>JSON</ResultFormat> </NotifyConfig> <ExtFilter> <State>On</State> <Video>true</Video> <Audio>false</Audio> <Image>false</Image> <Custom>false</Custom> <AllFile>false</AllFile> </ExtFilter> </Input> </Start> <Snapshot_1581665960536> <Type>Snapshot</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>abc/${RunId}/snapshot-${number}.${Ext}</Object> <SpriteObject>abc/${RunId}/sprite-${number}.${Ext}</SpriteObject> </Output> </Operation> </Snapshot_1581665960536> <Transcode_1581665960538> <Type>Transcode</Type> <Operation> <TemplateId>t16e81a29fe48c4e23acefc247a7792b63</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>bcd/${RunId}/trans.{Ext}</Object> </Output> </Operation> </Transcode_1581665960538> <Segment_15816659605667> <Type>Segment</Type> <Operation> <Segment> <Format>mkv</Format> <Duration>20</Duration> </Segment> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>test-trans${Number}.{Ext}</Object> </Output> </Operation> </Segment_15816659605667> <SmartCover_1581665960539> <Type>SmartCover</Type> <Operation> <TemplateId>t16e81a29fe48c4e23acefc247a7792b63</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>abc/${RunId}/cover-${Number}.{Ext}</Object> </Output> </Operation> </SmartCover_1581665960539> <PicProcess_15816659605668> <Type>PicProcess</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>bcd/${RunId}/pic.{Ext}</Object> </Output> </Operation> </PicProcess_15816659605668> </Nodes> </Topology> </MediaWorkflowList> <MediaWorkflowList> <Name>workflow-2</Name> <State>Active</State> <WorkflowId>w93aa43ba105347169fa093ed857b2a90</WorkflowId> <BucketId>test-1234567890</BucketId> <CreateTime>2022-06-29T14:37:44+0800</CreateTime> <UpdateTime>2022-06-29T14:37:44+0800</UpdateTime> <Topology> <Dependencies> <Start>StreamPackConfig_1581665960532</Start> <StreamPackConfig_1581665960532>VideoStream_1581665960536,VideoStream_1581665960537</StreamPackConfig_1581665960532> <VideoStream_1581665960536>StreamPack_1581665960538</VideoStream_1581665960536> <VideoStream_1581665960537>StreamPack_1581665960538</VideoStream_1581665960537> <StreamPack_1581665960538>End</StreamPack_1581665960538> </Dependencies> <Nodes> <Start> <Type>Start</Type> <Input> <QueueId>p09d709939fef48a0a5c247ef39d90cec</QueueId> <ObjectPrefix>input/workflow-2</ObjectPrefix> <NotifyConfig> <State>On</State> <Url>http://www.callback.com</Url> <Event>TaskFinish,WorkflowFinish,WorkflowStart</Event> <Type>Url</Type> <ResultFormat>JSON</ResultFormat> </NotifyConfig> <ExtFilter> <State>On</State> <Video>true</Video> <Audio>false</Audio> <Image>false</Image> <Custom>false</Custom> <AllFile>false</AllFile> </ExtFilter> </Input> </Start> <StreamPackConfig_1581665960532> <Type>StreamPackConfig</Type> <Operation> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>${InputPath}/${InputName}._${RunId}.${ext}</Object> </Output> <StreamPackConfig> <PackType>HLS</PackType> <IgnoreFailedStream>true</IgnoreFailedStream> </StreamPackConfig> </Operation> </StreamPackConfig_1581665960532> <VideoStream_1581665960536> <Type>VideoStream</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>${RunId}_Substream_1/video.m3u8</Object> </Output> </Operation> </VideoStream_1581665960536> <VideoStream_1581665960537> <Type>VideoStream</Type> <Operation> <TemplateId>t1460606bgfdg2148c4ab182f55163ba7bj</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>${RunId}_Substream_2/video.m3u8</Object> </Output> </Operation> </VideoStream_1581665960537> <StreamPack_1581665960538> <Type>StreamPack</Type> <Operation> <StreamPackInfo> <VideoStreamConfig> <VideoStreamName>VideoStream_1581665960536</VideoStreamName> <BandWidth>200000000</BandWidth> </VideoStreamConfig> <VideoStreamConfig> <VideoStreamName>VideoStream_1581665960537</VideoStreamName> <BandWidth>200000000</BandWidth> </VideoStreamConfig> </StreamPackInfo> </Operation> </StreamPack_1581665960538> </Nodes> </Topology> </MediaWorkflowList></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
RequestId | Response | 请求的唯一 ID | String |
TotalCount | Response | 工作流总数 | Int |
PageNumber | Response | 当前页数,同请求中的 pageNumber | Int |
PageSize | Response | 每页个数,同请求中的 pageSize | Int |
MediaWorkflowList | Response | 工作流数组 | Container |
Container节点 MediaWorkflowList 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 限制 |
Name | Response.MediaWorkflowList | 工作流名称 | String | 是 | 支持中文、英文、数字、—和_,长度限制128字符 |
WorkflowId | Response.MediaWorkflowList | 工作流 ID | String | 是 | 工作流唯一 ID |
State | Response.MediaWorkflowList | 工作流状态 | String | 是 | 1. Active 2. Paused |
CreateTime | Response.MediaWorkflowList | 创建时间 | String | 是 | 无 |
UpdateTime | Response.MediaWorkflowList | 更新时间 | String | 是 | 无 |
Topology | Response.MediaWorkflowList | 拓扑信息 | Container | 是 | 同创建工作流接口的 Topology |
错误码
该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。
实际案例
请求1:工作流 ID
GET /workflow?ids=wc666d0b9f9dd47ae9137a096252d49f7,A,B HTTP/1.1Authorization: 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.comContent-Length: 0Content-Type: application/xml
响应1
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NjJmMWZmMzRfOTBmYTUwNjRfNjVmOF8x
<Response> <RequestId>NjJmMWZmMzRfOTBmYTUwNjRfNjVmOF8x</RequestId> <MediaWorkflowList> <Name>workflow-1</Name> <State>Active</State> <WorkflowId>wc666d0b9f9dd47ae9137a096252d49f7</WorkflowId> <BucketId>test-1234567890</BucketId> <CreateTime>2022-06-29T14:37:44+0800</CreateTime> <UpdateTime>2022-06-29T14:37:44+0800</UpdateTime> <Topology> <Dependencies> <Start>Snapshot_1581665960536,Transcode_1581665960538</Start> <Snapshot_1581665960536>End</Snapshot_1581665960536> <Transcode_1581665960538>Segment_15816659605667,SmartCover_1581665960539</Transcode_1581665960538> <Segment_15816659605667>End</Segment_15816659605667> <SmartCover_1581665960539>PicProcess_15816659605668</SmartCover_1581665960539> <PicProcess_15816659605668>End</PicProcess_15816659605668> </Dependencies> <Nodes> <Start> <Type>Start</Type> <Input> <QueueId>p09d709939fef48a0a5c247ef39d90cec</QueueId> <PicProcessQueueId>p2911917386e148639319e13c285cc774</PicProcessQueueId> <ObjectPrefix>input/workflow-1</ObjectPrefix> <NotifyConfig> <State>On</State> <Url>http://www.callback.com</Url> <Event>TaskFinish,WorkflowFinish,WorkflowStart</Event> <Type>Url</Type> <ResultFormat>JSON</ResultFormat> </NotifyConfig> <ExtFilter> <State>On</State> <Video>true</Video> <Audio>false</Audio> <Image>false</Image> <Custom>false</Custom> <AllFile>false</AllFile> </ExtFilter> </Input> </Start> <Snapshot_1581665960536> <Type>Snapshot</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>abc/${RunId}/snapshot-${number}.${Ext}</Object> <SpriteObject>abc/${RunId}/sprite-${number}.${Ext}</SpriteObject> </Output> </Operation> </Snapshot_1581665960536> <Transcode_1581665960538> <Type>Transcode</Type> <Operation> <TemplateId>t16e81a29fe48c4e23acefc247a7792b63</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>bcd/${RunId}/trans.{Ext}</Object> </Output> </Operation> </Transcode_1581665960538> <Segment_15816659605667> <Type>Segment</Type> <Operation> <Segment> <Format>mkv</Format> <Duration>20</Duration> </Segment> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>test-trans${Number}.{Ext}</Object> </Output> </Operation> </Segment_15816659605667> <SmartCover_1581665960539> <Type>SmartCover</Type> <Operation> <TemplateId>t16e81a29fe48c4e23acefc247a7792b63</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>abc/${RunId}/cover-${Number}.{Ext}</Object> </Output> </Operation> </SmartCover_1581665960539> <PicProcess_15816659605668> <Type>PicProcess</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>bcd/${RunId}/pic.{Ext}</Object> </Output> </Operation> </PicProcess_15816659605668> </Nodes> </Topology> </MediaWorkflowList> <NonExistIDs>A</NonExistIDs> <NonExistIDs>B</NonExistIDs></Response>
请求2:工作流列表
GET /workflow?pageNumber=1&pageSize=10 HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host: test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 0Content-Type: application/xml
响应2
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=
<Response> <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId> <TotalCount>2</TotalCount> <PageNumber>1</PageNumber> <PageSize>10</PageSize> <MediaWorkflowList> <Name>workflow-1</Name> <State>Active</State> <WorkflowId>wc666d0b9f9dd47ae9137a096252d49f7</WorkflowId> <BucketId>test-1234567890</BucketId> <CreateTime>2022-06-29T14:37:44+0800</CreateTime> <UpdateTime>2022-06-29T14:37:44+0800</UpdateTime> <Topology> <Dependencies> <Start>Snapshot_1581665960536,Transcode_1581665960538</Start> <Snapshot_1581665960536>End</Snapshot_1581665960536> <Transcode_1581665960538>Segment_15816659605667,SmartCover_1581665960539</Transcode_1581665960538> <Segment_15816659605667>End</Segment_15816659605667> <SmartCover_1581665960539>PicProcess_15816659605668</SmartCover_1581665960539> <PicProcess_15816659605668>End</PicProcess_15816659605668> </Dependencies> <Nodes> <Start> <Type>Start</Type> <Input> <QueueId>p09d709939fef48a0a5c247ef39d90cec</QueueId> <PicProcessQueueId>p2911917386e148639319e13c285cc774</PicProcessQueueId> <ObjectPrefix>input/workflow-1</ObjectPrefix> <NotifyConfig> <State>On</State> <Url>http://www.callback.com</Url> <Event>TaskFinish,WorkflowFinish,WorkflowStart</Event> <Type>Url</Type> <ResultFormat>JSON</ResultFormat> </NotifyConfig> <ExtFilter> <State>On</State> <Video>true</Video> <Audio>false</Audio> <Image>false</Image> <Custom>false</Custom> <AllFile>false</AllFile> </ExtFilter> </Input> </Start> <Snapshot_1581665960536> <Type>Snapshot</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>abc/${RunId}/snapshot-${number}.${Ext}</Object> <SpriteObject>abc/${RunId}/sprite-${number}.${Ext}</SpriteObject> </Output> </Operation> </Snapshot_1581665960536> <Transcode_1581665960538> <Type>Transcode</Type> <Operation> <TemplateId>t16e81a29fe48c4e23acefc247a7792b63</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>bcd/${RunId}/trans.{Ext}</Object> </Output> </Operation> </Transcode_1581665960538> <Segment_15816659605667> <Type>Segment</Type> <Operation> <Segment> <Format>mkv</Format> <Duration>20</Duration> </Segment> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>test-trans${Number}.{Ext}</Object> </Output> </Operation> </Segment_15816659605667> <SmartCover_1581665960539> <Type>SmartCover</Type> <Operation> <TemplateId>t16e81a29fe48c4e23acefc247a7792b63</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>abc/${RunId}/cover-${Number}.{Ext}</Object> </Output> </Operation> </SmartCover_1581665960539> <PicProcess_15816659605668> <Type>PicProcess</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>bcd/${RunId}/pic.{Ext}</Object> </Output> </Operation> </PicProcess_15816659605668> </Nodes> </Topology> </MediaWorkflowList> <MediaWorkflowList> <Name>workflow-2</Name> <State>Active</State> <WorkflowId>w93aa43ba105347169fa093ed857b2a90</WorkflowId> <BucketId>test-1234567890</BucketId> <CreateTime>2022-06-29T14:37:44+0800</CreateTime> <UpdateTime>2022-06-29T14:37:44+0800</UpdateTime> <Topology> <Dependencies> <Start>StreamPackConfig_1581665960532</Start> <StreamPackConfig_1581665960532>VideoStream_1581665960536,VideoStream_1581665960537</StreamPackConfig_1581665960532> <VideoStream_1581665960536>StreamPack_1581665960538</VideoStream_1581665960536> <VideoStream_1581665960537>StreamPack_1581665960538</VideoStream_1581665960537> <StreamPack_1581665960538>End</StreamPack_1581665960538> </Dependencies> <Nodes> <Start> <Type>Start</Type> <Input> <QueueId>p09d709939fef48a0a5c247ef39d90cec</QueueId> <ObjectPrefix>input/workflow-2</ObjectPrefix> <NotifyConfig> <State>On</State> <Url>http://www.callback.com</Url> <Event>TaskFinish,WorkflowFinish,WorkflowStart</Event> <Type>Url</Type> <ResultFormat>JSON</ResultFormat> </NotifyConfig> <ExtFilter> <State>On</State> <Video>true</Video> <Audio>false</Audio> <Image>false</Image> <Custom>false</Custom> <AllFile>false</AllFile> </ExtFilter> </Input> </Start> <StreamPackConfig_1581665960532> <Type>StreamPackConfig</Type> <Operation> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>${InputPath}/${InputName}._${RunId}.${ext}</Object> </Output> <StreamPackConfig> <PackType>HLS</PackType> <IgnoreFailedStream>true</IgnoreFailedStream> </StreamPackConfig> </Operation> </StreamPackConfig_1581665960532> <VideoStream_1581665960536> <Type>VideoStream</Type> <Operation> <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>${RunId}_Substream_1/video.m3u8</Object> </Output> </Operation> </VideoStream_1581665960536> <VideoStream_1581665960537> <Type>VideoStream</Type> <Operation> <TemplateId>t1460606bgfdg2148c4ab182f55163ba7bj</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>${RunId}_Substream_2/video.m3u8</Object> </Output> </Operation> </VideoStream_1581665960537> <StreamPack_1581665960538> <Type>StreamPack</Type> <Operation> <StreamPackInfo> <VideoStreamConfig> <VideoStreamName>VideoStream_1581665960536</VideoStreamName> <BandWidth>200000000</BandWidth> </VideoStreamConfig> <VideoStreamConfig> <VideoStreamName>VideoStream_1581665960537</VideoStreamName> <BandWidth>200000000</BandWidth> </VideoStreamConfig> </StreamPackInfo> </Operation> </StreamPack_1581665960538> </Nodes> </Topology> </MediaWorkflowList></Response>
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145328.html