'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Mts',
'version' => '2014-06-18',
],
'directories' => [
[
'id' => 122500,
'title' => '媒体信息接口',
'type' => 'directory',
'children' => [
'SubmitMediaInfoJob',
'QueryMediaInfoJobList',
],
],
[
'id' => 179157,
'title' => '转码接口',
'type' => 'directory',
'children' => [
'SubmitJobs',
'CancelJob',
'QueryJobList',
'ListJob',
],
],
[
'id' => 179156,
'title' => '预置智能模板推荐接口',
'type' => 'directory',
'children' => [
'SubmitAnalysisJob',
'QueryAnalysisJobList',
],
],
[
'id' => 122569,
'title' => '自定义转码模板接口',
'type' => 'directory',
'children' => [
'AddTemplate',
'UpdateTemplate',
'QueryTemplateList',
'SearchTemplate',
'DeleteTemplate',
],
],
[
'id' => 122563,
'title' => '水印模板接口',
'type' => 'directory',
'children' => [
'AddWaterMarkTemplate',
'DeleteWaterMarkTemplate',
'UpdateWaterMarkTemplate',
'SearchWaterMarkTemplate',
'QueryWaterMarkTemplateList',
],
],
[
'id' => 122553,
'title' => '截图接口',
'type' => 'directory',
'children' => [
'SubmitSnapshotJob',
'QuerySnapshotJobList',
],
],
[
'id' => 122517,
'title' => '管道接口',
'type' => 'directory',
'children' => [
'UpdatePipeline',
'QueryPipelineList',
'SearchPipeline',
'AddPipeline',
'DeletePipeline',
],
],
[
'id' => 122542,
'title' => '媒体工作流接口',
'type' => 'directory',
'children' => [
'AddMediaWorkflow',
'ActivateMediaWorkflow',
'DeactivateMediaWorkflow',
'DeleteMediaWorkflow',
'UpdateMediaWorkflow',
'QueryMediaWorkflowList',
'SearchMediaWorkflow',
'UpdateMediaWorkflowTriggerMode',
],
],
[
'id' => 179221,
'title' => '媒体工作流执行实例接口',
'type' => 'directory',
'children' => [
'QueryMediaWorkflowExecutionList',
'ListMediaWorkflowExecutions',
],
],
[
'id' => 122587,
'title' => '媒体Bucket接口',
'type' => 'directory',
'children' => [
'BindInputBucket',
'BindOutputBucket',
'UnbindInputBucket',
'UnbindOutputBucket',
'ListAllMediaBucket',
],
],
[
'id' => 179158,
'title' => '媒体接口',
'type' => 'directory',
'children' => [
'AddMedia',
'DeleteMedia',
'UpdateMedia',
'UpdateMediaCategory',
'UpdateMediaCover',
'AddMediaTag',
'DeleteMediaTag',
'UpdateMediaPublishState',
'QueryMediaList',
'QueryMediaListByURL',
],
],
[
'id' => 179196,
'title' => '智能生产接口',
'type' => 'directory',
'children' => [
'QueryIProductionJob',
'SubmitIProductionJob',
],
],
[
'id' => 122528,
'title' => '智能标签接口',
'type' => 'directory',
'children' => [
'SubmitSmarttagJob',
'QuerySmarttagJob',
'AddSmarttagTemplate',
'QuerySmarttagTemplateList',
'UpdateSmarttagTemplate',
'DeleteSmarttagTemplate',
'RegisterCustomFace',
'UnregisterCustomFace',
'TagCustomPerson',
'ListCustomPersons',
'CreateCustomGroup',
'CreateCustomEntity',
'RegisterCustomView',
'DeleteCustomEntity',
'DeleteCustomGroup',
'DeleteCustomView',
'ListCustomViews',
'ListCustomEntities',
'ListCustomGroups',
],
],
[
'id' => 122592,
'title' => '媒体审核接口',
'type' => 'directory',
'children' => [
'SubmitMediaCensorJob',
'QueryMediaCensorJobDetail',
'QueryMediaCensorJobList',
'ImAudit',
],
],
[
'id' => 122493,
'title' => '视频DNA接口',
'type' => 'directory',
'children' => [
'SubmitFpShotJob',
'QueryFpShotJobList',
'CreateFpShotDB',
'ListFpShotDB',
'ImportFpShotJob',
'ListFpShotFiles',
'SubmitFpFileDeleteJob',
'QueryFpFileDeleteJobList',
'SubmitFpDBDeleteJob',
'QueryFpDBDeleteJobList',
'ListFpShotImportJob',
],
],
[
'id' => 193954,
'title' => '数字水印接口',
'type' => 'directory',
'children' => [
'SubmitCopyrightJob',
'QueryCopyrightJob',
'SubmitTraceAbJob',
'QueryTraceAbJob',
'SubmitTraceM3u8Job',
'QueryTraceM3u8Job',
'SubmitCopyrightExtractJob',
'QueryCopyrightExtractJob',
'SubmitTraceExtractJob',
'QueryTraceExtractJob',
'SubmitImageCopyright',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'SubmitMediaInfoJob' => [
'summary' => '提交媒体信息作业。调用本接口之后媒体处理MPS会对输入文件进行媒体信息分析,返回输入文件的媒体信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '23180',
'abilityTreeNodes' => [
'FEATUREmtsZWMPKM',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '作业输入。详细说明请参见[Input详情](~~29253#section-f3p-d24-y2b~~)。'."\n"
."\n"
.'> - 在媒体处理API中,Object必须经过[URL Encoding](~~423796~~)(基于UTF-8编码)后使用。'."\n"
.'- OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Fexample.flv"}',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据。可以使用中英文、数字、中划线(-)等,不能以特殊符号开头,最大长度1024个字节。',
'type' => 'string',
'required' => false,
'example' => 'testid-001',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID。详细信息请参见[基本概念](~~29197~~)。'."\n"
.'- 可选值:可以通过[MPS控制台](https://mps.console.aliyun.com/overview)>**全局设置**>**管道**查询和创建。'."\n"
.'- 如果需要异步通知,请为管道绑定MNS消息,具体请参见[接收消息通知](https://help.aliyun.com/document_detail/42618.html)[接收消息通知](https://www.alibabacloud.com/help/en/mps/receive-message-notifications/?spm=a2c63.p38356.0.0.b48576d2jxNSca)。',
'type' => 'string',
'required' => false,
'example' => '88c6ca184c0e432bbf5b665e2a15****',
],
],
[
'name' => 'Async',
'in' => 'query',
'schema' => [
'description' => '是否发起异步作业。取值:'."\n"
."\n"
.'- **true**:发起异步作业(推荐)。'."\n"
.'- **false**:不发起异步作业。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'Config',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'MediaInfoJob' => [
'description' => '媒体信息作业详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '作业添加时间。',
'type' => 'string',
'example' => '2014-01-10T12:00:00Z',
],
'State' => [
'description' => '作业状态。'."\n"
."\n"
.'- **Success**:成功。'."\n"
.'- **Fail**:失败。'."\n"
.'- **Analyzing**:分析中。'."\n",
'type' => 'string',
'example' => 'Analyzing',
],
'JobId' => [
'description' => '元信息分析作业ID。',
'type' => 'string',
'example' => '23ca1d184c0e4341e5b665e2a12****',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'Code' => [
'description' => '元信息分析失败时错误码。',
'type' => 'string',
'example' => 'InvalidParameter.JsonObjectFormatInvalid',
],
'Message' => [
'description' => '元信息分析失败时错误信息。',
'type' => 'string',
'example' => 'The parameter ”*” does not conform to the JSON Object specification',
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => '88c6ca184c0e432bbf5b665e2a15****',
],
'Async' => [
'description' => '是否异步。',
'type' => 'boolean',
'example' => 'true',
],
'Input' => [
'description' => '作业输入信息。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example.flv',
],
'Location' => [
'description' => '输入文件OSS的服务区域。',
'type' => 'string',
'example' => 'example-location',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。如果执行失败则不返回此参数。',
'type' => 'string',
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
'ErrorMessage' => [
'description' => '失败时错误信息。如果执行成功则不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.JsonObjectFormatInvalid',
],
'ErrorCode' => [
'description' => '失败时错误码。如果执行成功则不返回此参数。',
'type' => 'string',
'example' => 'The parameter \\"Input\\" does not conform to the JSON Object specification',
],
],
],
'Properties' => [
'description' => '媒体文件属性。',
'type' => 'object',
'properties' => [
'Width' => [
'description' => '视频宽度,单位为px。',
'type' => 'string',
'example' => '1920',
],
'Height' => [
'description' => '视频高度,单位为px。',
'type' => 'string',
'example' => '1080',
],
'Duration' => [
'description' => '总时长,单位为秒(s)。',
'type' => 'string',
'example' => '17.226000',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25',
],
'Bitrate' => [
'description' => '码率。单位为Kbps。',
'type' => 'string',
'example' => '1630.045',
],
'FileFormat' => [
'description' => '文件格式。',
'type' => 'string',
'example' => 'QuickTime/MOV',
],
'Streams' => [
'description' => '流信息。',
'type' => 'object',
'properties' => [
'VideoStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoStream' => [
'description' => '视频流列表。列表元素至多4个。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Sar' => [
'description' => '编码信号分辨率比。',
'type' => 'string',
'example' => '1:1',
],
'Height' => [
'description' => '视频高度,单位为px。',
'type' => 'string',
'example' => '1080',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'avc1',
],
'NetworkCost' => [
'description' => '网络带宽消耗。',
'type' => 'object',
'properties' => [
'PreloadTime' => [
'description' => '预加载时间。',
'type' => 'string',
'example' => '8',
],
'AvgBitrate' => [
'description' => '平均码率,单位为Kbps。',
'type' => 'string',
'example' => '300.34',
],
'CostBandwidth' => [
'description' => '最大消耗带宽。',
'type' => 'string',
'example' => '10',
],
],
],
'Width' => [
'description' => '视频宽度,单位为px。',
'type' => 'string',
'example' => '1920',
],
'Index' => [
'description' => '视频流序号。标识视频流在整个媒体流中的位置。某些播放平台可以指定起播的视频流序号,某些默认从1号起播。',
'type' => 'string',
'example' => '1',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/24000',
],
'AvgFPS' => [
'description' => '平均帧率。',
'type' => 'string',
'example' => '23.976025',
],
'PixFmt' => [
'description' => '像素格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Lang' => [
'description' => '语言。',
'type' => 'string',
'example' => 'eng',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '100',
],
'Rotate' => [
'description' => '视频旋转角度。',
'type' => 'string',
'example' => '90',
],
'Bitrate' => [
'description' => '码率,单位Kbps。',
'type' => 'string',
'example' => '1496.46',
],
'HasBFrames' => [
'description' => '是否有B帧。0表示无,1表示有。',
'type' => 'string',
'example' => '0',
],
'Profile' => [
'description' => '编码预置。',
'type' => 'string',
'example' => 'High',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.042000',
],
'Dar' => [
'description' => '编码显示分辨率比。Dar=视频宽度/视频高度,可以作为判断视频横竖屏的依据。',
'type' => 'string',
'example' => '16:9',
],
'CodecName' => [
'description' => '编码格式简述名。可选值:'."\n"
."\n"
.'- **h264**'."\n"
."\n"
.'- **h265**'."\n"
."\n"
.'- **gif**'."\n"
."\n"
.'- **webp**',
'type' => 'string',
'example' => 'h264',
],
'Duration' => [
'description' => '时长,单位为秒(s)。',
'type' => 'string',
'example' => '17.225542',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x31637661',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1001/48000',
],
'Level' => [
'description' => '编码等级。',
'type' => 'string',
'example' => '41',
],
'ColorRange' => [
'description' => '色彩范围。',
'type' => 'string',
'example' => '700',
],
'ColorTransfer' => [
'description' => '色彩通道。',
'type' => 'string',
'example' => 'R255 G83 B170',
],
'ColorPrimaries' => [
'description' => '色原。',
'type' => 'string',
'example' => '700',
],
'DurationInaccurate' => [
'type' => 'string',
],
],
],
],
],
],
'AudioStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioStream' => [
'description' => '音频流列表。列表元素至多4个。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/44100',
],
'Index' => [
'description' => '音频流序号。标识音频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'SampleFmt' => [
'description' => '采样格式。',
'type' => 'string',
'example' => 'fltp',
],
'ChannelLayout' => [
'description' => '声道输出样式。',
'type' => 'string',
'example' => 'stereo',
],
'Lang' => [
'description' => '语言。',
'type' => 'string',
'example' => 'eng',
],
'Samplerate' => [
'description' => '采样率,单位Hz。',
'type' => 'string',
'example' => '44100',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'AAC (Advanced Audio Coding)',
],
'Channels' => [
'description' => '声道数。',
'type' => 'string',
'example' => '2',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '123',
],
'Bitrate' => [
'description' => '码率,单位为Kbps。',
'type' => 'string',
'example' => '128.806',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'mp4a',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'CodecName' => [
'description' => '编码格式简述名。默认值:acc。可取值:'."\n"
."\n"
.'- **acc**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **mp4**'."\n"
."\n"
.'- **ogg**'."\n"
."\n"
.'- **flac**',
'type' => 'string',
'example' => 'aac',
],
'Duration' => [
'description' => '时长,单位为秒(s)。',
'type' => 'string',
'example' => '17.159546',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x6134706d',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/44100',
],
'DurationInaccurate' => [
'type' => 'string',
],
],
],
],
],
],
'SubtitleStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubtitleStream' => [
'description' => '字幕流列表。列表元素至多4个。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/1000',
],
'Index' => [
'description' => '字幕流序号。标识字幕流在整个媒体流中的位置。',
'type' => 'string',
'example' => '3',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'CodecName' => [
'description' => '编码格式简述名。可选值:'."\n"
."\n"
.'- **srt**'."\n"
."\n"
.'- **ass**',
'type' => 'string',
'example' => 'ass',
],
'Lang' => [
'description' => '语言。',
'type' => 'string',
'example' => 'eng',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'ASS (Advanced SSA) subtitle',
],
'Duration' => [
'description' => '时长,单位为秒(s)。',
'type' => 'string',
'example' => '1370.116000',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x0000',
],
'CodecTimeBase' => [
'description' => '编码时基。'."\n",
'type' => 'string',
'example' => '0/1',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => '[0][0][0][0]',
],
],
],
],
],
],
],
],
'Format' => [
'description' => '格式信息。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'NumPrograms' => [
'description' => '节目流总数。',
'type' => 'string',
'example' => '0',
],
'Size' => [
'description' => '文件大小,单位为字节(byte)。',
'type' => 'string',
'example' => '3509895',
],
'NumStreams' => [
'description' => '媒体流总数。',
'type' => 'string',
'example' => '2',
],
'FormatLongName' => [
'description' => '容器、封装格式长述名。',
'type' => 'string',
'example' => 'QuickTime/MOV',
],
'Duration' => [
'description' => '总时长,单位为秒(s)。',
'type' => 'string',
'example' => '17.226000',
],
'Bitrate' => [
'description' => '总码率,单位为Kbps。',
'type' => 'string',
'example' => '1630.045',
],
'FormatName' => [
'description' => '容器、封装格式简述名。更多参数信息请参见[参数详情](~~29253~~)。',
'type' => 'string',
'example' => 'mov',
],
],
],
'FileSize' => [
'description' => '文件大小,单位为字节(byte)。',
'type' => 'string',
'example' => '3509895',
],
'MD5' => [
'type' => 'string',
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '62D9BE16-B7D5-550C-A482-7A0F60E09877',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaInfoJob\\": {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"State\\": \\"Analyzing\\",\\n \\"JobId\\": \\"23ca1d184c0e4341e5b665e2a12****\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.JsonObjectFormatInvalid\\",\\n \\"Message\\": \\"The parameter ”*” does not conform to the JSON Object specification\\",\\n \\"PipelineId\\": \\"88c6ca184c0e432bbf5b665e2a15****\\",\\n \\"Async\\": true,\\n \\"Input\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"ErrorMessage\\": \\"InvalidParameter.JsonObjectFormatInvalid\\",\\n \\"ErrorCode\\": \\"The parameter \\\\\\\\\\\\\\"Input\\\\\\\\\\\\\\" does not conform to the JSON Object specification\\"\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Fps\\": \\"25\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FileFormat\\": \\"QuickTime/MOV\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"1080\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300.34\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Width\\": \\"1920\\",\\n \\"Index\\": \\"1\\",\\n \\"Timebase\\": \\"1/24000\\",\\n \\"AvgFPS\\": \\"23.976025\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Rotate\\": \\"90\\",\\n \\"Bitrate\\": \\"1496.46\\",\\n \\"HasBFrames\\": \\"0\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.042000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Duration\\": \\"17.225542\\",\\n \\"Fps\\": \\"25\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1001/48000\\",\\n \\"Level\\": \\"41\\",\\n \\"ColorRange\\": \\"700\\",\\n \\"ColorTransfer\\": \\"R255 G83 B170\\",\\n \\"ColorPrimaries\\": \\"700\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/44100\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Lang\\": \\"eng\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"123\\",\\n \\"Bitrate\\": \\"128.806\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"17.159546\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Timebase\\": \\"1/1000\\",\\n \\"Index\\": \\"3\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"ass\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"ASS (Advanced SSA) subtitle\\",\\n \\"Duration\\": \\"1370.116000\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"0/1\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"3509895\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"3509895\\",\\n \\"MD5\\": \\"\\"\\n }\\n },\\n \\"RequestId\\": \\"62D9BE16-B7D5-550C-A482-7A0F60E09877\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2014-01-10T12:00:00Z\\n Analyzing\\n 23ca1d184c0e4341e5b665e2a12****\\n testid-001\\n 88c6ca184c0e432bbf5b665e2a15****\\n true\\n \\n \\n example-location\\n example-bucket\\n \\n \\n 16f01ad6175e4230ac42bb5182cd****\\n \\n \\n 1920\\n 1080\\n 17.226000\\n 25\\n 1630.045\\n QuickTime/MOV\\n \\n \\n 1:1\\n 1080\\n avc1\\n \\n 8\\n 300.34\\n 10\\n \\n 1920\\n 1\\n 1/24000\\n 23.976025\\n yuv420p\\n eng\\n H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\n 100\\n 90\\n 1496.46\\n 0\\n High\\n 0.042000\\n 16:9\\n h264\\n 17.225542\\n 25\\n 0x31637661\\n 1001/48000\\n 41\\n 700\\n R255 G83 B170\\n 700\\n \\n \\n 1/44100\\n 1\\n fltp\\n stereo\\n eng\\n 44100\\n AAC (Advanced Audio Coding)\\n 2\\n 123\\n 128.806\\n mp4a\\n 0.000000\\n aac\\n 17.159546\\n 0x6134706d\\n 1/44100\\n \\n \\n 1/1000\\n 3\\n 0.000000\\n ass\\n eng\\n ASS (Advanced SSA) subtitle\\n 1370.116000\\n 0x0000\\n 0/1\\n [0][0][0][0]\\n \\n \\n \\n 0.000000\\n 0\\n 3509895\\n 2\\n QuickTime/MOV\\n 17.226000\\n 1630.045\\n mov\\n \\n 3509895\\n \\n \\n 62D9BE16-B7D5-550C-A482-7A0F60E09877\\n","errorExample":""}]',
'title' => '提交媒体信息作业',
'description' => '- 请确认文件已成功上传至OSS后再提交媒体信息作业,否则会导致执行失败。您可通过**配置OSS回调消息**确认文件上传状态。'."\n"
.'- 媒体信息作业分为同步和异步模式。'."\n"
.'- 异步模式不保证时效性,在提交媒体信息作业后,任务会添加到管道中排队,被调度执行。所以在接口返回时,不保证作业已经生成。执行完成后需要调用[查询媒体信息作业](~~602828~~)接口轮询执行结果,或通过为管道绑定MNS消息接收执行结果,详细说明请参见[接收消息通知](https://help.aliyun.com/document_detail/42618.html)[接收消息通知](https://www.alibabacloud.com/help/en/mps/receive-message-notifications/?spm=a2c63.p38356.0.0.b48576d2jxNSca)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMediaInfoJobList' => [
'summary' => '查询媒体信息作业。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '23101',
'abilityTreeNodes' => [
'FEATUREmtsZWMPKM',
],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'MediaInfoJobIds',
'in' => 'query',
'schema' => [
'description' => '媒体信息作业ID。'."\n"
.'- 一次最多查询10个,使用半角逗号(,)分隔。'."\n"
.'- 可以从[提交媒体信息作业](~~602827~~)的返回参数中获取。'."\n"
."\n"
.'> 如果不传入此参数,则会返回**InvalidParameter**(参数无效)错误码。',
'type' => 'string',
'required' => true,
'example' => '23ca1d184c0e4341e5b665e2a12****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NonExistMediaInfoJobIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的媒体信息作业。',
'type' => 'array',
'items' => [
'description' => '不存在的媒体信息作业ID列表,无数据时不返回该参数。',
'type' => 'string',
'example' => '11ce1d184c0e4341e5b665e2a12****',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '46A04AA5-B119-41BB-B750-7C5327AC3E7A',
],
'MediaInfoJobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaInfoJob' => [
'description' => '媒体信息作业列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '作业添加时间。',
'type' => 'string',
'example' => '2014-01-10T12:00:00Z',
],
'State' => [
'description' => '作业状态。'."\n"
."\n"
.'- **Analyzing**:分析中。'."\n"
.'- **Success**:分析成功。'."\n"
.'- **Fail**:分析失败。',
'type' => 'string',
'example' => 'Success',
],
'JobId' => [
'description' => '元信息分析作业ID。',
'type' => 'string',
'example' => '23ca1d184c0e4341e5b665e2a12****',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'Code' => [
'description' => '元信息分析失败时错误码。',
'type' => 'string',
'example' => 'InvalidParameter.JsonObjectFormatInvalid',
],
'Message' => [
'description' => '元信息分析失败时错误信息。',
'type' => 'string',
'example' => 'The parameter ”*” does not conform to the JSON Object specification',
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => '88c6ca184c0e432bbf5b665e2a15****',
],
'Async' => [
'description' => '是否为异步作业。',
'type' => 'boolean',
'example' => 'true',
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => 'OSS的Object。',
'type' => 'string',
'example' => 'example.mp4',
],
'Location' => [
'description' => 'OSS的服务区域。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的消息结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。如果失败则不返回此参数。',
'type' => 'string',
'example' => '123',
],
'ErrorMessage' => [
'description' => '失败时错误信息。如果成功则不返回此参数。',
'type' => 'string',
'example' => 'The parameter \\"Input\\" does not conform to the JSON Object specification',
],
'ErrorCode' => [
'description' => '失败时错误码。如果成功则不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.JsonObjectFormatInvalid',
],
],
],
'Properties' => [
'description' => '媒体详细属性。更多信息请参见[数据类型AliyunProperties](~~29251~~)。',
'type' => 'object',
'properties' => [
'Width' => [
'description' => '视频像素宽。',
'type' => 'string',
'example' => '1280',
],
'Height' => [
'description' => '视频像素长。',
'type' => 'string',
'example' => '720',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17.226000',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '1630.045',
],
'FileFormat' => [
'description' => '文件格式。',
'type' => 'string',
'example' => 'QuickTime/MOV',
],
'Streams' => [
'description' => '流信息。',
'type' => 'object',
'properties' => [
'VideoStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoStream' => [
'description' => '视频流信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Sar' => [
'description' => '编码信号分辨率比。',
'type' => 'string',
'example' => '1:1',
],
'Height' => [
'description' => '视频分辨率长。',
'type' => 'string',
'example' => '1080',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => '[0][0][0][0]',
],
'NetworkCost' => [
'description' => '网络带宽消耗。',
'type' => 'object',
'properties' => [
'PreloadTime' => [
'description' => '预加载时间。',
'type' => 'string',
'example' => '8',
],
'AvgBitrate' => [
'description' => '平均码率。',
'type' => 'string',
'example' => '300.34',
],
'CostBandwidth' => [
'description' => '最大消耗带宽。',
'type' => 'string',
'example' => '10',
],
],
],
'Width' => [
'description' => '视频分辨率宽。',
'type' => 'string',
'example' => '1920',
],
'Index' => [
'description' => '视频流序号,标识视频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/1000',
],
'AvgFPS' => [
'description' => '平均帧率。',
'type' => 'string',
'example' => '23.976025',
],
'PixFmt' => [
'description' => '像素格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Lang' => [
'description' => '语言。',
'type' => 'string',
'example' => 'eng',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '100',
],
'Rotate' => [
'description' => '视频旋转角度。',
'type' => 'string',
'example' => '180',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '30541090',
],
'HasBFrames' => [
'description' => '是否有B帧。0表示无,1表示有。',
'type' => 'string',
'example' => '0',
],
'Profile' => [
'description' => '编码预置。',
'type' => 'string',
'example' => 'High',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.042000',
],
'Dar' => [
'description' => '编码显示分辨率比。',
'type' => 'string',
'example' => '16:9',
],
'CodecName' => [
'description' => '编码格式简述名。可选值:'."\n"
."\n"
.'- **h264**'."\n"
."\n"
.'- **h265**'."\n"
."\n"
.'- **gif**'."\n"
."\n"
.'- **webp**',
'type' => 'string',
'example' => 'h264',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '100',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x0000',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1001/48000',
],
'Level' => [
'description' => '编码等级。',
'type' => 'string',
'example' => '41',
],
'ColorRange' => [
'description' => '色彩范围。',
'type' => 'string',
'example' => '700',
],
'ColorTransfer' => [
'description' => '色彩通道。',
'type' => 'string',
'example' => 'R255 G83 B170',
],
'ColorPrimaries' => [
'description' => '色原。',
'type' => 'string',
'example' => '700',
],
'DurationInaccurate' => [
'type' => 'string',
],
],
],
],
],
],
'AudioStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioStream' => [
'description' => '音频流信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/1000',
],
'Index' => [
'description' => '音频流序号,标识音频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'SampleFmt' => [
'description' => '采样格式。',
'type' => 'string',
'example' => 'fltp',
],
'ChannelLayout' => [
'description' => '声道数。',
'type' => 'string',
'example' => '5.1(side)',
],
'Lang' => [
'description' => '语言。更多信息请参见[FFmpeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html?spm=a2c4g.11186623.2.66.243851cd2SntfN#Metadata)。',
'type' => 'string',
'example' => 'eng',
],
'Samplerate' => [
'description' => '采样率。',
'type' => 'string',
'example' => '48000',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'DCA (DTS Coherent Acoustics)',
],
'Channels' => [
'description' => '声道输出样式。',
'type' => 'string',
'example' => '2',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '123',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '1536000',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => '[0][0][0][0]',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.042000',
],
'CodecName' => [
'description' => '编码格式简述名。可取值:'."\n"
."\n"
.'- **acc**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **mp4**'."\n"
."\n"
.'- **ogg**'."\n"
."\n"
.'- **flac**',
'type' => 'string',
'example' => 'acc',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '123',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x0000',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/48000',
],
'DurationInaccurate' => [
'type' => 'string',
],
],
],
],
],
],
'SubtitleStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubtitleStream' => [
'description' => '字幕流信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/1000',
],
'Index' => [
'description' => '字幕流序号,标识字幕流在整个媒体流中的位置。',
'type' => 'string',
'example' => '3',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'CodecName' => [
'description' => '编码格式简述名。可选值:'."\n"
."\n"
.'- **srt**'."\n"
."\n"
.'- **ass**',
'type' => 'string',
'example' => 'ass',
],
'Lang' => [
'description' => '语言。',
'type' => 'string',
'example' => 'eng',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'ASS (Advanced SSA) subtitle',
],
'Duration' => [
'description' => '时长,单位秒(s)。',
'type' => 'string',
'example' => '1370.116000',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x0000',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '0/1',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => '[0][0][0][0]',
],
],
],
],
],
],
],
],
'Format' => [
'description' => '格式信息。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.042000',
],
'NumPrograms' => [
'description' => '节目流总数。',
'type' => 'string',
'example' => '2',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '3509895',
],
'NumStreams' => [
'description' => '媒体流总数。',
'type' => 'string',
'example' => '1',
],
'FormatLongName' => [
'description' => '容器、封装格式长述名。',
'type' => 'string',
'example' => 'QuickTime/MOV',
],
'Duration' => [
'description' => '总时长。',
'type' => 'string',
'example' => '17.226000',
],
'Bitrate' => [
'description' => '总码率。',
'type' => 'string',
'example' => '1630.045',
],
'FormatName' => [
'description' => '容器、封装格式简述名。',
'type' => 'string',
'example' => 'mov',
],
],
],
'FileSize' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '3509895',
],
'FileMd5' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistMediaInfoJobIds\\": {\\n \\"String\\": [\\n \\"11ce1d184c0e4341e5b665e2a12****\\"\\n ]\\n },\\n \\"RequestId\\": \\"46A04AA5-B119-41BB-B750-7C5327AC3E7A\\",\\n \\"MediaInfoJobList\\": {\\n \\"MediaInfoJob\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"State\\": \\"Success\\",\\n \\"JobId\\": \\"23ca1d184c0e4341e5b665e2a12****\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.JsonObjectFormatInvalid\\",\\n \\"Message\\": \\"The parameter ”*” does not conform to the JSON Object specification\\",\\n \\"PipelineId\\": \\"88c6ca184c0e432bbf5b665e2a15****\\",\\n \\"Async\\": true,\\n \\"Input\\": {\\n \\"Object\\": \\"example.mp4\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"123\\",\\n \\"ErrorMessage\\": \\"The parameter \\\\\\\\\\\\\\"Input\\\\\\\\\\\\\\" does not conform to the JSON Object specification\\",\\n \\"ErrorCode\\": \\"InvalidParameter.JsonObjectFormatInvalid\\"\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"1280\\",\\n \\"Height\\": \\"720\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Fps\\": \\"25\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FileFormat\\": \\"QuickTime/MOV\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"1080\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300.34\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Width\\": \\"1920\\",\\n \\"Index\\": \\"1\\",\\n \\"Timebase\\": \\"1/1000\\",\\n \\"AvgFPS\\": \\"23.976025\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Rotate\\": \\"180\\",\\n \\"Bitrate\\": \\"30541090\\",\\n \\"HasBFrames\\": \\"0\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.042000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Duration\\": \\"100\\",\\n \\"Fps\\": \\"25\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"1001/48000\\",\\n \\"Level\\": \\"41\\",\\n \\"ColorRange\\": \\"700\\",\\n \\"ColorTransfer\\": \\"R255 G83 B170\\",\\n \\"ColorPrimaries\\": \\"700\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/1000\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"5.1(side)\\",\\n \\"Lang\\": \\"eng\\",\\n \\"Samplerate\\": \\"48000\\",\\n \\"CodecLongName\\": \\"DCA (DTS Coherent Acoustics)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"123\\",\\n \\"Bitrate\\": \\"1536000\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"StartTime\\": \\"0.042000\\",\\n \\"CodecName\\": \\"acc\\",\\n \\"Duration\\": \\"123\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"1/48000\\",\\n \\"DurationInaccurate\\": \\"\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Timebase\\": \\"1/1000\\",\\n \\"Index\\": \\"3\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"ass\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"ASS (Advanced SSA) subtitle\\",\\n \\"Duration\\": \\"1370.116000\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"CodecTimeBase\\": \\"0/1\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.042000\\",\\n \\"NumPrograms\\": \\"2\\",\\n \\"Size\\": \\"3509895\\",\\n \\"NumStreams\\": \\"1\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"17.226000\\",\\n \\"Bitrate\\": \\"1630.045\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"3509895\\",\\n \\"FileMd5\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 11ce1d184c0e4341e5b665e2a12****\\n 46A04AA5-B119-41BB-B750-7C5327AC3E7A\\n \\n 2014-01-10T12:00:00Z\\n Success\\n 23ca1d184c0e4341e5b665e2a12****\\n testid-001\\n 88c6ca184c0e432bbf5b665e2a15****\\n true\\n \\n \\n oss-cn-hangzhou\\n example-bucket\\n \\n \\n 123\\n \\n \\n 1280\\n 720\\n 17.226000\\n 25\\n 1630.045\\n QuickTime/MOV\\n \\n \\n 1:1\\n 1080\\n [0][0][0][0]\\n \\n 8\\n 300.34\\n 10\\n \\n 1920\\n 1\\n 1/1000\\n 24000/1001\\n yuv420p\\n eng\\n H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\n 100\\n 180\\n 30541090\\n 0\\n High\\n 0.042000\\n 16:9\\n h264\\n 100\\n 25\\n 0x0000\\n 1001/48000\\n 41\\n 700\\n R255 G83 B170\\n 700\\n \\n \\n 1/1000\\n 1\\n fltp\\n 5.1(side)\\n eng\\n 48000\\n DCA (DTS Coherent Acoustics)\\n 2\\n 123\\n 1536000\\n [0][0][0][0]\\n 0.042000\\n acc\\n 123\\n 0x0000\\n 1/48000\\n \\n \\n 1/1000\\n 3\\n 0.000000\\n ass\\n eng\\n ASS (Advanced SSA) subtitle\\n 1370.116000\\n 0x0000\\n 0/1\\n [0][0][0][0]\\n \\n \\n \\n 0.042000\\n 2\\n 3509895\\n 1\\n QuickTime/MOV\\n 17.226000\\n 1630.045\\n mov\\n \\n 3509895\\n \\n \\n","errorExample":""}]',
'title' => '查询媒体信息作业信息',
'description' => '- 异步模式需要等到**[提交媒体信息作业](~~602827~~)**的MNS回调成功后才能查询到媒体信息。如果长时间查询不到媒体信息,可能是提交媒体信息作业执行失败。'."\n"
.'- 本接口一次最多可查询10个媒体信息作业。'."\n"
.'- 本接口返回值默认按CreationTime降序排列。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' **回调消息格式定义**'."\n"
."\n"
.'当媒体信息任务执行状态改变时,mps会发送消息到用户指定的queue中(如何指定回调queue详见mps的[更新管道接口](~~188374~~))。消息体是一个JSON字符串,包含字段如下:'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Type": "MediaInfo",'."\n"
.' "State": "Success",'."\n"
.' "JobId": "bb558c1cc25b45309aab5be44d19****",'."\n"
.' "UserData": "{\\"key\\":\\"value\\"}",'."\n"
.' "RequestId": "B52658D4-07AB-43CD-82B0-210958A6****"'."\n"
.'}'."\n"
.'```'."\n"
."\n\n"
.'| 名称 | 类型 |描述|'."\n"
.'|---------------|--------|-----------|'."\n"
.'|Type |String |固定字符串“MediaInfo”,表示媒体信息任务。 |'."\n"
.'|JobId | String|任务唯一ID。 |'."\n"
.'|State | String|任务当前状态,与QueryMediaInfoJobList中的State一致。|'."\n"
.'|UserData |String |用户在SubmitMediaInfoJob中传入的UserData。|'."\n",
'extraInfo' => ' ',
],
'SubmitJobs' => [
'summary' => '提交转码作业。当控制台创建的转码任务和工作流均无法满足您的使用场景时,可以按需调用SubmitJobs接口进行转码。根据您的业务逻辑配置所需的转码参数即可。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '23174',
'abilityTreeNodes' => [
'FEATUREmts0IG2Y5',
'FEATUREmtsCLNI07',
'FEATUREmtsG9UOE6',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '作业输入。详细说明,请参见[Input详情](~~29253~~)。'."\n"
."\n"
.'> - 在媒体处理API中,Object必须经过URL Encoding(基于UTF-8编码)后使用。'."\n"
.'- OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"example.flv","Referer": "用户自行在OSS控制台设置的OSS防盗链参数"}',
],
],
[
'name' => 'Outputs',
'in' => 'query',
'schema' => [
'description' => '作业输出配置。详细说明,请参见[Output详情](~~29253~~)。'."\n"
.'- Outputs由Output列表构成,JSON数组,大小上限为30。',
'type' => 'string',
'required' => true,
'example' => '[{"OutputObject":"exampleOutput.mp4","TemplateId":"6181666213ab41b9bc21da8ff5ff****","WaterMarks":[{"InputFile":{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"image_01.png"},"WaterMarkTemplateId":"9b772ce2740d4d55876d8b542d47****"}],"UserData":"testid-001"}]',
],
],
[
'name' => 'OutputBucket',
'in' => 'query',
'schema' => [
'description' => '输出文件所在的OSS Bucket。'."\n"
.'- 遵守OSS Bucket定义,更多信息请参见[基本概念](~~31827~~)。',
'type' => 'string',
'required' => true,
'example' => 'exampleBucket',
],
],
[
'name' => 'OutputLocation',
'in' => 'query',
'schema' => [
'description' => '输出文件所在的OSS Bucket的地域(OSS Region)。'."\n"
.'- OSS Bucket必须与媒体处理服务在同一个地域。'."\n"
.'- 遵守OSS Bucket定义,更多信息请参见[基本概念](~~31827~~)。',
'type' => 'string',
'required' => false,
'example' => 'oss-cn-hangzhou',
'default' => 'oss-cn-hangzhou',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID。更多信息,请参见[基本概念](~~31827~~)。'."\n"
."\n"
.'- 可以通过[MPS控制台](https://mps.console.aliyun.com/overview) > **全局设置** > **管道及回调**查询。'."\n"
."\n"
.'- 如果需要异步通知,请为管道绑定MNS消息。详细操作,请参见[接收消息通知](https://help.aliyun.com/document_detail/42618.html)[接收消息通知](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications)。',
'type' => 'string',
'required' => true,
'example' => 'dd3dae411e704030b921e52698e5****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'JobResultList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'JobResult' => [
'description' => '提交转码作业结果列表。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '创建作业失败时错误码。创建成功时此参数不返回。',
'type' => 'string',
'example' => 'InvalidParameter.NullValue',
],
'Job' => [
'description' => '作业详细信息。如果提交失败则不会生成作业ID。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '转码失败时的错误码。转码成功时不返回。',
'type' => 'string',
'example' => 'InternalError',
],
'CreationTime' => [
'description' => '作业添加时间。',
'type' => 'string',
'example' => '2014-01-10T12:00:00Z',
],
'FinishTime' => [
'description' => '作业完成时间。',
'type' => 'string',
'example' => '2014-01-10T12:20:00Z',
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => '作业输入的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
'Location' => [
'description' => '作业输入的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Object' => [
'description' => '作业输入的OSS Object。',
'type' => 'string',
'example' => 'example.flv',
],
],
],
'JobId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '31fa3c9ca8134f9cec2b4b0b0f78****',
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的消息结果。',
'type' => 'object',
'properties' => [
'ErrorCode' => [
'description' => '失败时错误码。成功时此参数不返回。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
'ErrorMessage' => [
'description' => '失败时错误信息。成功时此参数不返回。',
'type' => 'string',
'example' => 'The resource operated "%s" cannot be found.',
],
'MessageId' => [
'description' => '失败时错误信息ID。成功时此参数不返回。',
'type' => 'string',
'example' => '123',
],
],
],
'Message' => [
'description' => '转码失败时的消息。转码成功时不返回。',
'type' => 'string',
'example' => 'The operation has failed due to some unknown error, exception or failure.',
],
'Output' => [
'description' => '作业输出。',
'type' => 'object',
'properties' => [
'AmixList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Amix' => [
'description' => '混音列表。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'AmixURL' => [
'description' => '需要被混音的背景音轨媒体。'."\n"
."\n"
.'- 可取值:OSS地址或字符串`"input"`。'."\n"
."\n"
.'- input场景:同一视频两路音轨合并。',
'type' => 'string',
'example' => 'https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3',
],
'Duration' => [
'description' => '持续时长。数字或时间格式。',
'type' => 'string',
'example' => '20',
],
'Map' => [
'description' => '在AmixURL中选取目标音轨,取值为:0:a:{audio_index}, 如0:a:0。',
'type' => 'string',
'example' => '0:a:0',
],
'MixDurMode' => [
'description' => '媒体时长取值。可取值:**first**、**long**。'."\n"
."\n"
.'- **first**:输出媒体的时长以输入媒体的时长为准。'."\n"
."\n"
.'- **long**:输出媒体的时长以两个媒体中时长最长的为准。'."\n"
.'- 默认值:**long**。',
'type' => 'string',
'example' => 'long',
],
'Start' => [
'description' => '起始时间。数字或时间格式例如:"1:25:36.240", "32000.23"。',
'type' => 'string',
'example' => '0',
],
],
],
],
],
],
'Audio' => [
'description' => '音频配置。'."\n"
."\n"
.'> 如果请求参数中指定了音频配置则覆盖指定转码模板中的对应参数。',
'type' => 'object',
'properties' => [
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '128',
],
'Channels' => [
'description' => '声道数。'."\n"
."\n"
.'- 当Codec设置为mp3时,声道数只支持**1**、**2**。'."\n"
."\n"
.'- 当Codec设置为aac时,声道数只支持**1**、**2**、**4**、**5**、**6**、**8**。'."\n"
."\n"
.'- 默认值:**2**。',
'type' => 'string',
'example' => '6',
],
'Codec' => [
'description' => '音频编解码格式。'."\n"
."\n"
.'- 支持**aac**、**mp3**、**vorbis**、**flac**。'."\n"
.'- 默认值:**aac**。',
'type' => 'string',
'example' => 'aac',
],
'Profile' => [
'description' => '音频编码预置。'."\n"
."\n"
.'> 当**Codec**为**aac**时可以取如下范围中的值:**aac_low**、**aac_he**、**aac_he_v2**、**aac_ld**、**aac_eld**。',
'type' => 'string',
'example' => 'aac_low',
],
'Qscale' => [
'description' => '音频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 支持**22050**、**32000**、**44100**、**48000**、**96000**。'."\n"
.'- 单位:Hz。'."\n"
.'- 默认值:**44100**。'."\n"
."\n"
.'> 若视频容器格式为flv,音频编解码格式选择为mp3时,采样率不支持32000、48000、96000;音频编解码格式为mp3时,采样率不支持96000。',
'type' => 'string',
'example' => '32000',
],
'Volume' => [
'description' => '音量控置。',
'type' => 'object',
'properties' => [
'Level' => [
'description' => '音量调整幅度'."\n"
."\n"
.'- 单位:db。'."\n"
.'- 默认:**-20db**。',
'type' => 'string',
'example' => '-20',
],
'Method' => [
'description' => '音量调整方式。可取值:'."\n"
."\n"
.'- **auto**:自动调整。'."\n"
."\n"
.'- **dynamic**:动态调整。'."\n"
."\n"
.'- **linear**:线性调整。',
'type' => 'string',
'example' => 'auto',
],
],
],
],
],
'AudioStreamMap' => [
'description' => '音频流序号。'."\n"
."\n"
.'- 格式:格式:0:a:{序号},示例:0:a:0。'."\n"
."\n"
.'- 序号的含义是音频流列表的下标,序号从0开始。'."\n"
."\n"
.'- 若未设置,选择默认的音频流。',
'type' => 'string',
'example' => '0:a:0',
],
'Clip' => [
'description' => '剪辑片段。',
'type' => 'object',
'properties' => [
'TimeSpan' => [
'description' => '剪辑时间段。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '延续时间。'."\n"
.'- 格式:`hh:mm:ss[.SSS]`或`sssss[.SSS]`。'."\n"
."\n"
.'- 取值范围:`[00:00:00.000,23:59:59.999]`或`[0.000,86399.999]`。',
'type' => 'string',
'example' => '01:00:59.999',
],
'Seek' => [
'description' => '开始时间。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或`sssss[.SSS]`。'."\n"
."\n"
.'- 取值范围:`[00:00:00.000,23:59:59.999]`或`[0.000,86399.999]`。',
'type' => 'string',
'example' => '01:59:59.999',
],
],
],
],
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。'."\n"
."\n"
.'- 默认值:**mp4**。'."\n"
."\n"
.'- 视频转码可取值flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。'."\n"
."\n"
.'- 音频转码可取值mp3、mp4、ogg、flac、m4a。'."\n"
."\n"
.'- 图片可取值gif、WEBP。'."\n"
."\n"
.'- 容器格式为gif时,VideoCodec设置只能设置为GIF。'."\n"
."\n"
.'- 容器格式为webp时,VideoCodec设置只能设置为WEBP。'."\n"
."\n"
.'- 容器格式为flv时,VideoCodec不能设置为H265。',
'type' => 'string',
'example' => 'flv',
],
],
],
'DeWatermark' => [
'description' => '模糊处理,JSON对象。更多信息请参见[参数详情](~~29253~~)中的**模糊处理详情**。',
'type' => 'string',
'example' => '{"0": [{"l": 10,"t": 10,"w": 10,"h": 10},{"l": 100,"t": 0.1,"w": 10,"h": 10}],"128000": [],"250000": [{"l": 0.2,"t": 0.1,"w": 0.01,"h": 0.05}]}',
],
'DigiWaterMark' => [
'description' => '数字水印。',
'type' => 'object',
'properties' => [
'Alpha' => [
'description' => '文字或图片的透明度。'."\n"
."\n"
.'- 取值范围:**(0,1]**。'."\n"
."\n"
.'- 默认值:**1.0**。',
'type' => 'string',
'example' => '1.0',
],
'InputFile' => [
'description' => '输入文件。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-intput.flv',
],
],
],
'Type' => [
'description' => '水印类型。如果设置过水印类型,则此值覆盖水印模板对应参数。可取值:'."\n"
."\n"
.'- **Image**:默认值,图片水印。'."\n"
."\n"
.'- **Text**:文字水印。',
'type' => 'string',
'example' => 'Image',
],
],
],
'Encryption' => [
'description' => '数据加密,只支持m3u8格式的输出。',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '加密ID。',
'type' => 'string',
'example' => '31fa3c9ca8134f9cec2b4b0b0f78****',
],
'Key' => [
'description' => '加密视频的密钥。',
'type' => 'string',
'example' => 'encryptionkey128',
],
'KeyType' => [
'description' => '密钥Key不能明文传输给MPS,需要加密,方式为Base64或KMS。如密钥为"encryptionkey128”, 则Base64(“encryptionkey128”), 或 KMS(Base64(“encryptionkey128”)。',
'type' => 'string',
'example' => 'Base64',
],
'KeyUri' => [
'description' => '密钥的访问URL,使用BASE64进行编码。',
'type' => 'string',
'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/',
],
'SkipCnt' => [
'description' => '前面不加密的片数(视频能快速播放起来)。',
'type' => 'string',
'example' => '3',
],
'Type' => [
'description' => '加密类型。取值:**hls-aes-128**。',
'type' => 'string',
'example' => 'hls-aes-128',
],
],
],
'M3U8NonStandardSupport' => [
'description' => 'M3U8非标准支持,JSON对象。更多信息请参见[参数详情](~~29253~~)中的**M3U8非标准参数支持详情**。',
'type' => 'object',
'properties' => [
'TS' => [
'description' => 'JSON对象,TS文件相关非标准支持。更多信息请参见[参数详情](~~29253~~)中的**TS参数支持详情**。',
'type' => 'object',
'properties' => [
'Md5Support' => [
'description' => '是否支持在M3U8文件中输出TS的md5值。可取值:'."\n"
.'- **true**:支持。'."\n"
."\n"
.'- **false**:不支持。',
'type' => 'boolean',
'example' => 'true',
],
'SizeSupport' => [
'description' => '是否支持在M3U8文件中输出TS文件的大小。可取值:'."\n"
."\n"
.'- **true**:支持。'."\n"
."\n"
.'- **false**:不支持。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'MergeConfigUrl' => [
'description' => '**MergeList**与**MergeConfigUrl**两个参数只支持二选一。'."\n"
."\n"
.'- MergeConfigUrl指定的配置文件允许50个拼接片段上限。'."\n"
.'- MergeConfigUrl是拼接配置文件URL地址。'."\n"
.'- 只支持存放在OSS上的配置文件,且需要保证有授权给MPS可访问权限,文件内部内容参见拼接参数详情。'."\n"
.'- mergeConfigfile文件内部内容示例:`{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}` 。',
'type' => 'string',
'example' => '`{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}',
],
'MergeList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Merge' => [
'description' => '视频拼接配置。',
'type' => 'array',
'items' => [
'description' => '视频拼接配置详细信息。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '持续时间。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或者`sssss[.SSS]`。'."\n"
.'- 示例:01:59:59.999或者32000.23。',
'type' => 'string',
'example' => '00000.20',
],
'MergeURL' => [
'description' => '拼接片段地址。'."\n"
."\n"
.'- 示例:`http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv`'."\n"
.'- Object需要经过URLEncode,采用UTF-8编码。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv',
],
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
'Start' => [
'description' => '起始时间点。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或者`sssss[.SSS]`。'."\n"
."\n"
.'- 示例:01:59:59.999或者32000.23。',
'type' => 'string',
'example' => '00000.50',
],
],
],
],
],
],
'MuxConfig' => [
'description' => '转码封包配置。如果请求参数中设置了此参数,则覆盖指定转码模板中的对应参数。',
'type' => 'object',
'properties' => [
'Gif' => [
'description' => 'Gif对应的封包配置。',
'type' => 'object',
'properties' => [
'DitherMode' => [
'description' => '调色板颜色抖动方式。可取值:**sierra**、**bayer**。',
'type' => 'string',
'example' => 'bayer',
],
'FinalDelay' => [
'description' => '终帧暂停时间,单位:厘秒。',
'type' => 'string',
'example' => '0',
],
'IsCustomPalette' => [
'description' => '自定义调色板功能。可取值:'."\n"
."\n"
.'- **true**:自定义'."\n"
."\n"
.'- **false**:非自定义。',
'type' => 'string',
'example' => 'false',
],
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
],
],
'Segment' => [
'description' => '切片配置,JSON对象。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。整数,单位:秒。'."\n"
."\n"
.'- 可取值范围:**\\[1,10\\]**。'."\n"
."\n"
.'- 默认值:**10**秒。',
'type' => 'string',
'example' => '20',
],
],
],
'Webp' => [
'description' => 'Webp对应的封包配置。',
'type' => 'object',
'properties' => [
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
],
],
],
],
'OpeningList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Opening' => [
'description' => '开板列表,JSON对象。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 可取值:**0~4096**、**-1**、**full**。'."\n"
."\n"
.'- 默认值:**-1**。'."\n"
."\n"
.'- **-1**代表片源的值,'."\n"
.'- **full**表示填满画面。',
'type' => 'string',
'example' => '1080',
],
'Start' => [
'description' => '相对正片视频的开始时间。从0开始延迟多长时间后,显示开板视频。'."\n"
."\n"
.'- 单位:秒。'."\n"
."\n"
.'- 默认值:**0**。',
'type' => 'string',
'example' => '1',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 可取值:**0~4096**、**-1**、**full**。'."\n"
."\n"
.'- 默认值:**-1**。'."\n"
."\n"
.'- **-1**代表片源的值。'."\n"
.'- **full**表示填满画面。',
'type' => 'string',
'example' => '1920',
],
'openUrl' => [
'description' => '开板视频的OSS URL地址。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv',
],
],
],
],
],
],
'OutSubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OutSubtitle' => [
'description' => '输出字幕列表。',
'type' => 'array',
'items' => [
'description' => '输出字幕详情。',
'type' => 'object',
'properties' => [
'Map' => [
'description' => '视频轨。格式:`0:{流}:{流序号} `,即`0:v:{video_index}`。流取值为v: video音频流,序号的含义是音频流列表的下标,序号从0开始。',
'type' => 'string',
'example' => '0:v:0',
],
'Message' => [
'description' => '创建作业失败时错误消息。创建成功时此参数不返回。',
'type' => 'string',
'example' => 'The specified parameter “%s” cannot be null.',
],
'OutSubtitleFile' => [
'description' => '输出文件详细信息。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
'Location' => [
'description' => '输出文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Object' => [
'description' => '输出文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
],
],
'Success' => [
'description' => '是否成功。可取值:'."\n"
."\n"
.'- **true**:成功。'."\n"
."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'OutputFile' => [
'description' => '输出文件。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
'Location' => [
'description' => '输出文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Object' => [
'description' => '输出文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
],
],
'Priority' => [
'description' => '任务在其对应管道内的优先级。'."\n"
."\n"
.'- 最高优先级:**10**。'."\n"
.'- 默认值:**6**。',
'type' => 'string',
'example' => '5',
],
'Properties' => [
'description' => '媒体属性。',
'type' => 'object',
'properties' => [
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '1000',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '55',
],
'FileFormat' => [
'description' => '文件格式。',
'type' => 'string',
'example' => 'QuickTime / MOV',
],
'FileSize' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '3509895',
],
'Format' => [
'description' => '格式信息。',
'type' => 'object',
'properties' => [
'Bitrate' => [
'description' => '总码率。',
'type' => 'string',
'example' => '1000',
],
'Duration' => [
'description' => '总时长。',
'type' => 'string',
'example' => '55',
],
'FormatLongName' => [
'description' => '容器、封装格式长述名。',
'type' => 'string',
'example' => 'QuickTime / MOV',
],
'FormatName' => [
'description' => '容器、封装格式简述名。可取值:mov、mp4、m4a、3gp、3g2、mj2。',
'type' => 'string',
'example' => 'mov',
],
'NumPrograms' => [
'description' => '节目流总数。',
'type' => 'string',
'example' => '0',
],
'NumStreams' => [
'description' => '媒体流总数。',
'type' => 'string',
'example' => '2',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '3509895',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
],
],
'Fps' => [
'description' => '帧率,数字。',
'type' => 'string',
'example' => '25',
],
'Height' => [
'description' => '视频长。',
'type' => 'string',
'example' => '720',
],
'Streams' => [
'description' => '流信息。',
'type' => 'object',
'properties' => [
'AudioStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioStream' => [
'description' => '音频流列表。',
'type' => 'array',
'items' => [
'description' => '音频流详细信息。',
'type' => 'object',
'properties' => [
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '128.806',
],
'ChannelLayout' => [
'description' => '声道输出样式。',
'type' => 'string',
'example' => 'stereo',
],
'Channels' => [
'description' => '声道数。',
'type' => 'string',
'example' => '2',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'AAC (Advanced Audio Coding)',
],
'CodecName' => [
'description' => '编码格式简述名。',
'type' => 'string',
'example' => 'aac',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x6134706d',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'mp4a',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/44100',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17.159546',
],
'Index' => [
'description' => '音频流序号。标识音频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'eng',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '25',
],
'SampleFmt' => [
'description' => '采样格式。',
'type' => 'string',
'example' => 'fltp',
],
'Samplerate' => [
'description' => '采样率。',
'type' => 'string',
'example' => '44100',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/44100',
],
],
],
],
],
],
'SubtitleStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubtitleStream' => [
'description' => '字幕流列表。',
'type' => 'array',
'items' => [
'description' => '字幕流详细信息。',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '字幕流序号,标识字幕流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'eng',
],
],
],
],
],
],
'VideoStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoStream' => [
'description' => '视频流列表。',
'type' => 'array',
'items' => [
'description' => '视频流详细信息。',
'type' => 'object',
'properties' => [
'AvgFPS' => [
'description' => '平均帧率。',
'type' => 'string',
'example' => '23.976025',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '1496.46',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10',
],
'CodecName' => [
'description' => '编码格式简述名。',
'type' => 'string',
'example' => 'h264',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x31637661',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'avc1',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1001/48000',
],
'Dar' => [
'description' => '编码显示分辨率比。',
'type' => 'string',
'example' => '16:9',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17.225542',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '23.976025',
],
'HasBFrames' => [
'description' => '是否有B帧。',
'type' => 'string',
'example' => '2',
],
'Height' => [
'description' => '视频分辨率长。',
'type' => 'string',
'example' => '720',
],
'Index' => [
'description' => '视频流序号,标识视频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '0',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'eng',
],
'Level' => [
'description' => '编码等级。',
'type' => 'string',
'example' => '51',
],
'NetworkCost' => [
'description' => '网络带宽消耗。'."\n",
'type' => 'object',
'properties' => [
'AvgBitrate' => [
'description' => '平均码率。',
'type' => 'string',
'example' => '100',
],
'CostBandwidth' => [
'description' => '最大消耗带宽。',
'type' => 'string',
'example' => '10',
],
'PreloadTime' => [
'description' => '预加载时间。',
'type' => 'string',
'example' => '8',
],
],
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '25',
],
'PixFmt' => [
'description' => '像素格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Profile' => [
'description' => '编码预置。',
'type' => 'string',
'example' => 'high',
],
'Sar' => [
'description' => '编码信号分辨率比。',
'type' => 'string',
'example' => '1:1',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/24000',
],
'Width' => [
'description' => '视频分辨率宽,数字。',
'type' => 'string',
'example' => '1280',
],
],
],
],
],
],
],
],
'Width' => [
'description' => '视频宽。',
'type' => 'string',
'example' => '1280',
],
],
],
'Rotate' => [
'description' => '视频顺时针旋转角度。',
'type' => 'string',
'example' => '180',
],
'SubtitleConfig' => [
'description' => '字幕配置信息。',
'type' => 'object',
'properties' => [
'ExtSubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ExtSubtitle' => [
'description' => '外部字幕列表,JSON数组,最多**4**个。',
'type' => 'array',
'items' => [
'description' => '外部字幕详细信息。',
'type' => 'object',
'properties' => [
'CharEnc' => [
'description' => '外部字幕字符编码。'."\n"
."\n"
.'- 范围:**UTF-8**、**GBK**、**BIG5**、**auto**。'."\n"
.'- 默认:**auto**。'."\n"
."\n"
.'> 外部字幕字符编码设置为**auto**时,存在误检情况,建议您指定具体的字符编码。',
'type' => 'string',
'example' => 'UTF-8',
],
'FontName' => [
'description' => '外挂字幕转换成硬字幕对应的字体名称。默认值:**SimSun**。更多字体信息请参见[字体列表](~~59950~~)。',
'type' => 'string',
'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"',
],
'Input' => [
'description' => 'JSON对象,外部输入字幕文件。目前支持**srt**、**ass**格式。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => '输入文件所在的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
'Location' => [
'description' => '输入文件所在的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
],
],
],
],
],
],
],
'SubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Subtitle' => [
'description' => '字幕列表。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Map' => [
'description' => '音轨。格式:`0:{流}:{流序号} `,即`0:a:{audio_index}`。流取值为a: audio音频流,序号的含义是音频流列表的下标,序号从0开始。',
'type' => 'string',
'example' => '0:a:0',
],
],
],
],
],
],
],
],
'SuperReso' => [
'description' => '分辨率随源。',
'type' => 'object',
'properties' => [
'IsHalfSample' => [
'description' => '是否获取采样率相关参数。可取值:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。',
'type' => 'string',
'example' => 'true',
],
],
],
'TailSlateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TailSlate' => [
'description' => '尾板列表,JSON对象。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'BgColor' => [
'description' => '如果尾板视频的宽、高小于正片时,设置空白处填充的背景色。默认为**White**,更多取值请参见[bgcolor](https://docs-aliyun.cn-hangzhou.oss.aliyun-inc.com/assets/attach/29253/cn_zh/1502784952344/color.txt?spm=a2c4g.11186623.2.63.241240f77qp3Yy&file=color.txt)。',
'type' => 'string',
'example' => 'White',
],
'BlendDuration' => [
'description' => '正片视频和尾板视频过渡的时长。过渡的效果是淡入淡出:正片显示最后一帧,同时播放尾板视频,正片最后一帧逐步变暗,尾板视频逐步变亮。单位秒,默认**0**。',
'type' => 'string',
'example' => '2',
],
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 可取值:**0\\~4096**、**\\-1**、**full**。'."\n"
.'- **-1**代表片源的值,**full**表示填满画面。'."\n"
.'- 默认为**\\-1**。',
'type' => 'string',
'example' => '1080',
],
'IsMergeAudio' => [
'description' => '是否要拼接尾板视频的音频内容。可取值:'."\n"
."\n"
.'- **true**:拼接。'."\n"
."\n"
.'- **false**:不拼接。',
'type' => 'boolean',
'example' => 'false',
],
'Start' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '1',
],
'TailUrl' => [
'description' => '尾板视频的OSS URL地址。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 可取值:**0\\~4096**、**\\-1**、**full**。'."\n"
.'- **\\-1**代表片源的值,**full**表示填满画面。'."\n"
.'- 默认为**\\-1**。',
'type' => 'string',
'example' => '1920',
],
],
],
],
],
],
'TemplateId' => [
'description' => '转码模板ID。',
'type' => 'string',
'example' => 'S00000000-000010',
],
'TransConfig' => [
'description' => '转码通用配置。'."\n"
."\n"
.'> 如果请求参数中设置了该值,则覆盖指定转码模板中的对应参数。',
'type' => 'object',
'properties' => [
'AdjDarMethod' => [
'description' => '分辨率改写方式。默认值:**none**。可取值:'."\n"
."\n"
.'- rescale:重新做scale。'."\n"
."\n"
.'- crop:裁剪。'."\n"
."\n"
.'- pad:填充。'."\n"
."\n"
.'- none:不改写。',
'type' => 'string',
'example' => 'crop',
],
'IsCheckAudioBitrate' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于IsCheckAudioBitrateFail。'."\n"
."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:'."\n"
.' - 参数为空,并且codec和输入源不一样:false。'."\n"
.' - 参数为空,并且codec和输入源一样:true。',
'type' => 'string',
'example' => 'false',
],
'IsCheckAudioBitrateFail' => [
'description' => '是否检查音频码率。此值优先级大于**IsCheckAudioBitrate**。当输出音频码率大于媒体源音频码率时,不进行转码,直接返回转码失败。'."\n"
."\n"
.'- **false**:检查。'."\n"
.'- **true**:不检查。',
'type' => 'string',
'example' => 'true',
],
'IsCheckReso' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则视为输出分辨率等于输入分辨率。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckResoFail' => [
'description' => '是否检查分辨率。此值优先级大于IsCheckReso。如果输出分辨率大于输入分辨率(判断条件是宽或高),不进行转码,直接返回转码失败。'."\n"
."\n"
.'- **true**:检查。'."\n"
.'- **false**:不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckVideoBitrate' => [
'description' => '是否检查视频码率。如果视频输出码率大于视频输入码率,则视为视频输出码率等于视频输入码率。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckVideoBitrateFail' => [
'description' => '是否检查码率。当输出视频码率大于媒体源视频码率时,则不进行转码,直接返回转码失败。此值优先级大于**IsCheckVideoBitrate**。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'true',
],
'TransMode' => [
'description' => '转码模式。可取值:'."\n"
."\n"
.'- **onepass**: 基于One-Pass算法,准确性较好。'."\n"
."\n"
.'- **twopass**:基于Two-Pass算法,准确性较差。'."\n"
."\n"
.'- **CBR**:Constant bit rate,固定码率。',
'type' => 'string',
'example' => 'onepass',
],
],
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'example data',
],
'Video' => [
'description' => '视频配置。'."\n"
."\n"
.'> 指定则替换**TemplateId**所指定模板的**AliyunVideoCodec**设置。',
'type' => 'object',
'properties' => [
'Bitrate' => [
'description' => '视频输出文件的码率。单位:Kbps。',
'type' => 'string',
'example' => '10',
],
'BitrateBnd' => [
'description' => '视频平均码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '总码率上限。单位:Kbps。',
'type' => 'string',
'example' => '20',
],
'Min' => [
'description' => '总码率下限。单位:Kbps。',
'type' => 'string',
'example' => '10',
],
],
],
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 单位:Kb。'."\n"
.'- 默认值:**6000**。',
'type' => 'string',
'example' => '1000',
],
'Codec' => [
'description' => '编解码格式。'."\n"
."\n"
.'- 支持**H.264**、**H.265**、**GIF**、**WEBP**。'."\n"
.'- 默认值:**H.264**。',
'type' => 'string',
'example' => 'H.264',
],
'Crf' => [
'description' => '码率-质量控制因子。'."\n"
."\n"
.'- 如果设置了**Crf**,则**Bitrate**的设置失效。'."\n"
."\n"
.'- 默认值:编码格式为H264,默认值为**23**。编码格式为H265,默认值为**26**。',
'type' => 'string',
'example' => '22',
],
'Crop' => [
'description' => '视频画面裁切。支持2种方式:'."\n"
.'- 自动检测黑边并裁切:设置为**border**。'."\n"
.'- 自定义裁切:参数格式为width:height:left:top。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Degrain' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '5',
],
'Fps' => [
'description' => '帧率。'."\n"
."\n"
.'- 单位:fps。'."\n"
."\n"
.'- 可取值范围:0~60,当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取输入文件帧率。',
'type' => 'string',
'example' => '60',
],
'Gop' => [
'description' => '关键帧间最大时间间隔或最大帧数。单位:秒(s)。'."\n"
."\n"
.'- 默认值:10s。'."\n"
."\n"
.'- 最大帧数时无单位。',
'type' => 'string',
'example' => '1',
],
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:视频原始高度。',
'type' => 'string',
'example' => '1280',
],
'MaxFps' => [
'description' => '最大帧率。',
'type' => 'string',
'example' => '15',
],
'Maxrate' => [
'description' => '视频码率峰值。单位:Kbps。',
'type' => 'string',
'example' => '10',
],
'Pad' => [
'description' => '视频贴黑边。'."\n"
."\n"
.'- 参数格式:width:height:left:top。'."\n"
."\n"
.'- 单位:px。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'PixFmt' => [
'description' => '视频颜色格式。'."\n"
.'- 默认值:**yuv420p**或原始颜色格式。'."\n"
.'- 可取值:**yuv420p**,**yuvj420p**等标准颜色格式。'."\n"
."\n"
.' > 非标准颜色格式(比如:yuvj420p(pc, bt470bg/bt470bg/smpte170m)需要配置兼容,否则会导致转码失败。 ',
'type' => 'string',
'example' => 'yuvj420p',
],
'Preset' => [
'description' => '视频算法器预置。默认值:**medium**。可取值:'."\n"
."\n"
.'- **veryfast**:超快。'."\n"
."\n"
.'- **fast**:快。'."\n"
."\n"
.'- **medium**:中等。'."\n"
."\n"
.'- **slow**:慢。'."\n"
."\n"
.'- **slower**:超慢。',
'type' => 'string',
'example' => 'veryfast',
],
'Profile' => [
'description' => '编码级别,目前仅H264支持此参数。默认值:**high**,可取值:'."\n"
.'> 如果您有多个清晰度,建议最低清晰度配置成baseline,以保证最低端设备可播放。其他清晰度配置为main或high。'."\n"
."\n"
.'- **baseline**:针对移动设备。'."\n"
."\n"
.'- **main**:针对标准分辨率设备。'."\n"
."\n"
.'- **high**:针对高分辨率设备。',
'type' => 'string',
'example' => 'baseline',
],
'Qscale' => [
'description' => '视频质量控制值。',
'type' => 'string',
'example' => '15',
],
'ResoPriority' => [
'description' => '资源优先级。',
'type' => 'string',
'example' => '1',
],
'ScanMode' => [
'description' => '扫描模式。取值如下:'."\n"
.'- **不设置**:按输入文件的原始模式。'."\n"
.'- **auto**:自动去隔行。'."\n"
.'- **progressive**:顺序扫描(逐行扫描)。'."\n"
.'- **interlaced**:交叉扫描(隔行扫描)。'."\n"
.'- **默认值**:空,即不设置。'."\n"
."\n"
.'**最佳实践**:交叉扫描虽然比顺序扫描更节省数据量,但画质不佳,所以现在主流视频制作都采用顺序扫描。'."\n"
.'- 如果您设置了**顺序扫描**或**交叉扫描**,但与原视频模式不符,会导致转码失败。'."\n"
.'- 建议您设置**原视频模式**或**自动去隔行**,以提高兼容性。',
'type' => 'string',
'example' => 'interlaced',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始宽度**。',
'type' => 'string',
'example' => '1080',
],
],
],
'VideoStreamMap' => [
'description' => '视频流序号。'."\n"
.'- 格式:格式:0:a:{序号},示例:0:a:0。'."\n"
."\n"
.'- 序号的含义是音频流列表的下标,序号从0开始。'."\n"
."\n"
.'- 若未设置,选择默认的视频流。',
'type' => 'string',
'example' => '0:a:0',
],
'WaterMarkConfigUrl' => [
'description' => '水印配置文件URL。',
'type' => 'string',
'example' => 'http://example.com/configure',
],
'WaterMarkList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WaterMark' => [
'description' => '水印列表。'."\n"
."\n"
.'> 如果水印输出截断或失败,请先检查您添加的文本水印中是否包含特殊字符,如有,则需要对特殊字符进行转义后再传入,或[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?product=mts)[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.dticket.68797bbcm8H408#/ticket/add/?productId=1232)联系阿里云客服进行兼容处理。',
'type' => 'array',
'items' => [
'description' => '水印详细信息。',
'type' => 'object',
'properties' => [
'Dx' => [
'description' => '水印图片相对输出视频的水平偏移量。如果请求参数中设置了此值,则覆盖水印模板对应参数。默认值为0。值有两种形式:'."\n"
."\n"
.'- 整数型:代表偏移像素值。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表水平偏移量与输出分辨率宽的比率。'."\n"
."\n"
.' - 范围:(0,1)。'."\n"
."\n"
.' - 支持四位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '1',
],
'Dy' => [
'description' => '水印图片相对输出视频的垂直偏移量。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片相对输出视频的垂直偏移量。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片相对输出视频的垂直偏移量像素。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表水印图片相对输出视频的垂直偏移量比率。'."\n"
."\n"
.' - 范围:**(0,1)**。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '1',
],
'Height' => [
'description' => '水印图片高。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片高。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片高的像素值。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表相对输出视频分辨率高的比率。'."\n"
."\n"
.' - 范围:**(0,1)**。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '1280',
],
'InputFile' => [
'description' => '水印输入文件。目前支持png图片、mov文件作为输入文件。',
'type' => 'object',
'properties' => [
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-logo-****.png',
],
],
],
'ReferPos' => [
'description' => '水印的位置。如果请求参数中设置了此值,则覆盖水印模板对应参数。可取值:'."\n"
."\n"
.'- **TopRight**:右上。'."\n"
.'- **TopLeft**:左上。'."\n"
.'- **BottomRight**:右下。'."\n"
.'- **BottomLeft**:左下。',
'type' => 'string',
'example' => 'TopRight',
],
'Type' => [
'description' => '水印类型。如果请求参数中设置了此参数,则此值覆盖水印模板对应参数。更多信息,请参见[参数详情](~~29253~~)。可取值:'."\n"
."\n"
.'- **Image**:图片水印。'."\n"
.'- **Text**:文字水印。',
'type' => 'string',
'example' => 'Image',
],
'WaterMarkTemplateId' => [
'description' => '水印模板ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'Width' => [
'description' => '水印图片宽。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片宽。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片宽的像素值。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表相对输出视频分辨率宽的比率。'."\n"
."\n"
.' - 范围:**(0,1)**。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '1080',
],
],
],
],
],
],
],
],
'Percent' => [
'description' => '转码进度。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a126797',
],
'State' => [
'description' => '作业状态。'."\n"
."\n"
.'- **Submitted**:作业已提交。'."\n"
.'- **TranscodeFail**:转码失败。',
'type' => 'string',
'example' => 'Submitted',
],
],
],
'Message' => [
'description' => '创建作业失败时错误消息。创建成功时此参数不返回。',
'type' => 'string',
'example' => 'The specified parameter "%s" cannot be null.',
],
'Success' => [
'description' => '是否成功。可取值:'."\n"
."\n"
.'- **true**:成功。'."\n"
."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A45S71F6-D73936451234',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"JobResultList\\": {\\n \\"JobResult\\": [\\n {\\n \\"Code\\": \\"InvalidParameter.NullValue\\",\\n \\"Job\\": {\\n \\"Code\\": \\"InternalError\\",\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"FinishTime\\": \\"2014-01-10T12:20:00Z\\",\\n \\"Input\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example.flv\\"\\n },\\n \\"JobId\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"MNSMessageResult\\": {\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"ErrorMessage\\": \\"The resource operated \\\\\\"%s\\\\\\" cannot be found.\\",\\n \\"MessageId\\": \\"123\\"\\n },\\n \\"Message\\": \\"The operation has failed due to some unknown error, exception or failure.\\",\\n \\"Output\\": {\\n \\"AmixList\\": {\\n \\"Amix\\": [\\n {\\n \\"AmixURL\\": \\"https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3\\",\\n \\"Duration\\": \\"20\\",\\n \\"Map\\": \\"0:a:0\\",\\n \\"MixDurMode\\": \\"long\\",\\n \\"Start\\": \\"0\\"\\n }\\n ]\\n },\\n \\"Audio\\": {\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"6\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"Volume\\": {\\n \\"Level\\": \\"-20\\",\\n \\"Method\\": \\"auto\\"\\n }\\n },\\n \\"AudioStreamMap\\": \\"0:a:0\\",\\n \\"Clip\\": {\\n \\"TimeSpan\\": {\\n \\"Duration\\": \\"01:00:59.999\\",\\n \\"Seek\\": \\"01:59:59.999\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n },\\n \\"DeWatermark\\": \\"{\\\\\\"0\\\\\\": [{\\\\\\"l\\\\\\": 10,\\\\\\"t\\\\\\": 10,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10},{\\\\\\"l\\\\\\": 100,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10}],\\\\\\"128000\\\\\\": [],\\\\\\"250000\\\\\\": [{\\\\\\"l\\\\\\": 0.2,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 0.01,\\\\\\"h\\\\\\": 0.05}]}\\",\\n \\"DigiWaterMark\\": {\\n \\"Alpha\\": \\"1.0\\",\\n \\"InputFile\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-intput.flv\\"\\n },\\n \\"Type\\": \\"Image\\"\\n },\\n \\"Encryption\\": {\\n \\"Id\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"Key\\": \\"encryptionkey128\\",\\n \\"KeyType\\": \\"Base64\\",\\n \\"KeyUri\\": \\"https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/\\",\\n \\"SkipCnt\\": \\"3\\",\\n \\"Type\\": \\"hls-aes-128\\"\\n },\\n \\"M3U8NonStandardSupport\\": {\\n \\"TS\\": {\\n \\"Md5Support\\": true,\\n \\"SizeSupport\\": true\\n }\\n },\\n \\"MergeConfigUrl\\": \\"`{\\\\\\"MergeList\\\\\\":[{\\\\\\"MergeURL\\\\\\":\\\\\\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\\\\\\"}]}\\",\\n \\"MergeList\\": {\\n \\"Merge\\": [\\n {\\n \\"Duration\\": \\"00000.20\\",\\n \\"MergeURL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv\\",\\n \\"RoleArn\\": \\"acs:ram:::role/\\",\\n \\"Start\\": \\"00000.50\\"\\n }\\n ]\\n },\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"DitherMode\\": \\"bayer\\",\\n \\"FinalDelay\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\",\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"20\\"\\n },\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n }\\n },\\n \\"OpeningList\\": {\\n \\"Opening\\": [\\n {\\n \\"Height\\": \\"1080\\",\\n \\"Start\\": \\"1\\",\\n \\"Width\\": \\"1920\\",\\n \\"openUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\"\\n }\\n ]\\n },\\n \\"OutSubtitleList\\": {\\n \\"OutSubtitle\\": [\\n {\\n \\"Map\\": \\"0:v:0\\",\\n \\"Message\\": \\"The specified parameter “%s” cannot be null.\\",\\n \\"OutSubtitleFile\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"RoleArn\\": \\"acs:ram:::role/\\"\\n },\\n \\"Success\\": true\\n }\\n ]\\n },\\n \\"OutputFile\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"RoleArn\\": \\"acs:ram:::role/\\"\\n },\\n \\"Priority\\": \\"5\\",\\n \\"Properties\\": {\\n \\"Bitrate\\": \\"1000\\",\\n \\"Duration\\": \\"55\\",\\n \\"FileFormat\\": \\"QuickTime / MOV\\",\\n \\"FileSize\\": \\"3509895\\",\\n \\"Format\\": {\\n \\"Bitrate\\": \\"1000\\",\\n \\"Duration\\": \\"55\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"FormatName\\": \\"mov\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"Size\\": \\"3509895\\",\\n \\"StartTime\\": \\"0.000000\\"\\n },\\n \\"Fps\\": \\"25\\",\\n \\"Height\\": \\"720\\",\\n \\"Streams\\": {\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Bitrate\\": \\"128.806\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Channels\\": \\"2\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"Duration\\": \\"17.159546\\",\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"eng\\",\\n \\"NumFrames\\": \\"25\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Timebase\\": \\"1/44100\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"eng\\"\\n }\\n ]\\n },\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"AvgFPS\\": \\"23.976025\\",\\n \\"Bitrate\\": \\"1496.46\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"CodecTimeBase\\": \\"1001/48000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Duration\\": \\"17.225542\\",\\n \\"Fps\\": \\"23.976025\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Height\\": \\"720\\",\\n \\"Index\\": \\"0\\",\\n \\"Lang\\": \\"eng\\",\\n \\"Level\\": \\"51\\",\\n \\"NetworkCost\\": {\\n \\"AvgBitrate\\": \\"100\\",\\n \\"CostBandwidth\\": \\"10\\",\\n \\"PreloadTime\\": \\"8\\"\\n },\\n \\"NumFrames\\": \\"25\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Profile\\": \\"high\\",\\n \\"Sar\\": \\"1:1\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Timebase\\": \\"1/24000\\",\\n \\"Width\\": \\"1280\\"\\n }\\n ]\\n }\\n },\\n \\"Width\\": \\"1280\\"\\n },\\n \\"Rotate\\": \\"180\\",\\n \\"SubtitleConfig\\": {\\n \\"ExtSubtitleList\\": {\\n \\"ExtSubtitle\\": [\\n {\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"FontName\\": \\"\\\\\\"WenQuanYi Zen Hei\\\\\\", \\\\\\"Yuanti SC Regular\\\\\\", \\\\\\"SimSun\\\\\\"\\",\\n \\"Input\\": {\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-output.flv\\"\\n }\\n }\\n ]\\n },\\n \\"SubtitleList\\": {\\n \\"Subtitle\\": [\\n {\\n \\"Map\\": \\"0:a:0\\"\\n }\\n ]\\n }\\n },\\n \\"SuperReso\\": {\\n \\"IsHalfSample\\": \\"true\\"\\n },\\n \\"TailSlateList\\": {\\n \\"TailSlate\\": [\\n {\\n \\"BgColor\\": \\"White\\",\\n \\"BlendDuration\\": \\"2\\",\\n \\"Height\\": \\"1080\\",\\n \\"IsMergeAudio\\": false,\\n \\"Start\\": \\"1\\",\\n \\"TailUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\",\\n \\"Width\\": \\"1920\\"\\n }\\n ]\\n },\\n \\"TemplateId\\": \\"S00000000-000010\\",\\n \\"TransConfig\\": {\\n \\"AdjDarMethod\\": \\"crop\\",\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"TransMode\\": \\"onepass\\"\\n },\\n \\"UserData\\": \\"example data\\",\\n \\"Video\\": {\\n \\"Bitrate\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"20\\",\\n \\"Min\\": \\"10\\"\\n },\\n \\"Bufsize\\": \\"1000\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Crf\\": \\"22\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Degrain\\": \\"5\\",\\n \\"Fps\\": \\"60\\",\\n \\"Gop\\": \\"1\\",\\n \\"Height\\": \\"1280\\",\\n \\"MaxFps\\": \\"15\\",\\n \\"Maxrate\\": \\"10\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"PixFmt\\": \\"yuvj420p\\",\\n \\"Preset\\": \\"veryfast\\",\\n \\"Profile\\": \\"baseline\\",\\n \\"Qscale\\": \\"15\\",\\n \\"ResoPriority\\": \\"1\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"Width\\": \\"1080\\"\\n },\\n \\"VideoStreamMap\\": \\"0:a:0\\",\\n \\"WaterMarkConfigUrl\\": \\"http://example.com/configure\\",\\n \\"WaterMarkList\\": {\\n \\"WaterMark\\": [\\n {\\n \\"Dx\\": \\"1\\",\\n \\"Dy\\": \\"1\\",\\n \\"Height\\": \\"1280\\",\\n \\"InputFile\\": {\\n \\"Bucket\\": \\"example-bucket\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Object\\": \\"example-logo-****.png\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"Type\\": \\"Image\\",\\n \\"WaterMarkTemplateId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Width\\": \\"1080\\"\\n }\\n ]\\n }\\n },\\n \\"Percent\\": 100,\\n \\"PipelineId\\": \\"88c6ca184c0e47098a5b665e2a126797\\",\\n \\"State\\": \\"Submitted\\"\\n },\\n \\"Message\\": \\"The specified parameter \\\\\\"%s\\\\\\" cannot be null.\\",\\n \\"Success\\": true\\n }\\n ]\\n },\\n \\"RequestId\\": \\"25818875-5F78-4A45S71F6-D73936451234\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n 2014-01-10T12:00:00Z\\n 100\\n 2014-01-10T12:20:00Z\\n Submitted\\n 31fa3c9ca8134f9cec2b4b0b0f78****\\n InternalError\\n The operation has failed due to some unknown error, exception or failure.\\n \\n 88c6ca184c0e47098a5b665e2a126797\\n \\n \\n oss-cn-hangzhou\\n example-bucket-****\\n \\n \\n 123\\n The resource operated \\"%s\\" cannot be found.\\n InvalidParameter.ResourceNotFound\\n \\n \\n true\\n InvalidParameter.NullValue\\n The specified parameter \\"%s\\" cannot be null.\\n \\n 25818875-5F78-4A45S71F6-D73936451234\\n","errorExample":""}]',
'title' => '提交转码作业',
'description' => '- 转码作业为异步执行,不保证时效性。在提交转码作业后,任务会添加到管道中排队,被调度执行。所以在接口返回时,不保证转码已经完成。执行完成后需要调用[查询转码作业](~~602836~~)接口轮询执行结果,或通过为管道绑定MNS消息接收执行结果,详细操作请参见[接收消息通知](https://help.aliyun.com/document_detail/42618.html)[接收消息通知](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications)。'."\n"
."\n"
.'- 输入单个文件大小最大支持100 GB,超过可能导致执行失败。'."\n"
.'- 使用**预置智能模板**对输入文件进行转码时,必须要先调用提交预置模板分析作业接口([SubmitAnalysisJob](~~29223~~)),分析作业成功完成后可以通过调用查询模板分析作业接口( [QueryAnalysisJobList](~~29224~~))获取该输入文件的可用预置模板列表。在提交转码作业时,将TemplateId参数设置为可用的预置模板ID即可。若提交的转码作业中指定的模板不在可用的预置模板列表中,会导致转码作业失败。'."\n"
.'- 使用**预置静态模板**对输入文件进行转码时,不需要提交模板分析作业。'."\n"
."\n"
.'- 如需在MPS服务中使用多个账号,可以为阿里云账号创建RAM用户,详细说明请参见[创建RAM用户并授权](~~42841~~)。如果提交转码作业和查询转码作业使用的是不同的阿里云账号,则会导致查询不到数据。'."\n"
."\n"
.'- 如果您的账户已经欠费,欠费后24小时内会暂停服务。更多信息请参见[欠费说明](~~29203~~)。'."\n"
."\n"
.'- 更多转码常见问题,请参见[媒体处理常见问题](~~38986~~)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CancelJob' => [
'summary' => '取消转码作业。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmts0IG2Y5',
],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '需要取消的转码作业ID。可以通过**MPS控制台** > **任务管理**获取,或者从[提交转码作业](~~29226~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"JobId\\": \\"d1ce4d3efcb549419193f50f1fcd****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\n d1ce4d3efcb549419193f50f1fcd****\\n","errorExample":""}]',
'title' => '取消转码作业',
'description' => '- 本接口只能取消状态处于“已提交”状态的作业;'."\n"
.'- 建议先调用更新管道接口(**UpdatePipeline**)将管道状态置为Paused,暂停作业调度,再调用取消作业接口取消作业;取消完后需要恢复管道状态为Active,管道中的作业才会被调度执行。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryJobList' => [
'summary' => '通过转码作业ID,批量查询转码作业。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmts0IG2Y5',
],
],
'parameters' => [
[
'name' => 'JobIds',
'in' => 'query',
'schema' => [
'description' => '转码作业ID。'."\n"
.'- 一次最多查询10个,使用半角逗号(,)分隔。'."\n"
.'- 可以通过[MPS控制台](https://mps.console.aliyun.com/overview) > **任务管理**获取,也可以从[提交转码作业](~~29226~~)的返回参数中获取。'."\n"
."\n"
.'> 如果不传入此参数,则会返回`InvalidParameter`(参数无效)错误码。',
'type' => 'string',
'required' => false,
'example' => 'bb558c1cc25b45309aab5be44d19****,d1ce4d3efcb549419193f50f1fcd****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'NonExistJobIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的作业ID。',
'type' => 'array',
'items' => [
'description' => '不存在的转码作业ID列表,无数据时该结构不返回。',
'type' => 'string',
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '197ADF44-104C-514C-9F92-D8924CB34E2A',
],
'JobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Job' => [
'description' => '转码作业集合。',
'type' => 'array',
'items' => [
'description' => '转码作业详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '作业添加时间。',
'type' => 'string',
'example' => '2014-01-10T12:00:00Z',
],
'Percent' => [
'description' => '转码进度。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'FinishTime' => [
'description' => '作业完成时间。',
'type' => 'string',
'example' => '2014-01-10T12:20:25Z',
],
'State' => [
'description' => '作业状态。'."\n"
."\n"
.'- **Submitted**:作业已提交。'."\n"
.'- **Transcoding**:转码中。'."\n"
.'- **TranscodeSuccess**:转码成功。'."\n"
.'- **TranscodeFail**:转码失败。'."\n"
.'- **TranscodeCancelled**:转码取消。',
'type' => 'string',
'example' => 'TranscodeSuccess',
],
'JobId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '31fa3c9ca8134fb4b0b0f7878301****',
],
'Code' => [
'description' => '任务失败时的错误码。成功则不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.NullValue',
],
'Message' => [
'description' => '任务失败时的消息。成功则不返回此参数。',
'type' => 'string',
'example' => 'The specified parameter "%s" cannot be null.',
],
'Output' => [
'description' => '作业输出。',
'type' => 'object',
'properties' => [
'Video' => [
'description' => '视频配置。',
'type' => 'object',
'properties' => [
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 单位:Kb。'."\n"
.'- 默认值:**6000**。',
'type' => 'string',
'example' => '6000',
],
'Degrain' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '5',
],
'BitrateBnd' => [
'description' => '视频平均码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '最大码率。',
'type' => 'string',
'example' => '1000',
],
'Min' => [
'description' => '最小码率。',
'type' => 'string',
'example' => '300',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。范围:yuv420p,yuvj420p等标准颜色格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Pad' => [
'description' => '视频贴黑边。'."\n"
."\n"
.'- 单位:px。'."\n"
."\n"
.'- 参数格式:width:height:left:top。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Codec' => [
'description' => '编解码格式。'."\n"
."\n"
.'- 支持H.264、H.265。'."\n"
.'- 默认值:H.264。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:视频原始高度。',
'type' => 'string',
'example' => '720',
],
'Qscale' => [
'description' => '视频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Crop' => [
'description' => '视频画面裁剪,支持2种方式:'."\n"
.'- 自动检测黑边并裁切,设置为**border**。'."\n"
.'- 自定义裁切,参数格式为width:height:left:top。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Bitrate' => [
'description' => '视频平均码率。单位:Kbps。',
'type' => 'string',
'example' => '500',
],
'Maxrate' => [
'description' => '视频码率峰值。单位:Kbps。',
'type' => 'string',
'example' => '3000',
],
'MaxFps' => [
'description' => '最大帧率。',
'type' => 'string',
'example' => '60',
],
'Profile' => [
'description' => '编码级别。支持baseline、main、high。'."\n"
."\n"
.'> 如果您有多个清晰度,建议最低清晰度配置成baseline,以保证最低端设备可播放。其他清晰度配置为main或high。'."\n"
."\n"
.'- **baseline**:针对移动设备。'."\n"
.'- **main**:针对标准分辨率设备。'."\n"
.'- **high**:针对高分辨率设备。'."\n"
.'- 默认值:**high**。',
'type' => 'string',
'example' => 'high',
],
'Crf' => [
'description' => '码率-质量控制因子。'."\n"
."\n"
.'- 默认值:编码格式为H264,默认值为**23**。编码格式为H265,默认值为**26**。'."\n"
.'- 如果设置了Crf,则Bitrate的设置失效。',
'type' => 'string',
'example' => '26',
],
'Gop' => [
'description' => '关键帧间最大时间间隔或最大帧数。单位:秒。'."\n"
."\n"
.'- 默认值:**250**。'."\n"
."\n"
.'- 最大帧数时无单位。',
'type' => 'string',
'example' => '250',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:视频原始宽度。',
'type' => 'string',
'example' => '1280',
],
'Fps' => [
'description' => '帧率。'."\n"
."\n"
.'- 单位:fps。'."\n"
."\n"
.'- 当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取输入文件帧率。',
'type' => 'string',
'example' => '25',
],
'Preset' => [
'description' => '视频算法器预置。默认值:**medium**。可取值:'."\n"
."\n"
.'- **veryfast**:超快。'."\n"
."\n"
.'- **fast**:快。'."\n"
."\n"
.'- **medium**:中等。'."\n"
."\n"
.'- **slow**:慢。'."\n"
."\n"
.'- **slower**:超慢。',
'type' => 'string',
'example' => 'medium',
],
'ScanMode' => [
'description' => '扫描模式。取值如下:'."\n"
.'- **不设置**:按输入文件的原始模式。'."\n"
.'- **auto**:自动去隔行。'."\n"
.'- **progressive**:顺序扫描(逐行扫描)。'."\n"
.'- **interlaced**:交叉扫描(隔行扫描)。'."\n"
.'- **默认值**:空,即不设置。'."\n"
."\n"
.'**最佳实践**:交叉扫描虽然比顺序扫描更节省数据量,但画质不佳,所以现在主流视频制作都采用顺序扫描。'."\n"
.'- 如果您设置了**顺序扫描**或**交叉扫描**,但与原视频模式不符,会导致转码失败。'."\n"
.'- 建议您设置**原视频模式**或**自动去隔行**,以提高兼容性。',
'type' => 'string',
'example' => 'interlaced',
],
'ResoPriority' => [
'description' => '资源优先级。',
'type' => 'string',
'example' => '1',
],
],
],
'TransConfig' => [
'description' => '转码通用配置。'."\n"
."\n"
.'> 如果请求参数中设置了该值,则覆盖指定转码模板中的对应参数。',
'type' => 'object',
'properties' => [
'IsCheckAudioBitrate' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于IsCheckAudioBitrateFail。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:'."\n"
.' - 参数为空,并且codec和输入源不一样:false。'."\n"
.' - 参数为空,并且codec和输入源一样:true。',
'type' => 'string',
'example' => 'false',
],
'TransMode' => [
'description' => '转码模式。'."\n"
."\n"
.'- 可选范围:onepass、twopass、CBR。'."\n"
.'- 默认值:**onepass**。',
'type' => 'string',
'example' => 'onepass',
],
'IsCheckReso' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则视为输出分辨率等于输入分辨率。'."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckVideoBitrateFail' => [
'description' => '是否检查码率。当输出视频码率大于媒体源视频码率时,则不进行转码,直接返回转码失败。此值优先级大于IsCheckVideoBitrate。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'AdjDarMethod' => [
'description' => '分辨率改写方式。默认值:**none**。可取值:rescale、crop、pad、none。',
'type' => 'string',
'example' => 'none',
],
'IsCheckVideoBitrate' => [
'description' => '是否检查视频码率。如果视频输出码率大于视频输入码率,则视为视频输出码率等于视频输入码率。'."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckResoFail' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。'."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckAudioBitrateFail' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则不进行转码,直接返回转码失败,此值优先级大于IsCheckAudioBitrate。'."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
],
],
'Encryption' => [
'description' => '数据加密,只支持m3u8格式的输出。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '加密类型。取值:**hls-aes-128**。',
'type' => 'string',
'example' => 'hls-aes-128',
],
'Key' => [
'description' => '加密视频的密钥。',
'type' => 'string',
'example' => 'encryptionkey128',
],
'KeyType' => [
'description' => '密钥加密方式,可取值:Base64、KMS。'."\n"
."\n"
.'> 例如密钥为`"encryptionkey128"`,则`Base64("encryptionkey128")`,或`KMS(Base64("encryptionkey128")`。',
'type' => 'string',
'example' => 'Base64',
],
'Id' => [
'description' => '加密ID。',
'type' => 'string',
'example' => '31fa3c9ca8134f9cec2b4b0b0f78****',
],
'KeyUri' => [
'description' => '密钥的访问URL,使用BASE64进行编码。',
'type' => 'string',
'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/',
],
'SkipCnt' => [
'description' => '前面不加密的片数(视频能快速播放起来)。',
'type' => 'string',
'example' => '3',
],
],
],
'WaterMarkList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WaterMark' => [
'description' => '水印列表。',
'type' => 'array',
'items' => [
'description' => '水印详细信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '水印类型。如果请求参数中设置了此参数,则此值覆盖水印模板对应参数。更多信息,请参见[参数详情](~~29253~~)。可取值:'."\n"
."\n"
.'- Image:图片水印。'."\n"
."\n"
.'- Text:文字水印。',
'type' => 'string',
'example' => 'Image',
],
'ReferPos' => [
'description' => '水印的位置。如果请求参数中设置了此值,测覆盖水印模板对应参数。可取值:'."\n"
."\n"
.'- TopRight:右上。'."\n"
."\n"
.'- TopLeft:左上。'."\n"
."\n"
.'- BottomRight:右下。'."\n"
."\n"
.'- BottomLeft:左下。',
'type' => 'string',
'example' => 'TopRight',
],
'Dx' => [
'description' => '水印图片相对输出视频的水平偏移量。如果请求参数中设置了此值,则覆盖水印模板对应参数。默认值为0。值有两种形式:'."\n"
."\n"
.'- 整数型:代表偏移像素值。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表水平偏移量与输出分辨率宽的比率。'."\n"
."\n"
.' - 范围:(0,1)。'."\n"
."\n"
.' - 支持四位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '100',
],
'Width' => [
'description' => '水印图片宽。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片宽。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片宽的像素值。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表相对输出视频分辨率宽的比率。'."\n"
."\n"
.' - 范围:**(0,1)**。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '50',
],
'Height' => [
'description' => '水印图片搞高。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片高。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片高的像素值。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表相对输出视频分辨率高的比率。'."\n"
."\n"
.' - 范围:**(0,1)**。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '50',
],
'InputFile' => [
'description' => '水印输入文件。目前支持png图片、mov文件作为输入文件。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-logo-****.png',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'WaterMarkTemplateId' => [
'description' => '水印模板ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'Dy' => [
'description' => '水印图片相对输出视频的垂直偏移量。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片相对输出视频的垂直偏移量。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片相对输出视频的垂直偏移量像素。'."\n"
."\n"
.' - 范围:**\\[8,4096\\]**。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表水印图片相对输出视频的垂直偏移量比率。'."\n"
."\n"
.' - 范围:**(0,1)**。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '100',
],
],
],
],
],
],
'WaterMarkConfigUrl' => [
'description' => '水印配置文件URL。',
'type' => 'string',
'example' => 'http://example.com/configure',
],
'DeWatermark' => [
'description' => '模糊处理,JSON对象。更多信息请参见[参数详情](~~29253~~)中的模糊处理详情。',
'type' => 'string',
'example' => '{"0":[{"l":10,"t":10,"w":10,"h":10},{"l":100,"t":0.1,"w":10,"h":10}],"128000":[],"250000":[{"l":0.2,"t":0.1,"w":0.01,"h":0.05}]}',
],
'M3U8NonStandardSupport' => [
'description' => 'm3u8非标准支持,JSON对象。更多信息请参见[参数详情](~~29253~~)中的m3u8非标准参数支持详情。',
'type' => 'object',
'properties' => [
'TS' => [
'description' => 'JSON对象,TS文件相关非标准支持。更多信息请参见[参数详情](~~29253~~)中的TS参数支持详情。',
'type' => 'object',
'properties' => [
'SizeSupport' => [
'description' => '是否支持在m3u8文件中输出TS文件的大小。可取值:'."\n"
."\n"
.'- **true**:支持。'."\n"
."\n"
.'- **false**:不支持。',
'type' => 'boolean',
'example' => 'true',
],
'Md5Support' => [
'description' => '是否支持在m3u8文件中输出TS的md5值。可取值:'."\n"
."\n"
.'- **true**:支持。'."\n"
."\n"
.'- **false**:不支持。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'Priority' => [
'description' => '任务在其对应管道内的优先级。'."\n"
."\n"
.'- 最高优先级:10。'."\n"
."\n"
.'- 默认值:**6**。',
'type' => 'string',
'example' => '6',
],
'Audio' => [
'description' => '音频配置。'."\n"
."\n"
.'> 如果请求参数中指定了音频配置则覆盖指定转码模板中的对应参数。',
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当Codec为aac时可取值:aaclow、aache、aachev2、aacld、aaceld。',
'type' => 'string',
'example' => 'aaclow',
],
'Codec' => [
'description' => '音频编解码格式。'."\n"
."\n"
.'- 支持aac、mp3、vorbis、flac。'."\n"
."\n"
.'- 默认值:**aac**。',
'type' => 'string',
'example' => 'aac',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 支持22050、32000、44100、48000、96000。'."\n"
."\n"
.'- 单位:Hz。'."\n"
."\n"
.'- 默认值:44100。'."\n"
."\n"
.'> 若视频容器格式为flv,音频编解码格式选择为mp3时,采样率不支持32000、48000、96000;音频编解码格式为mp3时,采样率不支持96000。',
'type' => 'string',
'example' => '44100',
],
'Qscale' => [
'description' => '音频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Channels' => [
'description' => '声道数。'."\n"
."\n"
.'- 支持1、2、3、4、5、6、7、8。'."\n"
.'- 默认值:**2**。',
'type' => 'string',
'example' => '2',
],
'Volume' => [
'description' => '音量配置。',
'type' => 'object',
'properties' => [
'Method' => [
'description' => '音量调整方式。可取值:'."\n"
."\n"
.'- **auto**:自动调整。'."\n"
."\n"
.'- **dynamic**:动态调整。'."\n"
."\n"
.'- **linear**:线性调整。',
'type' => 'string',
'example' => 'auto',
],
'Level' => [
'description' => '音量调整幅度,默认为**-20db**。',
'type' => 'string',
'example' => '-20',
],
],
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '128',
],
],
],
'AudioStreamMap' => [
'description' => '音频流序号。'."\n"
."\n"
.'- 格式:格式:0:a:{序号},示例:0:a:0。'."\n"
."\n"
.'- 序号的含义是音频流列表的下标,序号从0开始。'."\n"
."\n"
.'- 若未设置,选择默认的音频流。',
'type' => 'string',
'example' => '0:a:0',
],
'MergeList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Merge' => [
'description' => '拼接设置。最多支持4个MergeURL。',
'type' => 'array',
'items' => [
'description' => '拼接详细信息。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '起始时间点。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或者`sssss[.SSS]`。'."\n"
.'- 示例:01:59:59.999或者32000.23。',
'type' => 'string',
'example' => '01:59:59.999',
],
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
'MergeURL' => [
'description' => '拼接片段地址。'."\n"
."\n"
.'- 示例:`http://example-bucket-.oss-cn-hangzhou.aliyuncs.com/example-object.flv`。'."\n"
.'- Object需要经过URL Encode,采用UTF-8编码。更多信息,请参见[URL编码说明](~~423796~~)。',
'type' => 'string',
'example' => 'http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv',
],
'Duration' => [
'description' => '持续时间。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或者`sssss[.SSS]`。'."\n"
.'- 示例:01:59:59.999或者32000.23。',
'type' => 'string',
'example' => '01:59:59.999',
],
],
],
],
],
],
'SuperReso' => [
'description' => '分辨率随源。',
'type' => 'object',
'properties' => [
'IsHalfSample' => [
'description' => '是否获取采样率相关参数。可取值:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。',
'type' => 'string',
'example' => 'true',
],
],
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'ExtendData' => [
'title' => '扩展字段',
'description' => '用户自定义扩展字段。',
'type' => 'string',
'example' => 'testid-002',
],
'OutSubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OutSubtitle' => [
'description' => '输出字幕列表。',
'type' => 'array',
'items' => [
'description' => '输出字幕详情。',
'type' => 'object',
'properties' => [
'Map' => [
'description' => '视频轨。格式:`0:{流}:{流序号} `,即`0:v:{video_index}`。流取值为v: video音频流,序号的含义是音频流列表的下标,序号从0开始。',
'type' => 'string',
'example' => '0:v:0',
],
'OutSubtitleFile' => [
'description' => '输出文件详细信息。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
'Object' => [
'description' => '输出文件的OSS Object。',
'type' => 'string',
'example' => 'example.flv',
],
'Location' => [
'description' => '输出文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输出文件的OSS Bucket。',
'type' => 'string',
'example' => 'exampleBucket',
],
],
],
'Success' => [
'description' => '是否成功。可取值:'."\n"
."\n"
.'- **true**:成功。'."\n"
."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '创建作业失败时错误消息。创建成功时此参数不返回。',
'type' => 'string',
'example' => 'The specified parameter “%s” cannot be null.',
],
],
],
],
],
],
'VideoStreamMap' => [
'description' => '视频流序号。序号从0开始,序号的含义是视频流列表的下标,若不设置,选择默认的视频流。',
'type' => 'string',
'example' => '0',
],
'OutputFile' => [
'description' => '输出文件。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
'Object' => [
'description' => '输出文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
'Location' => [
'description' => '输出文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输出文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'Rotate' => [
'description' => '视频旋转角度。',
'type' => 'string',
'example' => '90',
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。'."\n"
."\n"
.'- 默认值:mp4。'."\n"
."\n"
.'- 视频转码可取值flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。'."\n"
."\n"
.'- 音频转码可取值mp3、mp4、ogg、flac、m4a。'."\n"
."\n"
.'- 图片可取值gif、WEBP。容器格式为gif时,VideoCodec设置只能设置为GIF。'."\n"
."\n"
.'- 容器格式为webp时,VideoCodec设置只能设置为WEBP。'."\n"
."\n"
.'- 容器格式为flv时,VideoCodec不能设置为H265。',
'type' => 'string',
'example' => 'mp4',
],
],
],
'Clip' => [
'description' => '剪辑片段。',
'type' => 'object',
'properties' => [
'TimeSpan' => [
'description' => '剪辑时间段。',
'type' => 'object',
'properties' => [
'Seek' => [
'description' => '开始时间点。 '."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`。'."\n"
."\n"
.'- 示例:01:59:59.999。'."\n"
."\n"
.'或者'."\n"
."\n"
.'- 格式:`sssss[.SSS]`。'."\n"
."\n"
.'- 示例:32000.23。',
'type' => 'string',
'example' => '01:59:59.999',
],
'Duration' => [
'description' => '持续时长。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`。'."\n"
.'- 示例:01:00:59.999。'."\n"
."\n"
.'或者'."\n"
."\n"
.'- 格式:`sssss[.SSS]`。'."\n"
.'- 示例:32000.23。',
'type' => 'string',
'example' => '01:00:59.999',
],
],
],
],
],
'MergeConfigUrl' => [
'description' => '拼接配置文件URL地址。MergeList与MergeConfigUrl两个参数只支持二选一。'."\n"
."\n"
.'- MergeConfigUrl指定的配置文件允许50个拼接片段上限。'."\n"
."\n"
.'- MergeConfigUrl是拼接配置文件URL地址。只支持存放在OSS上的配置文件,且需要保证有授权给MPS可访问权限,文件内部内容参见拼接参数详情。'."\n"
."\n"
.'- mergeConfigfile文件内部内容示例:`{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`。',
'type' => 'string',
'example' => 'https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8',
],
'OpeningList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Opening' => [
'description' => '开板列表,JSON对象。',
'type' => 'array',
'items' => [
'description' => '开板详细信息。',
'type' => 'object',
'properties' => [
'openUrl' => [
'description' => '开板视频的OSS URL地址。',
'type' => 'string',
'example' => 'http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4',
],
'Start' => [
'description' => '相对正片视频的开始时间。'."\n"
."\n"
.'- 从0开始延迟多长时间后,显示开板视频。'."\n"
.'- 单位:秒。'."\n"
.'- 默认值:**0**。',
'type' => 'string',
'example' => '0',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 范围:(0,4096)、1、full。'."\n"
.'- -1代表片源的值。'."\n"
.'- full表示填满画面。'."\n"
.'- 默认值:**-1**。',
'type' => 'string',
'example' => '-1',
],
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 范围:(0,4096)、-1、full。'."\n"
.'- -1代表片源的值。'."\n"
.'- full表示填满画面。'."\n"
.'- 默认为:**-1**。',
'type' => 'string',
'example' => '-1',
],
],
],
],
],
],
'MuxConfig' => [
'description' => '转码封包配置。转码封包配置。如果请求参数中设置了此参数,则覆盖指定转码模板中的对应参数。',
'type' => 'object',
'properties' => [
'Webp' => [
'description' => 'Webp对应的封包配置。',
'type' => 'object',
'properties' => [
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
],
],
'Gif' => [
'description' => 'Gif对应的封包配置。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => '终帧暂停时间。单位:厘秒。',
'type' => 'string',
'example' => '0',
],
'DitherMode' => [
'description' => '调色板颜色抖动方式。可取值:sierra、bayer。',
'type' => 'string',
'example' => 'bayer',
],
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
'IsCustomPalette' => [
'description' => '自定义调色板功能。可取值:'."\n"
."\n"
.'- **true**:自定义。'."\n"
."\n"
.'- **false**:非自定义。',
'type' => 'string',
'example' => 'false',
],
],
],
'Segment' => [
'description' => '切片配置,JSON对象。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。单位:秒。',
'type' => 'string',
'example' => '20',
],
],
],
],
],
'TailSlateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TailSlate' => [
'description' => '尾板列表。',
'type' => 'array',
'items' => [
'description' => '尾板详细信息。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '尾板视频开始时间。',
'type' => 'string',
'example' => '00000.00',
],
'BgColor' => [
'description' => '如果尾板视频的宽、高小于正片时,设置空白处填充的背景色。默认为White,取值请参见[bgcolor](~~29253~~)。',
'type' => 'string',
'example' => 'White',
],
'IsMergeAudio' => [
'description' => '是否要拼接尾板视频的音频内容。可取值:'."\n"
."\n"
.'- **true**:拼接。'."\n"
."\n"
.'- **false**:不拼接。',
'type' => 'boolean',
'example' => 'true',
],
'Width' => [
'description' => '宽,范围:(0,4096)、-1、full。'."\n"
."\n"
.'- -1代表片源的值。'."\n"
.'- full表示填满画面。'."\n"
.'- 默认为**-1**。',
'type' => 'string',
'example' => '-1',
],
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 范围:(0,4096)、-1、full。'."\n"
."\n"
.'- -1代表片源的值。'."\n"
.'- full表示填满画面。'."\n"
.'- 默认为**-1**。',
'type' => 'string',
'example' => '-1',
],
'BlendDuration' => [
'description' => '正片视频和尾板视频过渡的时长。过渡的效果是淡入淡出:正片显示最后一帧,同时播放尾板视频,正片最后一帧逐步变暗,尾板视频逐步变亮。单位秒,默认0。',
'type' => 'string',
'example' => '0',
],
'TailUrl' => [
'description' => '尾板视频的OSS URL地址。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv',
],
],
],
],
],
],
'TemplateId' => [
'description' => '模板ID。',
'type' => 'string',
'example' => 'S00000001-200010',
],
'SubtitleConfig' => [
'description' => '字幕配置。',
'type' => 'object',
'properties' => [
'ExtSubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ExtSubtitle' => [
'description' => '外部字幕列表。',
'type' => 'array',
'items' => [
'description' => '字幕详细信息。',
'type' => 'object',
'properties' => [
'CharEnc' => [
'description' => '外部字幕字符编码。'."\n"
."\n"
.'- 范围:UTF-8、GBK、BIG5、auto。'."\n"
."\n"
.'- 默认:**auto**。'."\n"
."\n"
.'> 外部字幕字符编码设置为auto时,存在误检情况,建议您指定具体的字符编码。',
'type' => 'string',
'example' => 'auto',
],
'FontName' => [
'description' => '外挂字幕转换成硬字幕对应的字体名称。默认值:SimSum。更多信息,请参见[字体列表](~~59950~~)。',
'type' => 'string',
'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"',
],
'Input' => [
'description' => '外部输入字幕文件。'."\n"
."\n"
.'- 目前支持srt、ass格式。更多信息请参见[参数详情](~~29253~~)中的Input参数。'."\n"
."\n"
.'- 示例:`{“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”}`。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
'Location' => [
'description' => '输入文件所在的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件所在的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
],
],
],
],
],
],
],
'SubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Subtitle' => [
'description' => '字幕列表。',
'type' => 'array',
'items' => [
'description' => '字幕详细信息。',
'type' => 'object',
'properties' => [
'Map' => [
'description' => '音轨。格式:`0:{流}:{流序号}` ,即`0:a:{audio_index}`。流取值为a: audio音频流,序号的含义是音频流列表的下标,序号从0开始。',
'type' => 'string',
'example' => '0:a:0',
],
],
],
],
],
],
],
],
'Properties' => [
'description' => '媒体属性。',
'type' => 'object',
'properties' => [
'Width' => [
'description' => '视频宽。',
'type' => 'string',
'example' => '720',
],
'Height' => [
'description' => '视频长。',
'type' => 'string',
'example' => '1280',
],
'SourceLogos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SourceLogo' => [
'description' => '非引擎层的关键字。',
'type' => 'array',
'items' => [
'description' => '关键字详细信息。',
'type' => 'object',
'properties' => [
'Source' => [
'description' => '关键字。',
'type' => 'string',
'example' => 'example',
],
],
],
],
],
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '30',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '490',
],
'FileFormat' => [
'description' => '文件格式。',
'type' => 'string',
'example' => 'mp4',
],
'Streams' => [
'description' => '流信息。',
'type' => 'object',
'properties' => [
'VideoStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoStream' => [
'description' => '视频流列表。',
'type' => 'array',
'items' => [
'description' => '视频流详细信息。',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '视频流序号,标识视频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '0',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/15360',
],
'AvgFPS' => [
'description' => '平均帧率。',
'type' => 'string',
'example' => '30.0',
],
'PixFmt' => [
'description' => '像素格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Sar' => [
'description' => '编码信号分辨率比。',
'type' => 'string',
'example' => '1:1',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'eng',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10',
],
'Height' => [
'description' => '视频分辨率长。',
'type' => 'string',
'example' => '1280',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '30',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '421.117',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'avc1',
],
'HasBFrames' => [
'description' => '是否有B帧。',
'type' => 'string',
'example' => '2',
],
'Profile' => [
'description' => '编码预置。',
'type' => 'string',
'example' => 'high',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0.000000',
],
'NetworkCost' => [
'description' => '网络带宽消耗。',
'type' => 'object',
'properties' => [
'PreloadTime' => [
'description' => '预加载时间。',
'type' => 'string',
'example' => '8',
],
'AvgBitrate' => [
'description' => '平均码率。',
'type' => 'string',
'example' => '300',
],
'CostBandwidth' => [
'description' => '最大消耗带宽。',
'type' => 'string',
'example' => '10',
],
],
],
'Dar' => [
'description' => '编码显示分辨率比。',
'type' => 'string',
'example' => '9:16',
],
'CodecName' => [
'description' => '编码格式简述名。',
'type' => 'string',
'example' => 'h264',
],
'Width' => [
'description' => '视频分辨率宽,数字。',
'type' => 'string',
'example' => '720',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17.233333',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '30.0',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x31637661',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/60',
],
'Level' => [
'description' => ' 编码等级。',
'type' => 'string',
'example' => '31',
],
'colorTransfer' => [
'description' => '色彩转换。',
'type' => 'string',
'example' => 'bt709',
],
'colorPrimaries' => [
'description' => '基色、原色。',
'type' => 'string',
'example' => 'bt709',
],
'bitsPerRawSample' => [
'description' => '每个样本或像素使用的二进制位数。',
'type' => 'string',
'example' => '8',
],
],
],
],
],
],
'AudioStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioStream' => [
'description' => '音频流列表。',
'type' => 'array',
'items' => [
'description' => '音频流详细信息。',
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/32000',
],
'Index' => [
'description' => '音频流序号,标识音频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'SampleFmt' => [
'description' => '采样格式。',
'type' => 'string',
'example' => 'fltp',
],
'ChannelLayout' => [
'description' => '声道输出样式。',
'type' => 'string',
'example' => 'mono',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'und',
],
'Samplerate' => [
'description' => '采样率。',
'type' => 'string',
'example' => '32000',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'AAC (Advanced Audio Coding)',
],
'Channels' => [
'description' => '声道数。',
'type' => 'string',
'example' => '1',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '50',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '64.136',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'mp4',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0.064000',
],
'CodecName' => [
'description' => '编码格式简述名。',
'type' => 'string',
'example' => 'aac',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17.223562',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x6134706d',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/32000',
],
],
],
],
],
],
'SubtitleStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubtitleStream' => [
'description' => '字幕流列表。',
'type' => 'array',
'items' => [
'description' => '字幕流详细信息。',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '字幕流序号。'."\n"
.'标识字幕流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'eng',
],
],
],
],
],
],
],
],
'Format' => [
'description' => '格式信息。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '-0.064000',
],
'NumPrograms' => [
'description' => '节目流总数。',
'type' => 'string',
'example' => '0',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '1057273',
],
'NumStreams' => [
'description' => '媒体流总数。',
'type' => 'string',
'example' => '2',
],
'FormatLongName' => [
'description' => '容器、封装格式长述名。',
'type' => 'string',
'example' => 'QuickTime / MOV',
],
'Duration' => [
'description' => '总时长。',
'type' => 'string',
'example' => '17.234000',
],
'Bitrate' => [
'description' => '总码率。',
'type' => 'string',
'example' => '490.784',
],
'FormatName' => [
'description' => '容器、封装格式简述名。可取值:mov、mp4、m4a、3gp、3g2、mj2。',
'type' => 'string',
'example' => 'mov',
],
],
],
'FileSize' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '1057273',
],
],
],
'MultiSpeedInfo' => [
'description' => '倍速作业信息。使用倍速管道提交的任务才有(老版倍速无该信息)。',
'type' => 'object',
'properties' => [
'Enable' => [
'description' => '是否打开倍速开关。',
'type' => 'string',
'example' => 'true',
],
'Code' => [
'description' => '错误码(未实际启用倍速时的说明)。',
'type' => 'string',
'example' => 'Boost.NotNeedSpeed',
],
'Message' => [
'description' => '错误信息(未实际启用倍速时的说明)。',
'type' => 'string',
'example' => 'success',
],
'SettingSpeed' => [
'description' => '设定速率。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'DowngradePolicy' => [
'description' => '不支持倍速时的降级策略。',
'type' => 'string',
'example' => 'NormalSpeed',
],
'RealSpeed' => [
'description' => '实际倍速值。',
'type' => 'number',
'format' => 'double',
'example' => '6.576886940181647',
],
'Duration' => [
'description' => '输出视频时长。',
'type' => 'number',
'format' => 'double',
'example' => '21.0',
],
'TimeCost' => [
'description' => '任务耗时。',
'type' => 'number',
'format' => 'double',
'example' => '3.193',
],
],
],
],
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => '88c6ca184c0e47b665e2a1267971****',
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'video_01.mp4',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-shanghai',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'exampleBucket',
],
],
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的消息结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。',
'type' => 'string',
'example' => '123',
],
'ErrorMessage' => [
'description' => '失败时错误信息。执行成功则不返回此参数。',
'type' => 'string',
'example' => 'The resource operated “%s” cannot be found.',
],
'ErrorCode' => [
'description' => '失败时错误码。执行成功则不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
],
],
'SubmitTime' => [
'title' => '任务出队提交执行的时间',
'description' => '任务出队提交执行的时间。',
'type' => 'string',
'example' => '2021-03-04T06:44:43Z',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistJobIds\\": {\\n \\"String\\": [\\n \\"d1ce4d3efcb549419193f50f1fcd****\\"\\n ]\\n },\\n \\"RequestId\\": \\"197ADF44-104C-514C-9F92-D8924CB34E2A\\",\\n \\"JobList\\": {\\n \\"Job\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 100,\\n \\"FinishTime\\": \\"2014-01-10T12:20:25Z\\",\\n \\"State\\": \\"TranscodeSuccess\\",\\n \\"JobId\\": \\"31fa3c9ca8134fb4b0b0f7878301****\\",\\n \\"Code\\": \\"InvalidParameter.NullValue\\",\\n \\"Message\\": \\"The specified parameter \\\\\\"%s\\\\\\" cannot be null.\\",\\n \\"Output\\": {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1000\\",\\n \\"Min\\": \\"300\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Maxrate\\": \\"3000\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"26\\",\\n \\"Gop\\": \\"250\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\"\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"Encryption\\": {\\n \\"Type\\": \\"hls-aes-128\\",\\n \\"Key\\": \\"encryptionkey128\\",\\n \\"KeyType\\": \\"Base64\\",\\n \\"Id\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"KeyUri\\": \\"https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/\\",\\n \\"SkipCnt\\": \\"3\\"\\n },\\n \\"WaterMarkList\\": {\\n \\"WaterMark\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"50\\",\\n \\"Height\\": \\"50\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-logo-****.png\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"WaterMarkTemplateId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Dy\\": \\"100\\"\\n }\\n ]\\n },\\n \\"WaterMarkConfigUrl\\": \\"http://example.com/configure\\",\\n \\"DeWatermark\\": \\"{\\\\\\"0\\\\\\":[{\\\\\\"l\\\\\\":10,\\\\\\"t\\\\\\":10,\\\\\\"w\\\\\\":10,\\\\\\"h\\\\\\":10},{\\\\\\"l\\\\\\":100,\\\\\\"t\\\\\\":0.1,\\\\\\"w\\\\\\":10,\\\\\\"h\\\\\\":10}],\\\\\\"128000\\\\\\":[],\\\\\\"250000\\\\\\":[{\\\\\\"l\\\\\\":0.2,\\\\\\"t\\\\\\":0.1,\\\\\\"w\\\\\\":0.01,\\\\\\"h\\\\\\":0.05}]}\\",\\n \\"M3U8NonStandardSupport\\": {\\n \\"TS\\": {\\n \\"SizeSupport\\": true,\\n \\"Md5Support\\": true\\n }\\n },\\n \\"Priority\\": \\"6\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aaclow\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Channels\\": \\"2\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"Level\\": \\"-20\\"\\n },\\n \\"Bitrate\\": \\"128\\"\\n },\\n \\"AudioStreamMap\\": \\"0:a:0\\",\\n \\"MergeList\\": {\\n \\"Merge\\": [\\n {\\n \\"Start\\": \\"01:59:59.999\\",\\n \\"RoleArn\\": \\"acs:ram:::role/\\",\\n \\"MergeURL\\": \\"http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv\\",\\n \\"Duration\\": \\"01:59:59.999\\"\\n }\\n ]\\n },\\n \\"SuperReso\\": {\\n \\"IsHalfSample\\": \\"true\\"\\n },\\n \\"UserData\\": \\"testid-001\\",\\n \\"ExtendData\\": \\"testid-002\\",\\n \\"OutSubtitleList\\": {\\n \\"OutSubtitle\\": [\\n {\\n \\"Map\\": \\"0:v:0\\",\\n \\"OutSubtitleFile\\": {\\n \\"RoleArn\\": \\"acs:ram:::role/\\",\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"exampleBucket\\"\\n },\\n \\"Success\\": true,\\n \\"Message\\": \\"The specified parameter “%s” cannot be null.\\"\\n }\\n ]\\n },\\n \\"VideoStreamMap\\": \\"0\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram:::role/\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"Rotate\\": \\"90\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"Clip\\": {\\n \\"TimeSpan\\": {\\n \\"Seek\\": \\"01:59:59.999\\",\\n \\"Duration\\": \\"01:00:59.999\\"\\n }\\n },\\n \\"MergeConfigUrl\\": \\"https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8\\",\\n \\"OpeningList\\": {\\n \\"Opening\\": [\\n {\\n \\"openUrl\\": \\"http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4\\",\\n \\"Start\\": \\"0\\",\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\"\\n }\\n ]\\n },\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"bayer\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"20\\"\\n }\\n },\\n \\"TailSlateList\\": {\\n \\"TailSlate\\": [\\n {\\n \\"Start\\": \\"00000.00\\",\\n \\"BgColor\\": \\"White\\",\\n \\"IsMergeAudio\\": true,\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\",\\n \\"BlendDuration\\": \\"0\\",\\n \\"TailUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\"\\n }\\n ]\\n },\\n \\"TemplateId\\": \\"S00000001-200010\\",\\n \\"SubtitleConfig\\": {\\n \\"ExtSubtitleList\\": {\\n \\"ExtSubtitle\\": [\\n {\\n \\"CharEnc\\": \\"auto\\",\\n \\"FontName\\": \\"\\\\\\"WenQuanYi Zen Hei\\\\\\", \\\\\\"Yuanti SC Regular\\\\\\", \\\\\\"SimSun\\\\\\"\\",\\n \\"Input\\": {\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n }\\n ]\\n },\\n \\"SubtitleList\\": {\\n \\"Subtitle\\": [\\n {\\n \\"Map\\": \\"0:a:0\\"\\n }\\n ]\\n }\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"720\\",\\n \\"Height\\": \\"1280\\",\\n \\"SourceLogos\\": {\\n \\"SourceLogo\\": [\\n {\\n \\"Source\\": \\"example\\"\\n }\\n ]\\n },\\n \\"Duration\\": \\"17\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"490\\",\\n \\"FileFormat\\": \\"mp4\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Timebase\\": \\"1/15360\\",\\n \\"AvgFPS\\": \\"30.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Sar\\": \\"1:1\\",\\n \\"Lang\\": \\"eng\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Height\\": \\"1280\\",\\n \\"NumFrames\\": \\"30\\",\\n \\"Bitrate\\": \\"421.117\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"high\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Dar\\": \\"9:16\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": \\"720\\",\\n \\"Duration\\": \\"17.233333\\",\\n \\"Fps\\": \\"30.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/60\\",\\n \\"Level\\": \\"31\\",\\n \\"colorTransfer\\": \\"bt709\\",\\n \\"colorPrimaries\\": \\"bt709\\",\\n \\"bitsPerRawSample\\": \\"8\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/32000\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"1\\",\\n \\"NumFrames\\": \\"50\\",\\n \\"Bitrate\\": \\"64.136\\",\\n \\"CodecTagString\\": \\"mp4\\",\\n \\"StartTime\\": \\"0.064000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"17.223562\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/32000\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"eng\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"-0.064000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"1057273\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"Duration\\": \\"17.234000\\",\\n \\"Bitrate\\": \\"490.784\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"1057273\\"\\n },\\n \\"MultiSpeedInfo\\": {\\n \\"Enable\\": \\"true\\",\\n \\"Code\\": \\"Boost.NotNeedSpeed\\",\\n \\"Message\\": \\"success\\",\\n \\"SettingSpeed\\": 30,\\n \\"DowngradePolicy\\": \\"NormalSpeed\\",\\n \\"RealSpeed\\": 6.576886940181647,\\n \\"Duration\\": 21,\\n \\"TimeCost\\": 3.193\\n }\\n },\\n \\"PipelineId\\": \\"88c6ca184c0e47b665e2a1267971****\\",\\n \\"Input\\": {\\n \\"Object\\": \\"video_01.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"exampleBucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"123\\",\\n \\"ErrorMessage\\": \\"The resource operated “%s” cannot be found.\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n },\\n \\"SubmitTime\\": \\"2021-03-04T06:44:43Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n d1ce4d3efcb549419193f50f1fcd****\\n 197ADF44-104C-514C-9F92-D8924CB34E2A\\n \\n 2014-01-10T12:00:00Z\\n 100\\n 2014-01-10T12:20:25Z\\n TranscodeSuccess\\n 31fa3c9ca8134fb4b0b0f7878301****\\n InvalidParameter.NullValue\\n The specified parameter \\"%s\\" cannot be null.\\n \\n 88c6ca184c0e47b665e2a1267971****\\n \\n \\n oss-cn-shanghai\\n exampleBucket\\n \\n \\n 123\\n The resource operated “%s” cannot be found.\\n InvalidParameter.ResourceNotFound\\n \\n \\n","errorExample":""}]',
'title' => '查询转码作业',
'description' => '- 本接口一次最多查询10个转码作业。'."\n"
.'- 如果不传入JobIds,则会返回`InvalidParameter`(参数无效)错误码。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' **回调消息格式定义**'."\n"
."\n"
.'当转码任务执行状态改变时,mps会发送消息到用户指定的queue中(如何指定回调queue详见mps的[更新管道接口](~~188374~~))。消息体是一个JSON字符串,包含字段如下:'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Type": "Transcode",'."\n"
.' "State": "Success",'."\n"
.' "JobId": "39f8e0bc005e4f309379701645f4****",'."\n"
.' "UserData": "{\\"key\\":\\"value\\"}",'."\n"
.' "RequestId": "25818875-5F78-4A13-BEF6-D7393642****"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'| 名称 | 类型 |描述|'."\n"
.'|---------------|--------|-----------|'."\n"
.'|Type |String |固定字符串“Transcode”,表示转码任务。 |'."\n"
.'|JobId | String|任务唯一ID。 |'."\n"
.'|State | String|任务当前状态,与QueryJobList中的State一致。|'."\n"
.'|UserData |String |用户在SubmitJobs中传入的UserData。|',
'extraInfo' => ' ',
],
'ListJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '下一页标识。第一次请求无需传入,服务会返回,第二次请求传入即可。',
'type' => 'string',
'required' => false,
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
],
[
'name' => 'MaximumPageSize',
'in' => 'query',
'schema' => [
'description' => '单页最大可返回媒体工作流执行实例。'."\n"
."\n"
.'- 默认值:**10**。'."\n"
.'- 取值范围:**1~100**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '转码任务状态。默认为**All**(所有状态)。可取值:'."\n"
."\n"
.'- **All**:所有状态。'."\n"
.'- **Submitted**:作业已提交。'."\n"
.'- **Transcoding**:转码中。'."\n"
.'- **TranscodeSuccess**:转码成功。'."\n"
.'- **TranscodeFail**:转码失败。'."\n"
.'- **TranscodeCancelled**:转码取消。',
'type' => 'string',
'required' => false,
'example' => 'All',
'default' => 'All',
],
],
[
'name' => 'StartOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '创建转码作业时间范围中的下限值。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。',
'type' => 'string',
'required' => false,
'example' => '2014-01-10T12:00:00Z',
],
],
[
'name' => 'EndOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '创建转码作业时间的上限。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。',
'type' => 'string',
'required' => false,
'example' => '2014-01-11T12:00:00Z',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID。可以通过[MPS控制台](https://mps.console.aliyun.com/overview) > **全局设置** > **管道及回调**查询。',
'type' => 'string',
'required' => false,
'example' => '88c6ca184c0e424d5w5b665e2a12****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'BC860F04-778A-472F-AB39-E1BF329C1EA8',
],
'NextPageToken' => [
'description' => '下一页标识。需记录下来,在下一次请求时传入即可。',
'type' => 'string',
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
'JobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Job' => [
'description' => '转码作业集合。',
'type' => 'array',
'items' => [
'description' => '转码作业详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '作业添加时间。',
'type' => 'string',
'example' => '2014-01-10T12:00:00Z',
],
'Percent' => [
'description' => '转码进度。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'FinishTime' => [
'description' => '作业完成时间。',
'type' => 'string',
'example' => '2014-01-10T12:20:25Z',
],
'State' => [
'description' => '作业状态:'."\n"
."\n"
.'- **Submitted**:作业已提交。'."\n"
.'- **Transcoding**:转码中。'."\n"
.'- **TranscodeSuccess**:转码成功。'."\n"
.'- **TranscodeFail**:转码失败。'."\n"
.'- **TranscodeCancelled**:转码取消。',
'type' => 'string',
'example' => 'TranscodeSuccess',
],
'JobId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '31fa3c9ca8134fb4b0b0f7878301****',
],
'Code' => [
'description' => '任务失败时的错误码。任务成功时不返回。',
'type' => 'string',
'example' => 'InternalError',
],
'Message' => [
'description' => '任务失败时的消息。任务成功时不返回。',
'type' => 'string',
'example' => 'The operation has failed due to some unknown error, exception or failure.',
],
'Output' => [
'description' => ' 作业输出。',
'type' => 'object',
'properties' => [
'Video' => [
'description' => ' 视频配置。',
'type' => 'object',
'properties' => [
'Bufsize' => [
'description' => '缓冲区大小。',
'type' => 'string',
'example' => '6000',
],
'Degrain' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '5',
],
'BitrateBnd' => [
'description' => '视频码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '最大码率。单位:Kbps。',
'type' => 'string',
'example' => '1000',
],
'Min' => [
'description' => '最小码率。单位:Kbps。',
'type' => 'string',
'example' => '200',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。范围:yuv420p,yuvj420p等标准颜色格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Pad' => [
'description' => '视频贴黑边。单位:px。'."\n"
."\n"
.'- 参数格式:width:height:left:top。'."\n"
.'- 示例:1280:800:0:140。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Codec' => [
'description' => '编解码格式。可取值**H.264**、**H.265**、**GIF**、**WEBP**。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:视频原始高度。',
'type' => 'string',
'example' => '720',
],
'Qscale' => [
'description' => '视频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Crop' => [
'description' => '视频画面裁剪。支持2种方式。'."\n"
.'- 自动检测黑边并裁切,设置为**border**。'."\n"
.'- 自定义裁切,参数格式:width:height:left:top。示例:1280:800:0:140。',
'type' => 'string',
'example' => 'border',
],
'Bitrate' => [
'description' => '视频平均码率。单位:Kbps。',
'type' => 'string',
'example' => '428',
],
'Maxrate' => [
'description' => '视频码率峰值。单位:Kbps。',
'type' => 'string',
'example' => '1000',
],
'MaxFps' => [
'description' => '最大帧率。',
'type' => 'string',
'example' => '60',
],
'Profile' => [
'description' => '编码级别。'."\n"
."\n"
.'- **baseline**:针对移动设备。'."\n"
.'- **main**:针对标准分辨率设备。'."\n"
.'- **high**:针对高分辨率设备。'."\n"
.'- 默认值:**high**。',
'type' => 'string',
'example' => 'high',
],
'Crf' => [
'description' => '码率-质量控制因子。如果设置了Crf,则Bitrate的设置失效。默认值:**26**。',
'type' => 'string',
'example' => '26',
],
'Gop' => [
'description' => '关键帧间最大帧数。默认值:250。',
'type' => 'string',
'example' => '250',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:视频原始宽度。',
'type' => 'string',
'example' => '1280',
],
'Fps' => [
'description' => '帧率。'."\n"
."\n"
.'- 当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取输入文件帧率。',
'type' => 'string',
'example' => '25',
],
'Preset' => [
'description' => '视频算法器预置。默认值:medium。可取值:'."\n"
."\n"
.'- **veryfast**:超快。'."\n"
."\n"
.'- **fast**:快。'."\n"
."\n"
.'- **medium**:中等。'."\n"
."\n"
.'- **slow**:慢。'."\n"
."\n"
.'- **slower**:超慢。',
'type' => 'string',
'example' => 'medium',
],
'ScanMode' => [
'description' => '扫描模式。取值如下:'."\n"
.'- **不设置**:按输入文件的原始模式。'."\n"
.'- **auto**:自动去隔行。'."\n"
.'- **progressive**:顺序扫描(逐行扫描)。'."\n"
.'- **interlaced**:交叉扫描(隔行扫描)。'."\n"
.'- **默认值**:空,即不设置。'."\n"
."\n"
.'**最佳实践**:交叉扫描虽然比顺序扫描更节省数据量,但画质不佳,所以现在主流视频制作都采用顺序扫描。'."\n"
.'- 如果您设置了**顺序扫描**或**交叉扫描**,但与原视频模式不符,会导致转码失败。'."\n"
.'- 建议您设置**原视频模式**或**自动去隔行**,以提高兼容性。',
'type' => 'string',
'example' => 'interlaced',
],
'ResoPriority' => [
'description' => '资源优先级。',
'type' => 'string',
'example' => '1',
],
],
],
'TransConfig' => [
'description' => '转码通用配置。如果请求参数中设置了该值,则覆盖指定转码模板中的对应参数。 ',
'type' => 'object',
'properties' => [
'IsCheckAudioBitrate' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于IsCheckAudioBitrateFail。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:'."\n"
.' - 参数为空,并且codec和输入源不一样:false。'."\n"
.' - 参数为空,并且codec和输入源一样:true。',
'type' => 'string',
'example' => 'false',
],
'TransMode' => [
'description' => '转码模式。'."\n"
."\n"
.'- 可选范围onepass、twopass、CBR。'."\n"
.'- 默认值:onepass。',
'type' => 'string',
'example' => 'onepass',
],
'IsCheckReso' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckVideoBitrateFail' => [
'description' => '是否检查码率。当输出视频码率大于媒体源视频码率时,则不进行转码,直接返回转码失败。此值优先级大于IsCheckVideoBitrate。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:false。',
'type' => 'string',
'example' => 'false',
],
'AdjDarMethod' => [
'description' => '分辨率改写方式。默认值:**none**。可选范围:rescale、crop、pad、none。',
'type' => 'string',
'example' => 'none',
],
'IsCheckVideoBitrate' => [
'description' => '是否检查视频码率。如果视频输出码率大于视频输入码率,则视为视频输出码率等于视频输入码率。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckResoFail' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。'."\n"
."\n"
.'- **true**表示检查。'."\n"
."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckAudioBitrateFail' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则不进行转码,直接返回转码失败,此值优先级大于IsCheckAudioBitrate。'."\n"
."\n"
.'- **false**:检查。'."\n"
."\n"
.'- **true**:不检查。',
'type' => 'string',
'example' => 'false',
],
],
],
'Encryption' => [
'description' => '数据加密,只支持m3u8格式的输出。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '加密类型。取值:hls-aes-128。',
'type' => 'string',
'example' => 'hls-aes-128',
],
'Key' => [
'description' => '加密视频的密钥。',
'type' => 'string',
'example' => 'encryptionkey128',
],
'KeyType' => [
'description' => '密钥加密方式,可取值Base64、KMS。'."\n"
."\n"
.'> 如密钥为`"encryptionkey128”`, 则`Base64(“encryptionkey128”)`或 `KMS(Base64(“encryptionkey128”)`。',
'type' => 'string',
'example' => 'Base64',
],
'Id' => [
'description' => '加密ID。',
'type' => 'string',
'example' => '31fa3c9ca8134f9cec2b4b0b0f78****',
],
'KeyUri' => [
'description' => '密钥的访问URL,使用BASE64进行编码。',
'type' => 'string',
'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/',
],
'SkipCnt' => [
'description' => '前面不加密的片数(视频能快速播放起来)。',
'type' => 'string',
'example' => '3',
],
],
],
'WaterMarkList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WaterMark' => [
'description' => '水印列表。',
'type' => 'array',
'items' => [
'description' => '水印详细信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '水印类型。如果请求参数中设置了此参数,则此值覆盖水印模板对应参数。更多信息,请参见[参数详情](~~29253~~)。可取值:'."\n"
."\n"
.'- **Image**:图片水印。'."\n"
."\n"
.'- **Text**:文字水印。',
'type' => 'string',
'example' => 'Image',
],
'ReferPos' => [
'description' => '水印的位置。'."\n"
."\n"
.'- **TopRight**:右上。'."\n"
."\n"
.'- **TopLeft**:左上。'."\n"
."\n"
.'- **BottomRight**:右下。'."\n"
."\n"
.'- **BottomLeft**:左下。',
'type' => 'string',
'example' => 'TopRight',
],
'Dx' => [
'description' => '水印图片相对输出视频的水平偏移量。如果请求参数中设置了此值,则覆盖水印模板对应参数。默认值为0。值有两种形式:'."\n"
."\n"
.'- 整数型:代表偏移像素值。'."\n"
."\n"
.' - 范围:\\[8,4096\\]。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表水平偏移量与输出分辨率宽的比率。'."\n"
."\n"
.' - 范围:(0,1)。'."\n"
."\n"
.' - 支持四位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '100',
],
'Width' => [
'description' => '水印图片宽。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片宽。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片宽的像素值。'."\n"
."\n"
.' - 范围:\\[8,4096\\]。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表相对输出视频分辨率宽的比率。'."\n"
."\n"
.' - 范围:(0,1)。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '50',
],
'Height' => [
'description' => '水印图片高。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片高。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片高的像素值。'."\n"
."\n"
.' - 范围:\\[8,4096\\]。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表相对输出视频分辨率高的比率。'."\n"
."\n"
.' - 范围:(0,1)。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '50',
],
'InputFile' => [
'description' => '水印输入文件。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-logo-****.png',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'WaterMarkTemplateId' => [
'description' => '水印模板ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'Dy' => [
'description' => '水印图片相对输出视频的垂直偏移量。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片相对输出视频的垂直偏移量。值有两种形式:'."\n"
."\n"
.'- 整数型:代表水印图片相对输出视频的垂直偏移量像素。'."\n"
."\n"
.' - 范围:\\[8,4096\\]。'."\n"
."\n"
.' - 单位:px。'."\n"
."\n"
.'- 小数型:代表水印图片相对输出视频的垂直偏移量比率。'."\n"
."\n"
.' - 范围:(0,1)。'."\n"
."\n"
.' - 支持4位小数,例如:0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '100',
],
],
],
],
],
],
'WaterMarkConfigUrl' => [
'description' => '水印配置文件URL。',
'type' => 'string',
'example' => 'http://example.com/configure',
],
'DeWatermark' => [
'description' => '模糊处理,JSON对象。更多信息请参见[参数详情](~~29253~~)中的模糊处理详情。',
'type' => 'string',
'example' => '{"0": [{"l": 10,"t": 10,"w": 10,"h": 10},{"l": 100,"t": 0.1,"w": 10,"h": 10}],"128000": [],"250000": [{"l": 0.2,"t": 0.1,"w": 0.01,"h": 0.05}]}',
],
'M3U8NonStandardSupport' => [
'description' => 'M3U8非标准支持,JSON对象。更多信息请参见[参数详情](~~29253~~)中的M3U8非标准参数支持详情。',
'type' => 'object',
'properties' => [
'TS' => [
'description' => 'JSON对象,TS文件相关非标准支持。更多信息请参见[参数详情](~~29253~~)中的TS参数支持详情。',
'type' => 'object',
'properties' => [
'SizeSupport' => [
'description' => '是否支持在M3U8文件中输出ts文件的大小。'."\n"
."\n"
.'- **true**:支持。'."\n"
."\n"
.'- **false**:不支持。 ',
'type' => 'boolean',
'example' => 'true',
],
'Md5Support' => [
'description' => '是否支持在M3U8文件中输出TS的md5值。可取值:'."\n"
."\n"
.'- **true**:支持。'."\n"
."\n"
.'- **false**:不支持。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'Priority' => [
'description' => '任务在其对应管道内的优先级。'."\n"
."\n"
.'- 最高优先级:10。'."\n"
."\n"
.'- 默认值:**6**。',
'type' => 'string',
'example' => '6',
],
'Audio' => [
'description' => '音频配置。',
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当Codec为aac时可取值:aaclow、aache、aachev2、aacld、aaceld。',
'type' => 'string',
'example' => 'aaclow',
],
'Codec' => [
'description' => '音频编解码格式。'."\n"
."\n"
.'- 支持aac、mp3、vorbis、flac。'."\n"
."\n"
.'- 默认值:**aac**。',
'type' => 'string',
'example' => 'aac',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 支持22050、32000、44100、48000、96000。'."\n"
."\n"
.'- 单位:Hz。'."\n"
."\n"
.'- 默认值:44100。'."\n"
."\n"
.'- 若视频容器格式为flv,音频编解码格式选择为mp3时,采样率不支持32000、48000、96000;音频编解码格式为mp3时,采样率不支持96000。',
'type' => 'string',
'example' => '44100',
],
'Qscale' => [
'description' => '音频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Channels' => [
'description' => '声道数。'."\n"
."\n"
.'- 当Codec设置为mp3时,声道数只支持1、2。'."\n"
."\n"
.'- 当Codec设置为aac时,声道数只支持1、2、4、5、6、8。'."\n"
."\n"
.'- 默认值:2。',
'type' => 'string',
'example' => '2',
],
'Volume' => [
'description' => '音量配置。',
'type' => 'object',
'properties' => [
'Method' => [
'description' => '音量调整方式。可取值:'."\n"
."\n"
.'- **auto**:自动调整。'."\n"
."\n"
.'- **dynamic**:动态调整。'."\n"
."\n"
.'- **linear**:线性调整。',
'type' => 'string',
'example' => 'auto',
],
'Level' => [
'description' => '音量调整幅度。'."\n"
."\n"
.'- 单位:db。'."\n"
."\n"
.'- 默认:-**20db**。',
'type' => 'string',
'example' => '-20',
],
],
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 单位:Kbps。'."\n"
."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '128',
],
],
],
'AudioStreamMap' => [
'description' => '音频流序号。'."\n"
."\n"
.'- 格式:`0:a:{序号}`。'."\n"
."\n"
.'- 序号从0开始,序号的含义是音频流列表的下标,若不设置,选择默认的音频流。',
'type' => 'string',
'example' => '0:a:0',
],
'MergeList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Merge' => [
'description' => '视频拼接配置。',
'type' => 'array',
'items' => [
'description' => '视频拼接配置详细信息。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '起始时间点。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或者`sssss[.SSS]`。'."\n"
."\n"
.'- 示例:01:59:59.999或者32000.23。',
'type' => 'string',
'example' => '01:59:59.999或者32000.23',
],
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
'MergeURL' => [
'description' => '拼接片段地址。'."\n"
."\n"
.'- 示例:`http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object.flv`。'."\n"
."\n"
.'- Object需要经过URLEncode,采用UTF-8编码。',
'type' => 'string',
'example' => 'http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv',
],
'Duration' => [
'description' => '起始时间点。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或者`sssss[.SSS]`。'."\n"
."\n"
.'- 示例:01:59:59.999或者32000.23。',
'type' => 'string',
'example' => '01:59:59.999',
],
],
],
],
],
],
'SuperReso' => [
'description' => '分辨率随源。',
'type' => 'object',
'properties' => [
'IsHalfSample' => [
'description' => '是否获取采样率相关参数。可取值:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。',
'type' => 'string',
'example' => 'true',
],
],
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'test-001',
],
'OutSubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OutSubtitle' => [
'description' => '输出字幕列表。',
'type' => 'array',
'items' => [
'description' => '输出字幕详细信息。',
'type' => 'object',
'properties' => [
'Map' => [
'description' => '视频轨。格式:0:{流}:{流序号} ,即0:v:{video_index}。流取值为v: video音频流,序号的含义是音频流列表的下标,序号从0开始。',
'type' => 'string',
'example' => '0:v:0',
],
'OutSubtitleFile' => [
'description' => '输出文件详细信息。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
'Object' => [
'description' => '输出文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
'Location' => [
'description' => '输出文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
],
],
'Success' => [
'description' => '是否成功。可取值:'."\n"
."\n"
.'- **true**:成功。'."\n"
."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '创建作业失败时错误消息。创建成功时此参数不返回。',
'type' => 'string',
'example' => 'The specified parameter “%s” cannot be null.',
],
],
],
],
],
],
'VideoStreamMap' => [
'description' => '视频流序号。'."\n"
."\n"
.'- 格式:0:a:{序号},示例:0:a:0。'."\n"
."\n"
.'- 序号从0开始,序号的含义是视频流列表的下标。'."\n"
."\n"
.'- 若不设置,选择默认的视频流。',
'type' => 'string',
'example' => '0:a:0',
],
'OutputFile' => [
'description' => '输出文件。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'example' => 'acs:ram:::role/',
],
'Object' => [
'description' => '输出文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
'Location' => [
'description' => '输出文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'Rotate' => [
'description' => '视频旋转角度。',
'type' => 'string',
'example' => '90',
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。'."\n"
."\n"
.'- 默认值:mp4。'."\n"
."\n"
.'- 视频转码可取值flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。'."\n"
."\n"
.'- 音频转码可取值mp3、mp4、ogg、flac、m4a。'."\n"
."\n"
.'- 图片可取值gif、WEBP。'."\n"
."\n"
.'- 容器格式为gif时,VideoCodec设置只能设置为GIF。'."\n"
."\n"
.'- 容器格式为webp时,VideoCodec设置只能设置为WEBP。'."\n"
."\n"
.'- 容器格式为flv时,VideoCodec不能设置为H265。',
'type' => 'string',
'example' => 'flv',
],
],
],
'Clip' => [
'description' => '剪辑片段。',
'type' => 'object',
'properties' => [
'TimeSpan' => [
'description' => '剪辑时间段。',
'type' => 'object',
'properties' => [
'Seek' => [
'description' => '开始时间点。 '."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或`sssss[.SSS]`。'."\n"
.'- 取值范围 :`[00:00:00.000,23:59:59.999]`或`[0.000,86399.999]`。'."\n"
."\n"
.'- 示例:01:59:59.999或32000.23。',
'type' => 'string',
'example' => '01:00:59.999',
],
'Duration' => [
'description' => '持续时长。'."\n"
."\n"
.'- 格式:`hh:mm:ss[.SSS]`或`sssss[.SSS]`。'."\n"
.'- 取值范围 :`[00:00:00.000,23:59:59.999]`或`[0.000,86399.999]`。'."\n"
."\n"
.'- 示例:01:00:59.999或32000.23。',
'type' => 'string',
'example' => '01:00:59.999',
],
],
],
],
],
'MergeConfigUrl' => [
'description' => '拼接配置文件URL地址。MergeList与MergeConfigUrl两个参数只支持二选一。'."\n"
."\n"
.'- MergeConfigUrl指定的配置文件允许50个拼接片段上限。'."\n"
."\n"
.'- MergeConfigUrl是拼接配置文件URL地址。'."\n"
."\n"
.'- 只支持存放在OSS上的配置文件,且需要保证有授权给MPS可访问权限,文件内部内容参见拼接参数详情。'."\n"
."\n"
.'- mergeConfigfile文件内部内容示例:`{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`。',
'type' => 'string',
'example' => '{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}',
],
'OpeningList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Opening' => [
'description' => '开板列表。',
'type' => 'array',
'items' => [
'description' => '开板列表详细信息。',
'type' => 'object',
'properties' => [
'openUrl' => [
'description' => '开板视频的OSS URL地址。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv',
],
'Start' => [
'description' => '相对正片视频的开始时间。从0开始延迟多长时间后,显示开板视频。'."\n"
."\n"
.'- 单位:秒。'."\n"
."\n"
.'- 默认值:**0**。',
'type' => 'string',
'example' => '0',
],
'Width' => [
'description' => '宽。可取值:(0,4096)、-1、full。'."\n"
."\n"
.'- 默认值:**-1**。'."\n"
."\n"
.'- -1代表片源的值。'."\n"
."\n"
.'- full表示填满画面。',
'type' => 'string',
'example' => '-1',
],
'Height' => [
'description' => '高。可取值:(0,4096)、-1、full。'."\n"
."\n"
.'- 默认值:**-1**。'."\n"
."\n"
.'- -1代表片源的值。'."\n"
."\n"
.'- full表示填满画面。',
'type' => 'string',
'example' => '-1',
],
],
],
],
],
],
'MuxConfig' => [
'description' => '转码封包配置。',
'type' => 'object',
'properties' => [
'Webp' => [
'description' => 'Webp对应的封包配置。',
'type' => 'object',
'properties' => [
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
],
],
'Gif' => [
'description' => 'Gif对应的封包配置。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => '终帧暂停时间,单位:厘秒。',
'type' => 'string',
'example' => '0',
],
'DitherMode' => [
'description' => '调色板颜色抖动方式。可取值:**sierra**、**bayer**。',
'type' => 'string',
'example' => 'bayer',
],
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
'IsCustomPalette' => [
'description' => '自定义调色板功能。可取值:'."\n"
."\n"
.'- **true**:自定义。'."\n"
."\n"
.'- **false**:非自定义。',
'type' => 'string',
'example' => 'true',
],
],
],
'Segment' => [
'description' => '切片配置,JSON对象。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。整数,单位:秒。'."\n"
."\n"
.'- 可取值范围:\\[1,10\\]。'."\n"
."\n"
.'- 默认值:10秒。',
'type' => 'string',
'example' => '10',
],
],
],
],
],
'TailSlateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TailSlate' => [
'description' => '尾板列表。',
'type' => 'array',
'items' => [
'description' => '尾板列表详细信息。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '1',
],
'BgColor' => [
'description' => '如果尾板视频的宽、高小于正片时,设置空白处填充的背景色。默认为**White**,更多信息请参见[bgcolor](https://docs-aliyun.cn-hangzhou.oss.aliyun-inc.com/assets/attach/29253/cn_zh/1502784952344/color.txt?spm=a2c4g.11186623.2.63.1df840f74IH4Eq&file=color.txt)。',
'type' => 'string',
'example' => 'White',
],
'IsMergeAudio' => [
'description' => '是否要拼接尾板视频的音频内容。可取值:'."\n"
."\n"
.'- **true**:拼接。'."\n"
."\n"
.'- **false**:不拼接。',
'type' => 'boolean',
'example' => 'true',
],
'Width' => [
'description' => '宽。可取值:(0,4096)、-1、full。'."\n"
."\n"
.'- -1代表片源的值,full表示填满画面。'."\n"
."\n"
.'- 默认为**-1**。',
'type' => 'string',
'example' => '-1',
],
'Height' => [
'description' => '高,范围(0,4096)、-1、full'."\n"
."\n"
.'- -1代表片源的值。'."\n"
.'- full表示填满画面。'."\n"
.'- 默认为**-1**。',
'type' => 'string',
'example' => '-1',
],
'BlendDuration' => [
'description' => '正片视频和尾板视频过渡的时长。过渡的效果是淡入淡出:正片显示最后一帧,同时播放尾板视频,正片最后一帧逐步变暗,尾板视频逐步变亮。单位秒,默认0。',
'type' => 'string',
'example' => '0',
],
'TailUrl' => [
'description' => '尾板视频的OSS URL地址。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv',
],
],
],
],
],
],
'TemplateId' => [
'description' => '模板ID。',
'type' => 'string',
'example' => 'S00000000-000010',
],
'SubtitleConfig' => [
'description' => '字幕配置。',
'type' => 'object',
'properties' => [
'ExtSubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ExtSubtitle' => [
'description' => '外部字幕列表,JSON数组。',
'type' => 'array',
'items' => [
'description' => '字幕详细信息。',
'type' => 'object',
'properties' => [
'CharEnc' => [
'description' => '外部字幕字符编码。'."\n"
."\n"
.'- 范围:UTF-8、GBK、BIG5、auto。'."\n"
."\n"
.'- 默认:**auto**。'."\n"
."\n"
.'> 外部字幕字符编码设置为auto时,存在误检情况,建议您指定具体的字符编码。',
'type' => 'string',
'example' => 'auto',
],
'FontName' => [
'description' => '外挂字幕转换成硬字幕对应的字体名称。',
'type' => 'string',
'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"',
],
'Input' => [
'description' => '外部输入字幕文件。'."\n"
."\n"
.'- 目前支持srt、ass格式。更多信息请参见[参数详情](~~29253~~)中的Input参数。'."\n"
.'- 示例:`{“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”}`.',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-output.flv',
],
'Location' => [
'description' => '输入文件所在的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件所在的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
],
],
],
],
],
],
],
'SubtitleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Subtitle' => [
'description' => '字幕列表。',
'type' => 'array',
'items' => [
'description' => '字幕详细信息。',
'type' => 'object',
'properties' => [
'Map' => [
'description' => '视频流序号。序号从0开始,序号的含义是视频流列表的下标,若未设置,选择默认的视频流。',
'type' => 'string',
'example' => '0',
],
],
],
],
],
],
],
],
'Properties' => [
'description' => '媒体属性。',
'type' => 'object',
'properties' => [
'Width' => [
'description' => '视频宽。',
'type' => 'string',
'example' => '720',
],
'Height' => [
'description' => '视频长。',
'type' => 'string',
'example' => '1280',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '30',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '490',
],
'FileFormat' => [
'description' => '文件格式。',
'type' => 'string',
'example' => 'mp4',
],
'Streams' => [
'description' => '流信息。',
'type' => 'object',
'properties' => [
'VideoStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoStream' => [
'description' => '视频流列表。',
'type' => 'array',
'items' => [
'description' => '视频流详细信息。',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '视频流序号,标识视频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '0',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/15360',
],
'AvgFPS' => [
'description' => '平均帧率。',
'type' => 'string',
'example' => '30.0',
],
'PixFmt' => [
'description' => '像素格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Sar' => [
'description' => '编码信号分辨率比。',
'type' => 'string',
'example' => '1:1',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'und',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10',
],
'Height' => [
'description' => '视频分辨率长。',
'type' => 'string',
'example' => '1280',
],
'NumFrames' => [
'description' => '总帧率。',
'type' => 'string',
'example' => '30',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '421.117',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'avc1',
],
'HasBFrames' => [
'description' => '是否有B帧。',
'type' => 'string',
'example' => '2',
],
'Profile' => [
'description' => '编码预置。',
'type' => 'string',
'example' => 'high',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0.000000',
],
'NetworkCost' => [
'description' => '网络带宽消耗。',
'type' => 'object',
'properties' => [
'PreloadTime' => [
'description' => '预加载时间。'."\n",
'type' => 'string',
'example' => '8',
],
'AvgBitrate' => [
'description' => '平均码率。'."\n",
'type' => 'string',
'example' => '300',
],
'CostBandwidth' => [
'description' => '最大消耗带宽。'."\n",
'type' => 'string',
'example' => '10',
],
],
],
'Dar' => [
'description' => '视频显示分辨率比。',
'type' => 'string',
'example' => '9:16',
],
'CodecName' => [
'description' => '编码格式简述名。',
'type' => 'string',
'example' => 'h264',
],
'Width' => [
'description' => '视频分辨率宽,数字。',
'type' => 'string',
'example' => '720',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17.233333',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '30.0',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x31637661',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/60',
],
'Level' => [
'description' => '编码等级。',
'type' => 'string',
'example' => '31',
],
],
],
],
],
],
'AudioStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioStream' => [
'description' => '音频流列表。',
'type' => 'array',
'items' => [
'description' => '音频流详细信息。',
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/32000',
],
'Index' => [
'description' => '音频流序号,标识音频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'SampleFmt' => [
'description' => '采样格式。',
'type' => 'string',
'example' => 'fltp',
],
'ChannelLayout' => [
'description' => '声道输出样式。'."\n",
'type' => 'string',
'example' => 'mono',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)、[ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)。',
'type' => 'string',
'example' => 'und',
],
'Samplerate' => [
'description' => '采样率。',
'type' => 'string',
'example' => '32000',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'AAC (Advanced Audio Coding)',
],
'Channels' => [
'description' => '声道数。',
'type' => 'string',
'example' => '1',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '30',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '64.136',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'mp4a',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0.000000',
],
'CodecName' => [
'description' => '编码格式简述名。',
'type' => 'string',
'example' => 'aac',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '17.223562',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x6134706d',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/32000',
],
],
],
],
],
],
'SubtitleStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubtitleStream' => [
'description' => '字幕流列表。',
'type' => 'array',
'items' => [
'description' => '字幕流详细信息。',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '字幕流序号。'."\n"
.'标识字幕流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'Lang' => [
'description' => '语言。',
'type' => 'string',
'example' => 'und',
],
],
],
],
],
],
],
],
'Format' => [
'description' => '格式信息。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.064000',
],
'NumPrograms' => [
'description' => '节目流总数。',
'type' => 'string',
'example' => '0',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '1057273',
],
'NumStreams' => [
'description' => '媒体流总数。',
'type' => 'string',
'example' => '2',
],
'FormatLongName' => [
'description' => '容器、封装格式长述名。',
'type' => 'string',
'example' => 'QuickTime / MOV',
],
'Duration' => [
'description' => '总时长。',
'type' => 'string',
'example' => '17.234000',
],
'Bitrate' => [
'description' => '总码率。',
'type' => 'string',
'example' => '490.784',
],
'FormatName' => [
'description' => '容器、封装格式简述名。可取值:mov、mp4、m4a、3gp、3g2、mj2。',
'type' => 'string',
'example' => 'mov',
],
],
],
'FileSize' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '1057273',
],
],
],
],
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => '88c6ca184c0e47b665e2a1267971****',
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '作业输入的OSS Object。',
'type' => 'string',
'example' => 'example.flv',
],
'Location' => [
'description' => '作业输入的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '作业输入的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的消息结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。',
'type' => 'string',
'example' => '123',
],
'ErrorMessage' => [
'description' => '失败时错误信息。成功时此参数不返回。',
'type' => 'string',
'example' => 'The resource operated “%s” cannot be found.',
],
'ErrorCode' => [
'description' => '失败时错误码。成功时此参数不返回。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC860F04-778A-472F-AB39-E1BF329C1EA8\\",\\n \\"NextPageToken\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"JobList\\": {\\n \\"Job\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 100,\\n \\"FinishTime\\": \\"2014-01-10T12:20:25Z\\",\\n \\"State\\": \\"TranscodeSuccess\\",\\n \\"JobId\\": \\"31fa3c9ca8134fb4b0b0f7878301****\\",\\n \\"Code\\": \\"InternalError\\",\\n \\"Message\\": \\"The operation has failed due to some unknown error, exception or failure.\\",\\n \\"Output\\": {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1000\\",\\n \\"Min\\": \\"200\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"428\\",\\n \\"Maxrate\\": \\"1000\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"26\\",\\n \\"Gop\\": \\"250\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\"\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"Encryption\\": {\\n \\"Type\\": \\"hls-aes-128\\",\\n \\"Key\\": \\"encryptionkey128\\",\\n \\"KeyType\\": \\"Base64\\",\\n \\"Id\\": \\"31fa3c9ca8134f9cec2b4b0b0f78****\\",\\n \\"KeyUri\\": \\"https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/\\",\\n \\"SkipCnt\\": \\"3\\"\\n },\\n \\"WaterMarkList\\": {\\n \\"WaterMark\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"50\\",\\n \\"Height\\": \\"50\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-logo-****.png\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"WaterMarkTemplateId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Dy\\": \\"100\\"\\n }\\n ]\\n },\\n \\"WaterMarkConfigUrl\\": \\"http://example.com/configure\\",\\n \\"DeWatermark\\": \\"{\\\\\\"0\\\\\\": [{\\\\\\"l\\\\\\": 10,\\\\\\"t\\\\\\": 10,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10},{\\\\\\"l\\\\\\": 100,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 10,\\\\\\"h\\\\\\": 10}],\\\\\\"128000\\\\\\": [],\\\\\\"250000\\\\\\": [{\\\\\\"l\\\\\\": 0.2,\\\\\\"t\\\\\\": 0.1,\\\\\\"w\\\\\\": 0.01,\\\\\\"h\\\\\\": 0.05}]}\\",\\n \\"M3U8NonStandardSupport\\": {\\n \\"TS\\": {\\n \\"SizeSupport\\": true,\\n \\"Md5Support\\": true\\n }\\n },\\n \\"Priority\\": \\"6\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aaclow\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Channels\\": \\"2\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"Level\\": \\"-20\\"\\n },\\n \\"Bitrate\\": \\"128\\"\\n },\\n \\"AudioStreamMap\\": \\"0:a:0\\",\\n \\"MergeList\\": {\\n \\"Merge\\": [\\n {\\n \\"Start\\": \\"01:59:59.999或者32000.23\\",\\n \\"RoleArn\\": \\"acs:ram:::role/\\",\\n \\"MergeURL\\": \\"http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv\\",\\n \\"Duration\\": \\"01:59:59.999\\"\\n }\\n ]\\n },\\n \\"SuperReso\\": {\\n \\"IsHalfSample\\": \\"true\\"\\n },\\n \\"UserData\\": \\"test-001\\",\\n \\"OutSubtitleList\\": {\\n \\"OutSubtitle\\": [\\n {\\n \\"Map\\": \\"0:v:0\\",\\n \\"OutSubtitleFile\\": {\\n \\"RoleArn\\": \\"acs:ram:::role/\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n },\\n \\"Success\\": true,\\n \\"Message\\": \\"The specified parameter “%s” cannot be null.\\"\\n }\\n ]\\n },\\n \\"VideoStreamMap\\": \\"0:a:0\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram:::role/\\",\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"Rotate\\": \\"90\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n },\\n \\"Clip\\": {\\n \\"TimeSpan\\": {\\n \\"Seek\\": \\"01:00:59.999\\",\\n \\"Duration\\": \\"01:00:59.999\\"\\n }\\n },\\n \\"MergeConfigUrl\\": \\"{\\\\\\"MergeList\\\\\\":[{\\\\\\"MergeURL\\\\\\":\\\\\\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\\\\\\"}]}\\",\\n \\"OpeningList\\": {\\n \\"Opening\\": [\\n {\\n \\"openUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\",\\n \\"Start\\": \\"0\\",\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\"\\n }\\n ]\\n },\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"bayer\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"true\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"TailSlateList\\": {\\n \\"TailSlate\\": [\\n {\\n \\"Start\\": \\"1\\",\\n \\"BgColor\\": \\"White\\",\\n \\"IsMergeAudio\\": true,\\n \\"Width\\": \\"-1\\",\\n \\"Height\\": \\"-1\\",\\n \\"BlendDuration\\": \\"0\\",\\n \\"TailUrl\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv\\"\\n }\\n ]\\n },\\n \\"TemplateId\\": \\"S00000000-000010\\",\\n \\"SubtitleConfig\\": {\\n \\"ExtSubtitleList\\": {\\n \\"ExtSubtitle\\": [\\n {\\n \\"CharEnc\\": \\"auto\\",\\n \\"FontName\\": \\"\\\\\\"WenQuanYi Zen Hei\\\\\\", \\\\\\"Yuanti SC Regular\\\\\\", \\\\\\"SimSun\\\\\\"\\",\\n \\"Input\\": {\\n \\"Object\\": \\"example-output.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n }\\n ]\\n },\\n \\"SubtitleList\\": {\\n \\"Subtitle\\": [\\n {\\n \\"Map\\": \\"0\\"\\n }\\n ]\\n }\\n },\\n \\"Properties\\": {\\n \\"Width\\": \\"720\\",\\n \\"Height\\": \\"1280\\",\\n \\"Duration\\": \\"17\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"490\\",\\n \\"FileFormat\\": \\"mp4\\",\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Timebase\\": \\"1/15360\\",\\n \\"AvgFPS\\": \\"30.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Sar\\": \\"1:1\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Height\\": \\"1280\\",\\n \\"NumFrames\\": \\"30\\",\\n \\"Bitrate\\": \\"421.117\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"high\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"8\\",\\n \\"AvgBitrate\\": \\"300\\",\\n \\"CostBandwidth\\": \\"10\\"\\n },\\n \\"Dar\\": \\"9:16\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": \\"720\\",\\n \\"Duration\\": \\"17.233333\\",\\n \\"Fps\\": \\"30.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/60\\",\\n \\"Level\\": \\"31\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/32000\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"1\\",\\n \\"NumFrames\\": \\"30\\",\\n \\"Bitrate\\": \\"64.136\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"17.223562\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/32000\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.064000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"1057273\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime / MOV\\",\\n \\"Duration\\": \\"17.234000\\",\\n \\"Bitrate\\": \\"490.784\\",\\n \\"FormatName\\": \\"mov\\"\\n },\\n \\"FileSize\\": \\"1057273\\"\\n }\\n },\\n \\"PipelineId\\": \\"88c6ca184c0e47b665e2a1267971****\\",\\n \\"Input\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"123\\",\\n \\"ErrorMessage\\": \\"The resource operated “%s” cannot be found.\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n BC860F04-778A-472F-AB39-E1BF329C1EA8\\n 16f01ad6175e4230ac42bb5182cd****\\n \\n 2014-01-10T12:00:00Z\\n 100\\n 2014-01-10T12:20:25Z\\n TranscodeSuccess\\n 31fa3c9ca8134fb4b0b0f7878301****\\n InternalError\\n The operation has failed due to some unknown error, exception or failure.\\n \\n 88c6ca184c0e47b665e2a1267971****\\n \\n \\n oss-cn-hangzhou\\n example-bucket\\n \\n \\n 123\\n The resource operated “%s” cannot be found.\\n InvalidParameter.ResourceNotFound\\n \\n \\n","errorExample":""}]',
'title' => '遍历转码作业',
'summary' => '遍历转码作业。',
'description' => '- 本接口返回结果默认按CreationTime降序排列。'."\n"
.'- 本接口最多返回最近90天的任务,小于90天的按实际设置时间返回。'."\n"
.'- 您可以通过设置作业状态、创建时间区间、转码管道等请求参数筛选查询结果。'."\n"
.'- 媒体处理默认同一账号不同地域数据不互通,调用接口前请确认您传入的地域信息与待查询文件地域一致,否则可能导致接口调用失败或信息不一致。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitAnalysisJob' => [
'summary' => '提交预置模板分析作业。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmts0IG2Y5',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '作业输入,JSON对象。需在OSS控制台Bucket授权页面将Bucket读权限授权给媒体转码服务。更多信息请参见[参数详情](~~29253~~)。'."\n"
."\n"
.'> OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.flv"}',
],
],
[
'name' => 'AnalysisConfig',
'in' => 'query',
'schema' => [
'description' => '模板分析作业配置,根据您的实际需要按需设置。更多参数信息请参见[参数详情](~~29253~~)。',
'type' => 'string',
'required' => false,
'example' => '{"QualityControl":{"RateQuality":25,"MethodStreaming":"network"}}',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,可以使用中英文、数字、中划线(-)等,不能以特殊字符开头,最大长度1024个字节。',
'type' => 'string',
'required' => false,
'example' => 'testid-001',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,可以通过**MPS控制台**>**全局设置**>**管道**查看。如果需要异步通知,须保证此管道绑定了可用的消息主题。',
'type' => 'string',
'required' => true,
'example' => 'bb558c1cc25b45309aab5be44d19****',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => '任务在其对应管道内的转码优先级。'."\n"
."\n"
.'- 取值范围:**\\[1,10\\]**,10为最高优先级。'."\n"
.'- 默认值:**6**。',
'type' => 'string',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'B52658D4-07AB-43CD-82B0-210958A65E23',
],
'AnalysisJob' => [
'description' => '系统预置模板分析作业。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '作业添加时间。',
'type' => 'string',
'example' => '2014-01-10T12:00:00Z',
],
'Percent' => [
'description' => '转码进度。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'State' => [
'description' => '作业状态。'."\n"
."\n"
.'- **Submitted**:已提交。'."\n"
."\n"
.'- **Analyzing**:分析中。'."\n"
."\n"
.'- **Success**:分析成功。'."\n"
."\n"
.'- **Fail**:分析失败。',
'type' => 'string',
'example' => 'Success',
],
'AnalysisConfig' => [
'description' => '作业配置。',
'type' => 'object',
'properties' => [
'QualityControl' => [
'description' => '输出质量控制。',
'type' => 'object',
'properties' => [
'MethodStreaming' => [
'description' => '播放方式。'."\n"
."\n"
.'- **network**:在线。'."\n"
."\n"
.'- **local**:本地。'."\n"
."\n"
.'- 默认值:**network**。',
'type' => 'string',
'example' => 'network',
],
'RateQuality' => [
'description' => '输出质量等级。',
'type' => 'string',
'example' => '50',
],
],
],
'PropertiesControl' => [
'description' => '属性控制。',
'type' => 'object',
'properties' => [
'Deinterlace' => [
'description' => '强制扫描模式判定。'."\n"
."\n"
.'- **Auto**:自动。'."\n"
.'- **Force**:强制做deinterlace。'."\n"
.'- **None**:强制不做deinterlace。',
'type' => 'string',
'example' => 'Force',
],
'Crop' => [
'description' => '视频裁切配置。',
'type' => 'object',
'properties' => [
'Top' => [
'description' => '裁切上边距。'."\n"
."\n"
.'> 若**Mode**为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Width' => [
'description' => '裁切后宽。'."\n"
."\n"
.'> 若**Mode**为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Height' => [
'description' => '裁切后高。'."\n"
."\n"
.'> 若**Mode**为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Left' => [
'description' => '裁切左边距。'."\n"
."\n"
.'> 若**Mode**为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Mode' => [
'description' => '裁切方式。取值:'."\n"
."\n"
.'- **Auto**:自动(默认)。'."\n"
.'- **Force**:强制。'."\n"
.'- **None**:强制不做。',
'type' => 'string',
'example' => 'Auto',
],
],
],
],
],
],
],
'Message' => [
'description' => '分析失败时错误信息。',
'type' => 'string',
'example' => 'The resource operated \\"PipelineId\\" cannot be found',
],
'Priority' => [
'description' => '任务在其对应管道内的优先级。'."\n"
."\n"
.'- 取值范围:**\\[1,10\\]**。10为最高优先级。'."\n"
."\n"
.'- 默认值:**10**。',
'type' => 'string',
'example' => '10',
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。分析失败时不返回此参数。',
'type' => 'string',
'example' => '3ca84a39a9024f19853b21be9cf9****',
],
'ErrorMessage' => [
'description' => '失败时错误信息。分析成功时不返回此参数。',
'type' => 'string',
'example' => 'The resource operated \\"PipelineId\\" cannot be found',
],
'ErrorCode' => [
'description' => '失败时错误码。分析成功时不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
],
],
'TemplateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '作业输出的预置模板列表。',
'type' => 'array',
'items' => [
'description' => '作业输出的预置模板详细信息。',
'type' => 'object',
'properties' => [
'Video' => [
'description' => '视频编解码配置。',
'type' => 'object',
'properties' => [
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 单位:Kb。'."\n"
.'- 默认值:**6000**。',
'type' => 'string',
'example' => '5000',
],
'Degrain' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '5',
],
'BitrateBnd' => [
'description' => '视频平均码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '总码率上限。单位:Kbps。',
'type' => 'string',
'example' => '20',
],
'Min' => [
'description' => '总码率下限。单位:Kbps。',
'type' => 'string',
'example' => '10',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。包含yuv420p,yuvj420p等标准颜色格式。',
'type' => 'string',
'example' => 'yuvj420p',
],
'Codec' => [
'description' => '编解码格式。默认值:**H.264**。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '视频高。'."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始高度**。',
'type' => 'string',
'example' => '1880',
],
'Qscale' => [
'description' => '视频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Bitrate' => [
'description' => '视频平均码率。单位:Kbps。',
'type' => 'string',
'example' => '10',
],
'Maxrate' => [
'description' => '视频码率峰值。单位:Kbps。',
'type' => 'string',
'example' => '10',
],
'Profile' => [
'description' => '编码级别。'."\n"
."\n"
.'- **baseline**:针对移动设备。'."\n"
.'- **main**:针对标准分辨率设备。'."\n"
.'- **high**:针对高分辨率设备。'."\n"
."\n"
.'- 默认值:**high**。',
'type' => 'string',
'example' => 'baseline',
],
'Crf' => [
'description' => '码率-质量控制因子。'."\n"
."\n"
.'- 默认值:编码格式为H264,默认值为**23**。编码格式为H265,默认值为**26**。'."\n"
."\n"
.'- 如果设置了Crf,则Bitrate的设置失效。',
'type' => 'string',
'example' => '27',
],
'Gop' => [
'description' => '关键帧间最大帧数。默认值:**250**。',
'type' => 'string',
'example' => '1',
],
'Width' => [
'description' => '视频宽。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始宽度**。',
'type' => 'string',
'example' => '1990',
],
'Fps' => [
'description' => '帧率。'."\n"
."\n"
.'- 当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取**输入文件帧率**。',
'type' => 'string',
'example' => '60',
],
'Preset' => [
'description' => '视频算法器预置。支持veryfast(超快)、fast(快)、medium(中等)、slow(慢)、slower(超慢)。默认值:**medium**。',
'type' => 'string',
'example' => 'medium',
],
'ScanMode' => [
'description' => '扫描模式。取值:'."\n"
."\n"
.'- **interlaced**:交叉扫描。'."\n"
."\n"
.'- **progressive**:顺序扫描。',
'type' => 'string',
'example' => 'progressive',
],
],
],
'TransConfig' => [
'description' => '转码通用配置。',
'type' => 'object',
'properties' => [
'TransMode' => [
'description' => '转码模式。取值:onepass、twopass、CBR。默认值:**onepass**。',
'type' => 'string',
'example' => 'onepass',
],
],
],
'State' => [
'description' => '模板的状态。'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'MuxConfig' => [
'description' => '转码封包配置。',
'type' => 'object',
'properties' => [
'Gif' => [
'description' => 'gif格式。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => 'gif的loop间隔,单位为百分之一秒,比如500代表间隔为5秒。'."\n",
'type' => 'string',
'example' => '0',
],
'Loop' => [
'description' => 'gif与webp循环次数,默认不循环。',
'type' => 'string',
'example' => '0',
],
],
],
'Segment' => [
'description' => '切片配置。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。单位:秒。',
'type' => 'string',
'example' => '60',
],
],
],
],
],
'Name' => [
'description' => '模板名称。',
'type' => 'string',
'example' => 'FLV-UD',
],
'Audio' => [
'description' => '音频编解码配置。',
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当**Codec**为**aac**时可取值:aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。',
'type' => 'string',
'example' => 'aac_low',
],
'Codec' => [
'description' => '音频编解码格式。默认值:**aac**。',
'type' => 'string',
'example' => 'mp3',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 单位:Hz。'."\n"
.'- 默认值:**44100**。',
'type' => 'string',
'example' => '32000',
],
'Qscale' => [
'description' => '音频质量控制度。',
'type' => 'string',
'example' => '10',
],
'Channels' => [
'description' => '声道数。默认值:**2**。',
'type' => 'string',
'example' => '1',
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '8',
],
],
],
'Id' => [
'description' => '转码模板ID。',
'type' => 'string',
'example' => 'S00000000-00****',
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。',
'type' => 'string',
'example' => 'flv',
],
],
],
],
],
],
],
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'Code' => [
'description' => '分析失败时错误码。分析成功时不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
'InputFile' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => 'OSS的Object。',
'type' => 'string',
'example' => 'example.flv',
],
'Location' => [
'description' => 'OSS的服务区域。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => 'OSS的Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'bb558c1cc25b45309aab5be44d19****',
],
'Id' => [
'description' => '模板分析作业ID。',
'type' => 'string',
'example' => '57f6aa3f84824309bcba67231b40****',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B52658D4-07AB-43CD-82B0-210958A65E23\\",\\n \\"AnalysisJob\\": {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 100,\\n \\"State\\": \\"Success\\",\\n \\"AnalysisConfig\\": {\\n \\"QualityControl\\": {\\n \\"MethodStreaming\\": \\"network\\",\\n \\"RateQuality\\": \\"50\\"\\n },\\n \\"PropertiesControl\\": {\\n \\"Deinterlace\\": \\"Force\\",\\n \\"Crop\\": {\\n \\"Top\\": \\"8\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Left\\": \\"8\\",\\n \\"Mode\\": \\"Auto\\"\\n }\\n }\\n },\\n \\"Message\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"Priority\\": \\"10\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"ErrorMessage\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n },\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"5000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"20\\",\\n \\"Min\\": \\"10\\"\\n },\\n \\"PixFmt\\": \\"yuvj420p\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"1880\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Bitrate\\": \\"10\\",\\n \\"Maxrate\\": \\"10\\",\\n \\"Profile\\": \\"baseline\\",\\n \\"Crf\\": \\"27\\",\\n \\"Gop\\": \\"1\\",\\n \\"Width\\": \\"1990\\",\\n \\"Fps\\": \\"60\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\"\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"60\\"\\n }\\n },\\n \\"Name\\": \\"FLV-UD\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Codec\\": \\"mp3\\",\\n \\"Samplerate\\": \\"32000\\",\\n \\"Qscale\\": \\"10\\",\\n \\"Channels\\": \\"1\\",\\n \\"Bitrate\\": \\"8\\"\\n },\\n \\"Id\\": \\"S00000000-00****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n }\\n }\\n ]\\n },\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"PipelineId\\": \\"bb558c1cc25b45309aab5be44d19****\\",\\n \\"Id\\": \\"57f6aa3f84824309bcba67231b40****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B52658D4-07AB-43CD-82B0-210958A65E23\\n \\n 2014-01-10T12:00:00Z\\n 100\\n Success\\n \\n \\n network\\n 50\\n \\n \\n Force\\n \\n 8\\n 8\\n 8\\n 8\\n Auto\\n \\n \\n \\n The resource operated \\\\\\"PipelineId\\\\\\" cannot be found\\n 10\\n \\n 3ca84a39a9024f19853b21be9cf9****\\n \\n \\n \\n \\n onepass\\n \\n Normal\\n \\n \\n 0\\n 0\\n \\n \\n 60\\n \\n \\n FLV-UD\\n \\n S00000000-00****\\n \\n flv\\n \\n \\n testid-001\\n \\n \\n oss-cn-hangzhou\\n example-bucket\\n \\n bb558c1cc25b45309aab5be44d19****\\n 57f6aa3f84824309bcba67231b40****\\n \\n","errorExample":""}]',
'title' => '提交预置模板分析作业',
'description' => '- 通过本接口提交作业以后,媒体处理服务会对输入文件进行智能分析,推荐出适合输入文件的预置模板,可通过[查询模板分析作业](~~29224~~)接口得到模板分析作业结果,也可使用异步通知机制。'."\n"
.'- 预置模板分析的结果只保留半个月(从得到结果时算起),半个月后将被删除。如果半个月后再使用推荐的预置模板提交作业将返回转码作业失败,失败的错误码为:`AnalysisResultNotFound`。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryAnalysisJobList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AnalysisJobIds',
'in' => 'query',
'schema' => [
'description' => '模板分析作业ID列表。'."\n"
.'- 一次最多查询10个。'."\n"
.'- 多个使用半角逗号(,)作为分隔符。',
'type' => 'string',
'required' => true,
'example' => 'bb558c1cc25b45309aab5be44d19****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5CA6E020-4102-4FFF-AA56-5ED7ECD811A1',
],
'AnalysisJobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AnalysisJob' => [
'description' => '模板分析作业列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '作业添加时间。',
'type' => 'string',
'example' => '2014-01-10T12:00:00Z',
],
'Percent' => [
'description' => '转码进度。',
'type' => 'integer',
'format' => 'int64',
'example' => '86',
],
'State' => [
'description' => '作业状态。'."\n"
."\n"
.'- **Submitted**:已提交。'."\n"
."\n"
.'- **Analyzing**:分析中。'."\n"
."\n"
.'- **Success**:成功。'."\n"
."\n"
.'- **Fail**:失败。',
'type' => 'string',
'example' => 'Success',
],
'AnalysisConfig' => [
'description' => '作业配置。',
'type' => 'object',
'properties' => [
'QualityControl' => [
'description' => '输出质量控制。',
'type' => 'object',
'properties' => [
'MethodStreaming' => [
'description' => '播放方式。'."\n"
."\n"
.'- **network**:在线。'."\n"
."\n"
.'- **local**:本地。'."\n"
."\n"
.'- 默认值:**network**。',
'type' => 'string',
'example' => 'network',
],
'RateQuality' => [
'description' => '输出质量等级。默认值:**25**。',
'type' => 'string',
'example' => '25',
],
],
],
'PropertiesControl' => [
'description' => '属性控制。',
'type' => 'object',
'properties' => [
'Deinterlace' => [
'description' => '强制扫描模式判定。'."\n"
."\n"
.'- **Auto**:自动。'."\n"
.'- **Force**:强制做deinterlace。'."\n"
.'- **None**:强制不做deinterlace。',
'type' => 'string',
'example' => 'Auto',
],
'Crop' => [
'description' => '视频裁切配置。',
'type' => 'object',
'properties' => [
'Top' => [
'description' => '裁切上边距。'."\n"
."\n"
.'> 如果Mode为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Width' => [
'description' => '裁切后宽。'."\n"
."\n"
.'> 如果Mode为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Height' => [
'description' => '裁切后高。'."\n"
."\n"
.'> 如果Mode为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Left' => [
'description' => '裁切左边距。'."\n"
."\n"
.'> 如果Mode为Auto或None,则此值失效。',
'type' => 'string',
'example' => '8',
],
'Mode' => [
'description' => '裁切方式。取值:'."\n"
."\n"
.'- **Auto**:自动。'."\n"
.'- **Force**:强制。'."\n"
.'- **None**:强制不做。'."\n"
.'- 如Crop不是空JSON{},则此值必填。',
'type' => 'string',
'example' => 'Auto',
],
],
],
],
],
],
],
'Message' => [
'description' => '分析失败时错误信息。',
'type' => 'string',
'example' => 'The resource operated \\"PipelineId\\" cannot be found',
],
'Priority' => [
'description' => '任务在其对应管道内的优先级。'."\n"
.'- 取值范围:**\\[1,10\\]**。10为最高优先级。'."\n"
.'- 默认值:**10**。',
'type' => 'string',
'example' => '8',
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。分析失败时不返回此参数。',
'type' => 'string',
'example' => '3ca84a39a9024f19853b21be9cf9****',
],
'ErrorMessage' => [
'description' => '失败时错误信息。分析成功时不返回此参数。',
'type' => 'string',
'example' => 'The resource operated \\"PipelineId\\" cannot be found',
],
'ErrorCode' => [
'description' => '失败时错误码。分析成功时不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
],
],
'TemplateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '作业输出的预置模板列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Video' => [
'description' => '视频编解码配置。',
'type' => 'object',
'properties' => [
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 单位:Kb。'."\n"
.'- 默认值:**6000**。',
'type' => 'string',
'example' => '6000',
],
'Degrain' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '5',
],
'BitrateBnd' => [
'description' => '视频平均码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '总码率上限。单位:Kbps。',
'type' => 'string',
'example' => '1500',
],
'Min' => [
'description' => '总码率下限。单位:Kbps。',
'type' => 'string',
'example' => '800',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。包含yuv420p,yuvj420p等标准颜色格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Codec' => [
'description' => '编解码格式。支持H.264、H.265。 默认值:**H.264**。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '视频高。'."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始高度**。'."\n",
'type' => 'string',
'example' => '720',
],
'Qscale' => [
'description' => '视频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Bitrate' => [
'description' => '视频平均码率。单位:Kbps。',
'type' => 'string',
'example' => '1000',
],
'Maxrate' => [
'description' => '视频码率峰值。'."\n"
."\n"
.'- 取值范围:**\\[10,50000\\]**。'."\n"
.'- 单位:Kbps。',
'type' => 'string',
'example' => '2000',
],
'Profile' => [
'description' => '编码级别。'."\n"
.'- **baseline**:针对移动设备。'."\n"
.'- **main**:针对标准分辨率设备。'."\n"
.'- **high**:针对高分辨率设备。'."\n"
.'- 默认值:**high**。',
'type' => 'string',
'example' => 'high',
],
'Crf' => [
'description' => '码率-质量控制因子。'."\n"
.'- 默认值:编码格式为H264,默认值为**23**。编码格式为H265,默认值为**26**。'."\n"
.'- 如果设置了Crf,则Bitrate的设置失效。',
'type' => 'string',
'example' => '26',
],
'Gop' => [
'description' => '关键帧间最大帧数。默认值:**250**。',
'type' => 'string',
'example' => '250',
],
'Width' => [
'description' => '视频宽。'."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始宽度**。',
'type' => 'string',
'example' => '1280',
],
'Fps' => [
'description' => '帧率。'."\n"
.'- 当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取**输入文件帧率**。',
'type' => 'string',
'example' => '25',
],
'Preset' => [
'description' => '视频算法器预置。支持veryfast(超快)、fast(快)、medium(中等)、slow(慢)、slower(超慢)。 默认值:**medium**。',
'type' => 'string',
'example' => 'medium',
],
'ScanMode' => [
'description' => '扫描模式。取值:'."\n"
."\n"
.'- **interlaced**:交叉扫描。'."\n"
."\n"
.'- **progressive**:顺序扫描。',
'type' => 'string',
'example' => 'interlaced',
],
],
],
'TransConfig' => [
'description' => '转码通用配置。',
'type' => 'object',
'properties' => [
'TransMode' => [
'description' => '转码模式。默认值:**onepass**。可选范围:'."\n"
."\n"
.'- **onepass**'."\n"
."\n"
.'- **twopass**'."\n"
."\n"
.'- **CBR**',
'type' => 'string',
'example' => 'onepass',
],
],
],
'State' => [
'description' => '模板的状态。'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'MuxConfig' => [
'description' => '转码封包配置。',
'type' => 'object',
'properties' => [
'Gif' => [
'description' => 'gif格式。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => 'gif的loop间隔,单位为百分之一秒,比如500代表间隔为5秒。',
'type' => 'string',
'example' => '0',
],
'Loop' => [
'description' => 'gif与webp循环次数,默认不循环。',
'type' => 'string',
'example' => '0',
],
],
],
'Segment' => [
'description' => '切片配置。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。单位:秒。',
'type' => 'string',
'example' => '10',
],
],
],
],
],
'Name' => [
'description' => '模板名称。',
'type' => 'string',
'example' => 'FLV-UD',
],
'Audio' => [
'description' => '音频编解码配置。',
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当**Codec**为**aac**时可取值:'."\n"
."\n"
.'- **aac_low**'."\n"
."\n"
.'- **aac_he**'."\n"
."\n"
.'- **aac_he_v2**'."\n"
."\n"
.'- **aac_ld**'."\n"
."\n"
.'- **aac_eld**',
'type' => 'string',
'example' => 'aac_low',
],
'Codec' => [
'description' => '音频编解码格式。默认值:**aac**。可取值:'."\n"
."\n"
.'- **aac**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **vorbis**'."\n"
."\n"
.'- **flac**',
'type' => 'string',
'example' => 'aac',
],
'Samplerate' => [
'description' => '采样率。'."\n"
.'- 单位:Hz。'."\n"
.'- 默认值:**44100**。',
'type' => 'string',
'example' => '44100',
],
'Qscale' => [
'description' => '音频质量控制度。',
'type' => 'string',
'example' => '15',
],
'Channels' => [
'description' => '声道数。默认值:**2**。',
'type' => 'string',
'example' => '2',
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
.'- 取值范围:**8~1000**。'."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '128',
],
],
],
'Id' => [
'description' => '转码模板ID。',
'type' => 'string',
'example' => 'S00000000-00****',
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。',
'type' => 'string',
'example' => 'flv',
],
],
],
],
],
],
],
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'Code' => [
'description' => '分析失败时错误码。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
'InputFile' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => 'OSS的Object。',
'type' => 'string',
'example' => 'example.flv',
],
'Location' => [
'description' => 'OSS的服务区域。',
'type' => 'string',
'example' => 'oss-cn-hangzhou',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket',
],
],
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'bb558c1cc25b45309aab5be44d19****',
],
'Id' => [
'description' => '模板分析作业ID。',
'type' => 'string',
'example' => '57f6aa3f84824309bcba67231b406****',
],
],
],
],
],
],
'NonExistAnalysisJobIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的模板分析作业。',
'type' => 'array',
'items' => [
'description' => '不存在的模板分析作业ID列表,无数据时该结构不返回。',
'type' => 'string',
'example' => 'null',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5CA6E020-4102-4FFF-AA56-5ED7ECD811A1\\",\\n \\"AnalysisJobList\\": {\\n \\"AnalysisJob\\": [\\n {\\n \\"CreationTime\\": \\"2014-01-10T12:00:00Z\\",\\n \\"Percent\\": 86,\\n \\"State\\": \\"Success\\",\\n \\"AnalysisConfig\\": {\\n \\"QualityControl\\": {\\n \\"MethodStreaming\\": \\"network\\",\\n \\"RateQuality\\": \\"25\\"\\n },\\n \\"PropertiesControl\\": {\\n \\"Deinterlace\\": \\"Auto\\",\\n \\"Crop\\": {\\n \\"Top\\": \\"8\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Left\\": \\"8\\",\\n \\"Mode\\": \\"Auto\\"\\n }\\n }\\n },\\n \\"Message\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"Priority\\": \\"8\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"ErrorMessage\\": \\"The resource operated \\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\" cannot be found\\",\\n \\"ErrorCode\\": \\"InvalidParameter.ResourceNotFound\\"\\n },\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"5\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1500\\",\\n \\"Min\\": \\"800\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Bitrate\\": \\"1000\\",\\n \\"Maxrate\\": \\"2000\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"26\\",\\n \\"Gop\\": \\"250\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\"\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"FLV-UD\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"15\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"128\\"\\n },\\n \\"Id\\": \\"S00000000-00****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n }\\n }\\n ]\\n },\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"oss-cn-hangzhou\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n },\\n \\"PipelineId\\": \\"bb558c1cc25b45309aab5be44d19****\\",\\n \\"Id\\": \\"57f6aa3f84824309bcba67231b406****\\"\\n }\\n ]\\n },\\n \\"NonExistAnalysisJobIds\\": {\\n \\"String\\": [\\n \\"null\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 5CA6E020-4102-4FFF-AA56-5ED7ECD811A1\\n \\n 2014-01-10T12:00:00Z\\n 86\\n Success\\n \\n \\n network\\n 25\\n \\n \\n Auto\\n \\n 8\\n 8\\n 8\\n 8\\n Auto\\n \\n \\n \\n The resource operated \\\\\\"PipelineId\\\\\\" cannot be found\\n 8\\n \\n 3ca84a39a9024f19853b21be9cf9****\\n \\n \\n \\n \\n onepass\\n \\n Normal\\n \\n \\n 0\\n 0\\n \\n \\n 10\\n \\n \\n FLV-UD\\n \\n S00000000-00****\\n \\n flv\\n \\n \\n testid-001\\n \\n \\n oss-cn-hangzhou\\n example-bucket\\n \\n bb558c1cc25b45309aab5be44d19****\\n 57f6aa3f84824309bcba67231b406****\\n \\n null\\n","errorExample":""}]',
'title' => '查询模板分析作业',
'summary' => '查询模板分析作业,模板分析作业完成后,返回可用的预置模板列表。',
'description' => '本接口一次最多可查询10个模板分析作业。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '模板名称。最大长度128字节。',
'type' => 'string',
'required' => true,
'example' => 'mps-example',
],
],
[
'name' => 'Container',
'in' => 'query',
'schema' => [
'description' => '容器,JSON对象,其中包含参数为Format(容器格式)。不设置Container参数则转码输出默认为mp4格式,如需其他格式则必须设置此对象。更多信息请参见[Container详情](~~29253~~)。'."\n"
."\n"
.'- 默认值:mp4。'."\n"
."\n"
.'- 视频转码支持flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。'."\n"
."\n"
.'> 容器格式为flv时,Video Codec不能设置为H.265。'."\n"
."\n"
.'- 音频转码支持mp3、mp4、ogg、flac、m4a。'."\n"
."\n"
.'- 图片支持gif、WEBP。'."\n"
."\n"
.'> 容器格式为gif时,VideoCodec设置只能设置为GIF。容器格式为webp时,Video Codec设置只能设置为WEBP。',
'type' => 'string',
'required' => false,
'example' => '{"Format":"mp4"}',
],
],
[
'name' => 'Video',
'in' => 'query',
'schema' => [
'description' => '视频流配置。JSON对象,更多信息请参见[Video详情](~~29253~~)。'."\n"
."\n"
.'> 不设置Video参数则转码输出不包括视频流;如需保留视频流则必须设置此对象。',
'type' => 'string',
'required' => false,
'example' => '{"Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10s"}',
],
],
[
'name' => 'Audio',
'in' => 'query',
'schema' => [
'description' => '音频流配置。JSON对象,详情参见[Audio详情](~~29253~~)。'."\n"
."\n"
.'> 不设置Audio参数则转码输出不包括音频流;如需保留音频流则必须设置此对象。',
'type' => 'string',
'required' => false,
'example' => '{"Codec":"H.264","Samplerate":"44100","Bitrate":"500","Channels":"2"}',
],
],
[
'name' => 'TransConfig',
'in' => 'query',
'schema' => [
'description' => '转码通用配置。JSON对象,详情参见[TransConfig详情](~~29253~~)。不设置TransConfig参数则转码配置全部为默认值,如默认值不能满足您的转码需求则必须按需设置此对象。',
'type' => 'string',
'required' => false,
'example' => '{"TransMode":"onepass"}',
],
],
[
'name' => 'MuxConfig',
'in' => 'query',
'schema' => [
'description' => '切片配置字段。JSON对象,详情参见[MuxConfig详情](~~29253~~)。不设置MuxConfig参数则转码输出不分片,如需分片则必须设置此对象。',
'type' => 'string',
'required' => false,
'example' => '{"Segment":{"Duration":"10"}}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3',
],
'Template' => [
'description' => '转码模板详细信息。',
'type' => 'object',
'properties' => [
'Video' => [
'description' => '视频编解码配置。',
'type' => 'object',
'properties' => [
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 默认值:**6000**。'."\n"
.'- 单位:Kb。',
'type' => 'string',
'example' => '6000',
],
'LongShortMode' => [
'description' => '是否开启横竖屏自适应(长短边模式)。默认值:**false**。取值:'."\n"
."\n"
.'- **true**:开启横竖屏自适应。'."\n"
.'- **false**:关闭横竖屏自适应。'."\n"
."\n"
.'> 转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽)。'."\n",
'type' => 'string',
'example' => 'false',
],
'Degrain' => [
'description' => '视频质量控制度 。',
'type' => 'string',
'example' => '10',
],
'BitrateBnd' => [
'description' => '视频码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '最大码率。',
'type' => 'string',
'example' => '1500',
],
'Min' => [
'description' => '最小码率。',
'type' => 'string',
'example' => '800',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。范围yuv420p、yuvj420p等标准颜色格式。默认值:**yuv420p**或**原始颜色格式**。',
'type' => 'string',
'example' => 'yuv420p',
],
'Pad' => [
'description' => '视频贴黑边。参数格式:width:height:left:top。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Codec' => [
'description' => '编解码格式。支持H.264、H.265、GIF、WEBP。默认值:**H.264**。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '视频高度。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始高度**。',
'type' => 'string',
'example' => '800',
],
'Qscale' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '1',
],
'Crop' => [
'description' => '视频画面裁切。支持2种方式:'."\n"
."\n"
.'- **自动检测黑边并裁切**:设置为“border”。'."\n"
.'- **自定义裁切**:自定义参数并裁剪。参数格式:width:height:left:top。示例:1280:800:0:140。',
'type' => 'string',
'example' => 'border',
],
'Bitrate' => [
'description' => '视频输出文件的码率。单位:Kbps。',
'type' => 'string',
'example' => '500',
],
'Maxrate' => [
'description' => '视频码率峰值。单位Kbps。',
'type' => 'string',
'example' => '500',
],
'MaxFps' => [
'description' => '最大帧率。',
'type' => 'string',
'example' => '60',
],
'Profile' => [
'description' => '编码级别。'."\n"
."\n"
.'- **baseline**:适合移动设备。'."\n"
.'- **main**:适合标准分辨率设备。'."\n"
.'- **high**:适合高分辨率设备。'."\n"
."\n"
.'- 默认值:**high**。'."\n"
."\n"
.'最佳实践:如果您有多个清晰度,建议最低清晰度配成baseline,以保证最低端设备可播放。其他清晰度配置为main或high。'."\n"
."\n"
.'> 目前仅H.264支持此参数。',
'type' => 'string',
'example' => 'high',
],
'Crf' => [
'description' => '码率-质量控制因子。默认值:编码格式未H264,默认值为**23**。编码格式为H265,默认值为**26**。'."\n"
."\n"
.'> 如果设置了Crf,则Bitrate的设置失效。',
'type' => 'string',
'example' => '15',
],
'Remove' => [
'description' => '是否删除视频流。'."\n"
."\n"
.'- **true**:删除。'."\n"
.'- **false**:保留。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Gop' => [
'description' => '关键帧间最大时间间隔或者最大帧数。最大时间间隔时,必传单位为秒。最大帧数时无单位。默认值:**10s**。'."\n",
'type' => 'string',
'example' => '10s',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 默认值:**视频原始宽度**。'."\n"
.'- 单位:px。',
'type' => 'string',
'example' => '256',
],
'Fps' => [
'description' => '帧率。默认值:取输入文件帧率。当输入文件帧率超过60时取60。单位:fps。',
'type' => 'string',
'example' => '25',
],
'Preset' => [
'description' => '视频算法器预置。默认值:**medium**。可取值:'."\n"
."\n"
.'- **veryfast**:超快'."\n"
."\n"
.'- **fast**:快'."\n"
."\n"
.'- **medium**:中等'."\n"
."\n"
.'- **slow**:慢'."\n"
."\n"
.'- **slower**:超慢'."\n"
."\n"
.'> 目前仅H.264支持此参数。',
'type' => 'string',
'example' => 'fast',
],
'ScanMode' => [
'description' => '扫描模式。取值:'."\n"
."\n"
.'- **interlaced**:交叉扫描。'."\n"
."\n"
.'- **progressive**:逐行扫描。',
'type' => 'string',
'example' => 'interlaced',
],
'ResoPriority' => [
'description' => '分辨率调整优先级。',
'type' => 'string',
'example' => '0',
],
'Hdr2sdr' => [
'description' => '是否开启 hdr2sdr 功能。启用时会把 hdr 的视频转成 sdr。',
'type' => 'string',
'example' => 'true',
],
'NarrowBand' => [
'description' => '窄带高清设置参数',
'type' => 'object',
'properties' => [
'Version' => [
'description' => '窄带高清版本,可选值:1.0 。',
'type' => 'string',
'example' => '1.0',
],
'Abrmax' => [
'description' => '动态码率上限,设置后平均码率范围 (0, 1000000]。',
'type' => 'number',
'format' => 'float',
'example' => '3000',
],
'MaxAbrRatio' => [
'description' => '码率上限最大倍率,设置后 abrmax 不会超过视频源码率的 x 倍。范围 (0, 1.0]',
'type' => 'number',
'format' => 'float',
'example' => '1.0',
],
],
],
],
],
'TransConfig' => [
'description' => '转码通用配置。',
'type' => 'object',
'properties' => [
'IsCheckAudioBitrate' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于IsCheckAudioBitrateFail。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:'."\n"
.' - 参数为空,并且codec和输入源不一样:false。'."\n"
.' - 参数为空,并且codec和输入源一样:true。',
'type' => 'string',
'example' => 'true',
],
'TransMode' => [
'description' => '转码模式。可选范围:'."\n"
."\n"
.'- **onepass**'."\n"
."\n"
.'- **twopass**'."\n"
."\n"
.'- **CBR**'."\n"
."\n"
.'- 默认值:**onepass**',
'type' => 'string',
'example' => 'onepass',
],
'IsCheckReso' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。'."\n"
."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'true',
],
'IsCheckVideoBitrateFail' => [
'description' => '是否检查视频码率。当输出视频码率大于媒体源视频码率时,此值优先级大于IsCheckVideoBitrate。'."\n"
."\n"
.'- **true**表示不进行转码。'."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'true',
],
'AdjDarMethod' => [
'description' => '分辨率改写方式。默认值:**none**。可选范围:'."\n"
."\n"
.'- **rescale**:范围拉伸。'."\n"
."\n"
.'- **crop**:批量裁剪。'."\n"
."\n"
.'- **none**:不改变。',
'type' => 'string',
'example' => 'rescale',
],
'IsCheckVideoBitrate' => [
'description' => '是否检查视频码率。如果视频输出码率大于视频输入码率,则视频输出码率等于视频输入码率。'."\n"
."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。'."\n",
'type' => 'string',
'example' => 'true',
],
'IsCheckResoFail' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。'."\n"
."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'true',
],
'IsCheckAudioBitrateFail' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,此值优先级大于**IsCheckAudioBitrate**。'."\n"
."\n"
.'- **true**表示不进行转码。'."\n"
.'- **false**表示不检查。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'true',
],
],
],
'State' => [
'description' => '模板的状态。'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'MuxConfig' => [
'description' => '转码封包配置。',
'type' => 'object',
'properties' => [
'Webp' => [
'description' => 'Webp对应的封包配置。',
'type' => 'object',
'properties' => [
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
],
],
'Gif' => [
'description' => 'Gif对应的封包配置。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => '终帧暂停时间。单位:厘秒。',
'type' => 'string',
'example' => '0',
],
'DitherMode' => [
'description' => '调色板颜色抖动方式。可选值sierra、bayer。',
'type' => 'string',
'example' => 'sierra',
],
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
'IsCustomPalette' => [
'description' => '自定义调色板功能。',
'type' => 'string',
'example' => 'false',
],
],
],
'Segment' => [
'description' => '切片配置。',
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。单位:秒。',
'type' => 'string',
'example' => '10',
],
],
],
],
],
'Name' => [
'description' => '模板名称。',
'type' => 'string',
'example' => 'mps-example',
],
'Audio' => [
'description' => '音频编解码配置。',
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当**Codec**为**aac**时可以设置如下范围中的值:'."\n"
."\n"
.'- **aac_low**'."\n"
."\n"
.'- **aac_he**'."\n"
."\n"
.'- **aac_he_v2**'."\n"
."\n"
.'- **aac_ld**'."\n"
."\n"
.'- **aac_eld**',
'type' => 'string',
'example' => 'aac_low',
],
'Remove' => [
'description' => '是否删除音频流。'."\n"
."\n"
.'- **true**:表示删除。'."\n"
.'- **false**:表示保留。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'true',
],
'Codec' => [
'description' => '音频编解码格式。默认值:**aac**。可选值:'."\n"
."\n"
.'- **aac**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **vorbis**'."\n"
."\n"
.'- **flac**',
'type' => 'string',
'example' => 'aac',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 单位:Hz。'."\n"
.'- 默认值:**44100**。',
'type' => 'string',
'example' => '44100',
],
'Qscale' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '5',
],
'Channels' => [
'description' => '声道数。默认值:**2**。',
'type' => 'string',
'example' => '2',
],
'Volume' => [
'description' => '音量详情。',
'type' => 'object',
'properties' => [
'Method' => [
'description' => '音量调整方式。可取值:'."\n"
."\n"
.'- **auto**:自动调整。'."\n"
.'- **dynamic**:动态调整。'."\n"
."\n"
.'- **linear**:线性调整。',
'type' => 'string',
'example' => 'auto',
],
'Level' => [
'description' => '音量调整幅度。'."\n"
."\n"
.'- 默认值:**-20**。'."\n"
."\n"
.'- 单位:db。',
'type' => 'string',
'example' => '-20',
],
'IntegratedLoudnessTarget' => [
'title' => '目标音量。'."\n"
."\n"
.'当指定Method为dynamic时生效。'."\n"
."\n"
.'单位:db。'."\n"
."\n"
.'值范围:[-70,-5]。'."\n"
."\n"
.'默认值:-6。',
'description' => '目标音量。'."\n"
."\n"
.'当指定Method为dynamic时生效。'."\n"
."\n"
.'单位:db。'."\n"
."\n"
.'值范围:[-70,-5]。'."\n"
."\n"
.'默认值:-6。',
'type' => 'string',
],
'TruePeak' => [
'title' => '最大峰值。'."\n"
."\n"
.'当指定Method为dynamic时生效。'."\n"
."\n"
.'单位:db。'."\n"
."\n"
.'值范围:[-9,0]。'."\n"
."\n"
.'默认值:-1。',
'description' => '最大峰值。'."\n"
."\n"
.'当指定Method为dynamic时生效。'."\n"
."\n"
.'单位:db。'."\n"
."\n"
.'值范围:[-9,0]。'."\n"
."\n"
.'默认值:-1。',
'type' => 'string',
],
'LoudnessRangeTarget' => [
'title' => '相对目标音量的波动范围。'."\n"
."\n"
.'当指定Method为dynamic时生效。'."\n"
."\n"
.'单位:db。'."\n"
."\n"
.'值范围:[1,20]。'."\n"
."\n"
.'默认值:8。',
'description' => '相对目标音量的波动范围。'."\n"
."\n"
.'当指定Method为dynamic时生效。'."\n"
."\n"
.'单位:db。'."\n"
."\n"
.'值范围:[1,20]。'."\n"
."\n"
.'默认值:8。',
'type' => 'string',
],
'PeakLevel' => [
'title' => '音量调整系数。'."\n"
."\n"
.'当指定Method为adaptive时生效。'."\n"
."\n"
.'值范围:[0,1]。'."\n"
."\n"
.'默认值:0.9。',
'description' => '音量调整系数。'."\n"
."\n"
.'当指定Method为adaptive时生效。'."\n"
."\n"
.'值范围:[0,1]。'."\n"
."\n"
.'默认值:0.9。',
'type' => 'string',
],
],
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '500',
],
],
],
'Id' => [
'description' => '转码模板ID。建议您保存此ID便于后续调用其他相关接口时使用。',
'type' => 'string',
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。',
'type' => 'string',
'example' => 'mp4',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FA258E67-09B8-4EAA-8F33-BA567834A2C3\\",\\n \\"Template\\": {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"1500\\",\\n \\"Min\\": \\"800\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10s\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"fast\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"0\\",\\n \\"Hdr2sdr\\": \\"true\\",\\n \\"NarrowBand\\": {\\n \\"Version\\": \\"1.0\\",\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1\\n }\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"rescale\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"sierra\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"mps-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"true\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"5\\",\\n \\"Channels\\": \\"2\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"Level\\": \\"-20\\",\\n \\"IntegratedLoudnessTarget\\": \\"\\",\\n \\"TruePeak\\": \\"\\",\\n \\"LoudnessRangeTarget\\": \\"\\",\\n \\"PeakLevel\\": \\"\\"\\n },\\n \\"Bitrate\\": \\"500\\"\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FA258E67-09B8-4EAA-8F33-BA567834A2C3\\n \\n \\n \\n true\\n onepass\\n true\\n true\\n rescale\\n true\\n true\\n true\\n \\n Narmal\\n \\n \\n 0\\n \\n \\n 0\\n sierra\\n 0\\n false\\n \\n \\n 10\\n \\n \\n mps-example\\n \\n 16f01ad6175e4230ac42bb5182cd****\\n \\n mp4\\n \\n \\n","errorExample":""}]',
'title' => '新增自定义转码模版',
'summary' => '创建自定义模板,包含容器信息,视频跟音频流等设置。',
'description' => '本接口参数中包含容器信息、视频和音频流等设置,如果相应部分不做设置,则使用模板转出来的码流中也不会包含相应的信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => '**JSON对象Container详情**'."\n"
."\n"
.'|参数|值类型|是否必选|描述|'."\n"
.'|----|----|----|----|'."\n"
.'|Format |String | 否| 默认值:mp4。视频转码支持flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。音频转码支持mp3、mp4、ogg、flac、m4a。图片支持gif、WEBP。容器格式为gif时,Video Codec设置只能设置为GIF,容器格式为webp时,Video Codec设置只能设置为WEBP,容器格式为flv时,Video Codec不能设置为H.265。|'."\n"
."\n"
.'**JSON对象Video详情**'."\n"
."\n"
.'| 参数 |值类型 |是否必选|描述 |'."\n"
.'|-----|-------|---------|-----|'."\n"
.'| Codec | String | 否 | 编解码格式。支持H.264、H.265、GIF、WEBP,默认值:H.264。|'."\n"
.'| Profile | String | 否 | 编码级别。支持baseline(适合移动设备)、main(适合标准分辨率设备)、high(适合高分辨率设备),默认值:high。最佳实践:如果您有多个清晰度,建议最低清晰度配成baseline,以保证最低端设备可播放。其他清晰度配置为main或high。目前仅H.264支持此参数。 |'."\n"
.'|Bitrate | String | 否 | 值范围:10~50000,单位:Kbps。|'."\n"
.'|Crf |String |否 |码率-质量控制因子。值范围:0~51,默认值:26。如果设置了Crf,则Bitrate的设置失效。 |'."\n"
.'| Width |String | 否 | 宽。默认值:视频原始宽度,值范围:128~4096,单位:px。|'."\n"
.'| Height |String |否 | 高。默认值:视频原始高度,值范围:128~4096,单位:px。 |'."\n"
.'|Fps |String |否 |帧率。默认值:取输入文件帧率。当输入文件帧率超过60时取60。值范围:0~60。单位:fps。|'."\n"
.'|Gop |String |否 |关键帧间最大时间间隔或者最大帧数。最大时间间隔时,必传单位s。默认值:10s。最大帧数时,无单位,值范围:1~100000。 |'."\n"
.'|Preset | String | 否 |视频算法器预置。支持veryfast(超快)、fast(快)、medium(中等)、slow(慢)、slower(超慢)。默认值:medium。目前仅H.264支持此参数。 |'."\n"
.'| ScanMode | String | 否 | 扫描模式。支持interlaced、progressive。 |'."\n"
.'| Bufsize | String | 否 | 缓冲区大小。值范围:[1000,128000],默认值:6000,单位:Kb。 |'."\n"
.'| Maxrate| String | 否 | 视频码率峰值。值范围[10,50000],单位Kbps。 |'."\n"
.'| PixFmt | String | 否 | 视频颜色格式。范围yuv420p,yuvj420p等标准颜色格式。默认值:yuv420p或原始颜色格式。 |'."\n"
.'| Remove | String | 否 | 是否删除视频流。true表示删除,false表示保留,默认值:false。 |'."\n"
.'| Crop | String | 否 | 视频画面裁切。支持2种方式:自动检测黑边并裁切,设置为“border”。自定义裁切,参数格式:width:height:left:top。示例:1280:800:0:140。 |'."\n"
.'| Pad | String | 否 | 视频贴黑边。参数格式:width:height:left:top。示例:1280:800:0:140 。|'."\n"
.'| LongShortMode | String | 否 | 是否开启横竖屏自适应(即:长短边模式)。转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽),true表示开启,false表示关闭,默认值:false。 |'."\n"
."\n"
.'以下表格显示视频转码编解码格式与容器格式的组合支持情况:'."\n"
."\n"
.'| Container | Audio Codecs | Video Codecs |'."\n"
.'|:---------|:-------|:---------|'."\n"
.'| flv | AAC、MP3 | H.264 |'."\n"
.'| mp4 | AAC、MP3 | H.264、H.265 |'."\n"
.'| ts | AAC、MP3 | H.264、H.265 |'."\n"
.'| m3u8 | AAC、MP3 | H.264、H.265 |'."\n"
.'| gif | 不支持 | GIF |'."\n"
."\n"
.'以下表格显示视频编解码格式与视频流配置参数的组合支持情况:'."\n"
."\n"
.'|Video/Codec| H.264| H.265| GIF|'."\n"
.'|:---------|:-------|:---------|:---------|'."\n"
.'|Profile| Y| N| N|'."\n"
.'|Bitrate| Y| Y| N|'."\n"
.'|Crf| Y| Y| N|'."\n"
.'|Width| Y| Y| Y|'."\n"
.'|Height| Y| Y| Y|'."\n"
.'|Fps| Y| Y| Y|'."\n"
.'|Gop| Y| Y| N|'."\n"
.'|Preset| Y| N| N|'."\n"
.'|ScanMode| Y| Y| Y|'."\n"
.'|Bufsize| Y| Y| N|'."\n"
.'|Maxrate| Y| Y| N|'."\n"
.'|PixFmt| Y| Y| bgr8|'."\n"
."\n"
.'**JSON对象Audio详情**'."\n"
."\n"
.'| 参数 | 值类型 | 是否必选 | 描述 |'."\n"
.'|:---------|:-------|:---------|:---------|'."\n"
.'| Codec | String | 否 | 音频编解码格式,AAC、MP3、VORBIS、FLAC。默认值:AAC。 |'."\n"
.'| Profile | String | 否 | 音频编码预置。当Codec为AAC时,范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。 |'."\n"
.'| Samplerate | String | 否 | 采样率。默认值:44100,支持22050、32000、44100、48000、96000,单位:Hz。若视频容器格式为flv,音频编解码格式选择为mp3时,采样率不支持32000、48000、96000;音频编解码格式为mp3时,采样率不支持96000。 |'."\n"
.'| Bitrate | String | 否 | 输出文件的音频码率。值范围:[8,1000],单位:Kbps,默认值:128 。|'."\n"
.'| Channels | String | 否 | 声道数。默认值:2。当Codec设置为mp3时,声道数只支持1、2;当Codec设置为aac时,声道数只支持1、2、4、5、6、8。 |'."\n"
.'| Remove | String | 否 | 是否删除音频流。true表示删除,false表示保留,默认值:false。 |'."\n"
."\n"
.'以下表格显示音频转码编解码格式与容器格式的组合支持情况:'."\n"
."\n"
.'|Container| Audio Codecs|'."\n"
.'|:---------|:-------|'."\n"
.'|mp3| MP3|'."\n"
.'|mp4| AAC|'."\n"
.'|ogg| VORBIS、FLAC|'."\n"
.'|flac| FLAC|'."\n"
."\n"
.'**JSON对象TransConfig详情**'."\n"
."\n"
.'| 参数 | 值类型 | 是否必选 | 描述 |'."\n"
.'|:---------|:-------|:---------|:---------|'."\n"
.'| TransMode | String | 否 | 转码模式。默认值:onepass,可选范围onepass、twopass、CBR。 |'."\n"
.'| AdjDarMethod | String | 否 | 分辨率改写方式。默认值:none,可选范围rescale、crop、pad、none。 |'."\n"
.'| IsCheckReso | String | 否 | 是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。true表示检查,false表示不检查,默认值:false。 |'."\n"
.'| IsCheckResoFail | String | 否 | 是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。true表示检查,false表示不检查,默认值:false。 |'."\n"
.'| IsCheckVideoBitrate | String | 否 | 是否检查视频码率。如果视频输出码率大于视频输入码率,则视频输出码率等于视频输入码率。true表示检查,false表示不检查,默认值:false。|'."\n"
.'| IsCheckAudioBitrate | String | 否 | 是否检查音频码率。如果音频输出码率大于音频输入码率,则音频输出码率等于音频输入码率。true表示检查,false表示不检查,默认值:false。 |'."\n"
.'| IsCheckAudioBitrateFail | String | 否 | 当输出音频码率大于媒体源音频码率时,true表示不进行转码,false表示不检查,默认值:false,此值优先级大于IsCheckAudioBitrate。 |'."\n"
.'| IsCheckVideoBitrateFail | String | 否 | 当输出视频码率大于媒体源视频码率时,true表示不进行转码,false表示不检查,默认值:false,此值优先级大于IsCheckVideoBitrate。 |'."\n"
."\n"
.'**JSON对象MuxConfig详情**'."\n"
."\n"
.'| 参数 | 值类型 | 是否必选 | 描述 |'."\n"
.'|:---------|:-------|:---------|:---------|'."\n"
.'| Segment | String | 否 | JSON对象,切片配置字段。参见Segment详情。|'."\n"
."\n"
.'**Segment详情**'."\n"
."\n"
.'| 参数 | 值类型 | 是否必选 | 描述 |'."\n"
.'|:---------|:-------|:---------|:---------|'."\n"
.'| Duration | String | 否 | 分片时长。整数值,单位:秒,范围:[1,60],默认值:10秒。 |'."\n"
.'| ForceSegTime | String | 否 | 指定分片时间列表,逗号分隔,最多可指定10个分片时间点。小数型,支持3位小数,单位:秒。示例:23、55、60,代表在23,55,60秒处分片。 |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '模板ID。可以从[新增自定义转码模板](~~213306~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '模板名称。最大长度128字节。',
'type' => 'string',
'required' => true,
'example' => 'MPS-example',
],
],
[
'name' => 'Container',
'in' => 'query',
'schema' => [
'description' => '容器,JSON对象。默认值:**mp4**'."\n"
."\n"
.'- 视频转码支持flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。'."\n"
."\n"
.'- 音频转码支持mp3、mp4、ogg、flac、m4a。'."\n"
."\n"
.'- 图片支持gif、WEBP。'."\n"
."\n"
.'更多信息请参见参数详情[Container详情](~~29253~~)。'."\n",
'type' => 'string',
'required' => false,
'example' => '{"Format":"mp4"}',
],
],
[
'name' => 'Video',
'in' => 'query',
'schema' => [
'description' => '视频流配置,JSON对象。更多信息请参见参数详情[Video详情](~~29253~~)。',
'type' => 'string',
'required' => false,
'example' => '{"Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10"}',
],
],
[
'name' => 'Audio',
'in' => 'query',
'schema' => [
'description' => '音频流配置,JSON对象。更多信息请参见参数详情[Audio详情](~~29253~~)。',
'type' => 'string',
'required' => false,
'example' => '{"Codec":"aac","Samplerate":"44100","Bitrate":"500","Channels":"2"}',
],
],
[
'name' => 'MuxConfig',
'in' => 'query',
'schema' => [
'description' => '封包配置,JSON对象。更多信息请参见参数详情[MuxConfig详情](~~29253~~)。',
'type' => 'string',
'required' => false,
'example' => '{"Segment":{"Duration":"10"}}',
],
],
[
'name' => 'TransConfig',
'in' => 'query',
'schema' => [
'description' => '转码通用配置,JSON对象。更多信息请参见参数详情[TransConfig](~~29253~~)。',
'type' => 'string',
'required' => false,
'example' => '{"TransMode":"onepass"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21',
],
'Template' => [
'description' => '转码模板类型。',
'type' => 'object',
'properties' => [
'Video' => [
'description' => '视频编解码配置。'."\n",
'type' => 'object',
'properties' => [
'LongShortMode' => [
'description' => '是否开启横竖屏自适应(即:长短边模式)。'."\n"
."\n"
.'- 转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽)。'."\n"
.'- **true**表示开启。'."\n"
.'- **false**表示关闭。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 单位:Kb。'."\n"
.'- 默认值:**6000**。',
'type' => 'string',
'example' => '6000',
],
'Degrain' => [
'description' => '视频质量控制度。',
'type' => 'string',
'example' => '10',
],
'BitrateBnd' => [
'description' => '视频平均码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '总码率上限。单位:Kbps。',
'type' => 'string',
'example' => '500',
],
'Min' => [
'description' => '总码率下限。单位:Kbps。',
'type' => 'string',
'example' => '100',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。范围:yuv420p、yuvj420p等标准颜色格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Pad' => [
'description' => '视频贴黑边。 '."\n"
."\n"
.'- 参数格式:width:height:left:top。'."\n"
."\n"
.'- 示例:1280:800:0:140。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Codec' => [
'description' => '编解码格式。默认值:**H.264**。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '高。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始高度**。',
'type' => 'string',
'example' => '800',
],
'Qscale' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '1',
],
'Crop' => [
'description' => '视频画面裁切。支持2种方式:'."\n"
.'- **自动检测黑边并裁切**:设置为“border”。'."\n"
.'- **自定义裁切**:自定义格式进行裁剪。参数格式:width:height:left:top。示例:1280:800:0:140。',
'type' => 'string',
'example' => 'border',
],
'Bitrate' => [
'description' => '视频平均码率。单位:Kbps。',
'type' => 'string',
'example' => '200',
],
'Maxrate' => [
'description' => '视频码率峰值。单位:(Kbps)。',
'type' => 'string',
'example' => '500',
],
'MaxFps' => [
'description' => '最大帧率。',
'type' => 'string',
'example' => '60',
],
'Profile' => [
'description' => '编码级别。'."\n"
."\n"
.'- **baseline**:针对移动设备。'."\n"
.'- **main**:针对标准分辨率设备。'."\n"
.'- **high**:针对高分辨率设备。'."\n"
.'- 默认值:**high**。',
'type' => 'string',
'example' => 'high',
],
'Crf' => [
'description' => '码率-质量控制因子。'."\n"
."\n"
.'- 默认值:编码格式为H264,默认值为**23**。编码格式为H265,默认值为**26**。'."\n"
.'- 如果设置了Crf,则Bitrate的设置失效。',
'type' => 'string',
'example' => '15',
],
'Remove' => [
'description' => '是否删除视频流 '."\n"
."\n"
.'- **true**表示删除。'."\n"
.'- **false**表示保留。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Gop' => [
'description' => '关键帧间最大帧数。默认值:**250**。',
'type' => 'string',
'example' => '10',
],
'Width' => [
'description' => '视频宽。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始宽度**。',
'type' => 'string',
'example' => '256',
],
'Fps' => [
'description' => '帧率。'."\n"
."\n"
.'- 当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取**输入文件帧率**。',
'type' => 'string',
'example' => '25',
],
'Preset' => [
'description' => '视频算法器预置。默认值:**medium**。可选值:'."\n"
."\n"
.'- **veryfast**:超快。'."\n"
."\n"
.'- **fast**:快。'."\n"
."\n"
.'- **medium**:中等。'."\n"
."\n"
.'- **slow**:慢。'."\n"
."\n"
.'- **slower**:超慢。',
'type' => 'string',
'example' => 'medium',
],
'ScanMode' => [
'description' => '扫描模式。可选值:'."\n"
."\n"
.'- **interlaced**:交叉扫描。'."\n"
."\n"
.'- **progressive**:顺序扫描。',
'type' => 'string',
'example' => 'interlaced',
],
'ResoPriority' => [
'description' => '分辨率调整优先级',
'type' => 'string',
'example' => '1',
],
'Hdr2sdr' => [
'description' => '是否开启hdr2sdr功能。启用时会把hdr的视频转成sdr。',
'type' => 'string',
'example' => 'true',
],
'NarrowBand' => [
'description' => '窄带高清设置参数。',
'type' => 'object',
'properties' => [
'Version' => [
'description' => '窄带高清版本,可选值:1.0 。',
'type' => 'string',
'example' => '1.0',
],
'Abrmax' => [
'description' => '动态码率上限,设置后平均码率范围 (0, 1000000]。',
'type' => 'number',
'format' => 'float',
'example' => '3000',
],
'MaxAbrRatio' => [
'description' => '码率上限最大倍率,设置后 abrmax 不会超过视频源码率的 x 倍。范围 (0, 1.0]。',
'type' => 'number',
'format' => 'float',
'example' => '1.0',
],
],
],
],
],
'TransConfig' => [
'description' => '转码通用配置。'."\n",
'type' => 'object',
'properties' => [
'IsCheckAudioBitrate' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于IsCheckAudioBitrateFail。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:'."\n"
.' - 参数为空,并且codec和输入源不一样:false。'."\n"
.' - 参数为空,并且codec和输入源一样:true。',
'type' => 'string',
'example' => 'false',
],
'TransMode' => [
'description' => '转码模式。默认值:**onepass**。可选范围:'."\n"
."\n"
.'- **onepass**'."\n"
."\n"
.'- **twopass**'."\n"
."\n"
.'- **CBR**',
'type' => 'string',
'example' => 'onepass',
],
'IsCheckReso' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckVideoBitrateFail' => [
'description' => '是否检查视频码率。此值优先级大于IsCheckVideoBitrate。'."\n"
."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。'."\n",
'type' => 'string',
'example' => 'false',
],
'AdjDarMethod' => [
'description' => '分辨率改写方式。默认值:**none**。可选值:'."\n"
."\n"
.'- rescale:范围拉伸'."\n"
."\n"
.'- crop:批量裁剪'."\n"
."\n"
.'- none:不改变。',
'type' => 'string',
'example' => 'none',
],
'IsCheckVideoBitrate' => [
'description' => '是否检查视频码率。如果视频输出码率大于视频输入码率,则视频输出码率等于视频输入码率。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckResoFail' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckAudioBitrateFail' => [
'description' => '是否检查音频码率。此值优先级大于IsCheckAudioBitrate。'."\n"
."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。'."\n",
'type' => 'string',
'example' => 'false',
],
],
],
'State' => [
'description' => '模板的状态。'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'MuxConfig' => [
'description' => '转码封包配置。'."\n",
'type' => 'object',
'properties' => [
'Webp' => [
'description' => 'Webp对应的封包配置。',
'type' => 'object',
'properties' => [
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
],
],
'Gif' => [
'description' => 'Gif对应的封包配置。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => '终帧暂停时间。单位:毫秒(ms)。',
'type' => 'string',
'example' => 'false',
],
'DitherMode' => [
'description' => '调色板颜色抖动方式。抖动算法可选值为sierra算法和bayer算法。',
'type' => 'string',
'example' => 'bayer',
],
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
'IsCustomPalette' => [
'description' => '自定义调色板功能。',
'type' => 'string',
'example' => '0',
],
],
],
'Segment' => [
'description' => '切片配置。'."\n",
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。单位:秒(s)。',
'type' => 'string',
'example' => '10',
],
],
],
],
],
'Name' => [
'description' => '模板名称。'."\n",
'type' => 'string',
'example' => 'MPS-example',
],
'Audio' => [
'description' => '音频编解码配置。'."\n",
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当**Codec**为**aac**时可选值:'."\n"
."\n"
.'- **aac_low**'."\n"
."\n"
.'- **aac_he**'."\n"
."\n"
.'- **aac_he_v2**'."\n"
."\n"
.'- **aac_ld**'."\n"
."\n"
.'- **aac_eld**',
'type' => 'string',
'example' => 'aac_low',
],
'Remove' => [
'description' => '是否删除音频流。'."\n"
."\n"
.'- **true**表示删除。'."\n"
.'- **false**表示保留。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Codec' => [
'description' => '音频编解码格式。默认值:**aac**。可选值:'."\n"
."\n"
.'- **aac**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **vorbis**'."\n"
."\n"
.'- **flac** ',
'type' => 'string',
'example' => 'aac',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 单位:Hz。'."\n"
.'- 默认值:**44100**。',
'type' => 'string',
'example' => '44100',
],
'Qscale' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '1',
],
'Channels' => [
'description' => '声道数。默认值:**2**。',
'type' => 'string',
'example' => '2',
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 取值范围:**\\[8,1000\\]**。'."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '500',
],
'Volume' => [
'description' => '音量控制。',
'type' => 'object',
'properties' => [
'Method' => [
'description' => '音量调整方式。可取值:'."\n"
."\n"
.'- **auto**:自动调整。'."\n"
.'- **dynamic**:动态调整。'."\n"
."\n"
.'- **linear**:线性调整。',
'type' => 'string',
'example' => 'auto',
],
'TruePeak' => [
'description' => '最大峰值。'."\n"
.'- 当指定Method为dynamic时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:[-9,0]。'."\n"
.'- 默认值:-1。',
'type' => 'string',
'example' => '-1',
],
'IntegratedLoudnessTarget' => [
'description' => '目标音量。'."\n"
.'- 当指定Method为dynamic时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:[-70,-5]。'."\n"
.'- 默认值:-6。',
'type' => 'string',
'example' => '-6',
],
'Level' => [
'description' => '相对输入音频的音量提升的幅度。'."\n"
.'- 当指定Method为linear时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:不超过20db。'."\n"
.'- 默认值:-20db。',
'type' => 'string',
'example' => '-20',
],
'LoudnessRangeTarget' => [
'description' => '相对目标音量的波动范围。'."\n"
.'- 当指定Method为dynamic时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:[1,20]。'."\n"
.'- 默认值:8。',
'type' => 'string',
'example' => '8',
],
'PeakLevel' => [
'title' => '音量调整系数。'."\n"
."\n"
.'当指定Method为adaptive时生效。'."\n"
."\n"
.'值范围:[0,1]。'."\n"
."\n"
.'默认值:0.9。',
'description' => '音量调整系数。'."\n"
."\n"
.'当指定Method为adaptive时生效。'."\n"
."\n"
.'值范围:[0,1]。'."\n"
."\n"
.'默认值:0.9。',
'type' => 'string',
'example' => '0.9',
],
],
],
],
],
'Id' => [
'description' => '转码模板ID。',
'type' => 'string',
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
'Container' => [
'description' => '容器。'."\n",
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。',
'type' => 'string',
'example' => 'mp4',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21\\",\\n \\"Template\\": {\\n \\"Video\\": {\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"500\\",\\n \\"Min\\": \\"100\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"200\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\",\\n \\"Hdr2sdr\\": \\"true\\",\\n \\"NarrowBand\\": {\\n \\"Version\\": \\"1.0\\",\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1\\n }\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"false\\",\\n \\"DitherMode\\": \\"bayer\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"0\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"MPS-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"false\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"Level\\": \\"-20\\",\\n \\"LoudnessRangeTarget\\": \\"8\\",\\n \\"PeakLevel\\": \\"0.9\\"\\n }\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21\\n \\n \\n \\n false\\n onepass\\n false\\n false\\n none\\n false\\n false\\n false\\n \\n Normal\\n \\n \\n 0\\n \\n \\n false\\n bayer\\n 0\\n 0\\n \\n \\n 10\\n \\n \\n MPS-example\\n \\n 16f01ad6175e4230ac42bb5182cd****\\n \\n mp4\\n \\n \\n","errorExample":""}]',
'title' => '更新自定义转码模版',
'summary' => '更新自定义转码模板设置。',
'description' => '如果有状态为“已提交”的作业指定使用该自定义模板,则相应的转码模板信息不能被更新。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTemplateList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'TemplateIds',
'in' => 'query',
'schema' => [
'description' => '需要查询的模板ID列表。最多一次查询10个,用半角逗号(,)分隔。 ',
'type' => 'string',
'required' => true,
'example' => '16f01ad6175e4230ac42bb5182cd****,88c6ca184c0e424d5w5b665e2a12****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'NonExistTids' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的模板列表。',
'type' => 'array',
'items' => [
'description' => '不存在的模板列表,无数据时该参数不返回。',
'type' => 'string',
'example' => '88c6ca184c0e424d5w5b665e2a12****',
],
],
],
],
'TemplateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '转码模板列表。',
'type' => 'array',
'items' => [
'description' => '转码模板。',
'type' => 'object',
'properties' => [
'Video' => [
'description' => '视频编解码配置。',
'type' => 'object',
'properties' => [
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 单位:Kb。'."\n"
.'- 默认值:**6000**。',
'type' => 'string',
'example' => '6000',
],
'LongShortMode' => [
'description' => '是否开启横竖屏自适应(即:长短边模式)。'."\n"
."\n"
.'- 转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽)。'."\n"
.'- **true**表示开启。'."\n"
.'- **false**表示关闭。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Degrain' => [
'description' => '视频质量控制度 。',
'type' => 'string',
'example' => '10',
],
'BitrateBnd' => [
'description' => '视频平均码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '总码率上限。单位:Kbps。',
'type' => 'string',
'example' => '100',
],
'Min' => [
'description' => '总码率下限。单位:Kbps。',
'type' => 'string',
'example' => '500',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。范围:yuv420p,yuvj420p等标准颜色格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Pad' => [
'description' => '视频贴黑边。参数格式:width:height:left:top。示例:1280:800:0:140。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Codec' => [
'description' => '编解码格式。默认值:**H.264**。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '视频高。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始高度**。',
'type' => 'string',
'example' => '800',
],
'Qscale' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '1',
],
'Crop' => [
'description' => '视频画面裁切。'."\n"
.'- **自动检测黑边并裁切**:设置为“border”.'."\n"
.'- **自定义裁切**:自定义参数并裁剪。参数格式:width:height:left:top。示例:1280:800:0:140。',
'type' => 'string',
'example' => 'border',
],
'Bitrate' => [
'description' => '视频平均码率。单位:Kbps。',
'type' => 'string',
'example' => '200',
],
'Maxrate' => [
'description' => '视频码率峰值。单位:Kbps。',
'type' => 'string',
'example' => '500',
],
'MaxFps' => [
'description' => '最大帧率。',
'type' => 'string',
'example' => '60',
],
'Profile' => [
'description' => '编码级别。'."\n"
.'- **baseline**:针对移动设备。'."\n"
.'- **main**:针对标准分辨率设备。'."\n"
.'- **high**:针对高分辨率设备。'."\n"
.'- 默认值:**high**。',
'type' => 'string',
'example' => 'high',
],
'Crf' => [
'description' => '码率-质量控制因子。'."\n"
."\n"
.'- 默认值:编码格式为H264,默认值为**23**。编码格式为H265,默认值为**26**。'."\n"
.'- 如果设置了Crf,则Bitrate的设置失效。',
'type' => 'string',
'example' => '15',
],
'Remove' => [
'description' => '是否删除视频流。 '."\n"
."\n"
.'- **true**表示删除。'."\n"
.'- **false**表示保留。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Gop' => [
'description' => '关键帧间最大帧数。默认值:**250**。',
'type' => 'string',
'example' => '10',
],
'Width' => [
'description' => '宽。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始宽度**。',
'type' => 'string',
'example' => '256',
],
'Fps' => [
'description' => '帧率。'."\n"
."\n"
.'- 当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取**输入文件帧率**。',
'type' => 'string',
'example' => '25',
],
'Preset' => [
'description' => '视频算法器预置。支持veryfast(超快)、fast(快)、medium(中等)、slow(慢)、slower(超慢)。默认值:**medium**。',
'type' => 'string',
'example' => 'medium',
],
'ScanMode' => [
'description' => '扫描模式。可选值:'."\n"
."\n"
.'- **interlaced**:交叉扫描。'."\n"
."\n"
.'- **progressive**:顺序扫描。',
'type' => 'string',
'example' => 'interlaced',
],
'ResoPriority' => [
'description' => '分辨率调整优先级。支持cropFirst(裁剪优先)、widthFirst(宽度优先)、heightFirst(高度优先)。',
'type' => 'string',
'example' => 'heightFirst',
],
'Hdr2sdr' => [
'description' => '是否开启hdr2sdr功能。启用时会把hdr的视频转成sdr。',
'type' => 'string',
'example' => 'true',
],
'NarrowBand' => [
'description' => '窄带高清设置参数。',
'type' => 'object',
'properties' => [
'Version' => [
'description' => '窄带高清版本,可选值:1.0 。',
'type' => 'string',
'example' => '1.0',
],
'Abrmax' => [
'description' => '动态码率上限,设置后平均码率范围 (0, 1000000]。',
'type' => 'number',
'format' => 'float',
'example' => '3000',
],
'MaxAbrRatio' => [
'description' => '码率上限最大倍率,设置后abrmax不会超过视频源码率的x倍。范围 (0, 1.0]。',
'type' => 'number',
'format' => 'float',
'example' => '1.0',
],
],
],
],
],
'TransConfig' => [
'description' => '转码通用配置。',
'type' => 'object',
'properties' => [
'IsCheckAudioBitrate' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于IsCheckAudioBitrateFail。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:'."\n"
.' - 参数为空,并且codec和输入源不一样:false。'."\n"
.' - 参数为空,并且codec和输入源一样:true。',
'type' => 'string',
'example' => 'false',
],
'TransMode' => [
'description' => '转码模式。默认值:**onepass**。可选值:'."\n"
."\n"
.'- **onepass**'."\n"
."\n"
.'- **twopass**'."\n"
."\n"
.'- **CBR**',
'type' => 'string',
'example' => 'onepass',
],
'IsCheckReso' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckVideoBitrateFail' => [
'description' => '是否允许视频码率检查错误。此值优先级大于IsCheckVideoBitrate。'."\n"
."\n"
.'- **true**表示检查出错时不进行转码。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。'."\n",
'type' => 'string',
'example' => 'false',
],
'AdjDarMethod' => [
'description' => '分辨率改写方式。默认值:**none**。可选值:'."\n"
."\n"
.'- rescale:范围拉伸。'."\n"
."\n"
.'- crop:批量裁剪。'."\n"
."\n"
.'- none:不改变。',
'type' => 'string',
'example' => 'none',
],
'IsCheckVideoBitrate' => [
'description' => '是否检查视频码率。如果视频输出码率大于视频输入码率,则视频输出码率等于视频输入码率。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckResoFail' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckAudioBitrateFail' => [
'description' => '是否允许音频码率检查错误。此值优先级大于IsCheckAudioBitrate。'."\n"
."\n"
.'- **true**表示检查出错时不进行转码。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
],
],
'State' => [
'description' => '模板的状态。'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'MuxConfig' => [
'description' => '转码封包配置。',
'type' => 'object',
'properties' => [
'Webp' => [
'description' => 'Webp对应的封包配置。',
'type' => 'object',
'properties' => [
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
],
],
'Gif' => [
'description' => 'Gif对应的封包配置。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => '终帧暂停时间。',
'type' => 'string',
'example' => '0',
],
'DitherMode' => [
'description' => '调色板颜色抖动方式。抖动算法可选值为sierra算法和bayer算法。',
'type' => 'string',
'example' => 'sierra',
],
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
'IsCustomPalette' => [
'description' => '自定义调色板功能。',
'type' => 'string',
'example' => 'false',
],
],
],
'Segment' => [
'description' => '切片配置。'."\n",
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。单位:秒。',
'type' => 'string',
'example' => '10',
],
],
],
],
],
'Name' => [
'description' => '模板名称。',
'type' => 'string',
'example' => 'MPS-example',
],
'Audio' => [
'description' => '音频编解码配置。',
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当Codec为aac时可选值:'."\n"
."\n"
.'- **aac_low**'."\n"
."\n"
.'- **aac_he**'."\n"
."\n"
.'- **aac_he_v2**'."\n"
."\n"
.'- **aac_ld**'."\n"
."\n"
.'- **aac_eld**',
'type' => 'string',
'example' => 'aac_low',
],
'Remove' => [
'description' => '是否删除音频流。'."\n"
."\n"
.'- **true**表示删除。'."\n"
.'- **false**表示保留。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Codec' => [
'description' => '音频编解码格式。默认值:**aac**。可选值:'."\n"
."\n"
.'- **aac**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **vorbis**'."\n"
."\n"
.'- **flac**',
'type' => 'string',
'example' => 'aac',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 单位:Hz。'."\n"
.'- 默认值:**44100**。',
'type' => 'string',
'example' => '44100',
],
'Qscale' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '1',
],
'Channels' => [
'description' => '声道数。默认值:**2**。',
'type' => 'string',
'example' => '2',
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 取值范围:**\\[8,1000\\]**。'."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '500',
],
'Volume' => [
'description' => '音量控制。',
'type' => 'object',
'properties' => [
'Method' => [
'description' => '音量调整方式。可取值:'."\n"
."\n"
.'- **auto**:自动调整。'."\n"
.'- **dynamic**:动态调整。'."\n"
."\n"
.'- **linear**:线性调整。'."\n"
.'- 默认值:dynamic。',
'type' => 'string',
'example' => 'auto',
],
'TruePeak' => [
'description' => '最大峰值。'."\n"
.'- 当指定Method为dynamic时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:[-9,0]。'."\n"
.'- 默认值:-1。',
'type' => 'string',
'example' => '-1',
],
'IntegratedLoudnessTarget' => [
'description' => '目标音量。'."\n"
.'- 当指定Method为dynamic时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:[-70,-5]。'."\n"
.'- 默认值:-6。',
'type' => 'string',
'example' => '-6',
],
'LoudnessRangeTarget' => [
'description' => '相对目标音量的波动范围。'."\n"
.'- 当指定Method为dynamic时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:[1,20]。'."\n"
.'- 默认值:8。',
'type' => 'string',
'example' => '8',
],
'Level' => [
'description' => '相对输入音频的音量提升的幅度。'."\n"
.'- 当指定Method为linear时生效。'."\n"
.'- 单位:db。'."\n"
.'- 值范围:不超过20db。'."\n"
.'- 默认值:-20db。',
'type' => 'string',
'example' => '-20',
],
'PeakLevel' => [
'title' => '音量调整系数。'."\n"
."\n"
.'当指定Method为adaptive时生效。'."\n"
."\n"
.'值范围:[0,1]。'."\n"
."\n"
.'默认值:0.9。',
'description' => '音量调整系数。'."\n"
."\n"
.'当指定Method为adaptive时生效。'."\n"
."\n"
.'值范围:[0,1]。'."\n"
."\n"
.'默认值:0.9。',
'type' => 'string',
'example' => '0.9',
],
],
],
],
],
'Id' => [
'description' => '转码模板ID。',
'type' => 'string',
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。可选范围flv、mp4、ts、m3u8、gif、mp3、ogg、flac。',
'type' => 'string',
'example' => 'flv',
],
],
],
'CreationTime' => [
'description' => '模板创建时间。',
'type' => 'string',
'example' => '2021-03-04T06:44:43Z',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'BC860F04-778A-472F-AB39-E1BF329C1EA8',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistTids\\": {\\n \\"String\\": [\\n \\"88c6ca184c0e424d5w5b665e2a12****\\"\\n ]\\n },\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"100\\",\\n \\"Min\\": \\"500\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"200\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"heightFirst\\",\\n \\"Hdr2sdr\\": \\"true\\",\\n \\"NarrowBand\\": {\\n \\"Version\\": \\"1.0\\",\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1\\n }\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Webp\\": {\\n \\"Loop\\": \\"0\\"\\n },\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"sierra\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"MPS-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"false\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"LoudnessRangeTarget\\": \\"8\\",\\n \\"Level\\": \\"-20\\",\\n \\"PeakLevel\\": \\"0.9\\"\\n }\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"flv\\"\\n },\\n \\"CreationTime\\": \\"2021-03-04T06:44:43Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"BC860F04-778A-472F-AB39-E1BF329C1EA8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 88c6ca184c0e424d5w5b665e2a12****\\n \\n \\n \\n false\\n onepass\\n false\\n false\\n none\\n false\\n false\\n false\\n \\n Normal\\n \\n \\n 0\\n \\n \\n 0\\n sierra\\n 0\\n false\\n \\n \\n 10\\n \\n \\n MPS-example\\n \\n 16f01ad6175e4230ac42bb5182cd****\\n \\n flv\\n \\n \\n BC860F04-778A-472F-AB39-E1BF329C1EA8\\n","errorExample":""}]',
'title' => '通过自定义模版ID查询转码模板详情',
'summary' => '查询转码模板详细信息。',
'description' => '本接口一次最多可查询10个模板信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SearchTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '结果分页查询时设置的每页大小。'."\n"
."\n"
.'- 上限值:**100**。'."\n"
.'- 默认值:**10**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页号。默认值:**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '需要搜索的转码模板状态。'."\n"
."\n"
.'- **All**表示所有。'."\n"
.'- **Normal**表示正常。'."\n"
.'- **Deleted**表示已删除。'."\n"
."\n"
.'- 默认值:**All**。',
'type' => 'string',
'required' => false,
'example' => 'Normal',
'default' => 'All',
],
],
[
'name' => 'NamePrefix',
'in' => 'query',
'schema' => [
'description' => '按模板名称前缀搜索时填入的前缀。',
'type' => 'string',
'required' => false,
'example' => 'S00000001',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '搜索结果总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TemplateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '转码模板列表。',
'type' => 'array',
'items' => [
'description' => '转码模板。',
'type' => 'object',
'properties' => [
'Video' => [
'description' => '视频编解码配置。'."\n",
'type' => 'object',
'properties' => [
'Bufsize' => [
'description' => '缓冲区大小。'."\n"
."\n"
.'- 单位:Kb。'."\n"
.'- 默认值:**6000**。',
'type' => 'string',
'example' => '6000',
],
'LongShortMode' => [
'description' => '是否开启横竖屏自适应(即:长短边模式)。'."\n"
."\n"
.'- 转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽)。'."\n"
.'- **true**表示开启。'."\n"
.'- **false**表示关闭。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Degrain' => [
'description' => '视频质量控制度。',
'type' => 'string',
'example' => '10',
],
'BitrateBnd' => [
'description' => '视频平均码率范围。',
'type' => 'object',
'properties' => [
'Max' => [
'description' => '总码率上限。单位:Kbps。',
'type' => 'string',
'example' => '500',
],
'Min' => [
'description' => '总码率下限。单位:Kbps。',
'type' => 'string',
'example' => '100',
],
],
],
'PixFmt' => [
'description' => '视频颜色格式。范围:yuv420p,yuvj420p等标准颜色格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Pad' => [
'description' => '视频贴黑边。 '."\n"
."\n"
.'- 参数格式:width:height:left:top。'."\n"
.' '."\n"
.'- 示例:1280:800:0:140。',
'type' => 'string',
'example' => '1280:800:0:140',
],
'Codec' => [
'description' => '编解码格式。'."\n"
."\n"
.'- 可选值H.264、H.265。'."\n"
.'- 默认值:**H.264**。',
'type' => 'string',
'example' => 'H.264',
],
'Height' => [
'description' => '视频高。'."\n"
."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始高度**。',
'type' => 'string',
'example' => '800',
],
'Qscale' => [
'description' => '独立去噪算法强度。',
'type' => 'string',
'example' => '1',
],
'Crop' => [
'description' => '视频画面裁切。'."\n"
."\n"
.'- **自动检测黑边并裁切**:设置为“border”。'."\n"
.'- **自定义裁切**:自定义参数并裁剪。参数格式:width:height:left:top。示例:1280:800:0:140。',
'type' => 'string',
'example' => 'border',
],
'Bitrate' => [
'description' => '视频平均码率。单位:Kbps。',
'type' => 'string',
'example' => '200',
],
'Maxrate' => [
'description' => '视频码率峰值。单位:Kbps。',
'type' => 'string',
'example' => '500',
],
'NarrowBand' => [
'description' => '窄带高清设置参数。',
'type' => 'object',
'properties' => [
'Abrmax' => [
'description' => '动态码率上限,设置后平均码率范围 (0, 1000000]。',
'type' => 'number',
'format' => 'float',
'example' => '3000',
],
'MaxAbrRatio' => [
'description' => '码率上限最大倍率,设置后Abrmax值不会超过视频源码率的 x 倍。范围 (0, 1.0]。',
'type' => 'number',
'format' => 'float',
'example' => '1.0',
],
'Version' => [
'description' => '窄带高清版本,可选值:1.0 。',
'type' => 'string',
'example' => '1.0',
],
],
],
'MaxFps' => [
'description' => '最大帧率。',
'type' => 'string',
'example' => '60',
],
'Profile' => [
'description' => '编码级别。'."\n"
.'- **baseline**:针对移动设备。'."\n"
.'- **main**:针对标准分辨率设备。'."\n"
.'- **high**:针对高分辨率设备。'."\n"
.'- 默认值:**high**。',
'type' => 'string',
'example' => 'high',
],
'Crf' => [
'description' => '码率-质量控制因子。'."\n"
."\n"
.'- 默认值:编码格式为H264,默认值为**23**。编码格式为H265,默认值为**26**。'."\n"
.'- 如果设置了Crf,则Bitrate的设置失效。',
'type' => 'string',
'example' => '15',
],
'Remove' => [
'description' => '是否删除视频流。'."\n"
."\n"
.'- **true**表示删除。'."\n"
.'- **false**表示保留。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Gop' => [
'description' => '关键帧间最大帧数。默认值:**250**。',
'type' => 'string',
'example' => '10',
],
'Width' => [
'description' => '视频宽。'."\n"
."\n"
.' - 取值范围:**\\[128,4096\\]**。'."\n"
.'- 单位:px。'."\n"
.'- 默认值:**视频原始宽度**。',
'type' => 'string',
'example' => '256',
],
'Fps' => [
'description' => '帧率。'."\n"
."\n"
.'- 当输入文件帧率超过60时取60。'."\n"
.'- 默认值:取**输入文件帧率**。',
'type' => 'string',
'example' => '25',
],
'Preset' => [
'description' => '视频算法器预置。默认值:**medium**。可选值:'."\n"
."\n"
.'- **veryfast**:超快。'."\n"
."\n"
.'- **fast**:快。'."\n"
."\n"
.'- **medium**:中等。'."\n"
."\n"
.'- **slow**:慢。'."\n"
."\n"
.'- **slower**:超慢。'."\n",
'type' => 'string',
'example' => 'medium',
],
'ScanMode' => [
'description' => '扫描模式。可选值:'."\n"
."\n"
.'- **interlaced**:交叉扫描。'."\n"
."\n"
.'- **progressive**:顺序扫描。',
'type' => 'string',
'example' => 'interlaced',
],
'ResoPriority' => [
'description' => '分辨率调整优先级。',
'type' => 'string',
'example' => '1',
],
'Hdr2sdr' => [
'description' => '是否开启hdr2sdr功能。启用时会把hdr的视频转成sdr。',
'type' => 'string',
'example' => 'true',
],
],
],
'TransConfig' => [
'description' => '转码通用配置。'."\n",
'type' => 'object',
'properties' => [
'IsCheckAudioBitrate' => [
'description' => '是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于IsCheckAudioBitrateFail。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:'."\n"
.' - 参数为空,并且codec和输入源不一样:false。'."\n"
.' - 参数为空,并且codec和输入源一样:true。',
'type' => 'string',
'example' => 'false',
],
'TransMode' => [
'description' => '转码模式。默认值:**onepass**。可选值:'."\n"
."\n"
.'- **onepass**'."\n"
."\n"
.'- **twopass**'."\n"
."\n"
.'- **CBR**',
'type' => 'string',
'example' => 'onepass',
],
'IsCheckReso' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckVideoBitrateFail' => [
'description' => '是否允许视频码率检查错误。此值优先级大于IsCheckVideoBitrate。'."\n"
."\n"
.'- **true**表示检查出错时不进行转码。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'AdjDarMethod' => [
'description' => '分辨率改写方式。默认值:**none**。可选值:'."\n"
."\n"
.'- rescale:范围拉伸。'."\n"
."\n"
.'- crop:批量裁剪。'."\n"
."\n"
.'- none:不改变。',
'type' => 'string',
'example' => 'none',
],
'IsCheckVideoBitrate' => [
'description' => '是否检查视频码率。如果视频输出码率大于视频输入码率,则视频输出码率等于视频输入码率。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckResoFail' => [
'description' => '是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。'."\n"
.'- **true**表示检查。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'IsCheckAudioBitrateFail' => [
'description' => '是否允许音频码率检查错误。此值优先级大于IsCheckAudioBitrate。'."\n"
."\n"
.'- **true**表示检查出错时不进行转码。'."\n"
.'- **false**表示不检查。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
],
],
'State' => [
'description' => '模板的状态。'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'MuxConfig' => [
'description' => '转码封包配置。'."\n",
'type' => 'object',
'properties' => [
'Gif' => [
'description' => 'Gif对应的封包配置。',
'type' => 'object',
'properties' => [
'FinalDelay' => [
'description' => '终帧暂停时间,单位厘秒(cs)。',
'type' => 'string',
'example' => '0',
],
'DitherMode' => [
'description' => '调色板颜色抖动方式。可选的抖动算法为sierra算法和bayer算法。',
'type' => 'string',
'example' => 'sierra',
],
'Loop' => [
'description' => '循环次数。',
'type' => 'string',
'example' => '0',
],
'IsCustomPalette' => [
'description' => '自定义调色板功能。',
'type' => 'string',
'example' => 'false',
],
],
],
'Segment' => [
'description' => '切片配置。'."\n",
'type' => 'object',
'properties' => [
'Duration' => [
'description' => '分片时长。单位:秒。',
'type' => 'string',
'example' => '10',
],
],
],
],
],
'Name' => [
'description' => '模板名称。'."\n",
'type' => 'string',
'example' => 'MPS-example',
],
'Audio' => [
'description' => '音频编解码配置。'."\n",
'type' => 'object',
'properties' => [
'Profile' => [
'description' => '音频编码预置。当Codec为aac时可选值:'."\n"
."\n"
.'- **aac_low**'."\n"
."\n"
.'- **aac_he**'."\n"
."\n"
.'- **aac_he_v2**'."\n"
."\n"
.'- **aac_ld**'."\n"
."\n"
.'- **aac_eld**',
'type' => 'string',
'example' => 'aac_low',
],
'Remove' => [
'description' => '是否删除音频流。'."\n"
."\n"
.'- **true**表示删除。'."\n"
.'- **false**表示保留。'."\n"
.'- 默认值:**false**。',
'type' => 'string',
'example' => 'false',
],
'Codec' => [
'description' => '音频编解码格式。默认值:**aac**。可选值:'."\n"
."\n"
.'- **aac**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **vorbis**'."\n"
."\n"
.'- **flac**'."\n",
'type' => 'string',
'example' => 'aac',
],
'Samplerate' => [
'description' => '采样率。'."\n"
."\n"
.'- 单位:Hz。'."\n"
.'- 默认值:**44100**。',
'type' => 'string',
'example' => '44100',
],
'Qscale' => [
'description' => '独立去噪算法强度。取值:**\\[1,9\\]**。'."\n",
'type' => 'string',
'example' => '1',
],
'Channels' => [
'description' => '声道数。默认值:**2**。',
'type' => 'string',
'example' => '2',
],
'Bitrate' => [
'description' => '输出文件的音频码率。'."\n"
."\n"
.'- 单位:Kbps。'."\n"
.'- 默认值:**128**。',
'type' => 'string',
'example' => '500',
],
],
],
'Id' => [
'description' => '转码模板ID。',
'type' => 'string',
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
'Container' => [
'description' => '容器。',
'type' => 'object',
'properties' => [
'Format' => [
'description' => '容器格式。可选值:'."\n"
."\n"
.'- **flv**'."\n"
."\n"
.'- **mp4**'."\n"
."\n"
.'- **ts**'."\n"
."\n"
.'- **m3u8**'."\n"
."\n"
.'- **gif**'."\n"
."\n"
.'- **mp3**'."\n"
."\n"
.'- **ogg**'."\n"
."\n"
.'- **flac**',
'type' => 'string',
'example' => 'mp4',
],
],
],
'CreationTime' => [
'description' => '模板创建时间。',
'type' => 'string',
'example' => '2021-03-04T06:44:43Z',
],
],
],
],
],
],
'PageSize' => [
'description' => '分页查询时设置的每页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'BC860F04-778A-472F-AB39-E1BF329C****',
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Video\\": {\\n \\"Bufsize\\": \\"6000\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Degrain\\": \\"10\\",\\n \\"BitrateBnd\\": {\\n \\"Max\\": \\"500\\",\\n \\"Min\\": \\"100\\"\\n },\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"800\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Crop\\": \\"border\\",\\n \\"Bitrate\\": \\"200\\",\\n \\"Maxrate\\": \\"500\\",\\n \\"NarrowBand\\": {\\n \\"Abrmax\\": 3000,\\n \\"MaxAbrRatio\\": 1,\\n \\"Version\\": \\"1.0\\"\\n },\\n \\"MaxFps\\": \\"60\\",\\n \\"Profile\\": \\"high\\",\\n \\"Crf\\": \\"15\\",\\n \\"Remove\\": \\"false\\",\\n \\"Gop\\": \\"10\\",\\n \\"Width\\": \\"256\\",\\n \\"Fps\\": \\"25\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"interlaced\\",\\n \\"ResoPriority\\": \\"1\\",\\n \\"Hdr2sdr\\": \\"true\\"\\n },\\n \\"TransConfig\\": {\\n \\"IsCheckAudioBitrate\\": \\"false\\",\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"false\\",\\n \\"IsCheckVideoBitrateFail\\": \\"false\\",\\n \\"AdjDarMethod\\": \\"none\\",\\n \\"IsCheckVideoBitrate\\": \\"false\\",\\n \\"IsCheckResoFail\\": \\"false\\",\\n \\"IsCheckAudioBitrateFail\\": \\"false\\"\\n },\\n \\"State\\": \\"Normal\\",\\n \\"MuxConfig\\": {\\n \\"Gif\\": {\\n \\"FinalDelay\\": \\"0\\",\\n \\"DitherMode\\": \\"sierra\\",\\n \\"Loop\\": \\"0\\",\\n \\"IsCustomPalette\\": \\"false\\"\\n },\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\"\\n }\\n },\\n \\"Name\\": \\"MPS-example\\",\\n \\"Audio\\": {\\n \\"Profile\\": \\"aac_low\\",\\n \\"Remove\\": \\"false\\",\\n \\"Codec\\": \\"aac\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Qscale\\": \\"1\\",\\n \\"Channels\\": \\"2\\",\\n \\"Bitrate\\": \\"500\\"\\n },\\n \\"Id\\": \\"16f01ad6175e4230ac42bb5182cd****\\",\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"CreationTime\\": \\"2021-03-04T06:44:43Z\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"BC860F04-778A-472F-AB39-E1BF329C****\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n \\n \\n false\\n onepass\\n false\\n false\\n none\\n false\\n false\\n false\\n \\n Normal\\n \\n \\n 0\\n sierra\\n 0\\n false\\n \\n \\n 10\\n \\n \\n MPS-example\\n \\n 16f01ad6175e4230ac42bb5182cd****\\n \\n mp4\\n \\n \\n 10\\n BC860F04-778A-472F-AB39-E1BF329C****\\n 1\\n","errorExample":""}]',
'title' => '搜索自定义转码模板',
'summary' => '搜索指定状态的自定义模板。',
'description' => '本接口通过搜索转码模板状态搜索自定义模板。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '需要删除的自定义转码模板ID。可以通过**MPS控制台**>**全局设置**>**转码模板**获取。',
'type' => 'string',
'required' => true,
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2247541A-9F27-47EE-B6EC-484B5475****',
],
'TemplateId' => [
'description' => '已被删除的转码模板ID。',
'type' => 'string',
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2247541A-9F27-47EE-B6EC-484B5475****\\",\\n \\"TemplateId\\": \\"16f01ad6175e4230ac42bb5182cd****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2247541A-9F27-47EE-B6EC-484B5475****\\n 16f01ad6175e4230ac42bb5182cd****\\n","errorExample":""}]',
'title' => '删除自定义转码模板',
'summary' => '删除自定义模板。',
'description' => '如果有状态为“已提交”的作业指定使用该自定义转码模板,则相应的转码模板不能被删除。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddWaterMarkTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '水印模板名称。支持中英文,数字等,最大长度128字节。 ',
'type' => 'string',
'required' => true,
'example' => 'example-watermark-****',
],
],
[
'name' => 'Config',
'in' => 'query',
'schema' => [
'description' => '水印模板配置。JSON对象。更多信息请参见[水印模板配置详情](~~29253~~)。'."\n"
."\n"
.'> 如果水印文字不需要与分辨率变化正相关,可配置自适应,即在文字水印的text中添加选项`[\'adaptive\']=true`。 ',
'type' => 'string',
'required' => true,
'example' => '{"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'WaterMarkTemplate' => [
'description' => '水印模板。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '水印类型。可取值:'."\n"
."\n"
.'- Image:图片水印。'."\n"
."\n"
.'- Text:文字水印。',
'type' => 'string',
'example' => 'Image',
],
'RatioRefer' => [
'description' => '取值为百分比时参考的边。当Height,Width,Dx,Dy的取值处于(0,1)时,这个百分比是参考下列边得到的(按顺序):'."\n"
."\n"
.'- **Width**:宽。'."\n"
."\n"
.'- **Height**:高。'."\n"
."\n"
.'- **Long**:长边。'."\n"
.'- **Short**:短边。',
'type' => 'object',
'properties' => [
'Dx' => [
'description' => '水印图片相对输出视频的水平偏移量。默认值:**0**(无偏移)。'."\n"
.'值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表水平偏移量与输出分辨率宽的比率,相对比例,按照视频尺寸变化,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.51',
],
'Width' => [
'description' => '输出视频上水印图片宽。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片宽的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率宽的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.36',
],
'Height' => [
'description' => '输出视频上水印图片高。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片高的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.33',
],
'Dy' => [
'description' => '水印图片相对输出视频的垂直偏移量。默认值:**0**(无偏移)。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表垂直偏移量与输出分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.28',
],
],
],
'ReferPos' => [
'description' => '水印的位置。取值:'."\n"
."\n"
.'- **TopRight**:右上。'."\n"
."\n"
.'- **TopLeft**:左上。'."\n"
."\n"
.'- **BottomRight**:右下。'."\n"
."\n"
.'- **BottomLeft**:左下。',
'type' => 'string',
'example' => 'TopRight',
],
'State' => [
'description' => '水印模板的状态。'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'Dx' => [
'description' => '水平偏移量。单位:px。',
'type' => 'string',
'example' => '10',
],
'Width' => [
'description' => '水印图片宽。单位:px。',
'type' => 'string',
'example' => '10',
],
'Height' => [
'description' => '水印图片高。单位:px。',
'type' => 'string',
'example' => '30',
],
'Timeline' => [
'description' => '动态水印。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '水印开始出现时间。'."\n"
."\n"
.'- 单位:秒。'."\n"
.'- 默认值:**0**。',
'type' => 'string',
'example' => '0',
],
'Duration' => [
'description' => '水印持续时间。默认值:**ToEND**(直至视频结束)。',
'type' => 'string',
'example' => 'ToEND',
],
],
],
'Name' => [
'description' => '水印模板名称。',
'type' => 'string',
'example' => 'example-watermark-****',
],
'Dy' => [
'description' => '垂直偏移量。单位:px。',
'type' => 'string',
'example' => '5',
],
'Id' => [
'description' => '水印模板ID。建议您保存此ID便于后续调用相关接口时使用。',
'type' => 'string',
'example' => '3780bd69b2b74540bc7b1096f564****',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54BB917F-DD35-4F32-BABA-E60E31B21W63',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"WaterMarkTemplate\\": {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.28\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"10\\",\\n \\"Width\\": \\"10\\",\\n \\"Height\\": \\"30\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"Name\\": \\"example-watermark-****\\",\\n \\"Dy\\": \\"5\\",\\n \\"Id\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n },\\n \\"RequestId\\": \\"54BB917F-DD35-4F32-BABA-E60E31B21W63\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n Image\\n \\n 0.51\\n 0.36\\n 0.33\\n 0.28\\n \\n TopRight\\n Normal\\n 10\\n 10\\n 30\\n \\n 0\\n ToEND\\n \\n example-watermark-****\\n 5\\n 3780bd69b2b74540bc7b1096f564****\\n \\n 54BB917F-DD35-4F32-BABA-E60E31B21W63\\n","errorExample":""}]',
'title' => '新增水印模版',
'summary' => '创建水印模板。',
'description' => '通过本接口创建水印模板后,在[提交转码作业](~~29226~~)时指定水印模板和水印素材,即可为输出视频添加水印信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteWaterMarkTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'WaterMarkTemplateId',
'in' => 'query',
'schema' => [
'description' => '需要删除的水印模板ID,可以通过**MPS控制台**>**全局设置**>**水印模板**获取。',
'type' => 'string',
'required' => true,
'example' => '3780bd69b2b74540bc7b1096f564****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '030E2671-806A-52AF-A93C-DA8E308603A6',
],
'WaterMarkTemplateId' => [
'description' => '删除的水印模板ID。',
'type' => 'string',
'example' => '3780bd69b2b74540bc7b1096f564****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"030E2671-806A-52AF-A93C-DA8E308603A6\\",\\n \\"WaterMarkTemplateId\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 030E2671-806A-52AF-A93C-DA8E308603A6\\n 3780bd69b2b74540bc7b1096f564****\\n","errorExample":""}]',
'title' => '删除水印模板',
'summary' => '删除水印模板。',
'description' => '如果有状态为“已提交”的作业指定使用该水印模板,则相应的水印模板不能被删除。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateWaterMarkTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'WaterMarkTemplateId',
'in' => 'query',
'schema' => [
'description' => '需要更新的水印模板ID,可以通过**MPS控制台**>**全局设置**>**水印模板**获取。',
'type' => 'string',
'required' => true,
'example' => '3780bd69b2b74540bc7b1096f564****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '更新后的模板名称。支持中英文、数字等,最大长度128字节。 ',
'type' => 'string',
'required' => true,
'example' => 'example-watermark-****',
],
],
[
'name' => 'Config',
'in' => 'query',
'schema' => [
'description' => '更新后的水印模板配置。JSON对象,更多信息请参见[水印模板配置详情](~~29253~~)。',
'type' => 'string',
'required' => true,
'example' => '{"Width":"10","Height":"30","Dx":"10","Dy":"5","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'WaterMarkTemplate' => [
'description' => '水印模板详细信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '水印类型。取值:'."\n"
."\n"
.'- Image:图片。'."\n"
."\n"
.'- Text:文字。'."\n"
."\n"
.'> 目前仅支持Image类型。'."\n"
."\n",
'type' => 'string',
'example' => 'Image',
],
'RatioRefer' => [
'description' => '取值为百分比是参考的边。当Height、Width、Dx、Dy的取值处于(0,1)时,得到这个百分比参考的边(按顺序):'."\n"
."\n"
.'- **Width**:宽。'."\n"
."\n"
.'- **Height**:高。'."\n"
."\n"
.'- **Long**:长边。'."\n"
."\n"
.'- **Short**:短边。',
'type' => 'object',
'properties' => [
'Dx' => [
'description' => '水印图片相对输出视频的水平偏移量。默认值:**0**(无偏移)。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表水平偏移量与输出分辨率宽的比率,相对比例,按照视频尺寸变化,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.51',
],
'Width' => [
'description' => '输出视频上水印图片宽。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片宽的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率宽的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.36',
],
'Height' => [
'description' => '输出视频上水印图片高。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片高的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.33',
],
'Dy' => [
'description' => '水印图片相对输出视频的垂直偏移量。默认值:**0**(无偏移)。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表垂直偏移量与输出分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.28',
],
],
],
'ReferPos' => [
'description' => '水印的位置。取值:'."\n"
."\n"
.'- **TopRight**:右上。'."\n"
."\n"
.'- **TopLeft**:左上。'."\n"
."\n"
.'- **BottomRight**:右下。'."\n"
."\n"
.'- **BottomLeft**:左下。',
'type' => 'string',
'example' => 'TopRight',
],
'State' => [
'description' => '水印模板的状态。此处默认为**Normal**(正常)。',
'type' => 'string',
'example' => 'Normal',
],
'Dx' => [
'description' => '水平偏移量。单位:px。',
'type' => 'string',
'example' => '10',
],
'Width' => [
'description' => '水印图片宽度。单位:px。',
'type' => 'string',
'example' => '10',
],
'Height' => [
'description' => '水印图片高度。单位:px。',
'type' => 'string',
'example' => '30',
],
'Timeline' => [
'description' => '动态水印。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '水印开始出现时间。'."\n"
."\n"
.'- 单位:秒(s)。'."\n"
.'- 默认值:**0**。',
'type' => 'string',
'example' => '0',
],
'Duration' => [
'description' => '水印持续时间。默认值:**ToEND**(直至视频结束)。',
'type' => 'string',
'example' => '10',
],
],
],
'Name' => [
'description' => '水印模板名称。',
'type' => 'string',
'example' => 'example-watermark-****',
],
'Dy' => [
'description' => '垂直偏移量。单位:px。',
'type' => 'string',
'example' => '5',
],
'Id' => [
'description' => '水印模板ID。建议您保存此ID便于后续调用相关接口时使用。',
'type' => 'string',
'example' => '3780bd69b2b74540bc7b1096f564****',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E558894E-40D9-57C6-B5CC-0F5CDF23614E',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"WaterMarkTemplate\\": {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.28\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"10\\",\\n \\"Width\\": \\"10\\",\\n \\"Height\\": \\"30\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"10\\"\\n },\\n \\"Name\\": \\"example-watermark-****\\",\\n \\"Dy\\": \\"5\\",\\n \\"Id\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n },\\n \\"RequestId\\": \\"E558894E-40D9-57C6-B5CC-0F5CDF23614E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n Image\\n \\n 0.51\\n 0.36\\n 0.33\\n 0.28\\n \\n TopRight\\n Normal\\n 10\\n 10\\n 30\\n \\n 0\\n 10\\n \\n example-watermark-****\\n 5\\n 3780bd69b2b74540bc7b1096f564****\\n \\n E558894E-40D9-57C6-B5CC-0F5CDF23614E\\n","errorExample":""}]',
'title' => '更新水印模版',
'summary' => '更新指定水印模板的名称、配置。',
'description' => '- 本接口通过指定水印模板ID对水印模板的名称、配置等信息进行更新。'."\n"
.'- 如果有状态为“已提交”的作业指定使用该水印模板,则相应的水印模板不能被更新。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SearchWaterMarkTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页大小。'."\n"
."\n"
.'- 上限值:**100**。'."\n"
.'- 默认值:**10**。'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页号。默认值:**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '水印模板状态。'."\n"
."\n"
.'- **All**:表示所有,默认值。'."\n"
.'- **Normal**:表示正常。'."\n"
.'- **Deleted**:表示已删除。'."\n",
'type' => 'string',
'required' => false,
'example' => 'Normal',
'default' => 'Normal',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FC029D04-8F47-57FF-A759-23383C15617D',
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'WaterMarkTemplateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WaterMarkTemplate' => [
'description' => '模板列表。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '水印类型。取值:'."\n"
."\n"
.'- Image:图片。'."\n"
."\n"
.'- Text:文本。'."\n"
."\n"
.'> 目前仅支持**Image**。',
'type' => 'string',
'example' => 'Image',
],
'RatioRefer' => [
'description' => '取值为百分比是参考的边。当Height、Width、Dx、Dy的取值处于(0,1)时,这个百分比是参考哪个边得到的(按顺序):'."\n"
."\n"
.'- **Width**:宽。'."\n"
."\n"
.'- **Height**:高。'."\n"
."\n"
.'- **Long**:长边。'."\n"
."\n"
.'- **Short**:短边。',
'type' => 'object',
'properties' => [
'Dx' => [
'description' => '水印图片相对输出视频的水平偏移量。默认值:**0**(无偏移)。'."\n"
.'值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表水平偏移量与输出分辨率宽的比率,相对比例,按照视频尺寸变化,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.51',
],
'Width' => [
'description' => '输出视频上水印图片宽。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片宽的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率宽的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.36',
],
'Height' => [
'description' => '输出视频上水印图片高。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片高的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.33',
],
'Dy' => [
'description' => '水印图片相对输出视频的垂直偏移量。默认值:**0**(无偏移)。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表垂直偏移量与输出分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.2',
],
],
],
'ReferPos' => [
'description' => '水印的位置。取值:'."\n"
."\n"
.'- TopRight:右上。'."\n"
."\n"
.'- TopLeft:左上。'."\n"
."\n"
.'- BottomRight:右下。'."\n"
."\n"
.'- BottomLeft:左下。',
'type' => 'string',
'example' => 'TopRight',
],
'State' => [
'description' => '水印模板的状态。取值:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'Dx' => [
'description' => '水平偏移量。单位:px。',
'type' => 'string',
'example' => '100',
],
'Width' => [
'description' => '宽。单位:px。',
'type' => 'string',
'example' => '8',
],
'Height' => [
'description' => '高。单位:px。',
'type' => 'string',
'example' => '8',
],
'Timeline' => [
'description' => '动态水印。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '水印开始出现时间。'."\n"
."\n"
.'- 单位:秒。'."\n"
.'- 默认值:**0**。',
'type' => 'string',
'example' => '0',
],
'Duration' => [
'description' => '水印持续时间。默认值:**ToEND**(直至视频结束)。',
'type' => 'string',
'example' => 'ToEND',
],
],
],
'Name' => [
'description' => '水印模板名称。',
'type' => 'string',
'example' => 'example-watermark',
],
'Dy' => [
'description' => '垂直偏移量。单位:px。',
'type' => 'string',
'example' => '100',
],
'Id' => [
'description' => '水印模板ID。',
'type' => 'string',
'example' => '88c6ca184c0e4578645b665e2a12****',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"FC029D04-8F47-57FF-A759-23383C15617D\\",\\n \\"PageNumber\\": 1,\\n \\"WaterMarkTemplateList\\": {\\n \\"WaterMarkTemplate\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.2\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"Name\\": \\"example-watermark\\",\\n \\"Dy\\": \\"100\\",\\n \\"Id\\": \\"88c6ca184c0e4578645b665e2a12****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 10\\n FC029D04-8F47-57FF-A759-23383C15617D\\n 1\\n \\n Image\\n \\n 0.51\\n 0.36\\n 0.33\\n 0.2\\n \\n TopRight\\n Normal\\n 100\\n 8\\n 8\\n \\n 0\\n ToEND\\n \\n example-watermark\\n 100\\n 88c6ca184c0e4578645b665e2a12****\\n \\n","errorExample":""}]',
'title' => '搜索水印模板',
'summary' => '搜索水印模板。',
'description' => '本接口通过指定状态搜索水印模板,如不指定则默认搜索全部模板。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryWaterMarkTemplateList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'WaterMarkTemplateIds',
'in' => 'query',
'schema' => [
'description' => '需要查询的水印模板ID,可以通过**MPS控制台**>**全局设置**>**水印模板**获取。最多一次查10个,半角逗号(,)分隔。 ',
'type' => 'string',
'required' => true,
'example' => '3780bd69b2b74540bc7b1096f564****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '17079AF5-6276-51A9-B755-D26594C93F3C',
],
'NonExistWids' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的模板ID。',
'type' => 'array',
'items' => [
'description' => '不存在的水印模板列表,无数据时该参数不返回。',
'type' => 'string',
'example' => '72dfa5e679ab4be9a3ed9974c736****',
],
],
],
],
'WaterMarkTemplateList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WaterMarkTemplate' => [
'description' => '水印模板列表。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '水印类型。取值:'."\n"
."\n"
.'- Image:图片。'."\n"
."\n"
.'- Text:文本。'."\n"
."\n"
.'> 目前仅支持**Image**。',
'type' => 'string',
'example' => 'Image',
],
'RatioRefer' => [
'description' => '取值为百分比是参考的边。当Height、Width、Dx、Dy的取值处于(0,1)时,这个百分比是参考哪个边得到的(按顺序):'."\n"
."\n"
.'- **Width**:宽。'."\n"
."\n"
.'- **Height**:高。'."\n"
."\n"
.'- **Long**:长边。'."\n"
."\n"
.'- **Short**:短边。',
'type' => 'object',
'properties' => [
'Dx' => [
'description' => '水印图片相对输出视频的水平偏移量。默认值:**0**(无偏移)。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表水平偏移量与输出分辨率宽的比率,相对比例,按照视频尺寸变化,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.51',
],
'Width' => [
'description' => '输出视频上水印图片宽。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片宽的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率宽的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.36',
],
'Height' => [
'description' => '输出视频上水印图片高。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表水印图片高的像素值,绝对位置,单位:px。'."\n"
.'- **小数型**:代表相对输出视频分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.33',
],
'Dy' => [
'description' => '水印图片相对输出视频的垂直偏移量。默认值:**0**(无偏移)。值有两种形式:'."\n"
."\n"
.'- **整数型**:代表偏移像素,绝对位置,单位:px。'."\n"
.'- **小数型**:代表垂直偏移量与输出分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。',
'type' => 'string',
'example' => '0.4',
],
],
],
'ReferPos' => [
'description' => '水印的位置。取值:'."\n"
."\n"
.'- **TopRight**:右上。'."\n"
."\n"
.'- **TopLeft**:左上。'."\n"
."\n"
.'- **BottomRight**:右下。'."\n"
."\n"
.'- **BottomLeft**:左下。',
'type' => 'string',
'example' => 'TopRight',
],
'State' => [
'description' => '水印模板的状态。取值:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'Dx' => [
'description' => '水平偏移量。单位:px。',
'type' => 'string',
'example' => '100',
],
'Width' => [
'description' => '宽。单位:px。',
'type' => 'string',
'example' => '8',
],
'Height' => [
'description' => '高。单位:px。',
'type' => 'string',
'example' => '8',
],
'Timeline' => [
'description' => '动态水印。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '水印开始出现时间。'."\n"
."\n"
.'- 单位:秒。'."\n"
.'- 默认值:**0**。',
'type' => 'string',
'example' => '0',
],
'Duration' => [
'description' => '水印持续时间。默认值:**ToEND**(直至视频结束)。',
'type' => 'string',
'example' => '10',
],
],
],
'Name' => [
'description' => '水印模板名称。',
'type' => 'string',
'example' => 'example-watermark',
],
'Dy' => [
'description' => '垂直偏移量。单位:px。',
'type' => 'string',
'example' => '100',
],
'Id' => [
'description' => '水印模板ID。',
'type' => 'string',
'example' => '3780bd69b2b74540bc7b1096f564****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17079AF5-6276-51A9-B755-D26594C93F3C\\",\\n \\"NonExistWids\\": {\\n \\"String\\": [\\n \\"72dfa5e679ab4be9a3ed9974c736****\\"\\n ]\\n },\\n \\"WaterMarkTemplateList\\": {\\n \\"WaterMarkTemplate\\": [\\n {\\n \\"Type\\": \\"Image\\",\\n \\"RatioRefer\\": {\\n \\"Dx\\": \\"0.51\\",\\n \\"Width\\": \\"0.36\\",\\n \\"Height\\": \\"0.33\\",\\n \\"Dy\\": \\"0.4\\"\\n },\\n \\"ReferPos\\": \\"TopRight\\",\\n \\"State\\": \\"Normal\\",\\n \\"Dx\\": \\"100\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"10\\"\\n },\\n \\"Name\\": \\"example-watermark\\",\\n \\"Dy\\": \\"100\\",\\n \\"Id\\": \\"3780bd69b2b74540bc7b1096f564****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 17079AF5-6276-51A9-B755-D26594C93F3C\\n 72dfa5e679ab4be9a3ed9974c736****\\n \\n Image\\n \\n 0.51\\n 0.36\\n 0.33\\n 0.4\\n \\n TopRight\\n Normal\\n 100\\n 8\\n 8\\n \\n 0\\n 10\\n \\n example-watermark\\n 100\\n 3780bd69b2b74540bc7b1096f564****\\n \\n","errorExample":""}]',
'title' => '通过水印模板ID查询水印模板详情',
'summary' => '查询水印模板。',
'description' => '本接口一次最多查询10个水印模板。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitSnapshotJob' => [
'summary' => '提交截图作业。调用本接口之后媒体处理MPS会对输入文件进行截图和拼图。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '23185',
'abilityTreeNodes' => [
'FEATUREmtsU2L9V8',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '作业输入。详细说明请参见[Input详情](~~29253#section-f3p-d24-y2b~~)。'."\n"
."\n"
.'> - 在媒体处理API中,Object必须经过[URL Encoding](~~423796~~)(基于UTF-8编码)后使用。'."\n"
.' - OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"}',
],
],
[
'name' => 'SnapshotConfig',
'in' => 'query',
'schema' => [
'description' => '截图配置。详细说明,请参见[SnapshotConfig参数详情](~~29253#section-zh2-324-y2b~~)。',
'type' => 'string',
'required' => true,
'example' => '{"OutputFile":{"Bucket":"example-001","Location":"example-location","Object":"{Count}.jpg"},"Time":"5","Num":"10","Interval":"20"}',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据。支持中英文、数字、短划线(-),不能以特殊字符开头,最大长度1024个字节。',
'type' => 'string',
'required' => false,
'example' => 'testid-001',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,详细说明,请参见[基本概念](~~29197~~)。'."\n"
."\n"
.'- 可选值:可以通过[MPS控制台](https://mps.console.aliyun.com/overview) > **全局设置** > **管道**查询和创建管道。'."\n"
.'- 如果需要异步通知,请为管道绑定MNS消息,具体请参见[接收消息通知](https://help.aliyun.com/document_detail/42618.html)[接收消息通知](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications)。',
'type' => 'string',
'required' => false,
'example' => 'dd3dae411e704030b921e52698e5****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '19B6D8C5-A5DD-467A-B435-29D393C71E2D',
],
'SnapshotJob' => [
'description' => '截图作业。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => '2021-05-19T03:11:48Z',
],
'SnapshotConfig' => [
'description' => '截图配置。',
'type' => 'object',
'properties' => [
'Time' => [
'description' => '截图开始时间。单位:毫秒。',
'type' => 'string',
'example' => '5',
],
'TileOut' => [
'description' => '拼图配置。',
'type' => 'object',
'properties' => [
'Padding' => [
'description' => '图片间距。'."\n"
."\n"
.'- 默认:**0**。'."\n"
."\n"
.'- 单位:px。',
'type' => 'string',
'example' => '0',
],
'Color' => [
'description' => '背景颜色。'."\n"
.'- 默认:**black**。'."\n"
.'- 可取值范围:**颜色关键字**,**random**。'."\n"
."\n"
.'> 其中颜色关键字支持三种格式,比如黑色,支持Black,black,#000000。'."\n"
."\n\n",
'type' => 'string',
'example' => 'black',
],
'CellSelStep' => [
'description' => '选取单图片步长。',
'type' => 'string',
'example' => '3',
],
'CellHeight' => [
'description' => '单图片高度。默认截图输出分辨率高度。',
'type' => 'string',
'example' => '100',
],
'CellWidth' => [
'description' => '单图片宽度。默认截图输出分辨率宽度。',
'type' => 'string',
'example' => '100',
],
'Margin' => [
'description' => '外框宽度。'."\n"
."\n"
.'- 默认:**0**。'."\n"
."\n"
.'- 单位:px。',
'type' => 'string',
'example' => '5',
],
'Columns' => [
'description' => '图片拼合列数。默认:**10**。',
'type' => 'string',
'example' => '10',
],
'IsKeepCellPic' => [
'description' => '是否保留单图片。可取值:'."\n"
."\n"
.'- **true**:保留。'."\n"
."\n"
.'- **false**:不保留。'."\n"
."\n"
.'- 默认:**true**。'."\n",
'type' => 'string',
'example' => 'false',
],
'Lines' => [
'description' => '图片拼合行数。默认:**10**。',
'type' => 'string',
'example' => '10',
],
],
],
'Interval' => [
'description' => '截图间隔时间。'."\n"
."\n"
.'- 若指定则表示序列截图,且值大于0。'."\n"
.'- 单位:秒。'."\n"
.'- 默认值:**10**。',
'type' => 'string',
'example' => '20',
],
'FrameType' => [
'description' => '截图类型。默认值:**normal**。可取值:'."\n"
.'- **normal**:普通帧。'."\n"
.'- **intra**:I帧(关键帧)。'."\n"
."\n"
.'> 如果请求参数中将FrameType参数设置为I帧(关键帧),将只截取关键帧。如果指定的时间节点为非关键帧,则就近选取关键帧。在同等截图规则下,关键帧截图比普通帧截图速度快。'."\n",
'type' => 'string',
'example' => 'intra',
],
'Width' => [
'description' => '截图输出图片宽度。',
'type' => 'string',
'example' => '8',
],
'Height' => [
'description' => '截图输出图片高度。',
'type' => 'string',
'example' => '8',
],
'OutputFile' => [
'description' => '截图输出OSS配置。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '指定角色的ARN。格式:acs:ram::$accountID:role/$roleName。',
'type' => 'string',
'example' => 'acs:ram::1:role/testrole',
],
'Object' => [
'description' => '截图输出文件(OSS Object)。',
'type' => 'string',
'example' => 'test.png',
],
'Location' => [
'description' => '截图输出OSS Bucket所在数据中心(OSS Location)。',
'type' => 'string',
'example' => 'example-location',
],
'Bucket' => [
'description' => '截图输出文件所在OSS Bucket。',
'type' => 'string',
'example' => 'example',
],
],
],
'Num' => [
'description' => '截图数量。若指定则表示序列截图。',
'type' => 'string',
'example' => '10',
],
'TileOutputFile' => [
'description' => '拼图任务大图的输出OSS配置。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '指定角色的ARN。格式:acs:ram::$accountID:role/$roleName。',
'type' => 'string',
'example' => 'acs:ram::1:role/testrole',
],
'Object' => [
'description' => '输出文件 (OSS Object)。',
'type' => 'string',
'example' => 'example.png',
],
'Location' => [
'description' => '输出OSS Bucket所在数据中心(OSS Location)。',
'type' => 'string',
'example' => 'example-location',
],
'Bucket' => [
'description' => '输出文件所在OSS Bucket。',
'type' => 'string',
'example' => 'example',
],
],
],
'TimeArray' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TimePointList' => [
'description' => '指定时间点数组。',
'type' => 'array',
'items' => [
'description' => '指定时间点数组。单位毫秒,浮点数,保留2位小数,可重复,可无序提交,由MPS排序。最多100个时间点。指定该参数时,Num、Time、Interval均不指定。如指定则提示参数指定错误 InvalidParameter.Ambiguity。',
'type' => 'integer',
'format' => 'int64',
'example' => '[10050, 50000, 110000, 1000500, 1100500]',
],
],
],
],
],
],
'State' => [
'description' => '截图状态。取值:'."\n"
.'- **Submitted**:已提交。'."\n"
.'- **Snapshoting**:截图中。'."\n"
."\n"
.'- **Success**:截图成功。'."\n"
."\n"
.'- **Fail**:截图失败。'."\n"
."\n",
'type' => 'string',
'example' => 'Snapshoting',
],
'Message' => [
'description' => '分析失败时错误信息。若成功则不返回此参数。',
'type' => 'string',
'example' => 'The resource operated InputFile is bad',
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。若失败则不返回此参数。',
'type' => 'string',
'example' => '799454621135656C7F815F198A76****',
],
'ErrorMessage' => [
'description' => '失败时错误信息。若成功则不返回此参数。',
'type' => 'string',
'example' => 'The resource operated InputFile is bad',
],
'ErrorCode' => [
'description' => '失败时错误码。若成功则不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter',
],
],
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '指定角色的ARN。格式:acs:ram::$accountID:role/$roleName。',
'type' => 'string',
'example' => 'acs:ram::1:role/testrole',
],
'Object' => [
'description' => '输入文件(OSS Object)。',
'type' => 'string',
'example' => 'example.flv',
],
'Location' => [
'description' => '输入OSS Bucket所在数据中心(OSS Location)。',
'type' => 'string',
'example' => 'example-location\'',
],
'Bucket' => [
'description' => '输入文件所在OSS Bucket。',
'type' => 'string',
'example' => 'example',
],
],
],
'Count' => [
'description' => '截取图片的数量。',
'type' => 'string',
'example' => '1',
],
'TileCount' => [
'description' => '拼图图片数量。',
'type' => 'string',
'example' => '5',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'Code' => [
'description' => '分析失败时错误码。若成功则不返回此参数。',
'type' => 'string',
'example' => 'ResourceContentBad',
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'dd3dae411e704030b921e52698e5****',
],
'Id' => [
'description' => '截图作业ID。',
'type' => 'string',
'example' => 'f4e3b9ba9f3840c39d6e288056f0****',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19B6D8C5-A5DD-467A-B435-29D393C71E2D\\",\\n \\"SnapshotJob\\": {\\n \\"CreationTime\\": \\"2021-05-19T03:11:48Z\\",\\n \\"SnapshotConfig\\": {\\n \\"Time\\": \\"5\\",\\n \\"TileOut\\": {\\n \\"Padding\\": \\"0\\",\\n \\"Color\\": \\"black\\",\\n \\"CellSelStep\\": \\"3\\",\\n \\"CellHeight\\": \\"100\\",\\n \\"CellWidth\\": \\"100\\",\\n \\"Margin\\": \\"5\\",\\n \\"Columns\\": \\"10\\",\\n \\"IsKeepCellPic\\": \\"false\\",\\n \\"Lines\\": \\"10\\"\\n },\\n \\"Interval\\": \\"20\\",\\n \\"FrameType\\": \\"intra\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"test.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Num\\": \\"10\\",\\n \\"TileOutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"TimeArray\\": {\\n \\"TimePointList\\": [\\n 0\\n ]\\n }\\n },\\n \\"State\\": \\"Snapshoting\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"799454621135656C7F815F198A76****\\",\\n \\"ErrorMessage\\": \\"The resource operated InputFile is bad\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\"\\n },\\n \\"Input\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"example-location\'\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Count\\": \\"1\\",\\n \\"TileCount\\": \\"5\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"ResourceContentBad\\",\\n \\"PipelineId\\": \\"dd3dae411e704030b921e52698e5****\\",\\n \\"Id\\": \\"f4e3b9ba9f3840c39d6e288056f0****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 19B6D8C5-A5DD-467A-B435-29D393C71E2D\\n \\n 2021-05-19T03:11:48Z\\n \\n \\n \\n 0\\n black\\n 3\\n 100\\n 100\\n 5\\n 10\\n false\\n 10\\n \\n 20\\n intra\\n 8\\n 8\\n \\n acs:ram::1:role/testrole\\n \\n example-location\\n example\\n \\n 10\\n \\n acs:ram::1:role/testrole\\n \\n example-location\\n example\\n \\n \\n Snapshoting\\n The resource operated InputFile is bad\\n \\n 799454621135656C7F815F198A76****\\n The resource operated InputFile is bad\\n InvalidParameter\\n \\n \\n acs:ram::1:role/testrole\\n \\n example-location\'\\n example\\n \\n 1\\n 5\\n testid-001\\n ResourceContentBad\\n dd3dae411e704030b921e52698e5****\\n f4e3b9ba9f3840c39d6e288056f0****\\n \\n","errorExample":""}]',
'title' => '提交截图作业',
'description' => '- 输入单个文件大小最大支持100 GB,超过可能导致执行失败。'."\n"
.'- 请确认文件已成功上传至OSS后再提交截图作业,否则会导致执行失败。您可通过配置OSS回调消息确认文件上传状态。'."\n"
.'- 截图作业分为同步和异步模式。'."\n"
.' - 同步模式仅支持单张截图,会在接口返回时生成图片。'."\n"
.' - 异步模式不保证时效性,在提交截图作业后,任务会添加到管道中排队,被调度执行。所以在接口返回时,不保证截图已经生成。执行完成后需要调用[查询截图作业结果](~~602858~~)接口轮询执行结果,或通过为管道绑定MNS消息接收执行结果,具体请参见[接收消息通知](https://help.aliyun.com/document_detail/42618.html)[接收消息通知](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications)。'."\n"
.' - 只要设置了**Interval**和**Num**中的任何一个参数,就表示使用异步模式。'."\n"
."\n"
.'- 目前仅支持生成JPG格式图片。'."\n"
.'- 更多截图常见问题,请参见[截图常见问题](~~60805~~)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QuerySnapshotJobList' => [
'summary' => '查询截图作业。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '23114',
'abilityTreeNodes' => [
'FEATUREmtsU2L9V8',
],
],
'parameters' => [
[
'name' => 'SnapshotJobIds',
'in' => 'query',
'schema' => [
'description' => '截图作业ID列表。'."\n"
.'- 一次最多查询**10**个,半角逗号(,)分隔。 '."\n"
.'- 可以通过[MPS控制台](https://mps.console.aliyun.com/overview)>**任务管理**>**截图获取**,也可以从[提交截图作业](~~602857~~)的返回参数中获取。',
'type' => 'string',
'required' => false,
'example' => '72dfa5e679ab4be9a3ed9974c736****',
],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '下一页标识,32位UUID。'."\n"
.'- 查询结果大于一页会返回NextPageToken参数,每次查询值都会更新。获取后请在下一次查询时填入。',
'type' => 'string',
'required' => false,
'example' => 'cc6cbef8e8d5481ca536f5d2a466****',
],
],
[
'name' => 'MaximumPageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询每页最大返回数。'."\n"
."\n"
.'- 取值范围:**\\[1,300\\]**。'."\n"
.'- 默认值:**30** 。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '30',
'default' => '10',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '需要查询的截图状态。'."\n"
.'- **Submitted**:已提交。'."\n"
.'- **Snapshoting**:截图中。'."\n"
."\n"
.'- **Success**:截图成功。'."\n"
."\n"
.'- **Fail**:截图失败。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'Snapshoting',
'default' => 'All',
],
],
[
'name' => 'StartOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '最早任务创建时间。'."\n"
."\n"
.'- 日期格式按照ISO8601标准表示,并需要使用UTC时间。'."\n"
.'- 格式为:YYYY-MM-DDThh:mm:ssZ 。',
'type' => 'string',
'required' => false,
'example' => '2014-01-10T12:00:00Z',
],
],
[
'name' => 'EndOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '最晚任务创建时间。'."\n"
."\n"
.'- 日期格式按照ISO8601标准表示,并需要使用UTC时间。'."\n"
.'- 格式为:YYYY-MM-DDThh:mm:ssZ 。',
'type' => 'string',
'required' => false,
'example' => '2014-01-12T12:00:00Z',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID。详细信息请参见[基本概念](~~29197~~)。'."\n"
.'- 可选值:可以通过[MPS控制台](https://mps.console.aliyun.com/overview)>**全局设置**>**管道**查询和创建。'."\n"
.'- 如果需要异步通知,请为管道绑定MNS消息,详细说明请参见[接收消息通知](https://help.aliyun.com/document_detail/42618.html)[接收消息通知](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications)。',
'type' => 'string',
'required' => false,
'example' => 'b11c171cced04565b1f38f1ecc39****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'SnapshotJobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SnapshotJob' => [
'description' => '截图作业列表。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => '2021-06-30T12:34:29Z',
],
'SnapshotConfig' => [
'description' => '截图配置。',
'type' => 'object',
'properties' => [
'Time' => [
'description' => '截图开始时间。单位:毫秒。',
'type' => 'string',
'example' => '4',
],
'TileOut' => [
'description' => '拼图配置。',
'type' => 'object',
'properties' => [
'Padding' => [
'description' => '图片间距。'."\n"
."\n"
.'- 默认:**0**。'."\n"
."\n"
.'- 单位:px。',
'type' => 'string',
'example' => '0',
],
'Color' => [
'description' => '背景颜色。'."\n"
.'- 默认:**black**。'."\n"
.'- 可取值范围:**颜色关键字**,**random**。'."\n"
."\n"
.'> 其中颜色关键字支持三种格式,比如黑色,支持Black,black,#000000。'."\n"
."\n",
'type' => 'string',
'example' => 'black',
],
'CellSelStep' => [
'description' => '选取单图片步长。',
'type' => 'string',
'example' => '3',
],
'CellHeight' => [
'description' => '单图片高度。默认截图输出分辨率高度。',
'type' => 'string',
'example' => '8',
],
'CellWidth' => [
'description' => '单图片宽度。默认截图输出分辨率宽度。',
'type' => 'string',
'example' => '8',
],
'Margin' => [
'description' => '外框宽度。'."\n"
."\n"
.'- 默认:**0**。'."\n"
."\n"
.'- 单位:px。',
'type' => 'string',
'example' => '0',
],
'Columns' => [
'description' => '图片拼合列数。默认:**10**。',
'type' => 'string',
'example' => '10',
],
'IsKeepCellPic' => [
'description' => '是否保留单图片。默认:**true**。'."\n",
'type' => 'string',
'example' => 'false',
],
'Lines' => [
'description' => '图片拼合行数。默认:**10**。',
'type' => 'string',
'example' => '10',
],
],
],
'Interval' => [
'description' => '截图间隔时间。'."\n"
."\n"
.'- 若指定则表示序列截图,且值大于0。'."\n"
.'- 单位:秒。'."\n"
.'- 默认值:**10**。',
'type' => 'string',
'example' => '10',
],
'FrameType' => [
'description' => '截图类型。'."\n"
."\n"
.'- **normal**:普通帧。'."\n"
."\n"
.'- **intra**:I帧。'."\n"
."\n"
.'- 默认值:**intra**。',
'type' => 'string',
'example' => 'intra',
],
'Width' => [
'description' => '截图输出图片宽度。',
'type' => 'string',
'example' => '8',
],
'Height' => [
'description' => '截图输出图片高度。',
'type' => 'string',
'example' => '8',
],
'OutputFile' => [
'description' => '截图输出OSS配置。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '指定角色的ARN。格式:acs:ram::$accountID:role/$roleName。',
'type' => 'string',
'example' => 'acs:ram::1:role/testrole',
],
'Object' => [
'description' => '截图输出文件 (OSS Object)。',
'type' => 'string',
'example' => 'example.png',
],
'Location' => [
'description' => '截图输出OSS Bucket所在数据中心(OSS Location)。',
'type' => 'string',
'example' => 'example-location',
],
'Bucket' => [
'description' => '截图输出文件所在OSS Bucket。',
'type' => 'string',
'example' => 'example',
],
],
],
'Num' => [
'description' => '截图数量。若指定则表示序列截图。',
'type' => 'string',
'example' => '10',
],
'TileOutputFile' => [
'description' => '拼图任务大图的输出OSS配置。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '指定角色的ARN。格式:acs:ram::$accountID:role/$roleName。',
'type' => 'string',
'example' => 'acs:ram::1:role/testrole',
],
'Object' => [
'description' => '输出文件 (OSS Object)。',
'type' => 'string',
'example' => 'example.png',
],
'Location' => [
'description' => '输出OSS Bucket所在数据中心(OSS Location)。',
'type' => 'string',
'example' => 'example-location',
],
'Bucket' => [
'description' => '输出文件所在OSS Bucket。',
'type' => 'string',
'example' => 'example',
],
],
],
'TimeArray' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TimePointList' => [
'description' => '指定时间点数组。',
'type' => 'array',
'items' => [
'description' => '指定时间点数组,单位毫秒,浮点数,保留2位小数,可重复,可无序提交,由MPS排序。最多100个时间点。指定该参数时,Num、Time、Interval均不指定。如指定则提示参数指定错误 InvalidParameter.Ambiguity。',
'type' => 'integer',
'format' => 'int64',
'example' => '[10050, 50000, 110000, 1000500, 1100500]',
],
],
],
],
],
],
'State' => [
'description' => '截图状态。'."\n"
.'- **Submitted**:已提交。'."\n"
.'- **Snapshoting**:截图中。'."\n"
."\n"
.'- **Success**:截图成功。'."\n"
."\n"
.'- **Fail**:截图失败。'."\n"
."\n",
'type' => 'string',
'example' => 'Snapshoting',
],
'Message' => [
'description' => '分析失败时错误信息。如成功则不返回此消息。',
'type' => 'string',
'example' => 'The resource operated InputFile is bad',
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成的结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '成功时消息ID。如失败则不返回此参数。',
'type' => 'string',
'example' => '799454621135656C7F815F198A76****',
],
'ErrorMessage' => [
'description' => '失败时错误信息。如成功则不返回此参数。',
'type' => 'string',
'example' => 'The resource operated InputFile is bad',
],
'ErrorCode' => [
'description' => '失败时错误码。如成功则不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter',
],
],
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'RoleArn' => [
'description' => '指定角色的ARN。格式:acs:ram::$accountID:role/$roleName。',
'type' => 'string',
'example' => 'acs:ram::1:role/testrole',
],
'Object' => [
'description' => '输入文件 (OSS Object)。',
'type' => 'string',
'example' => 'example.flv',
],
'Location' => [
'description' => '输入OSS Bucket所在数据中心(OSS Location)。',
'type' => 'string',
'example' => 'example-location',
],
'Bucket' => [
'description' => '输入文件所在OSS Bucket。',
'type' => 'string',
'example' => 'example',
],
],
],
'Count' => [
'description' => '截取图片的数量。',
'type' => 'string',
'example' => '1',
],
'TileCount' => [
'description' => '拼图图片数量。',
'type' => 'string',
'example' => '7',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'Code' => [
'description' => '分析失败时错误码。如成功则不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter',
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'b11c171cced04565b1f38f1ecc39****',
],
'Id' => [
'description' => '截图作业ID。',
'type' => 'string',
'example' => 'cc6cbef8e8d5481ca536f5d2a466****',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '34BCAB31-2833-43A7-9FBD-B34302AB23EQ',
],
'NonExistSnapshotJobIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的截图作业ID列表。',
'type' => 'array',
'items' => [
'description' => '不存在的截图作业ID详情,无数据时该参数不返回。',
'type' => 'string',
'example' => 'c6d973c33d1c4b21bc39907d3b29****',
],
],
],
],
'NextPageToken' => [
'description' => '下一页标识,32位UUID。查询结果大于一页时返回,每次查询值都会更新。',
'type' => 'string',
'example' => 'b11c171cced04565b1f38f1ecc39****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotJobList\\": {\\n \\"SnapshotJob\\": [\\n {\\n \\"CreationTime\\": \\"2021-06-30T12:34:29Z\\",\\n \\"SnapshotConfig\\": {\\n \\"Time\\": \\"4\\",\\n \\"TileOut\\": {\\n \\"Padding\\": \\"0\\",\\n \\"Color\\": \\"black\\",\\n \\"CellSelStep\\": \\"3\\",\\n \\"CellHeight\\": \\"8\\",\\n \\"CellWidth\\": \\"8\\",\\n \\"Margin\\": \\"0\\",\\n \\"Columns\\": \\"10\\",\\n \\"IsKeepCellPic\\": \\"false\\",\\n \\"Lines\\": \\"10\\"\\n },\\n \\"Interval\\": \\"10\\",\\n \\"FrameType\\": \\"intra\\",\\n \\"Width\\": \\"8\\",\\n \\"Height\\": \\"8\\",\\n \\"OutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Num\\": \\"10\\",\\n \\"TileOutputFile\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.png\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"TimeArray\\": {\\n \\"TimePointList\\": [\\n 0\\n ]\\n }\\n },\\n \\"State\\": \\"Snapshoting\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"799454621135656C7F815F198A76****\\",\\n \\"ErrorMessage\\": \\"The resource operated InputFile is bad\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\"\\n },\\n \\"Input\\": {\\n \\"RoleArn\\": \\"acs:ram::1:role/testrole\\",\\n \\"Object\\": \\"example.flv\\",\\n \\"Location\\": \\"example-location\\",\\n \\"Bucket\\": \\"example\\"\\n },\\n \\"Count\\": \\"1\\",\\n \\"TileCount\\": \\"7\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"PipelineId\\": \\"b11c171cced04565b1f38f1ecc39****\\",\\n \\"Id\\": \\"cc6cbef8e8d5481ca536f5d2a466****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"34BCAB31-2833-43A7-9FBD-B34302AB23EQ\\",\\n \\"NonExistSnapshotJobIds\\": {\\n \\"String\\": [\\n \\"c6d973c33d1c4b21bc39907d3b29****\\"\\n ]\\n },\\n \\"NextPageToken\\": \\"b11c171cced04565b1f38f1ecc39****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2021-06-30T12:34:29Z\\n \\n \\n \\n 0\\n black\\n 3\\n 8\\n 8\\n 0\\n 10\\n false\\n 10\\n \\n 10\\n intra\\n 8\\n 8\\n \\n acs:ram::1:role/testrole\\n \\n example-location\\n example\\n \\n 10\\n \\n acs:ram::1:role/testrole\\n \\n example-location\\n example\\n \\n \\n Snapshoting\\n \\n 799454621135656C7F815F198A76****\\n \\n \\n acs:ram::1:role/testrole\\n \\n example-location\\n example\\n \\n 1\\n 7\\n testid-001\\n b11c171cced04565b1f38f1ecc39****\\n cc6cbef8e8d5481ca536f5d2a466****\\n \\n 34BCAB31-2833-43A7-9FBD-B34302AB23EQ\\n c6d973c33d1c4b21bc39907d3b29****\\n b11c171cced04565b1f38f1ecc39****\\n","errorExample":""}]',
'title' => '查询截图作业结果',
'description' => '- 您可以指定多个截图作业ID(SnapshotJobIds)进行查询。或不指定具体的截图作业ID,通过筛选截图状态、创建时间、管道等条件,进行分页查询。'."\n"
.'- 本接口一次最多查询10个截图作业。'."\n"
.'- 本接口返回值默认按CreationTime降序排列。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdatePipeline' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '需要更新的管道ID。可以通过**MPS控制台** > **全局设置** > **管道**获取。',
'type' => 'string',
'required' => true,
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '修改后的管道名称。支持中英文、数字、中划线(-)等,不能以特殊字符开头,最大长度128字节。',
'type' => 'string',
'required' => true,
'example' => 'example-pipeline-****',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '修改后的管道状态。'."\n"
."\n"
.'- **Active**:管道开启。管道内的作业会被媒体转码服务调度转码执行。'."\n"
.'- **Paused**:管道暂停。管道内的作业不再会被媒体转码调度转码执行,并且所有作业状态维持在已提交状态。已经处于转码中的任务将继续转码,不受影响。',
'type' => 'string',
'required' => true,
'example' => 'Paused',
],
],
[
'name' => 'NotifyConfig',
'in' => 'query',
'schema' => [
'description' => '阿里云轻量消息队列(原MNS) 配置,即MNS队列或主题信息。更多信息,请参见[NotifyConfig详情](~~29253~~)。',
'type' => 'string',
'required' => false,
'example' => '{"Topic":"example-topic-****"}',
],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => [
'description' => '当前RAM用户关联的角色。可以通过**RAM控制台** > **身份管理** > **角色**获取。',
'type' => 'string',
'required' => false,
'example' => 'AliyunMTSDefaultRole',
],
],
[
'name' => 'ExtendConfig',
'in' => 'query',
'schema' => [
'description' => '扩展配置',
'type' => 'string',
'required' => false,
'example' => '{\\"IsBoostNew\\":true,\\"MultiSpeedDowngradePolicy\\":\\"NormalSpeed\\",\\"MaxMultiSpeed\\":20}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1FE0F96B-544D-4244-9D83-DFCFB0E5A231',
],
'Pipeline' => [
'description' => '管道详细信息。',
'type' => 'object',
'properties' => [
'Speed' => [
'description' => '管道类型。默认值:**Standard**(标准管道)。可取值:'."\n"
."\n"
.'- **Boost**:倍速转码管道。'."\n"
."\n"
.'- **Standard**:标准管道。'."\n"
."\n"
.'- **NarrowBandHDV2**:窄带高清2.0管道。'."\n"
."\n"
.'- **AIVideoCover**:智能截图管道。'."\n"
."\n"
.'- **AIVideoFPShot**:视频DNA管道。'."\n"
."\n"
.'- **AIVideoCensor**:智能审核管道。'."\n"
."\n"
.'- **AIVideoMCU**:智能标签管道。'."\n"
."\n"
.'- **AIVideoSummary**:视频摘要管道。'."\n"
."\n"
.'- **AIVideoPorn**:视频鉴黄管道。'."\n"
."\n"
.'- **AIAudioKWS**:音频关键字识别管道。'."\n"
."\n"
.'- **AIAudioASR**:语音转文字管道。',
'type' => 'string',
'example' => 'Standard',
],
'State' => [
'description' => '管道状态。取值:'."\n"
."\n"
.'- **Active**:管道开启。'."\n"
.'- **Paused**:管道暂停。',
'type' => 'string',
'example' => 'Paused',
],
'NotifyConfig' => [
'description' => '阿里云MNS通知配置。',
'type' => 'object',
'properties' => [
'MqTopic' => [
'description' => '接收到的消息队列。',
'type' => 'string',
'example' => 'example1,example2',
],
'QueueName' => [
'description' => 'MNS中创建的队列。',
'type' => 'string',
'example' => 'example-queue-****',
],
'MqTag' => [
'description' => '标签。',
'type' => 'string',
'example' => 'mts-test',
],
'Topic' => [
'description' => 'MNS中创建的主题。',
'type' => 'string',
'example' => 'example-topic-****',
],
],
],
'Name' => [
'description' => '修改后的管道名称。',
'type' => 'string',
'example' => 'example-pipeline-****',
],
'Role' => [
'description' => '当前RAM用户关联的角色。',
'type' => 'string',
'example' => 'AliyunMTSExampleRole',
],
'Id' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
'QuotaAllocate' => [
'description' => '管道配额分配。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1FE0F96B-544D-4244-9D83-DFCFB0E5A231\\",\\n \\"Pipeline\\": {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Paused\\",\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1,example2\\",\\n \\"QueueName\\": \\"example-queue-****\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"example-topic-****\\"\\n },\\n \\"Name\\": \\"example-pipeline-****\\",\\n \\"Role\\": \\"AliyunMTSExampleRole\\",\\n \\"Id\\": \\"d1ce4d3efcb549419193f50f1fcd****\\",\\n \\"QuotaAllocate\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1FE0F96B-544D-4244-9D83-DFCFB0E5A231\\n \\n Standard\\n Paused\\n \\n example1,example2\\n example-queue-****\\n mts-test\\n example-topic-****\\n \\n example-pipeline-****\\n AliyunMTSExampleRole\\n d1ce4d3efcb549419193f50f1fcd****\\n 10\\n \\n","errorExample":""}]',
'title' => '更新管道:名称、状态及通知设定',
'summary' => '更新管道。',
'description' => '- 本接口可以修改指定管道的名称、状态及通知设定。'."\n"
.'- 暂停管道后,如果工作流或其他单任务(如视频审核、视频DNA等)中选择使用状态为已暂停的管道,会导致任务失败无法进行。'."\n"
."\n"
.''."\n"
.'>暂停管道后,不会影响已经提交的任务。如果任务提交后关闭管道,已经进入处理排队的任务将无法取消,会正常执行并收取相应的费用。'."\n"
.'>'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPipelineList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PipelineIds',
'in' => 'query',
'schema' => [
'description' => '需要查询的管道ID列表,可通过**MPS控制台** > **全局设置** > **管道**获取。一次最多查询10个,用半角逗号(,)分隔。 ',
'type' => 'string',
'required' => true,
'example' => 'd1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1C538EAA-ACAF-5AD8-B091-A72C63007149',
],
'PipelineList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Pipeline' => [
'description' => '管道列表。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Speed' => [
'description' => '管道类型。默认值:**Standard**(标准管道)。可取值:'."\n"
."\n"
.'- **Boost**:倍速转码管道。'."\n"
."\n"
.'- **Standard**:标准管道。'."\n"
."\n"
.'- **NarrowBandHDV2**:窄带高清2.0管道。'."\n"
."\n"
.'- **AIVideoCover**:智能截图管道。'."\n"
."\n"
.'- **AIVideoFPShot**:视频DNA管道。'."\n"
."\n"
.'- **AIVideoCensor**:智能审核管道。'."\n"
."\n"
.'- **AIVideoMCU**:智能标签管道。'."\n"
."\n"
.'- **AIVideoSummary**:视频摘要管道。'."\n"
."\n"
.'- **AIVideoPorn**:视频鉴黄管道。'."\n"
."\n"
.'- **AIAudioKWS**:音频关键字识别管道。'."\n"
."\n"
.'- **AIAudioASR**:语音转文字管道。',
'type' => 'string',
'example' => 'Standard',
],
'State' => [
'description' => '管道状态。'."\n"
."\n"
.'- **Active**:管道开启。'."\n"
.'- **Paused**:管道暂停。',
'type' => 'string',
'example' => 'Paused',
],
'SpeedLevel' => [
'description' => '管道级别。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'NotifyConfig' => [
'description' => '阿里云MNS通知配置。',
'type' => 'object',
'properties' => [
'MqTopic' => [
'description' => '接收到的消息队列。',
'type' => 'string',
'example' => 'example1,example2',
],
'QueueName' => [
'description' => '阿里云轻量消息队列(原MNS) 中创建的队列名称。',
'type' => 'string',
'example' => 'example-queue-****',
],
'MqTag' => [
'description' => '标签。',
'type' => 'string',
'example' => 'mts-test',
],
'Topic' => [
'description' => '阿里云轻量消息队列(原MNS) 中创建的主题名称。',
'type' => 'string',
'example' => 'example-topic-****',
],
],
],
'Role' => [
'description' => '当前RAM用户关联的角色。',
'type' => 'string',
'example' => 'AliyunMTSDefaultRole',
],
'Name' => [
'description' => '管道名称。',
'type' => 'string',
'example' => 'example-pipeline-****',
],
'Id' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
'QuotaAllocate' => [
'description' => '管道配额分配。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'ExtendConfig' => [
'type' => 'object',
'properties' => [
'IsBoostNew' => [
'type' => 'boolean',
],
'MaxMultiSpeed' => [
'type' => 'integer',
'format' => 'int32',
],
'MultiSpeedDowngradePolicy' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'NonExistPids' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的管道ID列表。',
'type' => 'array',
'items' => [
'description' => '不存在的管道ID列表,无数据时该参数不返回。'."\n"
."\n"
.'> 如果输入的管道ID确认无误时返回此参数,请检查您提交请求的UID和管道所在UID是否为同一个。',
'type' => 'string',
'example' => '72dfa5e679ab4be9a3ed9974c736****',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C538EAA-ACAF-5AD8-B091-A72C63007149\\",\\n \\"PipelineList\\": {\\n \\"Pipeline\\": [\\n {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Paused\\",\\n \\"SpeedLevel\\": 2,\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1,example2\\",\\n \\"QueueName\\": \\"example-queue-****\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"example-topic-****\\"\\n },\\n \\"Role\\": \\"AliyunMTSDefaultRole\\",\\n \\"Name\\": \\"example-pipeline-****\\",\\n \\"Id\\": \\"d1ce4d3efcb549419193f50f1fcd****\\",\\n \\"QuotaAllocate\\": 10,\\n \\"ExtendConfig\\": {\\n \\"IsBoostNew\\": true,\\n \\"MaxMultiSpeed\\": 0,\\n \\"MultiSpeedDowngradePolicy\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"NonExistPids\\": {\\n \\"String\\": [\\n \\"72dfa5e679ab4be9a3ed9974c736****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1C538EAA-ACAF-5AD8-B091-A72C63007149\\n \\n Standard\\n Paused\\n 2\\n \\n example1,example2\\n example-queue-****\\n mts-test\\n example-topic-****\\n \\n AliyunMTSDefaultRole\\n example-pipeline-****\\n d1ce4d3efcb549419193f50f1fcd****\\n 10\\n \\n 72dfa5e679ab4be9a3ed9974c736****\\n","errorExample":""}]',
'title' => '查询管道',
'summary' => '通过管道ID查询管道。',
'description' => '- 本接口一次最多可查询10个管道。'."\n"
.'- 当返回值为`"Code": "InvalidIdentity.ServiceDisabled","Message": "The request identity was not allowed operated.","Recommend"`时,请检查您是否拥有MPS权限(是否授权AliyunMTSDefaultRole角色)、账号是否欠费。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SearchPipeline' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数大小。'."\n"
."\n"
.'- 上限值:**100**。'."\n"
."\n"
.'- 默认值:**10**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页号。默认值:**1**。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '需要搜索的管道状态。如果为空则默认搜索所有管道。'."\n"
."\n"
.'- **All**:全部管道。'."\n"
."\n"
.'- **Active**:管道开启。'."\n"
."\n"
.'- **Paused**:管道暂停。'."\n"
."\n"
.'- 默认值:**All**。',
'type' => 'string',
'required' => false,
'example' => 'Paused',
'default' => 'All',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '每页行数大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5',
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PipelineList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Pipeline' => [
'description' => '管道列表。',
'type' => 'array',
'items' => [
'description' => '管道详细信息。',
'type' => 'object',
'properties' => [
'Speed' => [
'description' => '管道类型。默认值:**Standard**(标准管道)。可取值:'."\n"
."\n"
.'- **Boost**:倍速转码管道。'."\n"
."\n"
.'- **Standard**:标准管道。'."\n"
."\n"
.'- **NarrowBandHDV2**:窄带高清2.0管道。'."\n"
."\n"
.'- **AIVideoCover**:智能截图管道。'."\n"
."\n"
.'- **AIVideoFPShot**:视频DNA管道。'."\n"
."\n"
.'- **AIVideoCensor**:智能审核管道。'."\n"
."\n"
.'- **AIVideoMCU**:智能标签管道。'."\n"
."\n"
.'- **AIVideoSummary**:视频摘要管道。'."\n"
."\n"
.'- **AIVideoPorn**:视频鉴黄管道。'."\n"
."\n"
.'- **AIAudioKWS**:音频关键字识别管道。'."\n"
."\n"
.'- **AIAudioASR**:语音转文字管道。',
'type' => 'string',
'example' => 'Standard',
],
'State' => [
'description' => '管道状态。可取值:'."\n"
."\n"
.'- **Active**:管道开启。'."\n"
.'- **Paused**:管道暂停。',
'type' => 'string',
'example' => 'Paused',
],
'SpeedLevel' => [
'description' => '管道级别。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'NotifyConfig' => [
'description' => 'MNS通知配置。',
'type' => 'object',
'properties' => [
'MqTopic' => [
'description' => '接收到的消息队列。',
'type' => 'string',
'example' => 'example1,example2',
],
'QueueName' => [
'description' => '阿里云轻量消息队列(原MNS)中创建的队列。',
'type' => 'string',
'example' => 'example-queue-****',
],
'MqTag' => [
'description' => '标签。',
'type' => 'string',
'example' => 'mts-test',
],
'Topic' => [
'description' => '阿里云轻量消息队列(原MNS)中创建的主题。',
'type' => 'string',
'example' => 'example-topic-****',
],
],
],
'Role' => [
'description' => '当前RAM用户关联的角色。',
'type' => 'string',
'example' => 'AliyunMTSDefaultRole',
],
'Name' => [
'description' => '管道名称。',
'type' => 'string',
'example' => 'example-pipeline-****',
],
'Id' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
'QuotaAllocate' => [
'description' => '管道配额分配。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'CreationTime' => [
'title' => '管道创建时间',
'description' => '管道创建时间。',
'type' => 'string',
'example' => ' 2021-03-04T06:44:43Z',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"PageNumber\\": 1,\\n \\"PipelineList\\": {\\n \\"Pipeline\\": [\\n {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Paused\\",\\n \\"SpeedLevel\\": 1,\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1,example2\\",\\n \\"QueueName\\": \\"example-queue-****\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"example-topic-****\\"\\n },\\n \\"Role\\": \\"AliyunMTSDefaultRole\\",\\n \\"Name\\": \\"example-pipeline-****\\",\\n \\"Id\\": \\"d1ce4d3efcb549419193f50f1fcd****\\",\\n \\"QuotaAllocate\\": 10,\\n \\"CreationTime\\": \\" 2021-03-04T06:44:43Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 10\\n 338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\n 1\\n \\n Standard\\n Paused\\n 1\\n \\n example1,example2\\n example-queue-****\\n mts-test\\n example-topic-****\\n \\n AliyunMTSDefaultRole\\n example-pipeline-****\\n d1ce4d3efcb549419193f50f1fcd****\\n 10\\n \\n","errorExample":""}]',
'title' => '搜索管道',
'summary' => '通过管道状态搜索管道。',
'description' => '本接口通过管道状态搜索管道,如果不指定管道状态则默认搜索全部管道。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddPipeline' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '管道名称,最大长度128字节。',
'type' => 'string',
'required' => true,
'example' => 'test-pipeline',
],
],
[
'name' => 'Speed',
'in' => 'query',
'schema' => [
'description' => '管道类型。'."\n"
.'取值:'."\n"
."\n"
.'- **Boost**:倍速转码'."\n"
.'- **Standard**:普通管道'."\n"
.'- **NarrowBandHDV2**:窄带高清2.0'."\n"
.'- **AIVideoCover**:智能截图'."\n"
.'- **AIVideoTag**:视频标签(支持区域上海、北京、杭州)'."\n"
."\n\n"
.'默认值:**Standard**。',
'type' => 'string',
'required' => false,
'example' => 'Standard',
'default' => 'Standard',
],
],
[
'name' => 'SpeedLevel',
'in' => 'query',
'schema' => [
'description' => '管道级别,取值范围:**\\[1,3\\]**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'NotifyConfig',
'in' => 'query',
'schema' => [
'description' => 'MNS通知配置。',
'type' => 'string',
'required' => false,
'example' => '{"Topic":"mts-topic-1"}',
],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => [
'description' => '角色。',
'type' => 'string',
'required' => false,
'example' => 'AliyunMTSDefaultRole',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CFEA608A-5A1C-4C83-A54B-6197BC250D23',
],
'Pipeline' => [
'description' => '管道。',
'type' => 'object',
'properties' => [
'Speed' => [
'description' => '管道类型。',
'type' => 'string',
'example' => 'Standard',
],
'State' => [
'description' => '管道状态。'."\n"
."\n"
.'- Active:表示管道内的作业会被媒体转码服务调度转码执行。'."\n"
.'- Paused:表示管道暂停,作业不再会被媒体转码调度转码执行,管道内的所有作业状态维持在已提交状态,已经处于转码中的任务将继续转码,不受影响。',
'type' => 'string',
'example' => 'Active',
],
'SpeedLevel' => [
'description' => '管道级别。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'NotifyConfig' => [
'description' => 'MNS通知配置。',
'type' => 'object',
'properties' => [
'MqTopic' => [
'description' => '消息队列topic。',
'type' => 'string',
'example' => 'example1',
],
'QueueName' => [
'description' => '队列名称。',
'type' => 'string',
'example' => 'mts-queue-1',
],
'MqTag' => [
'description' => '消息队列mq标签。',
'type' => 'string',
'example' => 'mts-test',
],
'Topic' => [
'description' => '主题名称。',
'type' => 'string',
'example' => 'mts-topic-1',
],
],
],
'Role' => [
'description' => '角色。',
'type' => 'string',
'example' => 'AliyunMTSDefaultRole',
],
'Name' => [
'description' => '管道名称。',
'type' => 'string',
'example' => '视频DNA',
],
'Id' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'ed450ea0bfbd41e29f80a401fb4d****',
],
'QuotaAllocate' => [
'description' => '管道配额分配。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFEA608A-5A1C-4C83-A54B-6197BC250D23\\",\\n \\"Pipeline\\": {\\n \\"Speed\\": \\"Standard\\",\\n \\"State\\": \\"Active\\",\\n \\"SpeedLevel\\": 1,\\n \\"NotifyConfig\\": {\\n \\"MqTopic\\": \\"example1\\",\\n \\"QueueName\\": \\"mts-queue-1\\",\\n \\"MqTag\\": \\"mts-test\\",\\n \\"Topic\\": \\"mts-topic-1\\"\\n },\\n \\"Role\\": \\"AliyunMTSDefaultRole\\",\\n \\"Name\\": \\"视频DNA\\",\\n \\"Id\\": \\"ed450ea0bfbd41e29f80a401fb4d****\\",\\n \\"QuotaAllocate\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n CFEA608A-5A1C-4C83-A54B-6197BC250D23\\n \\n Standard\\n Active\\n 1\\n \\n example1\\n mts-queue-1\\n mts-test\\n mts-topic-1\\n \\n AliyunMTSDefaultRole\\n 视频DNA\\n ed450ea0bfbd41e29f80a401fb4d****\\n 10\\n \\n","errorExample":""}]',
'title' => '添加管道',
'summary' => '新增一个管道。',
],
'DeletePipeline' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '需要删除的管道ID。可以通过**MPS控制台** > **全局设置** > **管道**获取。',
'type' => 'string',
'required' => true,
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5',
],
'PipelineId' => [
'description' => '被删除的管道ID。',
'type' => 'string',
'example' => 'd1ce4d3efcb549419193f50f1fcd****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"PipelineId\\": \\"d1ce4d3efcb549419193f50f1fcd****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\n d1ce4d3efcb549419193f50f1fcd****\\n","errorExample":""}]',
'title' => '删除管道',
'summary' => '删除管道。',
'description' => '本接口一次只能删除一个管道。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'AddMediaWorkflow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '媒体工作流名称。'."\n"
."\n"
.'- 不能为空串。'."\n"
.'- 同一账号下的工作流名称不可重复。'."\n"
.'- 不超过64个字符。'."\n"
.'- UTF-8编码。',
'type' => 'string',
'required' => true,
'example' => 'mediaworkflow-example',
],
],
[
'name' => 'Topology',
'in' => 'query',
'schema' => [
'description' => '媒体工作流拓扑结构。格式为JSON对象,包括活动列表及活动依赖。更多信息请参见下文**Topology示例**。 '."\n"
."\n"
.'> OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{"Activities": {"mediaworkflow-example": {"Parameters": {"Outputs": "[{\\"OutputObject\\":\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\",\\"TemplateId\\":\\"S00000001-200010\\",\\"TemplateName\\":\\"MP4-流畅\\"}]","OutputBucket": "examplebucket","OutputLocation": "oss-cn-shanghai"},"Type": "Transcode"},"Act-Start": {"Parameters": {"PipelineId": "a7d481f07d8c45da88c71853ce7d****","InputFile": "{\\"Bucket\\":\\"example-input\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"ObjectPrefix\\":\\"mps-test/input/\\"}"},"Type": "Start"},"Act-Report": {"Parameters": {"PublishType": "Manual"},"Type": "Report"}},"Dependencies": {"mediaworkflow-example": ["Act-Report"],"Act-Start": ["mediaworkflow-example"],"Act-Report": []}}',
],
],
[
'name' => 'TriggerMode',
'in' => 'query',
'schema' => [
'description' => '触发模式。 取值:'."\n"
."\n"
.'- **OssAutoTrigger**:自动触发。'."\n"
."\n"
.'- **NotInAuto**:不自动触发。',
'type' => 'string',
'required' => false,
'example' => 'OssAutoTrigger',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F1D21261-ADB9-406A-1234-491382139D59',
],
'MediaWorkflow' => [
'description' => '媒体工作流详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '016-04-01T05:29:37Z',
],
'MediaWorkflowId' => [
'description' => '媒体工作流ID。建议您保存此ID便于后续对此工作流进行其他操作。',
'type' => 'string',
'example' => 'e00732b977da427d9177a4deb1aa****',
],
'State' => [
'description' => '媒体工作流状态。新建的工作流默认为**Active**(激活)状态。',
'type' => 'string',
'example' => 'Active',
],
'TriggerMode' => [
'description' => '触发模式。取值:'."\n"
."\n"
.'- **OssAutoTrigger**:自动触发。'."\n"
."\n"
.'- **NotInAuto**:不自动触发。',
'type' => 'string',
'example' => 'OssAutoTrigger',
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'mediaworkflow-example',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。格式为JSON对象,包括活动列表及活动依赖。',
'type' => 'string',
'example' => '{"Activities": {"mediaworkflow-example": {"Parameters": {"Outputs": "[{\\"OutputObject\\":\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\",\\"TemplateId\\":\\"S00000001-200010\\",\\"TemplateName\\":\\"MP4-流畅\\"}]","OutputBucket": "examplebucket","OutputLocation": "oss-cn-shanghai"},"Type": "Transcode"},"Act-Start": {"Parameters": {"PipelineId": "a7d481f07d8c45da88c71853ce7d****","InputFile": "{\\"Bucket\\":\\"example-input\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"ObjectPrefix\\":\\"mps-test/input/\\"}"},"Type": "Start"},"Act-Report": {"Parameters": {"PublishType": "Manual"},"Type": "Report"}},"Dependencies": {"mediaworkflow-example": ["Act-Report"],"Act-Start": ["mediaworkflow-example"],"Act-Report": []}}',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1D21261-ADB9-406A-1234-491382139D59\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"e00732b977da427d9177a4deb1aa****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"mediaworkflow-example\\",\\n \\"Topology\\": \\"{\\\\\\"Activities\\\\\\": {\\\\\\"mediaworkflow-example\\\\\\": {\\\\\\"Parameters\\\\\\": {\\\\\\"Outputs\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"OutputObject\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"S00000001-200010\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MP4-流畅\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\": \\\\\\"examplebucket\\\\\\",\\\\\\"OutputLocation\\\\\\": \\\\\\"oss-cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\": \\\\\\"Transcode\\\\\\"},\\\\\\"Act-Start\\\\\\": {\\\\\\"Parameters\\\\\\": {\\\\\\"PipelineId\\\\\\": \\\\\\"a7d481f07d8c45da88c71853ce7d****\\\\\\",\\\\\\"InputFile\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-shanghai\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ObjectPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mps-test/input/\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\": \\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\": {\\\\\\"Parameters\\\\\\": {\\\\\\"PublishType\\\\\\": \\\\\\"Manual\\\\\\"},\\\\\\"Type\\\\\\": \\\\\\"Report\\\\\\"}},\\\\\\"Dependencies\\\\\\": {\\\\\\"mediaworkflow-example\\\\\\": [\\\\\\"Act-Report\\\\\\"],\\\\\\"Act-Start\\\\\\": [\\\\\\"mediaworkflow-example\\\\\\"],\\\\\\"Act-Report\\\\\\": []}}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F1D21261-ADB9-406A-1234-491382139D59\\n \\n 016-04-01T05:29:37Z\\n e00732b977da427d9177a4deb1aa****\\n Active\\n OssAutoTrigger\\n mediaworkflow-example\\n {\\"Activities\\": {\\"mediaworkflow-example\\": {\\"Parameters\\": {\\"Outputs\\": \\"[{\\\\\\"OutputObject\\\\\\":\\\\\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\":\\\\\\"S00000001-200010\\\\\\",\\\\\\"TemplateName\\\\\\":\\\\\\"MP4-流畅\\\\\\"}]\\",\\"OutputBucket\\": \\"examplebucket\\",\\"OutputLocation\\": \\"oss-cn-shanghai\\"},\\"Type\\": \\"Transcode\\"},\\"Act-Start\\": {\\"Parameters\\": {\\"PipelineId\\": \\"a7d481f07d8c45da88c71853ce7d****\\",\\"InputFile\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"example-input\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"ObjectPrefix\\\\\\":\\\\\\"mps-test/input/\\\\\\"}\\"},\\"Type\\": \\"Start\\"},\\"Act-Report\\": {\\"Parameters\\": {\\"PublishType\\": \\"Manual\\"},\\"Type\\": \\"Report\\"}},\\"Dependencies\\": {\\"mediaworkflow-example\\": [\\"Act-Report\\"],\\"Act-Start\\": [\\"mediaworkflow-example\\"],\\"Act-Report\\": []}}\\n \\n","errorExample":""}]',
'title' => '新增媒体工作流',
'summary' => '新增媒体工作流。',
'description' => '- 本接口可以定义媒体工作流的拓扑结构(DAG)、活动以及依赖关系。活动详情,请参见[媒体工作流活动介绍](~~68494~~)。使用本接口创建的工作流可以在媒体处理控制台查看并调用。'."\n"
.'- MPS媒体工作流仅支持通过前缀(文件路径)自动触发工作流,不支持通过后缀名触发工作流执行。详细触发规则,请参见[媒体工作流的文件触发匹配规则](~~68574~~)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => '**Topology示例**'."\n"
."\n"
.'> OSS的地域需要与当前MPS所在地域保持一致。'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Activities": {'."\n"
.' "mediaworkflow-example": {'."\n"
.' "Parameters": {'."\n"
.' "Outputs": "[{\\"OutputObject\\":\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\",\\"TemplateId\\":\\"S00000001-200010\\",\\"TemplateName\\":\\"MP4-流畅\\"}]",'."\n"
.' "OutputBucket": "examplebucket",'."\n"
.' "OutputLocation": "oss-cn-shanghai"'."\n"
.' },'."\n"
.' "Type": "Transcode"'."\n"
.' },'."\n"
.' "Act-Start": {'."\n"
.' "Parameters": {'."\n"
.' "PipelineId": "a7d481f07d8c45da88c71853ce7d****",'."\n"
.' "InputFile": "{\\"Bucket\\":\\"example-input\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"ObjectPrefix\\":\\"mps-test/input/\\"}"'."\n"
.' },'."\n"
.' "Type": "Start"'."\n"
.' },'."\n"
.' "Act-Report": {'."\n"
.' "Parameters": {'."\n"
.' "PublishType": "Manual"'."\n"
.' },'."\n"
.' "Type": "Report"'."\n"
.' }'."\n"
.' },'."\n"
.' "Dependencies": {'."\n"
.' "mediaworkflow-example": ["Act-Report"],'."\n"
.' "Act-Start": ["mediaworkflow-example"],'."\n"
.' "Act-Report": []'."\n"
.' }'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ActivateMediaWorkflow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'MediaWorkflowId',
'in' => 'query',
'schema' => [
'description' => '媒体工作流ID。此参数可从[新增媒体工作流](~~44437~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'example' => '93ab850b4f6f44eab54b6e9181d4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A1326BD4-30B1-4CB6-Q123-3330B877B0D4',
],
'MediaWorkflow' => [
'description' => '媒体工作流详细参数。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '媒体工作流创建时间。',
'type' => 'string',
'example' => '2016-04-01T05:29:37Z',
],
'MediaWorkflowId' => [
'description' => '媒体工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e9181d4****',
],
'State' => [
'description' => '媒体工作流状态。此接口返回参数中状态默认为**Active**( 已激活)。',
'type' => 'string',
'example' => 'Active',
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'mediaworkflow-example',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。',
'type' => 'string',
'example' => '{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"oss-cn-hangzhou\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"OutputObject\\\\\\":\\\\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"panda-vod-hls\\",\\"OutputLocation\\":\\"oss-cn-hangzhou\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1326BD4-30B1-4CB6-Q123-3330B877B0D4\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Active\\",\\n \\"Name\\": \\"mediaworkflow-example\\",\\n \\"Topology\\": \\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"oss-cn-hangzhou\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"OutputObject\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"panda-vod-hls\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A1326BD4-30B1-4CB6-Q123-3330B877B0D4\\n \\n 2016-04-01T05:29:37Z\\n 93ab850b4f6f44eab54b6e9181d4****\\n Active\\n mediaworkflow-example\\n {\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"oss-cn-hangzhou\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"OutputObject\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode%2F%7BObjectPrefix%7D%7BFileName%7D\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"panda-vod-hls\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"oss-cn-hangzhou\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\n \\n","errorExample":""}]',
'title' => '激活媒体工作流',
'summary' => '激活媒体工作流。',
'description' => '当媒体工作流处于停用状态时,可以通过此接口激活。当媒体工作流处于激活状态时,无法修改工作流信息(包括名称、拓扑结构、触发模式等)。新建的工作流默认为Active(激活)状态,无需手动激活。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeactivateMediaWorkflow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'MediaWorkflowId',
'in' => 'query',
'schema' => [
'description' => '需要停用的媒体工作流ID,可以通过**MPS控制台** > **工作流管理** > **工作流设置**获取。',
'type' => 'string',
'required' => true,
'example' => '93ab850b4f6f44eab54b6e9181d4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '16CD0CDD-457E-420D-9755-8385075A1234',
],
'MediaWorkflow' => [
'description' => '媒体工作流详细参数。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-04-01T05:29:37Z',
],
'MediaWorkflowId' => [
'description' => '被停用的媒体工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e9181d4****',
],
'State' => [
'description' => '状态。此处返回**Inactive**(停用)。',
'type' => 'string',
'example' => 'Inactive',
],
'Name' => [
'description' => '被停用的媒体工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。',
'type' => 'string',
'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-9755-8385075A1234\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Inactive\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16CD0CDD-457E-420D-9755-8385075A1234\\n \\n 2016-04-01T05:29:37Z\\n 93ab850b4f6f44eab54b6e9181d4****\\n Inactive\\n example-mediaworkflow-****\\n {mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}\\n \\n","errorExample":""}]',
'title' => '停用媒体工作流',
'summary' => '停用媒体工作流。',
'description' => '- 当媒体工作流被停用时,可以对工作流信息进行修改。'."\n"
.'- 删除或停用工作流后,工作流将无法使用。此时,如果上传文件至工作流指定的Bucket路径中,也不会自动触发工作流执行。'."\n"
."\n"
.''."\n"
.'>删除或停用工作流后,不会影响已经提交的任务。如果提交任务后删除或停用工作流,已经进入处理排队中的任务将无法取消,会正常执行并收取对应的费用。'."\n"
.'>'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteMediaWorkflow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'MediaWorkflowId',
'in' => 'query',
'schema' => [
'description' => '需要删除的媒体工作流ID,可以通过**MPS控制台** > **工作流管理** > **工作流设置**获取。',
'type' => 'string',
'required' => true,
'example' => '93ab850b4f6f44eab54b6e9181d4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7D752035-97DA-54E5-88E2-E8405EEA4394',
],
'MediaWorkflow' => [
'description' => '媒体工作流详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-04-01T05:29:37Z',
],
'MediaWorkflowId' => [
'description' => '被删除的媒体工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e9181d4****',
],
'State' => [
'description' => '状态。此处返回**Deleted**(已删除)。',
'type' => 'string',
'example' => 'Deleted',
],
'Name' => [
'description' => '被删除的媒体工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。',
'type' => 'string',
'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D752035-97DA-54E5-88E2-E8405EEA4394\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Deleted\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7D752035-97DA-54E5-88E2-E8405EEA4394\\n \\n 2016-04-01T05:29:37Z\\n 93ab850b4f6f44eab54b6e9181d4****\\n Deleted\\n example-mediaworkflow-****\\n {mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}\\n \\n","errorExample":""}]',
'title' => '删除媒体工作流',
'summary' => '删除媒体工作流。',
'description' => '删除或停用工作流后,工作流将无法使用。此时,如果上传文件至工作流指定的Bucket路径中,也不会自动触发工作流执行。'."\n"
.''."\n"
.'>删除或停用工作流后,不会影响已经提交的任务。如果提交任务后删除或停用工作流,已经进入处理排队中的任务将无法取消,会正常执行并收取对应的费用。'."\n"
.'>'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateMediaWorkflow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '25042',
'abilityTreeNodes' => [
'FEATUREmts0IG2Y5',
],
],
'parameters' => [
[
'name' => 'MediaWorkflowId',
'in' => 'query',
'schema' => [
'description' => '需要更新的媒体工作流ID,可以通过**MPS控制台** > **工作流管理** > **工作流设置**获取。',
'type' => 'string',
'required' => true,
'example' => '6307eb0d3f85477882d205aa040f****',
],
],
[
'name' => 'Topology',
'in' => 'query',
'schema' => [
'description' => '更新的媒体工作流拓扑结构。JSON对象,包括活动列表及活动依赖。 '."\n"
."\n"
.'> OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{'."\n"
.' "Activities": {'."\n"
.' "Act-Start": {'."\n"
.' "Parameters": {'."\n"
.' "PipelineId": "130266f58161436a80bf07cb12c8****",'."\n"
.' "InputFile": "{\\"Bucket\\": \\"example-bucket-****\\",\\"Location\\": \\"cn-shanghai\\"}"'."\n"
.' },'."\n"
.' "Type": "Start"'."\n"
.' },'."\n"
.' "Act-Report": {'."\n"
.' "Parameters": {},'."\n"
.' "Type": "Report"'."\n"
.' },'."\n"
.' "Act-Transcode-M3U8": {'."\n"
.' "Parameters": {'."\n"
.' "Outputs": "[{\\"Object\\":\\"transcode/{ObjectPrefix}{FileName}\\",\\"TemplateId\\": \\"957d1719ee85ed6527b90cf62726****\\"}]",'."\n"
.' "OutputBucket": "example-bucket-****",'."\n"
.' "OutputLocation": "cn-shanghai"'."\n"
.' },'."\n"
.' "Type": "Transcode"'."\n"
.' }'."\n"
.' },'."\n"
.' "Dependencies": {'."\n"
.' "Act-Start": ['."\n"
.' "Act-Transcode-M3U8"'."\n"
.' ],'."\n"
.' "Act-Report": [],'."\n"
.' "Act-Transcode-M3U8": ['."\n"
.' "Act-Report"'."\n"
.' ]'."\n"
.' }'."\n"
.'}',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '媒体工作流名称。'."\n"
."\n"
.'- 不能为空串。'."\n"
.'- 同一账号下的工作流名称不可重复。'."\n"
.'- 不超过 64 个字符。'."\n"
.'- UTF-8 编码。',
'type' => 'string',
'required' => false,
'example' => 'mediaworkflow-example'."\n",
],
],
[
'name' => 'TriggerMode',
'in' => 'query',
'schema' => [
'description' => '触发模式。 取值:'."\n"
.'- OssAutoTrigger:自动触- 发。'."\n"
.'- NotInAuto:不自动触发。',
'type' => 'string',
'required' => false,
'example' => 'OssAutoTrigger',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7D752035-97DA-54E5-88E2-E8405EEA****',
],
'MediaWorkflow' => [
'description' => '媒体工作流详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-04-01T05:29:38Z',
],
'MediaWorkflowId' => [
'description' => '更新的媒体工作流ID。',
'type' => 'string',
'example' => '6307eb0d3f85477882d205aa040f****',
],
'State' => [
'description' => '媒体工作流状态。可取值:'."\n"
."\n"
.'- **Inactive**:已停用。'."\n"
."\n"
.'- **Active**:已启用。',
'type' => 'string',
'example' => 'Active',
],
'TriggerMode' => [
'description' => '触发模式。可取值:'."\n"
."\n"
.'- **OssAutoTrigger**:自动触发。'."\n"
."\n"
.'- **NotInAuto**:不自动触发。',
'type' => 'string',
'example' => 'OssAutoTrigger',
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'examp-mediaworkflow-****',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。',
'type' => 'string',
'example' => '{'."\n"
.' "Activities": {'."\n"
.' "Act-Start": {'."\n"
.' "Parameters": {'."\n"
.' "PipelineId": "130266f58161436a80bf07cb12c8****",'."\n"
.' "InputFile": "{\\"Bucket\\": \\"example-bucket-****\\",\\"Location\\": \\"cn-shanghai\\"}"'."\n"
.' },'."\n"
.' "Type": "Start"'."\n"
.' },'."\n"
.' "Act-Report": {'."\n"
.' "Parameters": {},'."\n"
.' "Type": "Report"'."\n"
.' },'."\n"
.' "Act-Transcode-M3U8": {'."\n"
.' "Parameters": {'."\n"
.' "Outputs": "[{\\"Object\\":\\"transcode/{ObjectPrefix}{FileName}\\",\\"TemplateId\\": \\"957d1719ee85ed6527b90cf62726****\\"}]",'."\n"
.' "OutputBucket": "example-bucket-****",'."\n"
.' "OutputLocation": "cn-shanghai"'."\n"
.' },'."\n"
.' "Type": "Transcode"'."\n"
.' }'."\n"
.' },'."\n"
.' "Dependencies": {'."\n"
.' "Act-Start": ['."\n"
.' "Act-Transcode-M3U8"'."\n"
.' ],'."\n"
.' "Act-Report": [],'."\n"
.' "Act-Transcode-M3U8": ['."\n"
.' "Act-Report"'."\n"
.' ]'."\n"
.' }'."\n"
.'}',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D752035-97DA-54E5-88E2-E8405EEA****\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:38Z\\",\\n \\"MediaWorkflowId\\": \\"6307eb0d3f85477882d205aa040f****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"examp-mediaworkflow-****\\",\\n \\"Topology\\": \\"{\\\\n \\\\\\"Activities\\\\\\": {\\\\n \\\\\\"Act-Start\\\\\\": {\\\\n \\\\\\"Parameters\\\\\\": {\\\\n \\\\\\"PipelineId\\\\\\": \\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\n \\\\\\"InputFile\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"\\\\n },\\\\n \\\\\\"Type\\\\\\": \\\\\\"Start\\\\\\"\\\\n },\\\\n \\\\\\"Act-Report\\\\\\": {\\\\n \\\\\\"Parameters\\\\\\": {},\\\\n \\\\\\"Type\\\\\\": \\\\\\"Report\\\\\\"\\\\n },\\\\n \\\\\\"Act-Transcode-M3U8\\\\\\": {\\\\n \\\\\\"Parameters\\\\\\": {\\\\n \\\\\\"Outputs\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\n \\\\\\"OutputBucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\n \\\\\\"OutputLocation\\\\\\": \\\\\\"cn-shanghai\\\\\\"\\\\n },\\\\n \\\\\\"Type\\\\\\": \\\\\\"Transcode\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"Dependencies\\\\\\": {\\\\n \\\\\\"Act-Start\\\\\\": [\\\\n \\\\\\"Act-Transcode-M3U8\\\\\\"\\\\n ],\\\\n \\\\\\"Act-Report\\\\\\": [],\\\\n \\\\\\"Act-Transcode-M3U8\\\\\\": [\\\\n \\\\\\"Act-Report\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7D752035-97DA-54E5-88E2-E8405EEA****\\n \\n 2016-04-01T05:29:38Z\\n 6307eb0d3f85477882d205aa040f****\\n Active\\n OssAutoTrigger\\n examp-mediaworkflow-****\\n {mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}\\n \\n","errorExample":""}]',
'title' => '更新媒体工作流的拓扑结构',
'summary' => '更新媒体工作流。',
'description' => '- 本接口用于更新媒体工作流的拓扑结构。如需更新媒体工作流触发模式,请参见[更新媒体工作流触发模式](~~70372~~)。'."\n"
.'- 删除或停用工作流后,工作流将无法使用。此时,如果上传文件至工作流指定的Bucket路径中,也不会自动触发工作流执行。'."\n"
."\n"
.''."\n"
.'>删除或停用工作流后,不会影响已经提交的任务。如果提交任务后删除或停用工作流,已经进入处理排队中的任务将无法取消,会正常执行并收取对应的费用。'."\n"
.'>'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMediaWorkflowList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'MediaWorkflowIds',
'in' => 'query',
'schema' => [
'description' => '媒体工作流ID,可以通过**MPS控制台** > **工作流管理** > **工作流设置**获取。半角逗号(,)分隔,一次最多查询10个。',
'type' => 'string',
'required' => true,
'example' => '93ab850b4f6f44eab54b6e9181d4****,72dfa5e679ab4be9a3ed9974c736****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'NonExistMediaWorkflowIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaWorkflowId' => [
'description' => '不存在的工作流。',
'type' => 'array',
'items' => [
'description' => '不存在的媒体工作流ID列表,无数据时该参数不返回。',
'type' => 'string',
'example' => '72dfa5e679ab4be9a3ed9974c736****',
],
],
],
],
'MediaWorkflowList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaWorkflow' => [
'description' => '媒体工作流列表。',
'type' => 'array',
'items' => [
'description' => '媒体工作流详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-04-01T05:29:38Z',
],
'MediaWorkflowId' => [
'description' => '媒体工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e9181d4****',
],
'State' => [
'description' => '媒体工作流状态。可取值:'."\n"
."\n"
.'- **Inactive**:已停用。'."\n"
."\n"
.'- **Active**:已激活。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Active',
],
'TriggerMode' => [
'description' => '触发模式。可取值:'."\n"
."\n"
.'- **OssAutoTrigger**:自动触发。'."\n"
."\n"
.'- **NotInAuto**:不自动触发。',
'type' => 'string',
'example' => 'OssAutoTrigger',
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。',
'type' => 'string',
'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '16CD0CDD-457E-420D-1234-8385075A618B',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NonExistMediaWorkflowIds\\": {\\n \\"MediaWorkflowId\\": [\\n \\"72dfa5e679ab4be9a3ed9974c736****\\"\\n ]\\n },\\n \\"MediaWorkflowList\\": {\\n \\"MediaWorkflow\\": [\\n {\\n \\"CreationTime\\": \\"2016-04-01T05:29:38Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e9181d4****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-1234-8385075A618B\\"\\n}","type":"json"}]',
'title' => '查询已注册媒体工作流',
'summary' => '查询已注册的媒体工作流。',
'description' => '本接口一次最多查询10个媒体工作流。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SearchMediaWorkflow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分查询时设置的每页大小。'."\n"
."\n"
.'- 上限值:**100**。'."\n"
."\n"
.'- 默认值:**10**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页号。 默认值:**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'StateList',
'in' => 'query',
'schema' => [
'description' => '媒体工作流状态列表。 可多选,用半角逗号(,)分隔。默认值:“**Inactive,Active,Deleted**”(搜索全部)。取值范围:'."\n"
."\n"
.'- **Inactive**:已停用。'."\n"
."\n"
.'- **Active**:已启用。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'required' => false,
'example' => 'Inactive,Active,Deleted',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MediaWorkflowList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaWorkflow' => [
'description' => '媒体工作流列表。',
'type' => 'array',
'items' => [
'description' => '媒体工作流详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-04-01T05:38:41Z',
],
'MediaWorkflowId' => [
'description' => '媒体工作流ID。',
'type' => 'string',
'example' => '88c6ca184c0e4578645b665e2a12****',
],
'State' => [
'description' => '状态。可取值:'."\n"
."\n"
.'- **Inactive**:已停用。'."\n"
."\n"
.'- **Active**:已启用。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Active',
],
'TriggerMode' => [
'description' => '触发模式。可取值:'."\n"
."\n"
.'- **OssAutoTrigger**:自动触发。'."\n"
."\n"
.'- **NotInAuto**:不自动触发。',
'type' => 'string',
'example' => 'OssAutoTrigger',
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。',
'type' => 'string',
'example' => '{"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' => [
'description' => '分查询时设置的每页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '16CD0CDD-457E-420D-9755-8385075A1234',
],
'PageNumber' => [
'description' => '当前页号。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"MediaWorkflowList\\": {\\n \\"MediaWorkflow\\": [\\n {\\n \\"CreationTime\\": \\"2016-04-01T05:38:41Z\\",\\n \\"MediaWorkflowId\\": \\"88c6ca184c0e4578645b665e2a12****\\",\\n \\"State\\": \\"Active\\",\\n \\"TriggerMode\\": \\"OssAutoTrigger\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"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\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-9755-8385075A1234\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n 2016-04-01T05:38:41Z\\n 88c6ca184c0e4578645b665e2a12****\\n Active\\n OssAutoTrigger\\n example-mediaworkflow-****\\n {\\"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\\"}\\n \\n 10\\n 16CD0CDD-457E-420D-9755-8385075A1234\\n 1\\n","errorExample":""}]',
'title' => '搜索媒体工作流',
'summary' => '搜索媒体工作流。',
'description' => '本接口通过指定工作流状态搜索工作流,如果不指定则默认搜索全部状态的工作流。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateMediaWorkflowTriggerMode' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'MediaWorkflowId',
'in' => 'query',
'schema' => [
'description' => '需要更新的媒体工作流ID,可以通过**MPS控制台** > **工作流管理** > **工作流设置**获取。',
'type' => 'string',
'required' => true,
'example' => 'e00732b977da427d9177a4dee646****',
],
],
[
'name' => 'TriggerMode',
'in' => 'query',
'schema' => [
'description' => '触发模式。取值范围:'."\n"
."\n"
.'- **OssAutoTrigger**:自动触发。'."\n"
."\n"
.'- **NotInAuto**:不自动触发。',
'type' => 'string',
'required' => true,
'example' => 'NotInAuto',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '16CD0CDD-457E-420D-9755-8385075A1234',
],
'MediaWorkflow' => [
'description' => '媒体工作流详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-04-01T05:29:37Z',
],
'MediaWorkflowId' => [
'description' => '媒体工作流ID。',
'type' => 'string',
'example' => 'e00732b977da427d9177a4dee646****',
],
'State' => [
'description' => '媒体工作流状态。可取值:'."\n"
."\n"
.'- **Inactive**:已停用。'."\n"
."\n"
.'- **Active**:已启用。',
'type' => 'string',
'example' => 'Inactive',
],
'TriggerMode' => [
'description' => '触发模式。可取值:'."\n"
."\n"
.'- **OssAutoTrigger**:自动触发。'."\n"
."\n"
.'- **NotInAuto**:不自动触发。',
'type' => 'string',
'example' => 'NotInAuto',
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'Topology' => [
'description' => '媒体工作流拓扑结构。',
'type' => 'string',
'example' => '{mediaworkflow","State":"Active","Topology":"{\\"Activities\\":{\\"Act-Start\\":{\\"Parameters\\":{\\"PipelineId\\":\\"130266f58161436a80bf07cb12c8****\\",\\"InputFile\\":\\"{\\\\\\"Bucket\\\\\\": \\\\\\"example-bucket-****\\\\\\",\\\\\\"Location\\\\\\": \\\\\\"cn-shanghai\\\\\\"}\\"},\\"Type\\":\\"Start\\"},\\"Act-Report\\":{\\"Parameters\\":{},\\"Type\\":\\"Report\\"},\\"Act-Transcode-M3U8\\":{\\"Parameters\\":{\\"Outputs\\":\\"[{\\\\\\"Object\\\\\\":\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\",\\\\\\"TemplateId\\\\\\": \\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\"}]\\",\\"OutputBucket\\":\\"example-bucket-****\\",\\"OutputLocation\\":\\"cn-shanghai\\"},\\"Type\\":\\"Transcode\\"}},\\"Dependencies\\":{\\"Act-Start\\":[\\"Act-Transcode-M3U8\\"],\\"Act-Report\\":[],\\"Act-Transcode-M3U8\\":[\\"Act-Report\\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16CD0CDD-457E-420D-9755-8385075A1234\\",\\n \\"MediaWorkflow\\": {\\n \\"CreationTime\\": \\"2016-04-01T05:29:37Z\\",\\n \\"MediaWorkflowId\\": \\"e00732b977da427d9177a4dee646****\\",\\n \\"State\\": \\"Inactive\\",\\n \\"TriggerMode\\": \\"NotInAuto\\",\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Topology\\": \\"{mediaworkflow\\\\\\",\\\\\\"State\\\\\\":\\\\\\"Active\\\\\\",\\\\\\"Topology\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Activities\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"PipelineId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"InputFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Start\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Report\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Parameters\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Outputs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"OutputLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Transcode\\\\\\\\\\\\\\"}},\\\\\\\\\\\\\\"Dependencies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Act-Start\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"Act-Transcode-M3U8\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"Act-Report\\\\\\\\\\\\\\"]}}\\\\\\",\\\\\\"MediaWorkflowId\\\\\\":\\\\\\"93ab850b4f6f44eab54b6e91d24d****\\\\\\"}]},\\\\\\"RequestId\\\\\\":\\\\\\"16CD0CDD-457E-420D-9755-8385075A1234\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16CD0CDD-457E-420D-9755-8385075A1234\\n \\n 2016-04-01T05:29:37Z\\n e00732b977da427d9177a4dee646****\\n Inactive\\n NotInAuto\\n example-mediaworkflow-****\\n {mediaworkflow\\",\\"State\\":\\"Active\\",\\"Topology\\":\\"{\\\\\\"Activities\\\\\\":{\\\\\\"Act-Start\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"PipelineId\\\\\\":\\\\\\"130266f58161436a80bf07cb12c8****\\\\\\",\\\\\\"InputFile\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"example-bucket-****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cn-shanghai\\\\\\\\\\\\\\"}\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Start\\\\\\"},\\\\\\"Act-Report\\\\\\":{\\\\\\"Parameters\\\\\\":{},\\\\\\"Type\\\\\\":\\\\\\"Report\\\\\\"},\\\\\\"Act-Transcode-M3U8\\\\\\":{\\\\\\"Parameters\\\\\\":{\\\\\\"Outputs\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TemplateId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\\\\\\\\"}]\\\\\\",\\\\\\"OutputBucket\\\\\\":\\\\\\"example-bucket-****\\\\\\",\\\\\\"OutputLocation\\\\\\":\\\\\\"cn-shanghai\\\\\\"},\\\\\\"Type\\\\\\":\\\\\\"Transcode\\\\\\"}},\\\\\\"Dependencies\\\\\\":{\\\\\\"Act-Start\\\\\\":[\\\\\\"Act-Transcode-M3U8\\\\\\"],\\\\\\"Act-Report\\\\\\":[],\\\\\\"Act-Transcode-M3U8\\\\\\":[\\\\\\"Act-Report\\\\\\"]}}\\",\\"MediaWorkflowId\\":\\"93ab850b4f6f44eab54b6e91d24d****\\"}]},\\"RequestId\\":\\"16CD0CDD-457E-420D-9755-8385075A1234\\"}\\n \\n","errorExample":""}]',
'title' => '更新媒体工作流的触发模式状态',
'summary' => '更新媒体工作流的触发模式。',
'description' => '本接口只能修改工作流触发模式。如需修改其他信息,请参见[更新媒体工作流](~~44438~~)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMediaWorkflowExecutionList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RunIds',
'in' => 'query',
'schema' => [
'description' => '媒体工作流执行实例ID列表,可以通过**MPS控制台** > **工作流管理** > **执行实例**获取。使用半角逗号(,)分隔,一次最多查询10个。 ',
'type' => 'string',
'required' => true,
'example' => '48e33690ac19445488c706924321****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'NonExistRunIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RunId' => [
'description' => '不存在的媒体工作流实例列表。',
'type' => 'array',
'items' => [
'description' => '不存在的执行实例ID。如果没有则此参数不返回。',
'type' => 'string',
'example' => 'null',
],
],
],
],
'MediaWorkflowExecutionList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaWorkflowExecution' => [
'description' => '媒体工作流列表。',
'type' => 'array',
'items' => [
'description' => '媒体工作流详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '016-04-01T06:53:43Z',
],
'MediaWorkflowId' => [
'description' => '媒体工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e91****81d4',
],
'State' => [
'description' => '状态。取值:'."\n"
."\n"
.'- Running:执行中。'."\n"
."\n"
.'- Completed:执行完成。'."\n"
."\n"
.'> Completed仅表示工作流执行完成,每个活动的(转码、截图等)是否成功要看每个活动具体的状态值。'."\n"
."\n"
.'- Fail:执行失败。',
'type' => 'string',
'example' => 'Completed',
],
'ActivityList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Activity' => [
'description' => '媒体工作流活动列表。',
'type' => 'array',
'items' => [
'description' => '媒体工作流活动详情。',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '活动结束执行时间。',
'type' => 'string',
'example' => '2016-04-01T06:53:44Z',
],
'Type' => [
'description' => '媒体工作流活动类型。可取值:Start活动、Snapshot活动、Transcode活动、Analysis活动、Report活动。更多活动信息请参见[媒体工作流活动介绍](~~68494~~)。',
'type' => 'string',
'example' => 'Start',
],
'StartTime' => [
'description' => '活动开始执行时间。',
'type' => 'string',
'example' => '2016-04-01T06:53:44Z',
],
'State' => [
'description' => '状态。取值:'."\n"
."\n"
.'- Running:活动执行中。'."\n"
."\n"
.'- Success:活动执行成功。'."\n"
."\n"
.'- Fail:活动执行失败。'."\n"
."\n"
.'- Skipped:活动被跳过。'."\n"
."\n"
.'> 例如:分析活动之后有高清、标清两个转码活动,会根据实际分析的结果来决策,如果原视频内容清晰度不够,高清的转码活动就可能被跳过。',
'type' => 'string',
'example' => 'Running',
],
'JobId' => [
'description' => '活动执行时生成的作业ID(例如分析作业ID、转码作业ID、截图作业ID)。',
'type' => 'string',
'example' => '2376030d9d0849399cd20e20f4f3****',
],
'Code' => [
'description' => '错误码。'."\n"
."\n"
.'- 当活动状态是**Fail**时,会给出具体的错误码。'."\n"
."\n"
.'- 当活动状态是**Success**时,不返回此参数。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceContentBad',
],
'Message' => [
'description' => '错误信息。'."\n"
."\n"
.'- 当活动状态是**Fail**时,会给出详细的错误描述信息。'."\n"
."\n"
.'- 当活动状态是**Success**时,此参数不返回。',
'type' => 'string',
'example' => 'The resource operated InputFile is bad',
],
'Name' => [
'description' => '媒体工作流活动名称。'."\n"
."\n"
.'> 在同一个工作流中活动的名字是唯一的。',
'type' => 'string',
'example' => 'Start',
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '执行成功时消息的ID。如果执行失败则不返回此参数。',
'type' => 'string',
'example' => '4f3bc83233de4e2f81c7dade443e****',
],
'ErrorMessage' => [
'description' => '执行失败时错误信息。如果执行成功则不返回此参数。',
'type' => 'string',
'example' => 'MessageConfigEmpty',
],
'ErrorCode' => [
'description' => '执行失败时错误码。如果执行成功则不返回此参数。',
'type' => 'string',
'example' => 'The Topic/Queue config is empty, not send message',
],
],
],
],
],
],
],
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'Input' => [
'description' => '媒体工作流的用户自定义数据。',
'type' => 'object',
'properties' => [
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'example data ****',
],
'InputFile' => [
'description' => '媒体工作流的输入文件。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-mediaWorkflow-****/example-object-****/example.mp4',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'mps-cn-shanghai',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
],
],
],
],
'MediaId' => [
'description' => '媒体ID。媒体工作流生成的所有信息都属于这个媒体ID。',
'type' => 'string',
'example' => '512046582a924698a41e0f8b0d2b****',
],
'RunId' => [
'description' => '执行实例ID。',
'type' => 'string',
'example' => '48e33690ac19445488c706924321****',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistRunIds\\": {\\n \\"RunId\\": [\\n \\"null\\"\\n ]\\n },\\n \\"MediaWorkflowExecutionList\\": {\\n \\"MediaWorkflowExecution\\": [\\n {\\n \\"CreationTime\\": \\"016-04-01T06:53:43Z\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91****81d4\\",\\n \\"State\\": \\"Completed\\",\\n \\"ActivityList\\": {\\n \\"Activity\\": [\\n {\\n \\"EndTime\\": \\"2016-04-01T06:53:44Z\\",\\n \\"Type\\": \\"Start\\",\\n \\"StartTime\\": \\"2016-04-01T06:53:44Z\\",\\n \\"State\\": \\"Running\\",\\n \\"JobId\\": \\"2376030d9d0849399cd20e20f4f3****\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"Name\\": \\"Start\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"4f3bc83233de4e2f81c7dade443e****\\",\\n \\"ErrorMessage\\": \\"MessageConfigEmpty\\",\\n \\"ErrorCode\\": \\"The Topic/Queue config is empty, not send message\\"\\n }\\n }\\n ]\\n },\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Input\\": {\\n \\"UserData\\": \\"example data ****\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-mediaWorkflow-****/example-object-****/example.mp4\\",\\n \\"Location\\": \\"mps-cn-shanghai\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n },\\n \\"MediaId\\": \\"512046582a924698a41e0f8b0d2b****\\",\\n \\"RunId\\": \\"48e33690ac19445488c706924321****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n \\n 016-04-01T06:53:43Z\\n 93ab850b4f6f44eab54b6e91****81d4\\n Completed\\n \\n 2016-04-01T06:53:44Z\\n Start\\n 2016-04-01T06:53:44Z\\n Running\\n 2376030d9d0849399cd20e20f4f3****\\n InvalidParameter.ResourceContentBad\\n The resource operated InputFile is bad\\n Start\\n \\n 4f3bc83233de4e2f81c7dade443e****\\n MessageConfigEmpty\\n The Topic/Queue config is empty, not send message\\n \\n \\n example-mediaworkflow-****\\n \\n example data ****\\n \\n \\n mps-cn-shanghai\\n example-bucket-****\\n \\n \\n 512046582a924698a41e0f8b0d2b****\\n 48e33690ac19445488c706924321****\\n \\n D1D5C080-8E2F-5030-8AB4-13092F17631B\\n","errorExample":""}]',
'title' => '查询媒体工作流执行实例',
'summary' => '查询媒体工作流执行实例。',
'description' => '- 本接口一次最多查询10个媒体工作流执行实例。'."\n"
.'- 请确保工作流中使用的管道为开启状态,否则可能会导致工作流无法正常使用(比如:工作流节点显示已失效、工作流状态一直卡在已提交等)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListMediaWorkflowExecutions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'MediaWorkflowId',
'in' => 'query',
'schema' => [
'description' => '需要查询实例的媒体工作流ID。可以通过**MPS控制台** > **工作流管理** > **工作流设置**获取。',
'type' => 'string',
'required' => false,
'example' => '43b7335a4b1d4fe883670036affb****',
],
],
[
'name' => 'MediaWorkflowName',
'in' => 'query',
'schema' => [
'description' => '媒体工作流名称。可以通过**MPS控制台** > **工作流管理** > **工作流设置**获取。',
'type' => 'string',
'required' => false,
'example' => 'example-mediaworkflow-****',
],
],
[
'name' => 'InputFileURL',
'in' => 'query',
'schema' => [
'description' => '媒体工作流指定的输入文件OSS Bucket。遵循RFC 3986(UTF8编码,并对保留字符进行URLEncode)。更多信息,请参见[URLEncode说明](~~423796~~)。',
'type' => 'string',
'required' => false,
'example' => 'http://example-****.cn-hangzhou.aliyuncs.com/test****.flv',
],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '下一页标识,32位UUID。请求第一页时,NextPageToken为空;请求后续文件时需传入前一页查询结果中的NextPageToken值。',
'type' => 'string',
'required' => false,
'example' => '39f8e0bc005e4f309379701645f4****',
],
],
[
'name' => 'MaximumPageSize',
'in' => 'query',
'schema' => [
'description' => '最大可返回的媒体工作流执行实例数。取值范围:`[1,100]`,默认值:**10**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
'default' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'MediaWorkflowExecutionList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaWorkflowExecution' => [
'description' => '媒体工作流列表。',
'type' => 'array',
'items' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-04-01T06:53:43Z',
],
'MediaWorkflowId' => [
'description' => '媒体工作流ID。',
'type' => 'string',
'example' => '43b7335a4b1d4fe883670036affb****',
],
'State' => [
'description' => '工作流状态。可取值:'."\n"
."\n"
.'- **Running**:执行中。'."\n"
."\n"
.'- **Completed**:执行完成。'."\n"
."\n"
.'> Completed仅表示工作流执行完成,每个活动(转码、截图等)是否成功要看每个活动具体的状态值。'."\n"
."\n"
.'- **Fail**:执行失败。'."\n"
."\n"
.'- **Success**:执行成功。',
'type' => 'string',
'example' => 'Success',
],
'ActivityList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Activity' => [
'description' => '媒体工作流活动列表。',
'type' => 'array',
'items' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '活动结束执行时间。',
'type' => 'string',
'example' => '2016-04-01T06:54:00Z',
],
'Type' => [
'description' => '媒体工作流活动类型。可取值:Start活动、Snapshot活动、Transcode活动、Analysis活动、Report活动。更多信息请参见[媒体工作流活动介绍](~~2542772~~)。',
'type' => 'string',
'example' => 'Start',
],
'StartTime' => [
'description' => '活动开始执行时间。',
'type' => 'string',
'example' => '2016-04-01T06:53:45Z',
],
'State' => [
'description' => '活动状态。可取值:'."\n"
."\n"
.'- **Running**:活动执行中。'."\n"
."\n"
.'- **Fail**:活动执行失败。'."\n"
."\n"
.'- **Skipped**:活动被跳过。'."\n"
.'- **Success**:执行成功。'."\n"
."\n"
.'> 例如:分析活动之后有高清、标清两个转码活动,会根据实际分析的结果来决策,如果原视频内容清晰度不够,高清的转码活动就可能被跳过。',
'type' => 'string',
'example' => 'Success',
],
'JobId' => [
'description' => '活动执行时生成的作业ID。建议您保存此ID便于后续调用其他接口时使用。',
'type' => 'string',
'example' => '2376030d9d0849399cd20e20c876****',
],
'Code' => [
'description' => '错误码。'."\n"
."\n"
.'- 如果活动状态是**Fail**,会给出具体的错误码。'."\n"
."\n"
.'- 如果活动状态是**Success**,此参数不返回。',
'type' => 'string',
'example' => 'null',
],
'Message' => [
'description' => '错误信息。'."\n"
."\n"
.'- 如果活动状态是**Fail**,会给出详细的错误描述信息。'."\n"
.'- 如果活动状态是**Success**,此参数不返回。',
'type' => 'string',
'example' => 'null',
],
'Name' => [
'description' => '媒体工作流活动名称。'."\n"
."\n"
.'> 在同一个工作流中活动的名称是唯一的。',
'type' => 'string',
'example' => 'Act-2',
],
'MNSMessageResult' => [
'description' => 'MNS通知用户作业完成结果。',
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '执行成功时消息ID。如果执行失败则不返回此参数。',
'type' => 'string',
'example' => '4f3bc83233de4e2f81c7dade443e****',
],
'ErrorMessage' => [
'description' => '执行失败时错误信息。如果执行成功则不返回此参数。',
'type' => 'string',
'example' => 'MessageConfigEmpty',
],
'ErrorCode' => [
'description' => '执行失败时错误码。如果执行成功则不返回此参数。',
'type' => 'string',
'example' => 'The Topic/Queue config is empty, not send message',
],
],
],
],
],
],
],
],
'Name' => [
'description' => '媒体工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'Input' => [
'description' => '媒体工作流的用户自定义数据。',
'type' => 'object',
'properties' => [
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'example data',
],
'InputFile' => [
'description' => '媒体工作流的输入OSS Bucket。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-mediaWorkflow-****/example-object-****/example.mp4',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'cn-shanghai',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
],
],
],
],
'MediaId' => [
'description' => '媒体ID。媒体工作流生成的所有信息都属于这个媒体ID。',
'type' => 'string',
'example' => '512046582a924698a41e0f8b0d2b****',
],
'RunId' => [
'description' => '执行实例ID。',
'type' => 'string',
'example' => '48e33690ac19445488c706924321****',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B',
],
'NextPageToken' => [
'description' => '下一页标识。',
'type' => 'string',
'example' => '39f8e0bc005e4f309379701645f4****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaWorkflowExecutionList\\": {\\n \\"MediaWorkflowExecution\\": [\\n {\\n \\"CreationTime\\": \\"2016-04-01T06:53:43Z\\",\\n \\"MediaWorkflowId\\": \\"43b7335a4b1d4fe883670036affb****\\",\\n \\"State\\": \\"Success\\",\\n \\"ActivityList\\": {\\n \\"Activity\\": [\\n {\\n \\"EndTime\\": \\"2016-04-01T06:54:00Z\\",\\n \\"Type\\": \\"Start\\",\\n \\"StartTime\\": \\"2016-04-01T06:53:45Z\\",\\n \\"State\\": \\"Success\\",\\n \\"JobId\\": \\"2376030d9d0849399cd20e20c876****\\",\\n \\"Code\\": \\"null\\",\\n \\"Message\\": \\"null\\",\\n \\"Name\\": \\"Act-2\\",\\n \\"MNSMessageResult\\": {\\n \\"MessageId\\": \\"4f3bc83233de4e2f81c7dade443e****\\",\\n \\"ErrorMessage\\": \\"MessageConfigEmpty\\",\\n \\"ErrorCode\\": \\"The Topic/Queue config is empty, not send message\\"\\n }\\n }\\n ]\\n },\\n \\"Name\\": \\"example-mediaworkflow-****\\",\\n \\"Input\\": {\\n \\"UserData\\": \\"example data\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-mediaWorkflow-****/example-object-****/example.mp4\\",\\n \\"Location\\": \\"cn-shanghai\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n }\\n },\\n \\"MediaId\\": \\"512046582a924698a41e0f8b0d2b****\\",\\n \\"RunId\\": \\"48e33690ac19445488c706924321****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\",\\n \\"NextPageToken\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2016-04-01T06:53:43Z\\n 43b7335a4b1d4fe883670036affb****\\n Success\\n \\n 2016-04-01T06:54:00Z\\n Start\\n 2016-04-01T06:53:45Z\\n Success\\n 2376030d9d0849399cd20e20c876****\\n null\\n null\\n Act-2\\n \\n 4f3bc83233de4e2f81c7dade443e****\\n MessageConfigEmpty\\n The Topic/Queue config is empty, not send message\\n \\n \\n example-mediaworkflow-****\\n \\n example data\\n \\n \\n cn-shanghai\\n example-bucket-****\\n \\n \\n 512046582a924698a41e0f8b0d2b****\\n 48e33690ac19445488c706924321****\\n \\n D1D5C080-8E2F-5030-8AB4-13092F17631B\\n 39f8e0bc005e4f309379701645f4****\\n","errorExample":""}]',
'title' => '遍历媒体工作流执行实例',
'summary' => '遍历媒体工作流执行实例。',
'description' => '本接口只返回近90天执行实例。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BindInputBucket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Bucket',
'in' => 'query',
'schema' => [
'description' => '需要绑定的输入媒体Bucket名称,不超过64个字节。可以通过**MPS控制台**>**工作流管理**>**媒体Bucket**获取。'."\n"
."\n"
.'> Bucket名称只允许小写字母、数字、中划线(-),且不能以中划线开头或结尾。',
'type' => 'string',
'required' => true,
'example' => 'example-bucket-****',
],
],
[
'name' => 'Referer',
'in' => 'query',
'schema' => [
'description' => 'OSS防盗链设置。更多信息请参见[防盗链](~~31869~~)。'."\n"
."\n"
.'> - MPS设置的防盗链不会对OSS文件防盗链生效。若OSS没有设置防盗链,则MPS也无需设置。 '."\n"
.' > - 此处添加的Referer须为OSS侧防盗链中包含的Referer。如果您在OSS侧设置了多个Referer,MPS侧只需设置一个即可。',
'type' => 'string',
'required' => false,
'example' => 'http://www.example.com',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\n","errorExample":""}]',
'title' => '媒体库绑定输入Bucket',
'summary' => '媒体处理操作的文件资源均存放在OSS的Bucket中。将OSS的Bucket在媒体处理MPS中绑定为输入媒体Bucket、输出媒体Bucket后,媒体处理MPS才有权限监听该Bucket上传完成的消息,以实现触发工作流执行和处理完成的文件回写动作。您可以调用BindInputBucket接口绑定输入媒体Bucket。',
'description' => '在使用本接口进行绑定之前,您需要先创建媒体Bucket。如果没有创建媒体Bucket,请先参见[添加媒体Bucket](~~42430~~)添加完成后,再调用本接口进行绑定。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'BindOutputBucket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Bucket',
'in' => 'query',
'schema' => [
'description' => '需要绑定的输出OSS Bucket名称,支持中英文、数字、中划线(-),不能以特殊符号开头,不超过64个字节。',
'type' => 'string',
'required' => true,
'example' => 'example-bucket-****',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D0F80646-90D4-402F-9D56-CEFEAA6BCC9B',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0F80646-90D4-402F-9D56-CEFEAA6BCC9B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D0F80646-90D4-402F-9D56-CEFEAA6BCC9B\\n","errorExample":""}]',
'title' => '绑定输出媒体Bucket',
'summary' => '媒体处理操作的文件资源均存放在OSS的Bucket中。将OSS的Bucket在媒体处理MPS中绑定为输入媒体Bucket、输出媒体Bucket后,媒体处理MPS才有权限监听该Bucket上传完成的消息,以实现触发工作流执行和处理完成的文件回写动作。您可以调用BindOutputBucket接口绑定输出媒体Bucket。',
'description' => '在使用本接口进行绑定之前,您需要先创建媒体Bucket。如果没有创建媒体Bucket,请先参见[添加媒体Bucket](~~42430~~)添加完成后,在调用本接口进行绑定。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindInputBucket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Bucket',
'in' => 'query',
'schema' => [
'description' => '需要解绑的输入媒体Bucket名称,可以通过**MPS控制台** > **工作流管理** > **媒体Bucket**获取,或通过**OSS控制台** > **我的访问路径**获取。',
'type' => 'string',
'required' => true,
'example' => 'example-bucket-****',
],
],
[
'name' => 'RoleArn',
'in' => 'query',
'schema' => [
'description' => '代理授权使用的角色信息。',
'type' => 'string',
'required' => false,
'example' => 'acs:ram::174809843091****:role/exampleRole',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","type":"json"}]',
'title' => '媒体库解绑输入Bucket',
'summary' => '解绑输入媒体Bucket。',
'description' => '本接口通过媒体Bucket名称指定需要解绑的输入媒体Bucket。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'UnbindOutputBucket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Bucket',
'in' => 'query',
'schema' => [
'description' => '需要解绑的输出媒体Bucket名称,可以通过**MPS控制台** > **工作流管理** > **媒体Bucket**获取,或通过**OSS控制台** > **我的访问路径**获取。',
'type' => 'string',
'required' => true,
'example' => 'example-bucket-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\n","errorExample":""}]',
'title' => '解绑输出Bucket',
'summary' => '解绑输出媒体Bucket。',
'description' => '本接口通过媒体Bucket名称指定需要解绑的输出媒体Bucket。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'ListAllMediaBucket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '下一页标识。第一次请求无需传入,服务会返回此Token,第二次请求传入即可。',
'type' => 'string',
'required' => false,
'example' => 'P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****',
],
],
[
'name' => 'MaximumPageSize',
'in' => 'query',
'schema' => [
'description' => '本次请求可返回的媒体Bucket数目最大值。取值范围:1~100,默认值:50。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '79760D91-D3CF-4165-****-B7E2836EF62A',
],
'NextPageToken' => [
'description' => '查询下一页标识。',
'type' => 'string',
'example' => 'P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****',
],
'MediaBucketList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaBucket' => [
'description' => '媒体Bucket列表。',
'type' => 'array',
'items' => [
'description' => '媒体Bucket详细信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '媒体Bucket类型。可取值:'."\n"
."\n"
.'- Input:输入文件OSS Bucket。'."\n"
."\n"
.'- Output:输出文件OSS Bucket。',
'type' => 'string',
'example' => 'Input',
],
'Bucket' => [
'description' => '媒体Bucket名称。',
'type' => 'string',
'example' => 'example-bucket-****',
],
'Referer' => [
'description' => 'OSS防盗链设置。更多信息,请参见[防盗链](~~31869~~)。',
'type' => 'string',
'example' => 'http://www.example.com',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"79760D91-D3CF-4165-****-B7E2836EF62A\\",\\n \\"NextPageToken\\": \\"P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****\\",\\n \\"MediaBucketList\\": {\\n \\"MediaBucket\\": [\\n {\\n \\"Type\\": \\"Input\\",\\n \\"Bucket\\": \\"example-bucket-****\\",\\n \\"Referer\\": \\"http://www.example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 79760D91-D3CF-4165-****-B7E2836EF62A\\n P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****\\n \\n Input\\n example-bucket-****\\n http://www.example.com\\n \\n","errorExample":""}]',
'title' => '查询媒体Bucket',
'summary' => '列出媒体库所有媒体Bucket。',
'description' => '本接口最多返回100个媒体Bucket。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddMedia' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'FileURL',
'in' => 'query',
'schema' => [
'description' => '输入文件的路径,可以通过MPS或OSS控制台获取。详细触发规则请参见下文中**工作流触发匹配规则**。'."\n"
."\n"
.'- 仅支持OSS HTTP地址,不支持CDN地址和HTTPS地址。'."\n"
.'- 不超过3200字节。'."\n"
.'- URL遵循RFC 2396(UTF-8编码,并进行URLEncode)。更多信息,请参见[URLEncode说明](~~423796~~)。',
'type' => 'string',
'required' => true,
'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '媒体标题。'."\n"
."\n"
.'- 长度限制不超过128个字节。'."\n"
.'- UTF-8编码。',
'type' => 'string',
'required' => false,
'example' => 'mytest',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '描述。'."\n"
."\n"
.'- 长度限制不超过1024个字节。'."\n"
.'- UTF-8编码。',
'type' => 'string',
'required' => false,
'example' => 'A test video',
],
],
[
'name' => 'CoverURL',
'in' => 'query',
'schema' => [
'description' => '封面URL。即您需要设置的封面的存储地址,可以通过**MPS控制台** > **工作流管理** > **媒体Bucket**或**OSS控制台** > **我的访问路径**获取。'."\n"
."\n"
.'- 不超过3200字节。'."\n"
.'- URL遵循RFC 2396(UTF-8编码,并进行URLEncode)。更多信息,请参见[URLEncode说明](~~423796~~)。',
'type' => 'string',
'required' => false,
'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => ' 标签列表。'."\n"
."\n"
.'> 媒体处理中,每个媒体的每个标签都是独立的,可以通过搜索媒体库来查找所有设置了相同标签的媒体。'."\n"
."\n"
.'- 用半角逗号(,)分隔,不超过16个标签。'."\n"
.'- 单个标签不能超过32个字节。'."\n"
."\n"
.'- UTF-8编码。',
'type' => 'string',
'required' => false,
'example' => 'tag1,tag2',
],
],
[
'name' => 'MediaWorkflowId',
'in' => 'query',
'schema' => [
'description' => '媒体工作流ID。可通过MPS控制台或[新增媒体工作流](~~44437~~)接口获取。',
'type' => 'string',
'required' => false,
'example' => '07da6c65da7f458997336e0de192****',
],
],
[
'name' => 'MediaWorkflowUserData',
'in' => 'query',
'schema' => [
'description' => '媒体工作流用户自定义数据。'."\n"
."\n"
.'- 不超过1024字节。'."\n"
.'- UTF-8编码。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'InputUnbind',
'in' => 'query',
'schema' => [
'description' => '是否检查指定的工作流支持输入路径。此处建议您选择检查(true),避免因路径出错而导致的错误。取值:'."\n"
."\n"
.'- **true**:检查'."\n"
."\n"
.'- **false**:不检查',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'CateId',
'in' => 'query',
'schema' => [
'description' => '媒体所属类目ID。不允许为负数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'OverrideParams',
'in' => 'query',
'schema' => [
'description' => '覆盖参数。'."\n"
."\n"
.'- 示例1:HLS打包字幕覆盖`{“WebVTTSubtitleOverrides”,[{“RefActivityName”:”subtitleNode”,”WebVTTSubtitleURL”:”http://test.oss-cn-hangzhou.aliyuncs.com/example1.vtt"}]}`。'."\n"
.'- 示例2:DASH打包字幕覆盖` {“subtitleTransNodeName”:{“InputConfig”:{“Format”:”stl”,”InputFile”:{“URL”:”http://subtitleBucket.oss-cn-hangzhou.aliyuncs.com/package/example/CENG.stl"}}}}`。',
'type' => 'string',
'required' => false,
'example' => '{“subtitleTransNodeName”:{“InputConfig”:{“Format”:”stl”,”InputFile”:{“URL”:”http://exampleBucket.oss-cn-hangzhou.aliyuncs.com/package/example/CENG.stl"}}}}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD',
],
'Media' => [
'description' => '媒体信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-09-20T03:02:40Z',
],
'CateId' => [
'description' => '类目ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Height' => [
'description' => '媒体文件高度。',
'type' => 'string',
'example' => '1280',
],
'CensorState' => [
'description' => '视频审核状态。取值:'."\n"
."\n"
.'- **Initiated**:初始(上传成功审核未完成)。'."\n"
."\n"
.'- **Pass**:通过(上传成功审核已通过)。',
'type' => 'string',
'example' => 'Initiated',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'string',
'example' => 'tag,tag2',
],
],
],
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '1148.77',
],
'MediaId' => [
'description' => '媒体ID。',
'type' => 'string',
'example' => '3e6149d5a8c944c09b1a8d2dc3e4****',
],
'File' => [
'description' => '原文件。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。此处默认为**Normal**(正常)。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '文件URL。',
'type' => 'string',
'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4',
],
],
],
'PublishState' => [
'description' => '媒体发布状态,表示是否对外发布媒体。取值:'."\n"
."\n"
.'- **Initiated**:初始。'."\n"
.'- **UnPublish**:未发布,OSS播放文件权限为Private。'."\n"
.'- **Published**:已发布,OSS播放文件权限为Default。',
'type' => 'string',
'example' => 'Published',
],
'Description' => [
'description' => '描述。长度不超过1024个字节。',
'type' => 'string',
'example' => 'A test video',
],
'Width' => [
'description' => '媒体文件宽度。',
'type' => 'string',
'example' => '1280',
],
'Size' => [
'description' => '媒体文件大小。',
'type' => 'string',
'example' => '379860',
],
'CoverURL' => [
'description' => '封面URL。',
'type' => 'string',
'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png',
],
'RunIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RunId' => [
'description' => '媒体工作流执行实例ID列表。',
'type' => 'array',
'items' => [
'description' => '已执行的媒体工作流执行实例ID列表,半角逗号(,)分隔。',
'type' => 'string',
'example' => '{"RunId":["cbad98d35629470fa05ff393d347****"]}',
],
],
],
],
'Duration' => [
'description' => '媒体文件时长。',
'type' => 'string',
'example' => '2.645333',
],
'Fps' => [
'description' => '媒体文件帧率。',
'type' => 'string',
'example' => '25.0',
],
'Title' => [
'description' => '媒体标题。长度不超过128个字节。'."\n",
'type' => 'string',
'example' => 'mytest.mp4',
],
'Format' => [
'description' => '格式。支持mov,mp4,m4a,3gp,3g2,mj2。',
'type' => 'string',
'example' => 'mp4',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\",\\n \\"Media\\": {\\n \\"CreationTime\\": \\"2016-09-20T03:02:40Z\\",\\n \\"CateId\\": 1,\\n \\"Height\\": \\"1280\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag,tag2\\"\\n ]\\n },\\n \\"Bitrate\\": \\"1148.77\\",\\n \\"MediaId\\": \\"3e6149d5a8c944c09b1a8d2dc3e4****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4\\"\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"Description\\": \\"A test video\\",\\n \\"Width\\": \\"1280\\",\\n \\"Size\\": \\"379860\\",\\n \\"CoverURL\\": \\"http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png\\",\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"{\\\\\\"RunId\\\\\\":[\\\\\\"cbad98d35629470fa05ff393d347****\\\\\\"]}\\"\\n ]\\n },\\n \\"Duration\\": \\"2.645333\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Title\\": \\"mytest.mp4\\",\\n \\"Format\\": \\"mp4\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\n \\n 2016-09-20T03:02:40Z\\n 1\\n 1280\\n Initiated\\n tag,tag2\\n 1148.77\\n 3e6149d5a8c944c09b1a8d2dc3e4****\\n \\n Normal\\n http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4\\n \\n Published\\n A test video\\n 1280\\n 379860\\n http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png\\n {\\"RunId\\":[\\"cbad98d35629470fa05ff393d347****\\"]}\\n 2.645333\\n 25.0\\n mytest.mp4\\n mp4\\n \\n","errorExample":""}]',
'title' => '新增媒体',
'summary' => '提交新增媒体作业。',
'description' => '- 当在OSS上有存量视频时,可以通过此接口处理存量视频,从而避免重新上传视频到OSS。如果已经配置过工作流,上传媒体文件到OSS后,OSS会自动通知MPS。根据设置的OSS Bucket,Object自动匹配处于激活状态的工作流自动执行,因此通常情况下不需要手动调用AddMedia接口处理文件。'."\n"
.'- 只有指定激活状态的工作流处理媒体文件时,才会自动获取媒体信息;不指定工作流或指定其他状态的工作流时,不会获取媒体信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => '**工作流触发匹配规则**'."\n"
."\n"
.' 规则匹配执行策略如下:以新增文件的路径为基础,检查工作流绑定的位置,如果新增文件的路径中包含规则绑定的字符串则匹配,不包含则不匹配。例如:`http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test1.flv`规则:'."\n"
."\n"
.' ```'."\n"
.' 1、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/ 匹配'."\n"
.' 2、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/ 匹配'."\n"
.' 3、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/ 匹配'."\n"
.' 4、http://bucket.oss-cn-hangzhou.aliyuncs.com/ 匹配'."\n"
.' 5、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.flv 匹配'."\n"
.' 6、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/CC/ 不匹配'."\n"
.' 7、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/ 不匹配'."\n"
.' 8、http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/ 不匹配'."\n"
.' ```'."\n"
.'> 在新增媒体工作流时,请您不要配置一个工作流的输入路径为另外一个工作流的输入路径的前缀,否则会一个增量文件触发两次工作流执行实例。例如:两个工作流的输入路径分别配置test和test1,则当输入文件上传到test1文件夹下同样满足test前缀,因此会触发两次工作流执行实例。'."\n"
."\n"
.'**匹配文件扩展名**'."\n"
."\n"
.'触发要求必须是多媒体文件,媒体库服务是通过文件扩展名来判断的。文件或者没有扩展名(文件名中不包含扩展名分割符号“.”),或者扩展名符合下面的规则:'."\n"
.'> 对于swf,截图及转码服务质量不保障。'."\n"
."\n"
.'|类型 |扩展名|'."\n"
.'|:---------|:-------|'."\n"
.'|视频| 3gp, asf, avi, dat, dv, flv, f4v, gif, m2t, m3u8, m4v, mj2, mjpeg, mkv, mov, mp4, mpe, mpg, mpeg, mts, ogg, qt, rm, rmvb, swf, ts, vob, wmv, webm|'."\n"
.'|音频| aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff|'."\n"
."\n"
.'**媒体工作流消息**'."\n"
."\n"
.'媒体工作流采用 [阿里云轻量消息队列(原MNS) ](https://www.aliyun.com/product/mns?spm=a2c4g.11186623.2.10.6c44478epkHm97) 发送消息给视频云服务接入方,媒体工作流会在(Start/Report)活动节点完成时发送消息,若需要接收消息,需要在Start活动上设置队列/通知名称,媒体工作流产生的消息存储在队列/通知中,可以使用 [轻量消息队列(原MNS) SDK](~~27508~~) 获取消息,消息规格如下:'."\n"
."\n"
.'|名称 |类型 |描述|'."\n"
.'|:---------|:-------|:---------|'."\n"
.'|RunId |String |工作流执行ID。|'."\n"
.'|Name |String |活动名称。|'."\n"
.'|Type |String |活动类型。范围:Report、Start|'."\n"
.'|State |String |活动状态。范围:Fail、Success|'."\n"
.'|Code |String |错误码。如果活动状态是Fail时,会给出具体的错误码。|'."\n"
.'|Message |String |错误消息。如果活动状态是Fail时,会给出详细的错误描述信息。|'."\n"
.'|MediaWorkflowExecution |MediaWorkflowExecution |媒体工作流执行信息。|',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteMedia' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'MediaIds',
'in' => 'query',
'schema' => [
'description' => '需要删除的媒体ID列表。半角逗号(,)分隔,一次最多10个。 '."\n"
."\n"
.'> 媒体ID可以从[新增媒体](~~44458~~)的返回参数中获取,也可以登录媒体处理控制台,通过**媒体管理**>**媒体列表**找到目标视频,单击**管理**,从目标视频的基础信息页签获取。',
'type' => 'string',
'required' => true,
'example' => '3e1cd21131a94525be55acf65888****,3e6149d5a8c944c09b1a8d2dc3e4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\n","errorExample":""}]',
'title' => '删除媒体',
'summary' => '删除媒体。',
'description' => '本接口只是逻辑删除媒体,即该媒体文件不能继续被操作,并不会删除OSS Bucket中媒体对应输入、输出位置的物理文件。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateMedia' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => '需要更新基本信息的媒体ID。可以通过**MPS控制台** > **媒体管理** > **媒体列表**获取。',
'type' => 'string',
'required' => true,
'example' => '3e1cd21131a94525be55acf65888****',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '媒体标题。支持中英文、数字等。'."\n"
."\n"
.'- 若不设置则清空此字段。'."\n"
.'- UTF8编码,最大128字节。',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '媒体描述。支持中英文、数字等。'."\n"
."\n"
.'- 若不设置则清空此字段。'."\n"
.'- UTF8编码,最大1024字节。',
'type' => 'string',
'required' => false,
'example' => 'example description',
],
],
[
'name' => 'CoverURL',
'in' => 'query',
'schema' => [
'description' => '封面URL。即您需要设置的封面的存储地址,可以通过**MPS控制台** > **工作流管理** > **媒体Bucket**或**OSS控制台** > **我的访问路径**获取。'."\n"
."\n"
.'- 不超过3200字节。'."\n"
.'- URL遵循RFC 2396(UTF-8编码,并进行URLEncode)。更多信息,请参见[URLEncode说明](~~423796~~)。',
'type' => 'string',
'required' => false,
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/test****.jpg',
],
],
[
'name' => 'CateId',
'in' => 'query',
'schema' => [
'description' => '类目ID,整数。'."\n"
.'- 若不设置则清空此字段。'."\n"
.'- 不能为负数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => '标签列表。'."\n"
."\n"
.'- 用半角逗号(,)分隔,不超过16个标签。'."\n"
.'- 单个标签不超过32字节。'."\n"
.'- UTF8编码。',
'type' => 'string',
'required' => false,
'example' => 'tag1,tag2',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6A88246F-C91F-42BD-BABE-DB0DF993F960',
],
'Media' => [
'description' => '媒体信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-09-14T08:30:33Z',
],
'CateId' => [
'description' => '类目ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Height' => [
'description' => '媒体文件高。',
'type' => 'string',
'example' => '1080',
],
'CensorState' => [
'description' => '视频审核状态。取值:'."\n"
."\n"
.'- **Initiated**:初始(上传成功审核未完成)。'."\n"
."\n"
.'- **Pass**:通过(上传成功审核已通过)。',
'type' => 'string',
'example' => 'Initiated',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签信息。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'string',
'example' => 'tag1,tag2',
],
],
],
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '2659.326',
],
'MediaId' => [
'description' => '媒体ID。',
'type' => 'string',
'example' => '3e1cd21131a94525be55acf65888****',
],
'File' => [
'description' => '原文件。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。取值范围:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4',
],
],
],
'PublishState' => [
'description' => '媒体发布状态,表示是否对外发布媒体。取值:'."\n"
."\n"
.'- **Initiated**:初始。'."\n"
.'- **UnPublish**:未发布,OSS播放文件权限为Private。'."\n"
.'- **Published**:已发布,OSS播放文件权限为Default。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Published',
],
'Description' => [
'description' => '媒体文件描述。',
'type' => 'string',
'example' => 'example description',
],
'Width' => [
'description' => '媒体文件宽。',
'type' => 'string',
'example' => '1920',
],
'Size' => [
'description' => '媒体文件大小。',
'type' => 'string',
'example' => '2647692',
],
'CoverURL' => [
'description' => '封面URL。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg',
],
'RunIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RunId' => [
'description' => '媒体工作流执行实例ID列表。',
'type' => 'array',
'items' => [
'description' => '媒体工作流执行实例ID列表。',
'type' => 'string',
'example' => '{"RunId":["47b42486019c4f688bf144c1a6ba****"]}',
],
],
],
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '7.965000',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25.0',
],
'Title' => [
'description' => '标题。',
'type' => 'string',
'example' => 'hello',
],
'Format' => [
'description' => '格式。支持mov,mp4,m4a,3gp,3g2,mj2。',
'type' => 'string',
'example' => 'mov',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6A88246F-C91F-42BD-BABE-DB0DF993F960\\",\\n \\"Media\\": {\\n \\"CreationTime\\": \\"2016-09-14T08:30:33Z\\",\\n \\"CateId\\": 1,\\n \\"Height\\": \\"1080\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag1,tag2\\"\\n ]\\n },\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"MediaId\\": \\"3e1cd21131a94525be55acf65888****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"Description\\": \\"example description\\",\\n \\"Width\\": \\"1920\\",\\n \\"Size\\": \\"2647692\\",\\n \\"CoverURL\\": \\"http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg\\",\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"{\\\\\\"RunId\\\\\\":[\\\\\\"47b42486019c4f688bf144c1a6ba****\\\\\\"]}\\"\\n ]\\n },\\n \\"Duration\\": \\"7.965000\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Title\\": \\"hello\\",\\n \\"Format\\": \\"mov\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6A88246F-C91F-42BD-BABE-DB0DF993F960\\n \\n 2016-09-14T08:30:33Z\\n 1\\n 1080\\n Initiated\\n tag1,tag2\\n 2659.326\\n 3e1cd21131a94525be55acf65888****\\n \\n Normal\\n http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\n \\n Published\\n example description\\n 1920\\n 2647692\\n http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg\\n {\\"RunId\\":[\\"47b42486019c4f688bf144c1a6ba****\\"]}\\n 7.965000\\n 25.0\\n hello\\n mov\\n \\n","errorExample":""}]',
'title' => '更新媒体基本信息',
'summary' => '更新媒体基本信息。',
'description' => '本接口更新的媒体基本信息包括标题、描述、类目等。注意是全量更新,每个属性都要设置,未设置的会被空值覆盖。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateMediaCategory' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => '需要更新类目的媒体ID。'."\n"
."\n"
.'> 媒体ID可以从[新增媒体](~~44458~~)的返回参数中获取,也可以登录媒体处理控制台,通过**媒体管理>媒体列表**找到目标视频,单击**管理**,从目标视频的基础信息页签获取。',
'type' => 'string',
'required' => true,
'example' => '3e1cd21131a94525be55acf65888****',
],
],
[
'name' => 'CateId',
'in' => 'query',
'schema' => [
'description' => '类目ID,不能为负数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E3931857-E3D3-4D6E-9C7B-D2C09441BD01',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E3931857-E3D3-4D6E-9C7B-D2C09441BD01\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E3931857-E3D3-4D6E-9C7B-D2C09441BD01\\n","errorExample":""}]',
'title' => '更新媒体类目',
'summary' => '更新媒体类目。',
'description' => '本接口只能用于更新媒体类目ID,如需全量更新媒体信息,请参见[更新媒体-基本信息](~~44464~~)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateMediaCover' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => '需要更新封面的媒体ID。可以从[新增媒体](~~44458~~)的返回参数中获取,也可以登录媒体处理控制台,通过**媒体管理** > **媒体列表**找到目标视频,单击**管理**,从目标视频的基础信息页签获取。',
'type' => 'string',
'required' => true,
'example' => '6cc3aa66d1cb4bb2adf14e726c0a****',
],
],
[
'name' => 'CoverURL',
'in' => 'query',
'schema' => [
'description' => '媒体封面。URL遵循RFC 2396(UTF8编码),最大3200字节。'."\n"
."\n"
.'> CoverURL通过OSS Bucket中的图片URL获取,取问号之前的部分。目前仅支持HTTP协议。',
'type' => 'string',
'required' => false,
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '0DC39B9E-13D4-40BA-AE76-CFF9BD64239D',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0DC39B9E-13D4-40BA-AE76-CFF9BD64239D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0DC39B9E-13D4-40BA-AE76-CFF9BD64239D\\n","errorExample":""}]',
'title' => '更新媒体封面',
'summary' => '更新媒体封面。',
'description' => '本接口只能用于更新媒体封面,如需全量更新媒体信息,请参见[更新媒体-基本信息](~~44464~~)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'AddMediaTag' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => '需要添加标签的媒体文件的ID。'."\n"
."\n"
.'> 媒体ID可以从[新增媒体](~~44458~~)的返回参数中获取,也可以登录媒体处理控制台,通过**媒体管理**>**媒体列表**找到目标文件,单击**管理**,从目标文件的基础信息页签获取。',
'type' => 'string',
'required' => true,
'example' => '3e6149d5a8c944c09b1a8d2dc3e4****',
],
],
[
'name' => 'Tag',
'in' => 'query',
'schema' => [
'description' => '新增的媒体标签。不超过32个字节,UTF-8编码。'."\n"
."\n"
.'> 仅支持添加单个标签。如需一次设置多个标签,可以通过[更新媒体-基本信息](~~44464~~)接口实现。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '91B6CAB9-034C-4E4E-A40B-E7F5C81E1A2K',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"91B6CAB9-034C-4E4E-A40B-E7F5C81E1A2K\\"\\n}","type":"json"}]',
'title' => '新增媒体标签',
'summary' => '调用AddMediaTag接口为媒体文件添加单个标签。',
'description' => '本接口仅支持添加单个标签。如需一次设置多个标签,可以通过[更新媒体-基本信息](~~44464~~)接口实现。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'DeleteMediaTag' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => '需要删除标签的媒体ID。可以从[新增媒体](~~44458~~)的返回参数中获取,也可以登录媒体处理控制台,通过**媒体管理** > **媒体列表**找到目标视频,单击**管理**,从目标视频的基础信息页签获取。',
'type' => 'string',
'required' => true,
'example' => '3e6149d5a8c944c09b1a8d2dc3e4****',
],
],
[
'name' => 'Tag',
'in' => 'query',
'schema' => [
'description' => '需要删除的媒体标签。不超过32字节,UTF8编码。'."\n"
."\n"
.'> 一次只能删除一个标签。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '283DC68C-146F-4489-A2A1-2F88F1472A56',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"283DC68C-146F-4489-A2A1-2F88F1472A56\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 283DC68C-146F-4489-A2A1-2F88F1472A56\\n","errorExample":""}]',
'title' => '更新媒体-删除标签',
'summary' => '删除媒体标签。',
'description' => '本接口一次只能删除一个标签。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateMediaPublishState' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => '需更新发布状态的媒体ID。可以从[新增媒体](~~44458~~)的返回参数中获取,也可以登录媒体处理控制台,通过**媒体管理** > **媒体列表**找到目标视频,单击**管理**,从目标视频的基础信息页签获取。',
'type' => 'string',
'required' => true,
'example' => '3e6149d5a8c944c09b1a8d2dc3e4****',
],
],
[
'name' => 'Publish',
'in' => 'query',
'schema' => [
'description' => '发布状态。默认值:**Initialed**(初始)。可选范围:'."\n"
.'- **true**:发布。'."\n"
.'- **false**:不发布。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '91B6CAB9-034C-4E4E-A40B-E7F5C81E688C',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91B6CAB9-034C-4E4E-A40B-E7F5C81E688C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 91B6CAB9-034C-4E4E-A40B-E7F5C81E688C\\n","errorExample":""}]',
'title' => '更新媒体发布状态',
'summary' => '更新媒体发布状态。',
'description' => '本接口中所指发布的含义是媒体播放资源、截图文件的访问权限设置为继承所属Bucket的访问权限。不发布的含义是将媒体播放资源、截图文件的访问权限设置为私有。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => '**媒体发布默认状态与迁移规则**'."\n"
."\n"
.'默认状态:'."\n"
."\n"
.'媒体发布状态的默认值是**Initialed**(初始)。有两种媒体类型处于这种状态:'."\n"
.'- 新的媒体:第一次生成一个媒体(第一次触发媒体工作流执行)时,工作流还处于执行中,这个时候媒体就处于“初始“状态。只要媒体工作流执行完成,就会变更为一个确切状态(根据媒体工作流的配置来设置)。'."\n"
.'- 删除后的媒体:媒体删除后,发布状态就没有意义了,这个时候也是处于“初始”状态。如果把删除的媒体重新添加回媒体库,就从“新的媒体”开始重新执行。'."\n"
."\n"
.'迁移规则:'."\n"
."\n"
.'> 迁移指媒体发布状态在初始、发布、不发布三种状态之间的迁移。通过API调用和通过工作流执行调用的媒体迁移规则不同。'."\n"
."\n"
.'|调用者| 当前状态 |迁移后状态| 是否允许|'."\n"
.'|:---------|:-------|:---------|:---------|'."\n"
.'|API |初始 |发布 |不允许|'."\n"
.'|API |初始 |不发布 |不允许|'."\n"
.'|API |发布 |不发布 |允许|'."\n"
.'|API |不发布 |发布 |允许|'."\n"
.'|工作流执行 |初始 |发布 |允许|'."\n"
.'|工作流执行 |初始 |不发布 |允许|'."\n"
.'|工作流执行 |发布 |不发布 |不允许|'."\n"
.'|工作流执行 |不发布 |发布 |不允许|',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMediaList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'MediaIds',
'in' => 'query',
'schema' => [
'description' => '需要查询的媒体文件ID列表,可以登录MPS控制台,通过**媒体管理** > **媒体列表**获取。用半角逗号(,)分隔,一次最多查询10个。',
'type' => 'string',
'required' => true,
'example' => '3e1cd21131a94525be55acf65888****,e26cfa29e784402388463f61dbec****',
],
],
[
'name' => 'IncludePlayList',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含播放信息。'."\n"
."\n"
.'- 取值:true(是)、false(否)。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'IncludeSnapshotList',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含截图信息。'."\n"
."\n"
.'- 取值:true(是)、false(否)。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'IncludeMediaInfo',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含媒体信息。'."\n"
."\n"
.'- 取值:true(是)、false(否)。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'IncludeSummaryList',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含摘要。'."\n"
."\n"
.'- 取值:true(是)、false(否)。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'NonExistMediaIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaId' => [
'description' => '不存在的媒体ID列表。',
'type' => 'array',
'items' => [
'description' => '不存在的媒体ID。无数据时此参数不返回。',
'type' => 'string',
'example' => '{"MediaId":[e26cfa29e784402388463f61dbec****]}',
],
],
],
],
'MediaList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Media' => [
'description' => '媒体列表。',
'type' => 'array',
'items' => [
'description' => '媒体文件详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2016-09-14T08:30:33Z',
],
'CateId' => [
'description' => '类目ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Height' => [
'description' => '媒体文件高。',
'type' => 'string',
'example' => '1080',
],
'CensorState' => [
'description' => '视频审核状态。取值:'."\n"
."\n"
.'- **Initiated**:初始(上传成功审核未完成)。'."\n"
."\n"
.'- **Pass**:通过(上传成功审核已通过)。',
'type' => 'string',
'example' => 'Initiated',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签信息。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'string',
'example' => 'tag1,tag2',
],
],
],
],
'PlayList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Play' => [
'description' => '播放列表。',
'type' => 'array',
'items' => [
'description' => '播放文件详细信息。',
'type' => 'object',
'properties' => [
'Encryption' => [
'description' => '加密。取值:'."\n"
."\n"
.'- **0**:未加密。'."\n"
."\n"
.'- **1**:已加密。',
'type' => 'string',
'example' => '0',
],
'Height' => [
'description' => '高。',
'type' => 'string',
'example' => '1080',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '2659.326',
],
'File' => [
'description' => '播放文件。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。取值:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '输出文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4',
],
],
],
'MediaWorkflowId' => [
'description' => '产生播放文件的工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e91d24d****',
],
'Width' => [
'description' => '媒体文件宽。',
'type' => 'string',
'example' => '760',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '2647692',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25.0',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '7.965000',
],
'ActivityName' => [
'description' => '媒体工作流活动名称。',
'type' => 'string',
'example' => 'example-activity-****',
],
'Format' => [
'description' => '编码格式。支持mov、mp4、m4a、3gp、3g2、mj2。',
'type' => 'string',
'example' => 'mp4',
],
'MediaWorkflowName' => [
'description' => '产生播放文件的工作流。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
],
],
],
],
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '2659.326',
],
'MediaId' => [
'description' => '媒体ID。',
'type' => 'string',
'example' => '3e1cd21131a94525be55acf65888****',
],
'File' => [
'description' => '输入文件详细信息。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '状态。取值:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4',
],
],
],
'SummaryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Summary' => [
'description' => '视频摘要列表。',
'type' => 'array',
'items' => [
'description' => '视频摘要数据。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '摘要类型。取值:'."\n"
."\n"
.'- **Video**:视频类型。'."\n"
.'- **Gif**:动态图像类型。',
'type' => 'string',
'example' => 'Video',
],
'MediaWorkflowId' => [
'description' => '产生摘要的工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e91d24d****',
],
'ActivityName' => [
'description' => '媒体工作流活动名称。',
'type' => 'string',
'example' => 'example-activity-****',
],
'MediaWorkflowName' => [
'description' => '产生摘要的工作流名称。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'File' => [
'description' => '输入文件信息。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。范围:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4',
],
],
],
],
],
],
],
],
'PublishState' => [
'description' => '媒体发布状态,表示是否对外发布媒体。取值:'."\n"
."\n"
.'- **Initiated**:初始。'."\n"
.'- **UnPublish**:未发布,OSS播放文件权限为Private。'."\n"
.'- **Published**:已发布,OSS播放文件权限为Default。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Published',
],
'MediaInfo' => [
'description' => '媒体信息。',
'type' => 'object',
'properties' => [
'Streams' => [
'description' => '流信息。',
'type' => 'object',
'properties' => [
'VideoStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoStream' => [
'description' => '视频流列表。',
'type' => 'array',
'items' => [
'description' => '视频流数据。',
'type' => 'object',
'properties' => [
'Sar' => [
'description' => '编码信号分辨率比。',
'type' => 'string',
'example' => '1:1',
],
'Height' => [
'description' => '视频分辨率高。',
'type' => 'string',
'example' => '1080',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'avc1',
],
'NetworkCost' => [
'description' => '网络带宽消耗。',
'type' => 'object',
'properties' => [
'PreloadTime' => [
'description' => '预加载时间。',
'type' => 'string',
'example' => '0.01',
],
'AvgBitrate' => [
'description' => '平均码率。',
'type' => 'string',
'example' => '2659.326',
],
'CostBandwidth' => [
'description' => '最大消耗带宽。',
'type' => 'string',
'example' => '100',
],
],
],
'Width' => [
'description' => '视频分辨率宽。',
'type' => 'string',
'example' => '100',
],
'Index' => [
'description' => '视频流序号。标识视频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '5',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/30000',
],
'AvgFPS' => [
'description' => '平均帧率。',
'type' => 'string',
'example' => '29.97003',
],
'PixFmt' => [
'description' => '像素格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmpeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)。',
'type' => 'string',
'example' => 'und',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'QuickTime/MOV',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '12',
],
'Rotate' => [
'description' => '视频旋转角度。',
'type' => 'string',
'example' => '90',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '2659.326',
],
'HasBFrames' => [
'description' => '是否有B帧。**1**表示有,**2**表示没有。',
'type' => 'string',
'example' => '2',
],
'Profile' => [
'description' => '编码预置。',
'type' => 'string',
'example' => 'High',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0.000000',
],
'Dar' => [
'description' => '编码显示分辨率比。',
'type' => 'string',
'example' => '16:9',
],
'CodecName' => [
'description' => '编码格式简述名。支持mov、mp4、m4a、3gp、3g2、mj2。',
'type' => 'string',
'example' => 'mov',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '182.683000',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '29.97003',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x31637661',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1001/60000',
],
'Level' => [
'description' => '编码等级。',
'type' => 'string',
'example' => '40',
],
],
],
],
],
],
'AudioStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioStream' => [
'description' => '音频流列表。',
'type' => 'array',
'items' => [
'description' => '音频流数据。',
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/44100',
],
'Index' => [
'description' => '音频流序号,标识音频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'SampleFmt' => [
'description' => '采样格式。',
'type' => 'string',
'example' => 'fltp',
],
'ChannelLayout' => [
'description' => '声道输出样式。',
'type' => 'string',
'example' => 'stereo',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmpeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)。',
'type' => 'string',
'example' => 'und',
],
'Samplerate' => [
'description' => '采样率。',
'type' => 'string',
'example' => '44100',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'AAC(Advanced Audio Coding)',
],
'Channels' => [
'description' => '声道数。',
'type' => 'string',
'example' => '2',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '100',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '160.008',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'mp4a',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0.000000',
],
'CodecName' => [
'description' => '编码格式简述名。支持H264、mov、aac、avc、mpeg。',
'type' => 'string',
'example' => 'mov',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '182.591995',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x6134706d',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/44100',
],
],
],
],
],
],
'SubtitleStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubtitleStream' => [
'description' => '字幕流列表。',
'type' => 'array',
'items' => [
'description' => '字幕流数据。',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '字幕流序号,标识字幕流在整个媒体流中的位置。',
'type' => 'string',
'example' => '3',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmpeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)。',
'type' => 'string',
'example' => 'und',
],
],
],
],
],
],
],
],
'Format' => [
'description' => '格式信息。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'NumPrograms' => [
'description' => '节目流总数。',
'type' => 'string',
'example' => '2',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '2647692',
],
'NumStreams' => [
'description' => '媒体流总数。',
'type' => 'string',
'example' => '2',
],
'FormatLongName' => [
'description' => '容器/封装格式长述名。',
'type' => 'string',
'example' => 'QuickTime/MOV',
],
'Duration' => [
'description' => '总时长。',
'type' => 'string',
'example' => '7.965000',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '2659.326',
],
'FormatName' => [
'description' => '容器/封装格式简述名,支持mov,mp4,m4a,3gp,3g2,mj2。',
'type' => 'string',
'example' => 'mov',
],
],
],
],
],
'Description' => [
'description' => '描述。',
'type' => 'string',
'example' => 'This is description ****',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '2647692',
],
'Width' => [
'description' => '宽。',
'type' => 'string',
'example' => '1920',
],
'CoverURL' => [
'description' => '封面的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png',
],
'SnapshotList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Snapshot' => [
'description' => '截图列表。',
'type' => 'array',
'items' => [
'description' => '截图文件数据。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '截图类型。取值:'."\n"
."\n"
.'- **Single**:单张。'."\n"
."\n"
.'- **Sequence**:序列。',
'type' => 'string',
'example' => 'Sequence',
],
'MediaWorkflowId' => [
'description' => '产生截图文件的工作流ID。',
'type' => 'string',
'example' => '6cc3aa66d1cb4bb2adf14e726c0a****',
],
'ActivityName' => [
'description' => '产生截图文件的工作流活动名称。',
'type' => 'string',
'example' => 'example-activity1-****',
],
'Count' => [
'description' => '截图张数。此值只在**Type**为**Sequence**时有意义。',
'type' => 'string',
'example' => '5',
],
'MediaWorkflowName' => [
'description' => '产生截图文件的工作流。',
'type' => 'string',
'example' => 'example-workflow-****',
],
'File' => [
'description' => '截图文件。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。取值:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '截图文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png',
],
],
],
],
],
],
],
],
'RunIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RunId' => [
'description' => '实例列表。',
'type' => 'array',
'items' => [
'description' => '实例ID。',
'type' => 'string',
'example' => '{"RunId":["47b42486019c4f688bf144c1a6ba****"]}',
],
],
],
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '7.965000',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25.0',
],
'Title' => [
'description' => '标题。',
'type' => 'string',
'example' => 'example-title-****',
],
'Format' => [
'description' => '编码格式。支持mov,mp4,m4a,3gp,3g2,mj2。'."\n",
'type' => 'string',
'example' => 'mov',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '283DC68C-146F-4489-A2A1-2F88F1472A56',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NonExistMediaIds\\": {\\n \\"MediaId\\": [\\n \\"{\\\\\\"MediaId\\\\\\":[e26cfa29e784402388463f61dbec****]}\\"\\n ]\\n },\\n \\"MediaList\\": {\\n \\"Media\\": [\\n {\\n \\"CreationTime\\": \\"2016-09-14T08:30:33Z\\",\\n \\"CateId\\": 1,\\n \\"Height\\": \\"1080\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag1,tag2\\"\\n ]\\n },\\n \\"PlayList\\": {\\n \\"Play\\": [\\n {\\n \\"Encryption\\": \\"0\\",\\n \\"Height\\": \\"1080\\",\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91d24d****\\",\\n \\"Width\\": \\"760\\",\\n \\"Size\\": \\"2647692\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Duration\\": \\"7.965000\\",\\n \\"ActivityName\\": \\"example-activity-****\\",\\n \\"Format\\": \\"mp4\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\"\\n }\\n ]\\n },\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"MediaId\\": \\"3e1cd21131a94525be55acf65888****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"SummaryList\\": {\\n \\"Summary\\": [\\n {\\n \\"Type\\": \\"Video\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91d24d****\\",\\n \\"ActivityName\\": \\"example-activity-****\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n }\\n }\\n ]\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"MediaInfo\\": {\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"1080\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"0.01\\",\\n \\"AvgBitrate\\": \\"2659.326\\",\\n \\"CostBandwidth\\": \\"100\\"\\n },\\n \\"Width\\": \\"100\\",\\n \\"Index\\": \\"5\\",\\n \\"Timebase\\": \\"1/30000\\",\\n \\"AvgFPS\\": \\"29.97003\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"QuickTime/MOV\\",\\n \\"NumFrames\\": \\"12\\",\\n \\"Rotate\\": \\"90\\",\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"mov\\",\\n \\"Duration\\": \\"182.683000\\",\\n \\"Fps\\": \\"29.97003\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1001/60000\\",\\n \\"Level\\": \\"40\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/44100\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC(Advanced Audio Coding)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Bitrate\\": \\"160.008\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"mov\\",\\n \\"Duration\\": \\"182.591995\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"3\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NumPrograms\\": \\"2\\",\\n \\"Size\\": \\"2647692\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"7.965000\\",\\n \\"Bitrate\\": \\"2659.326\\",\\n \\"FormatName\\": \\"mov\\"\\n }\\n },\\n \\"Description\\": \\"This is description ****\\",\\n \\"Size\\": \\"2647692\\",\\n \\"Width\\": \\"1920\\",\\n \\"CoverURL\\": \\"http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png\\",\\n \\"SnapshotList\\": {\\n \\"Snapshot\\": [\\n {\\n \\"Type\\": \\"Sequence\\",\\n \\"MediaWorkflowId\\": \\"6cc3aa66d1cb4bb2adf14e726c0a****\\",\\n \\"ActivityName\\": \\"example-activity1-****\\",\\n \\"Count\\": \\"5\\",\\n \\"MediaWorkflowName\\": \\"example-workflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png\\"\\n }\\n }\\n ]\\n },\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"{\\\\\\"RunId\\\\\\":[\\\\\\"47b42486019c4f688bf144c1a6ba****\\\\\\"]}\\"\\n ]\\n },\\n \\"Duration\\": \\"7.965000\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Title\\": \\"example-title-****\\",\\n \\"Format\\": \\"mov\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"283DC68C-146F-4489-A2A1-2F88F1472A56\\"\\n}","errorExample":""},{"type":"xml","example":"\\n {\\"MediaId\\":[e26cfa29e784402388463f61dbec****]}\\n \\n 2016-09-14T08:30:33Z\\n 1\\n 1080\\n Initiated\\n tag1,tag2\\n \\n 0\\n 1080\\n 2659.326\\n \\n Normal\\n http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\n \\n 93ab850b4f6f44eab54b6e91d24d****\\n 760\\n 2647692\\n 25.0\\n 7.965000\\n example-activity-****\\n mp4\\n example-mediaworkflow-****\\n \\n 2659.326\\n 3e1cd21131a94525be55acf65888****\\n \\n Normal\\n http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\n \\n \\n Video\\n 93ab850b4f6f44eab54b6e91d24d****\\n example-activity-****\\n example-mediaworkflow-****\\n \\n Normal\\n http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\n \\n \\n Published\\n \\n \\n \\n 1:1\\n 1080\\n avc1\\n \\n 0.01\\n 2659.326\\n 100\\n \\n 100\\n 5\\n 1/30000\\n 29.97003\\n yuv420p\\n und\\n QuickTime/MOV\\n 12\\n 90\\n 2659.326\\n 2\\n High\\n 0.000000\\n 16:9\\n mov\\n 182.683000\\n 29.97003\\n 0x31637661\\n 1001/60000\\n 40\\n \\n \\n 1/44100\\n 1\\n fltp\\n stereo\\n und\\n 44100\\n AAC(Advanced Audio Coding)\\n 2\\n 100\\n 160.008\\n mp4a\\n 0.000000\\n mov\\n 182.591995\\n 0x6134706d\\n 1/44100\\n \\n \\n 3\\n und\\n \\n \\n \\n 0.000000\\n 2\\n 2647692\\n 2\\n QuickTime/MOV\\n 7.965000\\n 2659.326\\n mov\\n \\n \\n This is descirption ****\\n 2647692\\n 1920\\n http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png\\n \\n Sequence\\n 6cc3aa66d1cb4bb2adf14e726c0a****\\n example-activity1-****\\n 5\\n example-workflow-****\\n \\n Normal\\n http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png\\n \\n \\n {\\"RunId\\":[\\"47b42486019c4f688bf144c1a6ba****\\"]}\\n 7.965000\\n 25.0\\n example-title-****\\n mov\\n \\n 283DC68C-146F-4489-A2A1-2F88F1472A56\\n","errorExample":""}]',
'title' => '查询媒体列表',
'summary' => '使用媒体ID查询媒体。',
'description' => '本接口一次最多查询10个媒体文件。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMediaListByURL' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'FileURLs',
'in' => 'query',
'schema' => [
'description' => '需要查询的媒体文件地址,可以登录MPS控制台,通过**媒体管理** > **媒体列表**找到需要查询的媒体文件,单击**操作**列**管理**,在**获取转码地址**页签中获取媒体文件地址。用半角逗号(,)分隔,一次最多查询10个。'."\n"
.'- URL遵循RFC 3986(UTF8编码,并对保留字符进行URLEncode。更多信息,请参见[URLEncode说明](~~423796~~)),不超过3200字节。'."\n"
."\n"
.'- 仅支持OSS HTTP地址,不支持CDN地址和HTTPS地址。',
'type' => 'string',
'required' => true,
'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example.mp4',
],
],
[
'name' => 'IncludePlayList',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含播放信息。'."\n"
."\n"
.'- 取值范围:true(包含)、false(不包含)。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'IncludeSnapshotList',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含截图信息。'."\n"
.'- 取值范围:true(包含)、false(不包含)。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'IncludeMediaInfo',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含媒体信息。'."\n"
.'- 取值范围:true(包含)、false(不包含)。'."\n"
."\n"
.'- 默认值:**false**。'."\n"
."\n"
.' > 如需获取详细MediaInfo信息,请将本参数设置为true。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'IncludeSummaryList',
'in' => 'query',
'schema' => [
'description' => '返回结果中是否包含摘要列表。'."\n"
.'- 取值范围:true(是)、false(否)。'."\n"
."\n"
.'- 默认值:**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'MediaList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Media' => [
'description' => '媒体列表。',
'type' => 'array',
'items' => [
'description' => '媒体详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-07-14T13:05:00Z',
],
'CateId' => [
'description' => '类目ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'Height' => [
'description' => '查询到的媒体文件的高。',
'type' => 'string',
'example' => '360',
],
'CensorState' => [
'description' => '视频审核状态。取值:'."\n"
."\n"
.'- **Initiated**:初始(上传成功审核未完成)。'."\n"
."\n"
.'- **Pass**:通过(上传成功审核已通过)。',
'type' => 'string',
'example' => 'Initiated',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签信息。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'string',
'example' => 'tag1,tag2',
],
],
],
],
'PlayList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Play' => [
'description' => '播放列表。',
'type' => 'array',
'items' => [
'description' => '播放文件详细信息。',
'type' => 'object',
'properties' => [
'Encryption' => [
'description' => '加密。取值:'."\n"
."\n"
.'- **0**:未加密。'."\n"
."\n"
.'- **1**:已加密。',
'type' => 'string',
'example' => '1',
],
'Height' => [
'description' => '高。',
'type' => 'string',
'example' => '10',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '25.067',
],
'File' => [
'description' => '播放文件。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。取值范围:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '播放文件的输入OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4l-test/in/1.mp4',
],
],
],
'MediaWorkflowId' => [
'description' => '产生播放文件的工作流ID。',
'type' => 'string',
'example' => '6cc3aa66d1cb4bb2adf14e726c0a****',
],
'Width' => [
'description' => '宽。',
'type' => 'string',
'example' => '11',
],
'Size' => [
'description' => '大小。',
'type' => 'string',
'example' => '100',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '25.0',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '7.965000',
],
'ActivityName' => [
'description' => '媒体工作流活动名称。',
'type' => 'string',
'example' => 'test name',
],
'Format' => [
'description' => '编码格式。支持mov、mp4、m4a、3gp、3g2、mj2。',
'type' => 'string',
'example' => 'mov',
],
'MediaWorkflowName' => [
'description' => '产生播放文件的工作流。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
],
],
],
],
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '593.192',
],
'MediaId' => [
'description' => '媒体ID。',
'type' => 'string',
'example' => '52d7e98b05e648199612290bb819****',
],
'File' => [
'description' => '输入文件详细信息。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。取值范围:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4',
],
],
],
'SummaryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Summary' => [
'description' => '视频摘要列表。',
'type' => 'array',
'items' => [
'description' => '视频摘要数据。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '摘要类型。取值范围:'."\n"
."\n"
.'- **Video**:视频类型。'."\n"
."\n"
.'- **Gif**:动态图像类型。',
'type' => 'string',
'example' => 'Gif',
],
'MediaWorkflowId' => [
'description' => '产生摘要的工作流ID。',
'type' => 'string',
'example' => '93ab850b4f6f44eab54b6e91d24d****',
],
'ActivityName' => [
'description' => '媒体工作流活动名称。',
'type' => 'string',
'example' => 'example-activity-****',
],
'MediaWorkflowName' => [
'description' => '产生摘要的工作流。',
'type' => 'string',
'example' => 'example-mediaworkflow-****',
],
'File' => [
'description' => '原文件。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。取值范围:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket-****.o',
],
],
],
],
],
],
],
],
'PublishState' => [
'description' => '媒体发布状态,表示是否对外发布媒体。取值范围:'."\n"
."\n"
.'- **Initiated**:初始。'."\n"
.'- **UnPublish**:未发布,OSS播放文件权限为Private。'."\n"
.'- **Published**:已发布,OSS播放文件权限为Default。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Published',
],
'MediaInfo' => [
'description' => '媒体信息。',
'type' => 'object',
'properties' => [
'Streams' => [
'description' => '流信息。',
'type' => 'object',
'properties' => [
'VideoStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoStream' => [
'description' => '视频流列表。',
'type' => 'array',
'items' => [
'description' => '视频流数据。',
'type' => 'object',
'properties' => [
'Sar' => [
'description' => '编码信号分辨率比。',
'type' => 'string',
'example' => '1:1',
],
'Height' => [
'description' => '视频分辨率高。',
'type' => 'string',
'example' => '360',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'avc1',
],
'NetworkCost' => [
'description' => '网络带宽消耗。',
'type' => 'object',
'properties' => [
'PreloadTime' => [
'description' => '预加载时间。',
'type' => 'string',
'example' => '0.01',
],
'AvgBitrate' => [
'description' => '平均码率。',
'type' => 'string',
'example' => '2659.326',
],
'CostBandwidth' => [
'description' => '最大消耗带宽。',
'type' => 'string',
'example' => '100',
],
],
],
'Width' => [
'description' => '视频分辨率宽,数字,不能为负数。',
'type' => 'string',
'example' => '640',
],
'Index' => [
'description' => '视频流序号,标识视频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '5',
],
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/15360',
],
'AvgFPS' => [
'description' => '平均帧率。',
'type' => 'string',
'example' => '15.0',
],
'PixFmt' => [
'description' => '像素格式。',
'type' => 'string',
'example' => 'yuv420p',
],
'Lang' => [
'description' => '语言。更多信息,请参见[FFmpeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)。',
'type' => 'string',
'example' => 'und',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '12',
],
'Rotate' => [
'description' => '视频旋转角度。',
'type' => 'string',
'example' => '90',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '512.701',
],
'HasBFrames' => [
'description' => '是否有B帧。**1**表示有,**2**表示没有。',
'type' => 'string',
'example' => '2',
],
'Profile' => [
'description' => '编码预置。',
'type' => 'string',
'example' => 'High',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.046029',
],
'Dar' => [
'description' => '编码显示分辨率比。',
'type' => 'string',
'example' => '16:9',
],
'CodecName' => [
'description' => '编码格式简述名。支持H264、mov、aac、avc、mpeg。',
'type' => 'string',
'example' => 'H264',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '79.200000',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '15.0',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x31637661',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/30',
],
'Level' => [
'description' => '编码等级。',
'type' => 'string',
'example' => '31',
],
],
],
],
],
],
'AudioStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioStream' => [
'description' => '音频流列表。',
'type' => 'array',
'items' => [
'description' => '音频流数据。',
'type' => 'object',
'properties' => [
'Timebase' => [
'description' => '时基。',
'type' => 'string',
'example' => '1/44100',
],
'Index' => [
'description' => '音频流序号,标识音频流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'SampleFmt' => [
'description' => '采样格式。',
'type' => 'string',
'example' => 'fltp',
],
'ChannelLayout' => [
'description' => '声道输出样式。',
'type' => 'string',
'example' => 'stereo',
],
'Lang' => [
'description' => '语言。参考[FFmpeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)。',
'type' => 'string',
'example' => 'und',
],
'Samplerate' => [
'description' => '采样率。',
'type' => 'string',
'example' => '44100',
],
'CodecLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'AAC (Advanced Audio Coding)',
],
'Channels' => [
'description' => '声道数。',
'type' => 'string',
'example' => '2',
],
'NumFrames' => [
'description' => '总帧数。',
'type' => 'string',
'example' => '100',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '76.356',
],
'CodecTagString' => [
'description' => '编码格式标记文本。',
'type' => 'string',
'example' => 'mp4a',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0.000000',
],
'CodecName' => [
'description' => '编码格式简述名。支持H264、mov、aac、avc、mpeg。',
'type' => 'string',
'example' => 'aac',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '79.203265',
],
'CodecTag' => [
'description' => '编码格式标记。',
'type' => 'string',
'example' => '0x6134706d',
],
'CodecTimeBase' => [
'description' => '编码时基。',
'type' => 'string',
'example' => '1/44100',
],
],
],
],
],
],
'SubtitleStreamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubtitleStream' => [
'description' => '字幕流列表。',
'type' => 'array',
'items' => [
'description' => '字幕流数据。',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '字幕流序号,标识字幕流在整个媒体流中的位置。',
'type' => 'string',
'example' => '1',
],
'Lang' => [
'description' => '语言。参考[FFmpeg语言定义](https://www.ffmpeg.org/ffmpeg-all.html#Metadata)。',
'type' => 'string',
'example' => 'und',
],
],
],
],
],
],
],
],
'Format' => [
'description' => '格式信息。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0.000000',
],
'NumPrograms' => [
'description' => '节目流总数。',
'type' => 'string',
'example' => '0',
],
'Size' => [
'description' => '大小。',
'type' => 'string',
'example' => '5872904',
],
'NumStreams' => [
'description' => '媒体流总数。',
'type' => 'string',
'example' => '2',
],
'FormatLongName' => [
'description' => '编码格式长述名。',
'type' => 'string',
'example' => 'QuickTime/MOV',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '79.204000',
],
'Bitrate' => [
'description' => '码率。',
'type' => 'string',
'example' => '593.192',
],
'FormatName' => [
'description' => '容器/封装格式简述名,支持mov,mp4,m4a,3gp,3g2,mj2。',
'type' => 'string',
'example' => 'mov',
],
],
],
],
],
'Description' => [
'description' => '描述。',
'type' => 'string',
'example' => 'This is description ****',
],
'Size' => [
'description' => '文件大小。',
'type' => 'string',
'example' => '5872904',
],
'Width' => [
'description' => '宽。',
'type' => 'string',
'example' => '640',
],
'CoverURL' => [
'description' => '封面的OSS Bucket。',
'type' => 'string',
'example' => 'http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png',
],
'SnapshotList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Snapshot' => [
'description' => '截图列表。',
'type' => 'array',
'items' => [
'description' => '截图文件详细信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '截图类型。取值范围:'."\n"
."\n"
.'- **Single**:单张。'."\n"
.'- **Sequence**:序列。',
'type' => 'string',
'example' => 'Single',
],
'MediaWorkflowId' => [
'description' => '产生截图文件的工作流ID。',
'type' => 'string',
'example' => '6cc3aa66d1cb4bb2adf14e726c0a****',
],
'ActivityName' => [
'description' => '产生截图文件的工作流活动名称。',
'type' => 'string',
'example' => 'example-activity1-****',
],
'Count' => [
'description' => '截图张数。此值只在**Type**为**Sequence**时有意义。',
'type' => 'string',
'example' => '3',
],
'MediaWorkflowName' => [
'description' => '产生截图文件的工作流。',
'type' => 'string',
'example' => 'example-workflow-****',
],
'File' => [
'description' => '截图文件。',
'type' => 'object',
'properties' => [
'State' => [
'description' => '文件状态。取值范围:'."\n"
."\n"
.'- **Normal**:正常。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Normal',
],
'URL' => [
'description' => '截图文件的OSS Bucket。',
'type' => 'string',
'example' => 'http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png',
],
],
],
],
],
],
],
],
'RunIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RunId' => [
'description' => '媒体工作流列表。',
'type' => 'array',
'items' => [
'description' => '媒体工作流ID列表。',
'type' => 'string',
'example' => '9343bd0e7bb54ae19228529908e5****',
],
],
],
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '79.204000',
],
'Fps' => [
'description' => '帧率。',
'type' => 'string',
'example' => '15.0',
],
'Title' => [
'description' => '标题。',
'type' => 'string',
'example' => 'kled.mp4',
],
'Format' => [
'description' => '编码格式。支持mov,mp4,m4a,3gp,3g2,mj2。',
'type' => 'string',
'example' => 'mov',
],
],
],
],
],
],
'NonExistFileURLs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FileURL' => [
'description' => '不存在的媒体列表信息。',
'type' => 'array',
'items' => [
'description' => '不存在的媒体ID,无数据时此参数不返回。',
'type' => 'string',
'example' => 'null',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1C8A0AEB-4321-485B-B4CB-DA4E9E6C9B42',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaList\\": {\\n \\"Media\\": [\\n {\\n \\"CreationTime\\": \\"2021-07-14T13:05:00Z\\",\\n \\"CateId\\": 123,\\n \\"Height\\": \\"360\\",\\n \\"CensorState\\": \\"Initiated\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n \\"tag1,tag2\\"\\n ]\\n },\\n \\"PlayList\\": {\\n \\"Play\\": [\\n {\\n \\"Encryption\\": \\"1\\",\\n \\"Height\\": \\"10\\",\\n \\"Bitrate\\": \\"25.067\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4l-test/in/1.mp4\\"\\n },\\n \\"MediaWorkflowId\\": \\"6cc3aa66d1cb4bb2adf14e726c0a****\\",\\n \\"Width\\": \\"11\\",\\n \\"Size\\": \\"100\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Duration\\": \\"7.965000\\",\\n \\"ActivityName\\": \\"test name\\",\\n \\"Format\\": \\"mov\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\"\\n }\\n ]\\n },\\n \\"Bitrate\\": \\"593.192\\",\\n \\"MediaId\\": \\"52d7e98b05e648199612290bb819****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\"\\n },\\n \\"SummaryList\\": {\\n \\"Summary\\": [\\n {\\n \\"Type\\": \\"Gif\\",\\n \\"MediaWorkflowId\\": \\"93ab850b4f6f44eab54b6e91d24d****\\",\\n \\"ActivityName\\": \\"example-activity-****\\",\\n \\"MediaWorkflowName\\": \\"example-mediaworkflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example-bucket-****.o\\"\\n }\\n }\\n ]\\n },\\n \\"PublishState\\": \\"Published\\",\\n \\"MediaInfo\\": {\\n \\"Streams\\": {\\n \\"VideoStreamList\\": {\\n \\"VideoStream\\": [\\n {\\n \\"Sar\\": \\"1:1\\",\\n \\"Height\\": \\"360\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"NetworkCost\\": {\\n \\"PreloadTime\\": \\"0.01\\",\\n \\"AvgBitrate\\": \\"2659.326\\",\\n \\"CostBandwidth\\": \\"100\\"\\n },\\n \\"Width\\": \\"640\\",\\n \\"Index\\": \\"5\\",\\n \\"Timebase\\": \\"1/15360\\",\\n \\"AvgFPS\\": \\"15.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"12\\",\\n \\"Rotate\\": \\"90\\",\\n \\"Bitrate\\": \\"512.701\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Profile\\": \\"High\\",\\n \\"StartTime\\": \\"0.046029\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"CodecName\\": \\"H264\\",\\n \\"Duration\\": \\"79.200000\\",\\n \\"Fps\\": \\"15.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/30\\",\\n \\"Level\\": \\"31\\"\\n }\\n ]\\n },\\n \\"AudioStreamList\\": {\\n \\"AudioStream\\": [\\n {\\n \\"Timebase\\": \\"1/44100\\",\\n \\"Index\\": \\"1\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Lang\\": \\"und\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"2\\",\\n \\"NumFrames\\": \\"100\\",\\n \\"Bitrate\\": \\"76.356\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"79.203265\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\"\\n }\\n ]\\n },\\n \\"SubtitleStreamList\\": {\\n \\"SubtitleStream\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n },\\n \\"Format\\": {\\n \\"StartTime\\": \\"0.000000\\",\\n \\"NumPrograms\\": \\"0\\",\\n \\"Size\\": \\"5872904\\",\\n \\"NumStreams\\": \\"2\\",\\n \\"FormatLongName\\": \\"QuickTime/MOV\\",\\n \\"Duration\\": \\"79.204000\\",\\n \\"Bitrate\\": \\"593.192\\",\\n \\"FormatName\\": \\"mov\\"\\n }\\n },\\n \\"Description\\": \\"This is description ****\\",\\n \\"Size\\": \\"5872904\\",\\n \\"Width\\": \\"640\\",\\n \\"CoverURL\\": \\"http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png\\",\\n \\"SnapshotList\\": {\\n \\"Snapshot\\": [\\n {\\n \\"Type\\": \\"Single\\",\\n \\"MediaWorkflowId\\": \\"6cc3aa66d1cb4bb2adf14e726c0a****\\",\\n \\"ActivityName\\": \\"example-activity1-****\\",\\n \\"Count\\": \\"3\\",\\n \\"MediaWorkflowName\\": \\"example-workflow-****\\",\\n \\"File\\": {\\n \\"State\\": \\"Normal\\",\\n \\"URL\\": \\"http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png\\"\\n }\\n }\\n ]\\n },\\n \\"RunIdList\\": {\\n \\"RunId\\": [\\n \\"9343bd0e7bb54ae19228529908e5****\\"\\n ]\\n },\\n \\"Duration\\": \\"79.204000\\",\\n \\"Fps\\": \\"15.0\\",\\n \\"Title\\": \\"kled.mp4\\",\\n \\"Format\\": \\"mov\\"\\n }\\n ]\\n },\\n \\"NonExistFileURLs\\": {\\n \\"FileURL\\": [\\n \\"null\\"\\n ]\\n },\\n \\"RequestId\\": \\"1C8A0AEB-4321-485B-B4CB-DA4E9E6C9B42\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2021-07-14T13:05:00Z\\n 123\\n 360\\n Initiated\\n tag1,tag2\\n \\n 1\\n 10\\n 25.067\\n \\n Normal\\n http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4l-test/in/1.mp4\\n \\n 6cc3aa66d1cb4bb2adf14e726c0a****\\n 11\\n 100\\n 25.0\\n 7.965000\\n test name\\n mov\\n example-mediaworkflow-****\\n \\n 593.192\\n 52d7e98b05e648199612290bb819****\\n \\n Normal\\n http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4\\n \\n \\n Gif\\n 93ab850b4f6f44eab54b6e91d24d****\\n example-activity-****\\n example-mediaworkflow-****\\n \\n Normal\\n http://example-bucket-****.o\\n \\n \\n Published\\n \\n \\n \\n 1:1\\n 360\\n avc1\\n \\n 0.01\\n 2659.326\\n 100\\n \\n 640\\n 5\\n 1/15360\\n 15.0\\n yuv420p\\n und\\n H.264/AVC/MPEG-4 AVC/MPEG-4 part 10\\n 12\\n 90\\n 512.701\\n 2\\n High\\n 0.046029\\n 16:9\\n H264\\n 79.200000\\n 15.0\\n 0x31637661\\n 1/30\\n 31\\n \\n \\n 1/44100\\n 1\\n fltp\\n stereo\\n und\\n 44100\\n AAC (Advanced Audio Coding)\\n 2\\n 100\\n 76.356\\n mp4a\\n 0.000000\\n aac\\n 79.203265\\n 0x6134706d\\n 1/44100\\n \\n \\n 1\\n und\\n \\n \\n \\n 0.000000\\n 0\\n 5872904\\n 2\\n QuickTime/MOV\\n 79.204000\\n 593.192\\n mov\\n \\n \\n This is description ****\\n 5872904\\n 640\\n http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png\\n \\n Single\\n 6cc3aa66d1cb4bb2adf14e726c0a****\\n example-activity1-****\\n 3\\n example-workflow-****\\n \\n Normal\\n http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png\\n \\n \\n 9343bd0e7bb54ae19228529908e5****\\n 79.204000\\n 15.0\\n kled.mp4\\n mov\\n \\n null\\n 1C8A0AEB-4321-485B-B4CB-DA4E9E6C9B42\\n","errorExample":""}]',
'title' => '通过媒体的输入地址进行媒体信息的查询',
'summary' => '使用OSS文件地址查询媒体。',
'description' => '- 本接口一次最多查询10个媒体文件。'."\n"
.'- 调用本接口前,请先调用[新增媒体](~~44458~~)接口新增媒体文件,再调用本接口查询媒体信息。'."\n"
.'- 本接口仅支持查询工作流处理的文件信息。新上传的媒体文件,需要工作流执行完成后,通过本接口获取的文件信息才会完整。非工作流处理任务要想获得视频数据信息,需要调用[SubmitMediaInfoJob](~~29220~~)处理媒体信息作业之后方可查看。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryIProductionJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '需要查询的智能生产作业ID。从[提交智能生产作业](~~170216~~)的返回参数中获取。',
'type' => 'string',
'required' => false,
'example' => '88c6ca184c0e432bbf5b665e2a15****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'FunctionName' => [
'description' => '算法名称。取值:'."\n"
."\n"
.'- **VideoH2V**:视频横转竖。'."\n"
."\n"
.'- **VideoDelogo**:视频去图标。'."\n"
."\n"
.'- **Cover**:智能封面。'."\n"
."\n"
.'- **VideoClip**:视频摘要。'."\n"
."\n"
.'- **ImageH2V**:横转竖。'."\n"
."\n"
.'- **ImageDelogo**:图片去图标。'."\n"
."\n"
.'- **CaptionExtraction**:字幕提取。'."\n"
."\n"
.'- **VideoDetext**:视频去字幕。'."\n"
."\n"
.'- **VideoGreenScreenMatting**:绿幕抠图。'."\n"
."\n"
.'- **MusicSegmentDetect**:副歌检测。'."\n"
."\n"
.'- **AudioMixing**:混音处理。'."\n"
."\n"
.'- **AudioBeatDetection**:节奏检测。'."\n"
."\n"
.'- **ImageCartoonize**:3D风格、人脸风格化(需使用人脸风格化的功能请联系钉钉号:yuanzhigao1209对接)。'."\n"
."\n"
.'- **AudioQualityAssessment**:音质检测。'."\n"
."\n"
.' > 音质检测输入音频支持16bit量化的WAV音频文件,支持单双声道,支持的采样率范围为8000~48000Hz。',
'type' => 'string',
'example' => 'ImageCartoonize',
],
'Input' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12',
],
'UserData' => [
'description' => '用户的业务数据。',
'type' => 'string',
'example' => 'null',
],
'State' => [
'description' => '作业状态。取值:'."\n"
."\n"
.'- Queuing:排队中。'."\n"
."\n"
.'- Analysing:分析中。'."\n"
."\n"
.'- Fail:失败。'."\n"
."\n"
.'- Success:成功。',
'type' => 'string',
'example' => 'Success',
],
'Output' => [
'description' => '输出文件的OSS Bucket。',
'type' => 'string',
'example' => 'oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt',
],
'PipelineId' => [
'description' => '作业管道ID。',
'type' => 'string',
'example' => '39f8e0bc005e4f309379701645f4****',
],
'JobParams' => [
'description' => '算法作业参数。',
'type' => 'string',
'example' => '{mode:"gif"}',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '88c6ca184c0e432bbf5b665e2a15****',
],
'Result' => [
'description' => '作业结果详细信息。更多信息请参见[智能生产接口参数补充说明](~~352026~~)。',
'type' => 'string',
'example' => '{"Code":"Success","Data":"{\\"result\\":[{\\"file\\":\\"iproduction/test-result.jpg\\"},{\\"file\\":\\"iproduction/test-origin.jpg\\"}]}","Message":"Successful."}',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"FunctionName\\": \\"ImageCartoonize\\",\\n \\"Input\\": \\"oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4\\",\\n \\"RequestId\\": \\"D127C68E-F1A1-4CE5-A874-8FF724881A12\\",\\n \\"UserData\\": \\"null\\",\\n \\"State\\": \\"Success\\",\\n \\"Output\\": \\"oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt\\",\\n \\"PipelineId\\": \\"39f8e0bc005e4f309379701645f4****\\",\\n \\"JobParams\\": \\"{mode:\\\\\\"gif\\\\\\"}\\",\\n \\"JobId\\": \\"88c6ca184c0e432bbf5b665e2a15****\\",\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"Success\\\\\\",\\\\\\"Data\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"result\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"file\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"iproduction/test-result.jpg\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"file\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"iproduction/test-origin.jpg\\\\\\\\\\\\\\"}]}\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"Successful.\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ImageCartoonize\\n oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4\\n D127C68E-F1A1-4CE5-A874-8FF724881A12\\n null\\n Success\\n \\n 39f8e0bc005e4f309379701645f4****\\n {mode:\\"gif\\"}\\n 88c6ca184c0e432bbf5b665e2a15****\\n {\\"Code\\":\\"Success\\",\\"Data\\":\\"{\\\\\\"result\\\\\\":[{\\\\\\"file\\\\\\":\\\\\\"iproduction/test-result.jpg\\\\\\"},{\\\\\\"file\\\\\\":\\\\\\"iproduction/test-origin.jpg\\\\\\"}]}\\",\\"Message\\":\\"Successful.\\"}\\n","errorExample":""}]',
'title' => '查询智能生产作业',
'summary' => '查询智能生产作业。',
'description' => '- 本接口的查询结果中,包含对应请求算法的处理结果。'."\n"
.'- 若返回参数仅有RequestId和JobId,则需确认是否为智能生产作业。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'SubmitIProductionJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'FunctionName',
'in' => 'query',
'schema' => [
'description' => '功能算法名称。各功能算法支持的地域请参见[服务地域](~~43248~~)。取值:'."\n"
."\n"
.'- **VideoH2V**:视频横转竖'."\n"
."\n"
.'- **VideoDelogo**:视频去图标'."\n"
."\n"
.'- **Cover**:智能封面'."\n"
."\n"
.'- **VideoClip**:视频摘要'."\n"
."\n"
.'- **ImageH2V**:横转竖'."\n"
."\n"
.'- **ImageDelogo**:图片去图标'."\n"
."\n"
.'- **CaptionExtraction**:字幕提取(算法输入待处理视频的URL,输出提取的字幕文件)'."\n"
."\n"
.'- **VideoDetext**:视频去字幕'."\n"
."\n"
.'- **VideoGreenScreenMatting**:绿幕抠图(算法输入待抠图视频的URL和替换的背景图片URL,输出合成后的视频)'."\n"
."\n"
.'- **MusicSegmentDetect**:副歌检测(输入待处理音频、视频的URL,输出检测出的每一段副歌的起止时间,若检测不到副歌,则返回为空)'."\n"
."\n"
.'- **AudioMixing**:混音处理'."\n"
."\n"
.'- **AudioBeatDetection**:节奏检测(输入待处理音频、视频的URL,输出检测出的节拍时间列表BeatList和强拍时间列表DownBeatList)'."\n"
."\n"
.'- **ImageCartoonize**:3D风格、人脸风格化(如需使用人脸风格化的功能请联系钉钉号:yuanzhigao1209对接)'."\n"
."\n"
.'- **AudioQualityAssessment**:音质检测'."\n"
.'- **FaceBeauty**:视频美颜'."\n"
.'- **SpeechDenoise**:智能降噪'."\n"
.' '."\n"
.' > 音质检测输入音频支持16bit量化的WAV音频文件,支持单双声道,支持的采样率范围为8000~48000Hz。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ImageCartoonize',
],
],
[
'name' => 'ModelId',
'in' => 'query',
'schema' => [
'description' => '算法模型ID。如果为空,则选择对应功能的默认模型(此参数保持为空即可,一般无需传入,直接使用默认模型)。',
'type' => 'string',
'required' => false,
'example' => 'null',
],
],
[
'name' => 'JobParams',
'in' => 'query',
'schema' => [
'description' => '算法作业参数,JSON对象,不同算法对应参数内容不同。更多信息请参见[智能生产接口参数补充说明](~~352026~~)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '{"Model":"gif"}',
],
],
[
'name' => 'ScheduleParams',
'in' => 'query',
'schema' => [
'description' => '作业调度参数,设置任务调度配置(非必填,保持为空即可)。',
'type' => 'string',
'required' => false,
'example' => 'null',
],
],
[
'name' => 'NotifyUrl',
'in' => 'query',
'schema' => [
'description' => 'Callback路径,目前仅支持MNS消息队列。消息队列的路径可以通过**MNS控制台** > **队列列表** > **详情**查看。',
'type' => 'string',
'required' => false,
'example' => 'mns://125340688170****.mns.cn-beijing.aliyuncs.com/queues/example-pipeline',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户的业务数据,随回调信息回传给回调地址(非必填,保持为空即可)。',
'type' => 'string',
'required' => false,
'example' => '{\\"key\\":\\"value\\"}',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '作业管道ID,可以通过**MPS控制台** > **全局设置** > **管道**获取。用于确认作业回调队列以及提供租户隔离能力。若不传,则使用默认管道,默认作业并发数10,不绑定消息通知。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '39f8e0bc005e4f309379701645f4****',
],
],
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '输入文件的OSS Bucket(目前仅支持OSS路径,且OSS的地域需要与当前MPS所在地域保持一致),可以通过**MPS控制台** > **媒体管理** > **媒体列表**获取或OSS控制台选择对应的Bucke获取路径。'."\n"
."\n"
.'> 由于算法不同,Input在某些场景下为必填项。请根据您的实际业务需要选择是否传入此参数。',
'type' => 'string',
'required' => false,
'example' => 'oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4',
],
],
[
'name' => 'Output',
'in' => 'query',
'schema' => [
'description' => '输出文件的OSS Bucket(目前仅支持OSS路径),可以通过**MPS控制台** > **媒体管理** > **媒体列表**获取或OSS控制台选择对应的Bucke获取路径。OSS的地域需要与当前MPS所在地域保持一致。'."\n"
."\n"
.'> 格式为:`oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt`,其中`{source}`、`{timestamp}`和`{sequenceId}`为占位符,分别填充输入文件名、Unix时间戳和生成序号,占位符不必须,但对于多输出算法,比如智能封面等,需要注意加入序号占位符确保输出文件路径不重复,文件后缀名规则由用户自定义。',
'type' => 'string',
'required' => false,
'example' => 'oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26',
],
'JobId' => [
'description' => '作业ID。建议您保存此ID便于后续调用其他接口时使用。',
'type' => 'string',
'example' => '39f8e0bc005e4f309379701645f4****',
],
'Result' => [
'description' => '返回结果。不同算法返回结果不同,更多信息请参见[智能生产接口参数补充说明](~~352026~~)。',
'type' => 'string',
'example' => '{ "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" }',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8796E26\\",\\n \\"JobId\\": \\"39f8e0bc005e4f309379701645f4****\\",\\n \\"Result\\": \\"{ \\\\\\"Code\\\\\\":\\\\\\"Success\\\\\\", \\\\\\"Details\\\\\\":[], \\\\\\"FunctionName\\\\\\":\\\\\\"ImageCartoonize\\\\\\", \\\\\\"JobId\\\\\\":\\\\\\"39f8e0bc005e4f309379701645f4****\\\\\\", \\\\\\"Message\\\\\\":\\\\\\"success\\\\\\", \\\\\\"State\\\\\\":\\\\\\"Success\\\\\\", \\\\\\"Type\\\\\\":\\\\\\"IProduction\\\\\\" }\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5210DBB0-E327-4D45-ADBC-0B83C8796E26\\n 39f8e0bc005e4f309379701645f4****\\n { \\"Code\\":\\"Success\\", \\"Details\\":[], \\"FunctionName\\":\\"ImageCartoonize\\", \\"JobId\\":\\"39f8e0bc005e4f309379701645f4****\\", \\"Message\\":\\"success\\", \\"State\\":\\"Success\\", \\"Type\\":\\"IProduction\\" }\\n","errorExample":""}]',
'title' => '提交智能生产作业',
'summary' => '提交智能生产作业。',
'description' => '使用本接口提交的作业是异步执行方式。作业添加到管道中调度排队和执行,可以调用[查询智能生产作业](~~170217~~)接口查询作业执行结果,也可以使用异步的消息通知机制获取结果。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'SubmitSmarttagJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,用于区分业务,绑定消息通知。可以通过**MPS控制台** > **全局设置** > **管道**获取。可以为空(空格),表示默认管道。默认管道并发为10,需要提升并发数请提交[工单](https://ia.aliyun.com/home?channel=ticket&mark=console-home)。'."\n"
.' >管道目前仅支持后台创建,相关查询、更新接口请参见[更新管道](~~188374~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '视频标题,支持中英文、数字、中划线(-),不能以特殊符号开头,长度不能超过256B。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example-title-****',
],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => [
'description' => '视频内容描述,支持中英文、数字、中划线(-),不能以特殊符号开头,长度不能超过1KB。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'example content ****',
],
],
[
'name' => 'ContentType',
'in' => 'query',
'schema' => [
'description' => '已废弃',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'application/zip',
],
],
[
'name' => 'ContentAddr',
'in' => 'query',
'schema' => [
'description' => '已废弃',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'http://exampleBucket.oss-cn-shanghai.aliyuncs.com/mps-test/ai-tag.mp4',
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '额外的请求参数,使用JSON字符串表示,例如:`{"needAsrData":true, "needOcrData":false}`。字段说明:'."\n"
."\n"
.'- needAsrData:boolean值,分析结果中是否需要包含原始ASR结果,默认false(不包含),可选true(包含)'."\n"
."\n"
.'- needOcrData:boolean值,分析结果中是否需要包含原始OCR结果,默认false(不包含),可选true(包含)'."\n"
."\n"
.'- needMetaData:boolean值,分析结果中是否需要包含Meta信息,默认false(不包含),可选true(包含)'."\n"
.'- nlpParams: JsonObject值,nlp算子的输入参数,默认为空(不使用nlp算子),详见请求参数补充说明。',
'type' => 'string',
'required' => false,
'example' => '{"needAsrData":true, "needOcrData":false, "nlpParams":{"sourceLanguage":"cn"}}',
],
],
[
'name' => 'NotifyUrl',
'in' => 'query',
'schema' => [
'description' => 'Callback路径,目前仅支持HTTP、HTTPS地址。',
'type' => 'string',
'required' => false,
'example' => 'https://example.com/endpoint/aliyun/ai?id=76401125000***',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '通过回调透传回来的信息,长度不能超过1KB。',
'type' => 'string',
'required' => false,
'example' => '{"key":"value"}',
],
],
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '需要分析的视频或图片文件的地址,图片文件支持jpg、jpeg、png三种类型(按文件后缀名校验)。智能标签接口输入支持OSS地址、HTTP地址、视频点播(VoD)媒资地址等形式。'."\n"
."\n"
.'> 请确认您的文件名正确且所在Bucket与接口调用地域一致,否则可能导致找不到文件或接口调用失败。'."\n"
."\n"
.'- OSS地址:`oss://[Bucket名称]/[文件路径]`,例如`oss://[example-bucket-****]/[object_path-****]`。'."\n"
."\n"
.'- HTTP地址:公网可下载的地址,例如`http://example-test-****.mp4`。'."\n"
."\n"
.'- 视频点播(VoD)媒资地址:`vod://[VoD媒资MediaId]`,例如`vod://MediaId`。'."\n"
."\n"
.'举例如下:'."\n"
."\n"
.'- `oss://mybucket-****/example-****.mp4`'."\n"
."\n"
.'- `oss://testbucket-****/videos-****/1-****.mp4`'."\n"
."\n"
.'- `http://example-label-****.oss-cn-beijing.aliyuncs.com/example-****.mp4`'."\n"
."\n"
.'- `vod://181d739404a3419ba1c22b957ad2****`'."\n"
."\n\n"
.'> 注意OSS Bucket所在区域必须与调用OpenAPI所在的区域相同,MPS从用户Bucket拉取视频或图片免流量费用。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'oss://mybucket-****/example-****.mp4',
],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '模板ID用于指定分析算法,模板相关操作参见[添加模板](~~602910~~),[查询模板](~~187770~~),[更新模板](~~187776~~),[删除模板](~~187775~~)。'."\n"
."\n"
.'也可使用公共模版:'."\n"
."\n"
.'- nlp分析:public-nlp',
'type' => 'string',
'required' => false,
'example' => '39f8e0bc005e4f309379701645f4****',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => '任务在其对应管道内的优先级。最高优先级:0,最低优先级:9。默认值:5。',
'type' => 'string',
'required' => false,
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0',
],
'JobId' => [
'description' => '智能标签作业ID。建议您保存此ID便于后续调用其他接口时使用。',
'type' => 'string',
'example' => '39f8e0bc005e4f309379701645f4****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"JobId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7B117AF5-2A16-412C-B127-FA6175ED1AD0\\n 39f8e0bc005e4f309379701645f4****\\n","errorExample":""}]',
'title' => '提交智能标签作业',
'summary' => '提交智能标签作业。',
'description' => '- 通过本接口提交智能标签作业时,需要先通过模板配置分析类型。具体操作请参见[添加模板](~~187759~~)。'."\n"
.'- 智能标签功能,目前开通的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
.'- 目前智能标签管道默认并发数为2,如有更高需求,请[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?product=mts)[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.dticket.68797bbcm8H408#/ticket/add/?productId=1232)联系阿里云客服进行评估配置。'."\n"
.'- 智能标签任务和相关结果保留180天,超过会自动清理。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => '### nlpParams说明'."\n"
.'| 功能 | 名称 | 类型 | 必填 | 描述 | 示例值 |'."\n"
.'| --- | --- | --- | --- | --- | --- |'."\n"
.'| | nlpParams | object | 是 | 该参数包含了所有nlp处理的相关参数,template分析类型包含nlp的时候必填,否则任务失败。 | {"sourceLanguage":"cn"}|'."\n"
.'| 转录| sourceLanguage | string | 是 | 转写使用的源语言模型,可选:cn(中文)、en(英文)、 yue(粤语)、 fspk(中英文自由说)。 | "cn" |'."\n"
.'| | diarizationEnabled | boolean | 否 | 是否开启说话人分离功能,默认false。 | true |'."\n"
.'| | speakerCount | integer | 否 | 设置说话人分离参数。 不设置:不使用说话人角色区分。0:说话人角色区分结果为不定人数。2:说话人角色区分结果为2人。 | 2 |'."\n"
.'| 摘要 | summarizationEnabled | boolean | 否 | 是否启用摘要功能,开启后会可以生成全文摘要、发言人总结等结果。| true |'."\n"
.'| | summarizationTypes | string | 否 | 开启摘要功能时,需传入期望的摘要类型:Paragraph(全文摘要)、Conversational(发言人总结)、QuestionsAnswering(问答摘要)。| "Paragraph,Conversational,QuestionsAnswering" |'."\n"
.'| 翻译 | translationEnabled | boolean | 否 | 是否启用翻译功能。 | true |'."\n"
.'| | targetLanguages | string | 否 | 开启翻译功能后的目标语言,可选:cn(中文)、en(英文)、 ja(日文)。| "en" |'."\n"
.'| 章节识别 | autoChaptersEnabled | boolean | 否 | 是否启用章节速览功能,结果包含章节标题、章节摘要。 | true |'."\n"
.'| 智能纪要 | meetingAssistanceEnabled | boolean | 否 | 是否开启会议协助功能,结果包含分类、关键词、关键句、待办事项。若启用 MeetingAssistanceEnabled 但未通过 MeetingAssistance 设置算法类型,则默认都进行调用和返回。 | true |'."\n"
.'| | meetingAssistanceTypes | string | 否 | 开启智能功能时,需传入期望的功能参数类型,支持待办(Actions)、关键信息(KeyInformation)。其中关键信息包含关键词和重点内容(关键句)。| "Actions,KeyInformation" |',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'QuerySmarttagJob' => [
'summary' => '查询智能标签作业。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmts0VQEVI',
],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '需要查询的智能标签作业ID。可以从[提交智能标签作业](~~163486~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '39f8e0bc005e4f309379701645f4****',
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '额外的请求参数,使用JSON字符串表示,例如:`{"labelResultType":"auto"}`。其中,`labelResultType`为String类型,可取值:'."\n"
."\n"
.'- **auto**:机器打标结果'."\n"
."\n"
.'- **hmi**:人机协同结果',
'type' => 'string',
'required' => false,
'example' => '{"labelResultType":"auto"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'JobStatus' => [
'description' => '任务状态,可取值:'."\n"
."\n"
.'- **Success**:处理成功。'."\n"
."\n"
.'- **Fail**:处理失败。'."\n"
."\n"
.'- **Processing**:处理中。'."\n"
."\n"
.'- **Submitted**:已提交等待处理。'."\n",
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'type' => 'string',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0',
],
'Results' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Result' => [
'description' => '分析结果对象数组。',
'type' => 'array',
'items' => [
'description' => '分析结果对象数组详细信息。',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '分析结果的具体数据,以JSON字符串表示。不同Type的数据结构见下文**Result参数说明**。',
'type' => 'string',
'example' => '{"title":"example-title-****"}',
],
'Type' => [
'description' => '分析结果的类型。'."\n"
."\n"
.'- 标签1.0分析结果类型:'."\n"
."\n"
.' - TextLabel:文本标签'."\n"
.' - VideoLabel:视频标签'."\n"
.' - ASR:语音识别原始结果(默认不返回)'."\n"
.' - OCR:文字识别原始结果(默认不返回)'."\n"
.' - Process: 算法原始结果JSON文件链接(默认不返回),JSON结构请参见**补充说明**'."\n"
.'- 标签2.0分析结果类型:'."\n"
."\n"
.' - CPVLabel(人机)'."\n"
.' - Meta:视频标题等信息(默认不返回)'."\n"
.'- 标签2.0-custom分析结果类型:'."\n"
."\n"
.' - CPVLabel(人机)'."\n"
.' - Meta:视频标题等信息(默认不返回)',
'type' => 'string',
'example' => 'Meta',
],
],
],
],
],
],
'UserData' => [
'description' => '通过MNS回调时透传回来的信息。消息格式请参见下文**回调消息格式定义**。',
'type' => 'string',
'example' => 'example UserData ****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"JobStatus\\": \\"Success\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Data\\": \\"{\\\\\\"title\\\\\\":\\\\\\"example-title-****\\\\\\"}\\",\\n \\"Type\\": \\"Meta\\"\\n }\\n ]\\n },\\n \\"UserData\\": \\"example UserData ****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n 7B117AF5-2A16-412C-B127-FA6175ED1AD0\\n example UserData ****\\n \\n Meta\\n {\\"title\\":\\"example-title-****\\"}\\n \\n","errorExample":""}]',
'title' => '查询智能标签作业',
'description' => '- 本接口返回数据中包含视频中的人物、场景、关键词等各种算法智能分析得到的数据。'."\n"
.'- 智能标签功能,目前开通的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'responseParamsDescription' => '**回调消息格式定义**'."\n"
."\n"
.'当智能标签任务执行状态改变时,mps会发送消息到用户指定的queue中(如何指定回调queue详见mps的更新管道接口)。消息体是一个JSON字符串,包含字段如下:'."\n"
."\n"
.'| 名称 | 类型 |描述|'."\n"
.'|---------------|--------|-----------|'."\n"
.'|Type |String |固定字符串“smarttag”,表示智能标签任务 |'."\n"
.'|JobId | String|任务唯一ID |'."\n"
.'|State | String|任务当前状态,与QuerySmarttagJob中的JobStatus一致|'."\n"
.'|UserData |String |用户在SubmitSmarttagJob中传入的UserData|'."\n"
."\n"
.'**Result参数说明**'."\n"
."\n"
.'**VideoLabel**数据结构'."\n"
."\n"
.'| 名称 | 类型 |描述|'."\n"
.'|---------------|--------|-----------|'."\n"
.'| persons|JSONArray | 检测到的人物结果|'."\n"
.'|persons.name |String | 识别到的人物名称|'."\n"
.'| persons.category| String|人物类型,取值如下:`celebrity`(名人);`politician`(政治人物);`sensitive`(敏感人物);`unknown`(未知人物);自定义人物库ID(识别到的人物为自定义人物时返回) |'."\n"
.'|persons.ratio | double| 人物出现率,取值:0~1|'."\n"
.'| persons.occurrences| JSONArray| 人物出场详细信息|'."\n"
.'|persons.occurrences.score | double| 置信度得分|'."\n"
.'|persons.occurrences.from | double|检测到人物的起始时间,单位(秒) |'."\n"
.'|persons.occurrences.to |double |检测到人物的结束时间,单位(秒) |'."\n"
.'| persons.occurrences.position|JSONObject |人脸坐标 |'."\n"
.'|persons.occurrences.position.leftTop |int[] |左上角x,y坐标 |'."\n"
.'| persons.occurrences.position.rightBottom|int[] |右下角x,y坐标 |'."\n"
.'| persons.occurrences.timestamp| double|人脸坐标所在的时间戳,单位为秒 |'."\n"
.'|persons.occurrences.scene |String |人物镜头,包括:`closeUp`(特写);`medium-closeUp`(近景);`medium`(中景);`medium-long`(全景) |'."\n"
.'|tags | JSONArray| 检测到的物体场景等标签,详见下表举例|'."\n"
.'|tags.mainTagName |String |主标签 |'."\n"
.'| tags.subTagName| String| 子标签|'."\n"
.'|tags.ratio |double |出现率,取值:0~1 |'."\n"
.'|tags.occurrences | JSONArray|出现详细信息 |'."\n"
.'|tags.occurrences.score |double |置信度得分 |'."\n"
.'|tags.occurrences.from | double|起始时间,单位(秒) |'."\n"
.'|tags.occurrences.to |double | 结束时间,单位(秒)|'."\n"
.'| classifications| JSONArray| 视频分类信息|'."\n"
.'|classifications.score |double |置信度得分 |'."\n"
.'| classifications.category1| String|一级分类,比如:生活、动漫、汽车等等 |'."\n"
.'|classifications.category2 |String | 二级分类,比如生活下面细分为:健康、家居等等|'."\n"
."\n"
.'视频Tags标签举例说明'."\n"
."\n"
.'| mainTagName|subTagName |'."\n"
.'|---------------|--------|'."\n"
.'|节目 | 比如:爸爸去哪儿、欢乐喜剧人等|'."\n"
.'|人物角色 | 比如:医生、护士、教师等|'."\n"
.'| 物体|比如:钢琴、水杯、桌子、西红柿炒鸡蛋、小汽车、化妆品等 |'."\n"
.'| 标识| 比如:CCTV1、CCTV2、优酷、东方卫视等|'."\n"
.'| 动作事件| 比如:跳舞、接吻、拥抱、会晤、唱歌、打电话、骑马、打斗等|'."\n"
.'|地域 |比如:北京天安门、自由女神像、乐山大佛、中国、美国等 |'."\n"
.'| 场景| 比如:卧室、地铁站、梯田、海滩、沙漠等|'."\n"
."\n"
.'**ImageLabel**数据结构'."\n"
."\n"
.'|名称 |类型 |描述|'."\n"
.'|----------|--------|----|'."\n"
.'|persons | JSONArray| 检测到的人物结果|'."\n"
.'|persons.name | String|识别到的人物名称 |'."\n"
.'|persons.category | String|人物类型,取值如下:celebrity(名人);politician(政治人物);sensitive(敏感人物) |'."\n"
.'|persons.score | double|人物置信度得分 |'."\n"
.'| persons.position| JSONObject| 人脸坐标|'."\n"
.'| persons.position.leftTop| int[]| 左上角x,y坐标|'."\n"
.'| persons.position.rightBottom|int[] |右下角x,y坐标 |'."\n"
.'|persons.scene | String|人物镜头,包括:closeUp(特写);medium-closeUp(近景);medium(中景);medium-long(全景) |'."\n"
.'| tags|JSONArray |检测到的物体场景等标签,详见下表举例 |'."\n"
.'| tags.mainTagName|String |主标签 |'."\n"
.'|tags.subTagName | String|子标签 |'."\n"
.'|tags.score |double |置信度得分 |'."\n"
."\n"
.'图片tags标签举例说明'."\n"
."\n"
.'| mainTagName|subTagName |'."\n"
.'|---------------|--------|'."\n"
.'|人物角色| 比如:医生、护士、教师等|'."\n"
.'|地域 | 比如:北京天安门、自由女神像、乐山大佛、中国、美国等|'."\n"
.'| 动作事件|比如:讲话等 |'."\n"
.'| 标识| 比如:CCTV1、CCTV2、优酷、东方卫视等|'."\n"
.'| 动作事件| 比如:跳舞、接吻、拥抱、会晤、唱歌、打电话、骑马、打斗等|'."\n"
.'|物体 |比如:钢琴、水杯、桌子、西红柿炒鸡蛋、小汽车、化妆品等 |'."\n"
.'| 场景| 比如:卧室、地铁站、梯田、海滩、沙漠等|'."\n"
."\n"
.'TextLabel数据结构(来源于ASR和OCR)'."\n"
."\n"
.'|名称 |类型 |描述|'."\n"
.'|----------|--------|----|'."\n"
.'|tags |JSONArray |文本标签信息,详见下表举例 |'."\n"
.'| tags.name| String|标签类别 |'."\n"
.'|tags.value |String |标签值,可能有多个标签值,以半角逗号(,)分割 |'."\n"
."\n"
.'图片tags标签举例说明'."\n"
."\n"
.'| name|value |'."\n"
.'|---------------|--------|'."\n"
.'|地域| 比如:北京天安门、自由女神像、乐山大佛、中国、美国等|'."\n"
.'|组织机构 |比如:中国生动物保护协会、中央广播电视台等 |'."\n"
.'|标识 | 比如:耐克、李宁|'."\n"
.'|关键词 |比如:中坚力量 |'."\n"
."\n"
.'**CPVLabel**数据结构'."\n"
."\n"
.'- cates:类目(一级类目、二级类目、三级类目)'."\n"
.'- entities:类目属性(带有知识图谱信息)'."\n"
.'- hotwords:热点词(用户关注的名单)'."\n"
.'- freeTags:自由标签(关键词)'."\n"
."\n"
.'| 名称 | 类型 |示例值|说明|'."\n"
.'|---------------|--------|-----------|------|'."\n"
.'|type|String|hmi|结果类型。取值:hmi(人机协同结果)、autp(机器打标结果)|'."\n"
.'|cates|JSONArray|-|分类类目结果|'."\n"
.'|cates.labelLevel1|String|旅游|一级标签|'."\n"
.'| cates.labelLevel2 |String | 旅游风光 |二级标签 |'."\n"
.'| cates.label | String | "" |标签名称,算法可能返回空 |'."\n"
.'| cates.appearanceProbability | double | 0.96 | 出现率 |'."\n"
.'|cates.detailInfo |JSONArray |- | -|'."\n"
.'| cates.detailInfo.score | double|0.9 | 置信度 |'."\n"
.'|cates.detailInfo.startTime |double | 0.021 | 开始时间 |'."\n"
.'|cates.detailInfo.endTime |double |29.021 |结束时间 |'."\n"
.'| entities| JSONArray|- | -|'."\n"
.'|entities.labelLevel1 |String | 地域|一级标签 |'."\n"
.'| entities.labelLevel2| String| 地标|二级标签 |'."\n"
.'| entities.label|String | 黄果树瀑布| 标签名称|'."\n"
.'|entities.appearanceProbability | double|0.067 |出现率 |'."\n"
.'|entities.knowledgeInfo |String |{"name": "黄果树瀑布", "nameEn": "Huangguoshu Waterfall", "description": "亚洲四大瀑布之一"} |知识图谱信息,全部字段后附表:影视综IP图谱、音乐图谱、人物图谱、地标图谱、物体图谱。 |'."\n"
.'| entities.detailInfo|JSONArray |- |- |'."\n"
.'| entities.detailInfo.score| double|0.33292606472969055 | 置信度|'."\n"
.'|entities.detailInfo.startTime |double |6.021 | 开始时间|'."\n"
.'|entities.detailInfo.endTime |double |8.021 | 结束时间|'."\n"
.'|entities.detailInfo.trackData |JSONArray |- |实体标签结构化信息 |'."\n"
.'| entities.detailInfo.trackData.score| double|0.32 | 置信度|'."\n"
.'|entities.detailInfo.trackData.bbox |integer[] | 23,43,45,67| 坐标框|'."\n"
.'|entities.detailInfo.trackData.timestamp | double| 7.9|时间戳 |'."\n"
.'|hotwords |JSONArray | -|- |'."\n"
.'|hotwords.labelLevel1 | String|关键词 | 一级标签|'."\n"
.'|hotwords.labelLevel1 | String|关键词 |二级标签 |'."\n"
.'|hotwords.labelLevel2 |String |"" |二级标签 |'."\n"
.'|hotwords.label |String |中国气象局 |看点词内容 |'."\n"
.'| hotwords.appearanceProbability|double | 0.96|出现率 |'."\n"
.'|hotwords.detailInfo | JSONArray| | |'."\n"
.'| hotwords.detailInfo.score|double | 1.0| 置信度|'."\n"
.'|hotwords.detailInfo.startTime | double|0.021 |开始时间 |'."\n"
.'|hotwords.detailInfo.endTime | double| 29.021|结束时间 |'."\n"
.'| freeTags|JSONArray | | |'."\n"
.'|freeTags.labelLevel1 |String |关键词 |一级标签 |'."\n"
.'|freeTags.labelLevel2 | String| ""| 二级标签|'."\n"
.'|freeTags.label |String |中央气象台 |看点词内容 |'."\n"
.'|freeTags.appearanceProbability |double |0.96 | 出现率|'."\n"
.'|freeTags.detailInfo | JSONArray| | |'."\n"
.'|freeTags.detailInfo.score |double |0.9 | 置信度|'."\n"
.'| freeTags.detailInfo.startTime|double | 0.021| 开始时间|'."\n"
.'|freeTags.detailInfo.endTime |double | 29.021|结束时间 |'."\n"
."\n"
.'**语音识别ASR结果**'."\n"
."\n"
.'|名称 | 类型| 描述|'."\n"
.'|---------------|--------|-----------|'."\n"
.'| details|JSONArray | 任务详细结果|'."\n"
.'| details.from| double|开始时间戳,单位(秒) |'."\n"
.'|details.to |double |结束时间戳,单位(秒) |'."\n"
.'| details.content|String |识别出的文本内容 |'."\n"
."\n"
.'**文本识别OCR结果**'."\n"
."\n"
.'|名称 |类型 |描述 |'."\n"
.'|---------------|--------|-----------|'."\n"
.'|details |JSONArray |任务详细结果 |'."\n"
.'|details.timestamp |double | 时间戳信息,单位(秒)|'."\n"
.'|details.info | JSONArray|该时间点识别出的具体信息 |'."\n"
.'|details.info.score |double |置信度得分 |'."\n"
.'|details.info.position |JSONObject |文字坐标 |'."\n"
.'|details.info.position.leftTop |int[] | 左上角x,y坐标|'."\n"
.'|details.info.position.rightBottom |int[] |右下角x,y坐标 |'."\n"
.'| details.info.content| String|识别出的文本内容 |'."\n"
.'| details.info.textType| String|文本类型,取值:0(正常字幕)、1(滚动字幕)、2(定长标识性字幕,持续时间3秒以上) |'."\n"
."\n"
.'**Meta标注结果**'."\n"
."\n"
.'> 如果客户没有使用人机标注,在使用[SubmitSmarttagJob](~~163486~~)提交任务时如果指定了needMetaData,目前QuerySmarttagJob返回结果时会返回原始客户输入的标题。'."\n"
."\n"
.'|名称 | 类型|描述 |'."\n"
.'|---------------|--------|-----------|'."\n"
.'|title | String| 标题|'."\n"
."\n"
.'**字幕提取结果Subtitle**'."\n"
."\n"
.'|名称 |类型 |描述 |'."\n"
.'|---------------|--------|-----------|'."\n"
.'|details |JSONArray |任务详细结果 |'."\n"
.'|details.allResultUrl|String|全部字幕结果URL,URL有效期为任务完成后半年内可有效访问 |'."\n"
.'|details.chResultUrl|String|中文结果URL,URL有效期为任务完成后半年内可有效访问 |'."\n"
.'|details.engResultUrl|String|英文结果URL,URL有效期为任务完成后半年内可有效访问|'."\n"
."\n"
.'> 字幕结果URL内容:`序号+时间段+字幕内容(每句字幕为一行)`。',
'extraInfo' => '### 输出信息的解析'."\n"
."\n"
.'| 输出参数 | 描述 |'."\n"
.'| --- | --- |'."\n"
.'| name | 结果模块名:其中"tag"为标签结果,所有标签按照统一格式输出;"asr"为语音结果;“ocr”为文本识别结果。 |'."\n"
.'| result | 产品级结果列表,目前只包含内容分析产品 |'."\n"
.'| content | 产品级结果结构体 |'."\n"
.'| data | 具体算法结果列表 |'."\n"
."\n"
.'下面分name的值来说明字段:'."\n"
.'name = \'tag\' //融合标签结果'."\n"
."\n"
.'| 输出参数 | 描述 |'."\n"
.'| --- | --- |'."\n"
.'| labelLevel1 | 一级标签分类,如视频分类、节目、人脸、标识、人物角色、地域、场景、动作事件、组织机构、关键词等 |'."\n"
.'| labelLevel2 | 二级标签分类,其中人脸的二级标签类分组为:政治人物、敏感人物、名人、未知人脸、自定义,多种类型以\',\'隔开 |'."\n"
.'| label | 细粒度的标签 |'."\n"
.'| knowledgeInfo | 知识图谱信息(为字典) |'."\n"
.'| appearanceProbability | 标签的出场率,表示标签在视频中时间占比 |'."\n"
.'| isWhite | 表示该标签是否命中了用户定义的白名单 |'."\n"
.'| detailInfo | 该结构存储了标签出现的时间区间、score、区域、来源等详细信息 |'."\n"
.'| score | 是标签的置信度信息,部分标签置信度会不存在,不存在置信度时统一设置为-1. 比如挖掘出来的未知人脸的score分数为-1 |'."\n"
.'| bboxes | 标签区域位置信息,(将废弃,不建议使用),依次为区域左顶点X坐标、Y坐标、区域宽度、区域高度,后续逐渐废弃,信息迁移到trackData中 |'."\n"
.'| trackData | 在该时间段内等间隔记录在视频时刻上的算法结果,包含bbox、score、attributes、landmark、timestamp几个字段记录算法结果 |'."\n"
.'| score | trackData下的score,代表当前时刻的算法置信度,其中人脸算法为人脸检测的score |'."\n"
.'| bbox | trackData下的bbox,标签区域位置信息,'."\n"
.'格式为[x1,y1,x2,y2],左上顶点,右下顶点。 |'."\n"
.'| landmark | trackData下的landmark,标签区域关键像素信息 |'."\n"
.'| attributes | trackData下的attributes,有property、value、score字段,分别为该时刻的属性类、属性值、属性分数,表示标签在该帧的属性信息,如人脸的表情信息等 |'."\n"
.'| timestamp | trackData下的timestamp,标记当前时刻 |'."\n"
.'| source | 标签来源:\'vision\'为视觉来源、\'audio\'为音频来源、\'text\'为文本来源 |'."\n"
.'| subSource | 为算法模型层次的来源,用户可不用关心 |'."\n"
.'| metaData | 记载了标签的非统一信息,不同类型的标签会有所差别,可通过判断某个字段是否为空来确定该标签是否具备该字段信息,具体子字段如下 |'."\n"
.'| metaData.sampleUrl | 标签的代表图,如人脸识别中预测人物和该图是一致的,也是我们定义标签的标准 |'."\n"
.'| metaData.feature | 标签代表图的特征,如人脸识别中的最佳人脸的特征,即sampleUrl对应的图像特征 |'."\n"
.'| metaData.group| 标签的分组,如人脸识别中的人物库信息 |'."\n"
.'| metaData.itemUrl | 描述该标签的标准图 |'."\n"
.'| metaData.finegrainName | 描述该片段的细粒度标签 |'."\n"
.'| mediaData.entityInfo | 客户自定义的实体信息(用于自注册的算法) |'."\n"
."\n"
.'name = \'sbd\'//拆条识别结果'."\n"
."\n"
.'| 输出参数 | 描述 |'."\n"
.'| --- | --- |'."\n"
.'| index | 拆分片段id |'."\n"
.'| timestamp | 拆条结束时间 |'."\n"
.'| score | 拆条置信度 |'."\n"
."\n"
.'name = \'asr\'//语音识别结果'."\n"
."\n"
.'| 输出参数 | 描述 |'."\n"
.'| --- | --- |'."\n"
.'| startTime | 时间段开始时间 |'."\n"
.'| endTime | 时间段结束时间 |'."\n"
.'| text | asr文本 |'."\n"
."\n"
.'name = \'ocr\'//OCR文本识别结果'."\n"
."\n"
.'| 输出参数 | 描述 |'."\n"
.'| --- | --- |'."\n"
.'| startTime | 时间段开始时间 |'."\n"
.'| endTime | 时间段结束时间 |'."\n"
.'| detailInfo | 具体的OCR识别结果,是一个列表,表示不同区域的OCR结果 |'."\n"
.'| score | OCR识别的置信度 |'."\n"
.'| char_probs | OCR预测每个单字符的置信度 |'."\n"
.'| text | OCR的文本 |'."\n"
.'| bbox | 标签区域位置信息,依次为区域[x1,y1,x2,y2],左上顶点,右下顶点。 |'."\n"
.'| timestamp | 该帧图片在视频中时间戳 |'."\n"
."\n"
.'name = \'video_ocr\'//VideoOCR文本识别结果'."\n"
."\n"
.'| 输出参数 | 描述 |'."\n"
.'| --- | --- |'."\n"
.'| startTime | 时间段开始时间 |'."\n"
.'| endTime | 时间段结束时间 |'."\n"
.'| detailInfo | 具体的VideoOCR识别结果,是一个列表,表示不同clip区域的VideoOCR结果 |'."\n"
.'| score | VideoOCR识别的置信度 |'."\n"
.'| text | VideoOCR的文本 |'."\n"
.'| bbox | 标签区域位置信息,依次为区域[x1,y1,x2,y2],左上顶点,右下顶点。 |'."\n"
.'| text_type | 文本类型(0-正常字幕,1-滚动字幕,2-定长标识性字幕(持续时间大于3s以上)) |'."\n"
."\n"
.'```JSON'."\n"
.'['."\n"
.' {'."\n"
.' "name": "tag",//结果分类,分为tag、ocr、asr和sbd。分别对应标签结果、OCR结果、语音结果和拆条结果'."\n"
.' "result": [//结果值'."\n"
.' {'."\n"
.' "content": {'."\n"
.' "data": ['."\n"
.' {'."\n"
.' "labelLevel1": "人脸",//标签一级分类'."\n"
.' "labelLevel2": "政治人物",//标签二级分类'."\n"
.' "label": "李命名",//标签值'."\n"
.' "appearanceProbability":0.3547,//出场率'."\n"
.' "isWhite":true, //是否命中白名单'."\n"
.' "labelId": "0010014169",'."\n"
.' "knowledgeInfo":{},'."\n"
.' "detailInfo": [//标签详细信息'."\n"
.' {'."\n"
.' "score": 0.85797792673110962,//标签置信度,部分标签置信度会不存在,不存在置信度时统一设置为-1. 比如挖掘出来的未知人脸的score分数为-1'."\n"
.' "trackData": ['."\n"
.' {'."\n"
.' "score": 0.91240006685256958,'."\n"
.' "bbox": [205.0, 95.0, 318.0, 247.0],'."\n"
.' "attributes": ['."\n"
.' {'."\n"
.' "property":"表情",'."\n"
.' "value":"笑",'."\n"
.' "score": 0.8765'."\n"
.' }'."\n"
.' ],'."\n"
.' "landmark": [205.0, 95.0, 318.0, 247.0, 205.0, 95.0, 318.0, 247.0, 435.0, 435.0],'."\n"
.' "timestamp": 35.333000//时间点'."\n"
.' },'."\n"
.' {'."\n"
.' "score": 0.91240006685256958,'."\n"
.' "bbox": [201.0, 95.0, 314.0, 247.0],'."\n"
.' "attributes": ['."\n"
.' {'."\n"
.' "property":"表情",'."\n"
.' "value":"笑",'."\n"
.' "score": 0.8765'."\n"
.' }'."\n"
.' ],'."\n"
.' "landmark": [205.0, 95.0, 318.0, 247.0, 205.0, 95.0, 318.0, 247.0, 435.0, 435.0],'."\n"
.' "timestamp": 35.466000'."\n"
.' }'."\n"
.' ],'."\n"
.' "startTime": 35.0,//片段开始时间'."\n"
.' "endTime": 35.465999603271484,//片段结束时间'."\n"
.' "source": "vision",//标签来源,分为vision:视觉, text:文字,audio:语音'."\n"
.' "subSource": "facemot",//标签子来源'."\n"
.' "metaData": {//标签meta信息,不同的标签meta内容不同。'."\n"
.' "sampleUrl": "",//人像的图片地址'."\n"
.' "group": "politicians"//人像的图库名称'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "score": 0.85797792673110962, '."\n"
.' "trackData": ['."\n"
.' {'."\n"
.' "score": 0.91240006685256958,'."\n"
.' "bbox": [205.0, 95.0, 318.0, 247.0],'."\n"
.' "attributes": ['."\n"
.' {'."\n"
.' "property":"表情",'."\n"
.' "value":"笑",'."\n"
.' "score": 0.8765'."\n"
.' }'."\n"
.' ],'."\n"
.' "landmark": [205.0, 95.0, 318.0, 247.0, 205.0, 95.0, 318.0, 247.0, 435.0, 435.0],'."\n"
.' "timestamp": 35.333000'."\n"
.' },'."\n"
.' {'."\n"
.' "score": 0.91240006685256958,'."\n"
.' "bbox": [201.0, 95.0, 314.0, 247.0],'."\n"
.' "attributes": ['."\n"
.' {'."\n"
.' "property":"表情",'."\n"
.' "value":"笑",'."\n"
.' "score": 0.8765'."\n"
.' }'."\n"
.' ],'."\n"
.' "landmark": [205.0, 95.0, 318.0, 247.0, 205.0, 95.0, 318.0, 247.0, 435.0, 435.0],'."\n"
.' "timestamp": 35.466000'."\n"
.' }'."\n"
.' ],'."\n"
.' "startTime": 35.0,'."\n"
.' "endTime": 35.465999603271484,'."\n"
.' "source": "text",'."\n"
.' "subSource": "ocr_nlp",'."\n"
.' "metaData": {'."\n"
.' "sampleUrl": "",'."\n"
.' "group": ""'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "labelLevel1": "视频分类",'."\n"
.' "labelLevel2": "资讯",'."\n"
.' "label": "时政资讯",'."\n"
.' "labelId": "0100252",'."\n"
.' "detailInfo": ['."\n"
.' {'."\n"
.' "score": 0.85797792673110962,'."\n"
.' "bboxes": {},'."\n"
.' "trackData": [],'."\n"
.' "startTime": 0,'."\n"
.' "endTime": 35.465999603271484,'."\n"
.' "source": "vision",'."\n"
.' "subSource": "cate",'."\n"
.' "metaData": {'."\n"
.' "sampleUrl": "",'."\n"
.' "group": ""'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "score": 0.85797792673110962,'."\n"
.' "bboxes": {},'."\n"
.' "trackData": [],'."\n"
.' "startTime": 0,'."\n"
.' "endTime": 35.465999603271484,'."\n"
.' "source": "text",'."\n"
.' "subSource": "ocr_nlp",'."\n"
.' "metaData": {'."\n"
.' "sampleUrl": "",'."\n"
.' "group": ""'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "sbd",//结果分类,分为tag、ocr、asr和sbd。分别对应标签结果、OCR结果、语音结果和拆条结果'."\n"
.' "result": [//结果值'."\n"
.' {'."\n"
.' "content": {'."\n"
.' "data": ['."\n"
.' {'."\n"
.' "index": 0, '."\n"
.' "score": 0.9675695300102234, '."\n"
.' "timestamp": 10.16 # 第一个片段终止时间'."\n"
.' }, '."\n"
.' {"index": 1, '."\n"
.' "score": 0.9833308458328247, '."\n"
.' "timestamp": 12.64 # 第二个片段终止时间'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "ocr",//OCR结果'."\n"
.' "result": ['."\n"
.' {'."\n"
.' "content": {'."\n"
.' "data": ['."\n"
.' {'."\n"
.' "detailInfo": ['."\n"
.' {'."\n"
.' "score": 99,//OCR置信度'."\n"
.' "bbox": [//OCR文本位置信息'."\n"
.' 434,'."\n"
.' 31,'."\n"
.' 464,'."\n"
.' 43'."\n"
.' ],'."\n"
.' "text": "今天"//文本信息'."\n"
.' }'."\n"
.' ],'."\n"
.' "startTime": 0.0,//文本出现的帧的开始时间'."\n"
.' "endTime": 0.0 //文本出现的帧的结束时间'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "video_ocr",//video_ocr结果'."\n"
.' "result": ['."\n"
.' {'."\n"
.' "content": {'."\n"
.' "data": ['."\n"
.' {'."\n"
.' "detailInfo": ['."\n"
.' {'."\n"
.' "score": 0.99,//OCR置信度'."\n"
.' "bbox": [//OCR文本位置信息'."\n"
.' 434,'."\n"
.' 31,'."\n"
.' 464,'."\n"
.' 43'."\n"
.' ],'."\n"
.' "pos": [//OCR文本位置信息'."\n"
.' {'."\n"
.' "x": 166,'."\n"
.' "y": 660'."\n"
.' },'."\n"
.' {'."\n"
.' "x": 822,'."\n"
.' "y": 660'."\n"
.' },'."\n"
.' {'."\n"
.' "x": 822,'."\n"
.' "y": 682'."\n"
.' },'."\n"
.' {'."\n"
.' "x": 166,'."\n"
.' "y": 682'."\n"
.' }'."\n"
.' ],'."\n"
.' "text": "今天",//文本信息'."\n"
.' "text_type": 2//文本类型(0-正常字幕,1-滚动字幕,2-定长标识性字幕(持续时间大于3s以上))'."\n"
.' }'."\n"
.' ],'."\n"
.' "startTime": 0.0,//文本出现的帧的开始时间'."\n"
.' "endTime": 0.0 //文本出现的帧的结束时间'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "asr",//语音结果'."\n"
.' "result": ['."\n"
.' {'."\n"
.' "content": {'."\n"
.' "data": ['."\n"
.' {'."\n"
.' "text": "这个时候",//语音文本'."\n"
.' "startTime": 108.7699966430664, //语音文本开始时间'."\n"
.' "endTime": 110.79000091552734 //语音文本结束时间'."\n"
.' },'."\n"
.' {'."\n"
.' "text": "你不要着急。",//语音文本'."\n"
.' "startTime": 108.7699966430664,//语音文本开始时间'."\n"
.' "endTime": 110.79000091552734 //语音文本结束时间'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.']'."\n"
.'```',
],
'AddSmarttagTemplate' => [
'summary' => '添加一个智能标签作业的分析模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmts0VQEVI',
'FEATUREmts0A6ARW',
'FEATUREmtsS08B52',
],
],
'parameters' => [
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '自定义模板名称,字符串内容中英文不限,最长120字符。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'template-example-****',
],
],
[
'name' => 'Industry',
'in' => 'query',
'schema' => [
'description' => '待分析文件所处行业。默认值:**common**(通用行业)。请选择合适的行业,用于后台匹配适用于行业的算法组合。取值: '."\n"
."\n"
.'- **microVideo**:小视频行业。'."\n"
.'- **common**:通用行业。'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'common',
],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => [
'description' => '待分析文件使用场景。请选择合适的使用场景,用于后台匹配适用的算法组合。取值:'."\n"
."\n"
.'- **search**:搜索场景。'."\n"
.'- **recommend**:推荐场景。'."\n"
."\n"
.'- 默认值:**search**。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'search',
],
],
[
'name' => 'AnalyseTypes',
'in' => 'query',
'schema' => [
'description' => '分析类型,可多选,⽤半角逗号(,)分隔。当前有以下类型: '."\n"
.'> 请确保您的待分析文件中包含所选分析类型的结果,否则可能导致查询结果为空。例如:选择的分析类型为ocr,但上传的图片中没有ocr结果,则查询时返回结果为空。'."\n"
."\n"
.'- **ocr**:从图像⽂字中识别出标签 。'."\n"
.'- **asr**:从⾳频语⾳中识别出标签 。'."\n"
.'- **classification**:视频分类 。'."\n"
.'- **shows**:视频识别节⽬ 。'."\n"
.'- **face**:视频或图片识别⼈脸 。'."\n"
.'- **role**:视频识别⼈物⻆⾊ 。'."\n"
.'- **object**:视频识别物体 。'."\n"
.'- **tvstation**:视频识别台标。'."\n"
.'- **action**:视频识别动作事件 。'."\n"
.'- **emotion**:视频识别表情 。'."\n"
.'- **landmark**:视频识别地标 。'."\n"
.'- **scene**:视频识别场景。'."\n"
.'- **movieIp**:视频识别影视IP,目前仅支持华北2(北京)地域使用。'."\n"
.'- **subtitle**:字幕提取功能。'."\n"
."\n"
.'分析类型与计费项的对应关系如下:'."\n"
."\n"
.'> 通过本接口配置智能标签功能开启的分析类型,将会产生费用,收费标准请参见[计费项](~~299952~~)。'."\n"
."\n"
.'- 视频分类+结构化标签:除face,ocr,asr外的分析类型均属于此计费项,不叠加计费。'."\n"
.'- 视频人脸识别:开启face。'."\n"
.'- 视频文字识别标签:开启ocr。'."\n"
.'- 视频语音识别标签:开启asr。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ocr',
],
],
[
'name' => 'FaceCategoryIds',
'in' => 'query',
'schema' => [
'description' => '参与识别的⼈脸库ID列表,可多选,⽤半角逗号(,)分隔。可填⼊系统⼈脸库ID和⾃定义⼈脸库ID。其中系统⼈脸库ID如下:'."\n"
."\n"
.'- **celebrity**:明星⼈物。'."\n"
.'- **politician**:政治⼈物。'."\n"
.'- **sensitive**:敏感⼈物。'."\n"
."\n"
.'- ⾃定义⼈物库ID请参见[注册自定义人脸接口说明](~~187777~~)。',
'type' => 'string',
'required' => false,
'example' => 'celebrity',
],
],
[
'name' => 'FaceCustomParamsConfig',
'in' => 'query',
'schema' => [
'description' => '人脸算法的参数,JSON String形式,目前支持人脸检测阈值和人脸识别阈值调整。'."\n"
."\n"
.'- **faceDetThreshold**:人脸检测阈值,默认阈值0.999,只对陌生人脸分析有效。'."\n"
."\n"
.'- **faceRegThreshold**:人脸识别阈值,默认阈值0.9。',
'type' => 'string',
'required' => false,
'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }',
],
],
[
'name' => 'ObjectGroupIds',
'in' => 'query',
'schema' => [
'description' => '参与识别的物体库ID列表,可多选,⽤半角逗号(,)分隔。可填⼊系统物体库ID和⾃定义物体库ID。其中系统物体库ID如下:'."\n"
."\n"
.'- **general**:通用。'."\n"
."\n"
.'- **item**:商品。'."\n"
."\n"
.'- **weapon**:武器。'."\n"
."\n"
.'- **animal**:动物。'."\n"
."\n"
.'- ⾃定义物体库ID请参见[注册自定义实体](~~451180~~)接口说明。',
'type' => 'string',
'required' => false,
'example' => 'general,item,weapon,animal',
],
],
[
'name' => 'LandmarkGroupIds',
'in' => 'query',
'schema' => [
'description' => '参与识别的地域库ID列表,可多选,⽤半角逗号(,)分隔。可填⼊系统地域库ID和⾃定义地域库ID。其中系统地域库ID如下:'."\n"
."\n"
.'- common:通用。'."\n"
."\n"
.'- ⾃定义地域库ID请参见[注册自定义实体照片](~~451182~~)接口说明。',
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
[
'name' => 'IsDefault',
'in' => 'query',
'schema' => [
'description' => '是否设置为默认模板(设置为默认模板后,如果转码时不指定转码模板则使用默认模板进行转码)。取值:**true**(是)、**false**(否),默认**false**。⼀个阿里云账号下只能有⼀个默认模板,如果重复设置则会报错。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'LabelType',
'in' => 'query',
'schema' => [
'description' => '标注类型,目前支持类型:'."\n"
."\n"
.'- **auto**:机器打标。'."\n"
."\n"
.'- **hmi**:人机协同。',
'type' => 'string',
'required' => false,
'example' => 'hmi',
],
],
[
'name' => 'LabelVersion',
'in' => 'query',
'schema' => [
'description' => '指定智能标签版本,默认为"1.0"。'."\n"
."\n"
.'- 1.0:智能标签1.0'."\n"
."\n"
.'- 2.0:智能标签2.0(CPV标签)'."\n"
."\n"
.'- 2.0-custom:智能标签2.0-custom(CPV标签定制模型)',
'type' => 'string',
'required' => false,
'example' => '1.0',
],
],
[
'name' => 'KnowledgeConfig',
'in' => 'query',
'schema' => [
'description' => '智能标签2.0和2.0-custom模式下,设置返回标签结果中识别到知识图谱信息字段范围。更多知识图谱信息请参见[智能标签接口知识图谱字段说明](~~356383~~)。不填写或者knowledgeConfig为空或者knowledgeConfig非法(不为JSON String)时,默认输出以下字段:'."\n"
."\n"
.'- movie:'."\n"
."\n"
.' - name:IP名称'."\n"
."\n"
.' - alias:IP别名'."\n"
.' - chnl:类别'."\n"
.' - genre:类型'."\n"
.' - country:制片国家、地区'."\n"
.' - language:语言'."\n"
.' - releaseYear:发布年份'."\n"
."\n"
.'- music:'."\n"
."\n"
.' - songName:歌曲名称'."\n"
.' - artistName:歌手姓名'."\n"
.' - artistArea:歌手所属地区,华语/日本/韩国/欧美/其他'."\n"
.' - albumName:专辑名称'."\n"
."\n"
.'- person:'."\n"
."\n"
.' - name:姓名'."\n"
.' - gender:性别'."\n"
.' - citizenship:国籍'."\n"
.' - occupation:职业'."\n"
.' - classification:类型'."\n"
.' - nationality:民族'."\n"
.' - birthPlace:出生地'."\n"
.' - birthDate:出生日期'."\n"
."\n"
.'- landmark'."\n"
.' - name:名称'."\n"
.' - nameEn:英文名'."\n"
.' - description:描述'."\n"
.' - address:地址'."\n"
."\n"
.'- item'."\n"
."\n"
.' - brandName:品牌'."\n"
.' - finegrainName:细粒度描述',
'type' => 'string',
'required' => false,
'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }',
],
],
[
'name' => 'KeywordConfig',
'in' => 'query',
'schema' => [
'description' => '关键词标签配置。**type**代表词性类别选择,可多选,用半角逗号(,)分隔,当前支持以下类别:'."\n"
."\n"
.'- **name**:人名'."\n"
."\n"
.'- **location**:地名'."\n"
."\n"
.'- **organization**:机构名'."\n"
."\n"
.'- **other**:其他'."\n"
."\n"
.'> 当不传KeywordConfig时或者Keyword字段非法(不为JSON String)或者KeywordsConfig不包含type字段或者type字段非法时默认返回type全部类型关键词。',
'type' => 'string',
'required' => false,
'example' => '"type": "name,location,organization,other" }',
],
],
[
'name' => 'LabelCustomCategoryIds',
'in' => 'query',
'schema' => [
'description' => '参与识别的自定义标签库ID列表,可多选,⽤半角逗号(,)分隔。',
'type' => 'string',
'required' => false,
'example' => 'ab***cd,ef***hi',
],
],
[
'name' => 'LabelCustomParamsConfig',
'in' => 'query',
'schema' => [
'description' => '额外自定义标签库的参数配置,目前只支持阈值的设置。'."\n"
.'{"threshold": xxx}',
'type' => 'string',
'required' => false,
'example' => '{"threshold": 0.4}',
],
],
[
'name' => 'TemplateConfig',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B117AF5-2A16-412C-B127-FA6175EDAS3Q',
],
'TemplateId' => [
'description' => '模板ID。建议您保存此ID便于后续调用其他相关接口时使用。',
'type' => 'string',
'example' => '05de22f255284c7a8d2aab535dde****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175EDAS3Q\\",\\n \\"TemplateId\\": \\"05de22f255284c7a8d2aab535dde****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7B117AF5-2A16-412C-B127-FA6175EDAS3Q\\n 05de22f255284c7a8d2aab535dde****\\n","errorExample":""}]',
'title' => '添加模板',
'description' => '本接口添加的模板用于指定智能标签作业中的分析算法,可根据您的实际业务需求组合不同参数。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'QuerySmarttagTemplateList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '模板ID,可以从[添加模板](~~187759~~)的返回参数中获取。若指定该参数,则只返回该模板的信息;否则返回当前RAM⽤户所有模板的信息。'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '05de22f255284c7a8d2aab535dde****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26',
],
'Templates' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '模板列表。',
'type' => 'array',
'items' => [
'description' => '模板详细信息。',
'type' => 'object',
'properties' => [
'AnalyseTypes' => [
'description' => '分析类型,可能返回一个或多个。可取值: '."\n"
."\n"
.'- **ocr**:从图像⽂字中识别出标签 。'."\n"
.'- **asr**:从⾳频语⾳中识别出标签 。'."\n"
.'- **classification**:视频分类 。'."\n"
.'- **shows**:视频识别节⽬ 。'."\n"
.'- **face**:视频识别⼈脸 。'."\n"
.'- **role**:视频识别⼈物⻆⾊ 。'."\n"
.'- **object**:视频识别物体 。'."\n"
.'- **tvstation**:视频识别台标。'."\n"
.'- **action**:视频识别动作事件 。'."\n"
.'- **emotion**:视频识别表情 。'."\n"
.'- **landmark**:视频识别地标 。'."\n"
.'- **scene**:视频识别场景。'."\n"
.'- **movieIp**:视频识别影视IP。'."\n"
."\n"
.'- **subtitle**:字幕提取功能。',
'type' => 'string',
'example' => 'ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene',
],
'Industry' => [
'description' => '⾏业。默认值:**common**(通用行业)。可取值:'."\n"
."\n"
.'- **microVideo**:小视频行业。'."\n"
."\n"
.'- **common**:通用行业。'."\n"
."\n\n",
'type' => 'string',
'example' => 'common',
],
'IsDefault' => [
'description' => '是否为默认模板。可取值:'."\n"
."\n"
.'- **true**:是'."\n"
."\n"
.'- **false**:否'."\n",
'type' => 'boolean',
'example' => 'false',
],
'TemplateName' => [
'description' => '模板名称。',
'type' => 'string',
'example' => 'example-****',
],
'TemplateId' => [
'description' => '模板ID。',
'type' => 'string',
'example' => '05de22f255284c7a8d2aab535dde****',
],
'FaceCategoryIds' => [
'description' => '系统⼈脸库ID,可能返回一个或多个。可取值:'."\n"
."\n"
.'- celebrity:明星⼈物。'."\n"
.'- politician:政治⼈物。'."\n"
.'- sensitive:敏感⼈物。'."\n",
'type' => 'string',
'example' => 'politician,sensitive,celebrity',
],
'FaceCustomParamsConfig' => [
'description' => '人脸算法的参数,JSON String形式,目前支持人脸检测阈值和人脸识别阈值。取值:'."\n"
."\n"
.'- **faceDetThreshold**:人脸检测阈值,默认阈值0.999,只对陌生人脸分析有效。'."\n"
."\n"
.'- **faceRegThreshold**:人脸识别阈值,默认阈值0.9。',
'type' => 'string',
'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }',
],
'ObjectGroupIds' => [
'description' => '参与识别的物体库ID列表。',
'type' => 'string',
'example' => 'general,item,weapon,animal',
],
'LandmarkGroupIds' => [
'description' => '参与识别的地域库ID列表。',
'type' => 'string',
'example' => 'common',
],
'Scene' => [
'description' => '场景,可取值:'."\n"
."\n"
.'- **search**:搜索场景。'."\n"
.'- **recommend**:推荐场景。'."\n"
."\n",
'type' => 'string',
'example' => 'search',
],
'LabelType' => [
'description' => '标注类型,默认值**auto**。目前支持类型:'."\n"
."\n"
.'- **auto**:机器打标。'."\n"
."\n"
.'- **hmi**:人机协同。',
'type' => 'string',
'example' => 'hmi',
],
'LabelVersion' => [
'description' => '指定智能标签版本,默认为"1.0"。可取值:'."\n"
."\n"
.'- 1.0:智能标签1.0,'."\n"
."\n"
.'- 2.0:智能标签2.0(CPV标签)'."\n"
."\n"
.'- 2.0-custom:智能标签2.0-custom(CPV标签定制模型)',
'type' => 'string',
'example' => '1.0',
],
'KnowledgeConfig' => [
'description' => '智能标签2.0和2.0-custom模式下,设置返回标签结果中识别到知识图谱信息字段范围。更多知识图谱信息请参见[智能标签作业知识图谱字段说明](~~356383~~)。不填写或者knowledgeConfig为空或者knowledgeConfig非法(不为JSON String)时,默认输出以下字段:'."\n"
."\n"
.'- movie:'."\n"
."\n"
.' - name:IP名称'."\n"
."\n"
.' - alias:IP别名'."\n"
.' - chnl:类别'."\n"
.' - genre:类型'."\n"
.' - country:制片国家、地区'."\n"
.' - language:语言'."\n"
.' - releaseYear:发布年份'."\n"
."\n"
.'- music:'."\n"
."\n"
.' - songName:歌曲名称'."\n"
.' - artistName:歌手姓名'."\n"
.' - artistArea:歌手所属地区,华语/日本/韩国/欧美/其他'."\n"
.' - albumName:专辑名称'."\n"
."\n"
.'- person:'."\n"
."\n"
.' - name:姓名'."\n"
.' - gender:性别'."\n"
.' - citizenship:国籍'."\n"
.' - occupation:职业'."\n"
.' - classification:类型'."\n"
.' - nationality:民族'."\n"
.' - birthPlace:出生地'."\n"
.' - birthDate:出生日期'."\n"
."\n"
.'- landmark'."\n"
.' - name:名称'."\n"
.' - nameEn:英文名'."\n"
.' - description:描述'."\n"
.' - address:地址'."\n"
."\n"
.'- item'."\n"
."\n"
.' - brandName:品牌'."\n"
.' - finegrainName:细粒度描述',
'type' => 'string',
'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }',
],
'KeywordConfig' => [
'description' => '关键词标签配置。type代表词性类别选择,可多选,用半角逗号(,)分隔,当前有以下类别:'."\n"
."\n"
.'- name:人名'."\n"
."\n"
.'- location:地名'."\n"
."\n"
.'- organization:机构名'."\n"
."\n"
.'- other:其他'."\n"
."\n"
.'> 当不传KeywordConfig时或者Keyword字段非法(不为JSON String)或者KeywordsConfig不包含type字段或者type字段非法时默认返回type全部类型关键词。',
'type' => 'string',
'example' => '{ "type": "name,location,organization,other" }',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8796E26\\",\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"AnalyseTypes\\": \\"ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene\\",\\n \\"Industry\\": \\"common\\",\\n \\"IsDefault\\": false,\\n \\"TemplateName\\": \\"example-****\\",\\n \\"TemplateId\\": \\"05de22f255284c7a8d2aab535dde****\\",\\n \\"FaceCategoryIds\\": \\"politician,sensitive,celebrity\\",\\n \\"FaceCustomParamsConfig\\": \\"{ \\\\\\"faceDetThreshold\\\\\\":0.999, \\\\\\"faceRegThreshold\\\\\\":0.9 }\\",\\n \\"ObjectGroupIds\\": \\"general,item,weapon,animal\\",\\n \\"LandmarkGroupIds\\": \\"common\\",\\n \\"Scene\\": \\"search\\",\\n \\"LabelType\\": \\"hmi\\",\\n \\"LabelVersion\\": \\"1.0\\",\\n \\"KnowledgeConfig\\": \\"{ \\\\\\"movie\\\\\\":\\\\\\"name,alias,chnl,genre\\\\\\", \\\\\\"music\\\\\\":\\\\\\"songName,artistName\\\\\\", \\\\\\"person\\\\\\":\\\\\\"name,gender\\\\\\" }\\",\\n \\"KeywordConfig\\": \\"{ \\\\\\"type\\\\\\": \\\\\\"name,location,organization,other\\\\\\" }\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 5210DBB0-E327-4D45-ADBC-0B83C8796E26\\n \\n ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene\\n common\\n false\\n example-****\\n 05de22f255284c7a8d2aab535dde****\\n politician,sensitive,celebrity\\n { \\"faceDetThreshold\\":0.999, \\"faceRegThreshold\\":0.9 }\\n general,item,weapon,animal\\n common\\n search\\n hmi\\n 1.0\\n { \\"movie\\":\\"name,alias,chnl,genre\\", \\"music\\":\\"songName,artistName\\", \\"person\\":\\"name,gender\\" }\\n { \\"type\\": \\"name,location,organization,other\\" }\\n \\n","errorExample":""}]',
'title' => '查询模板',
'summary' => '查询智能标签作业的分析模板。',
'description' => '本接口通过模板ID查询模板,如果不传入模板ID则默认查询当前RAM用户所有模板。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'UpdateSmarttagTemplate' => [
'summary' => '更新一个智能标签作业的分析模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmts0A6ARW',
'FEATUREmtsS08B52',
],
],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '模板ID。可以从[添加模板](~~187759~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '05de22f255284c7a8d2aab535dde****',
],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '自定义模板名称,字符串内容中英文不限,最长120字符。'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'template-example-****',
],
],
[
'name' => 'Industry',
'in' => 'query',
'schema' => [
'description' => '待分析文件所处行业。默认值:**common**(通用行业)。请选择合适的行业,用于后台匹配适用于行业的算法组合。取值: '."\n"
."\n"
.'- **microVideo**:小视频行业。'."\n"
.'- **common**:通用行业。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'common',
],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => [
'description' => '使用场景,选择合适的使用场景,用于后台匹配适用的算法组合。取值:'."\n"
."\n"
.'- **search**:搜索场景。'."\n"
.'- **recommend**:推荐场景。'."\n"
."\n"
.'- 默认**search**。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'search',
],
],
[
'name' => 'AnalyseTypes',
'in' => 'query',
'schema' => [
'description' => '分析类型,可多选,⽤半角逗号(,)分隔。当前有以下类型:'."\n"
."\n"
.'- **ocr**:从图像⽂字中识别出标签。'."\n"
.'- **asr**:从⾳频语⾳中识别出标签。'."\n"
.'- **classification**:视频分类。'."\n"
.'- **shows**:视频识别节⽬。'."\n"
.'- **face**:视频识别⼈脸。'."\n"
.'- **role**:视频识别⼈物⻆⾊。'."\n"
.'- **object**:视频识别物体。'."\n"
.'- **tvstation**:视频识别台标。'."\n"
.'- **action**:视频识别动作事件。'."\n"
.'- **emotion**:视频识别表情。'."\n"
.'- **landmark**:视频识别地标。'."\n"
.'- **scene**:视频识别场景。'."\n"
."\n"
.'- **movielp**:视频识别影视IP。'."\n"
."\n"
.'- **subtitle**:字幕提取功能。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ocr,asr',
],
],
[
'name' => 'FaceCategoryIds',
'in' => 'query',
'schema' => [
'description' => '参与识别的⼈脸库ID列表,可多选,⽤逗号隔开。可填⼊系统⼈脸库ID和⾃定义⼈脸库ID。其中系统⼈脸库ID如下:'."\n"
."\n"
.'- **celebrity**:明星⼈物。'."\n"
.'- **politician**:政治⼈物。'."\n"
.'- **sensitive**:敏感⼈物。'."\n"
."\n"
.'- 参数默认值:**celebrity**,**politician**,**sensitive**。'."\n"
."\n"
.'> ⾃定义⼈物库ID详⻅[⾃定义⼈脸接⼝说明](~~187777~~)。'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'celebrity',
],
],
[
'name' => 'FaceCustomParamsConfig',
'in' => 'query',
'schema' => [
'description' => '人脸算法的参数,JSON String形式,目前支持人脸检测阈值和人脸识别阈值。'."\n"
."\n"
.'- **faceDetThreshold**:人脸检测阈值,默认阈值0.999,只对陌生人脸分析有效。'."\n"
."\n"
.'- **faceRegThreshold**:人脸识别阈值,默认阈值0.9。',
'type' => 'string',
'required' => false,
'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }',
],
],
[
'name' => 'ObjectGroupIds',
'in' => 'query',
'schema' => [
'description' => '参与识别的物体库ID列表,可多选,⽤半角逗号(,)分隔。可填⼊系统物体库ID和⾃定义物体库ID。其中系统物体库ID如下:'."\n"
."\n"
.'- **general**:通用。'."\n"
."\n"
.'- **item**:商品。'."\n"
."\n"
.'- **weapon**:武器。'."\n"
."\n"
.'- **animal**:动物。'."\n"
."\n"
.'- ⾃定义物体库ID请参见[注册自定义实体](~~451180~~)接口说明。',
'type' => 'string',
'required' => false,
'example' => 'general,item,weapon,animal',
],
],
[
'name' => 'LandmarkGroupIds',
'in' => 'query',
'schema' => [
'description' => '参与识别的地域库ID列表,可多选,⽤半角逗号(,)分隔。可填⼊系统地域库ID和⾃定义地域库ID。其中系统地域库ID如下:'."\n"
."\n"
.'- **common**:通用。'."\n"
."\n"
.'- ⾃定义地域库ID请参见[注册自定义实体照片](~~451182~~)接口说明。',
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
[
'name' => 'IsDefault',
'in' => 'query',
'schema' => [
'description' => '是否默认模板,取值:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
."\n"
.'默认**false**,⼀个⽤户只能有⼀个默认模板。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'example' => 'true',
],
],
[
'name' => 'LabelType',
'in' => 'query',
'schema' => [
'description' => '标注类型,默认**auto**。目前支持类型:'."\n"
."\n"
.'- **auto**:机器打标。'."\n"
."\n"
.'- **hmi**:人机协同。',
'type' => 'string',
'required' => false,
'example' => 'hmi',
],
],
[
'name' => 'LabelVersion',
'in' => 'query',
'schema' => [
'description' => '指定智能标签版本,默认为"1.0"。'."\n"
."\n"
.'- 1.0:智能标签1.0,'."\n"
."\n"
.'- 2.0:智能标签2.0(CPV标签)'."\n"
."\n"
.'- 2.0-custom:智能标签2.0-custom(CPV标签定制模型)',
'type' => 'string',
'required' => false,
'example' => '1.0',
],
],
[
'name' => 'KnowledgeConfig',
'in' => 'query',
'schema' => [
'description' => '智能标签2.0和2.0-custom模式下,设置返回标签结果中识别到知识图谱信息字段范围。更多知识图谱信息请参见[智能标签接口知识图谱字段说明](~~356383~~)。不填写或者knowledgeConfig为空或者knowledgeConfig非法(不为JSON String)时,默认输出以下字段:'."\n"
."\n"
.'- movie:'."\n"
."\n"
.' - name:IP名称'."\n"
."\n"
.' - alias:IP别名'."\n"
.' - chnl:类别'."\n"
.' - genre:类型'."\n"
.' - country:制片国家、地区'."\n"
.' - language:语言'."\n"
.' - releaseYear:发布年份'."\n"
."\n"
.'- music:'."\n"
."\n"
.' - songName:歌曲名称'."\n"
.' - artistName:歌手姓名'."\n"
.' - artistArea:歌手所属地区,华语/日本/韩国/欧美/其他'."\n"
.' - albumName:专辑名称'."\n"
."\n"
.'- person:'."\n"
."\n"
.' - name:姓名'."\n"
.' - gender:性别'."\n"
.' - citizenship:国籍'."\n"
.' - occupation:职业'."\n"
.' - classification:类型'."\n"
.' - nationality:民族'."\n"
.' - birthPlace:出生地'."\n"
.' - birthDate:出生日期'."\n"
."\n"
.'- landmark'."\n"
.' - name:名称'."\n"
.' - nameEn:英文名'."\n"
.' - description:描述'."\n"
.' - address:地址'."\n"
."\n"
.'- item'."\n"
."\n"
.' - brandName:品牌'."\n"
.' - finegrainName:细粒度描述',
'type' => 'string',
'required' => false,
'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }',
],
],
[
'name' => 'KeywordConfig',
'in' => 'query',
'schema' => [
'description' => '关键词标签配置。type代表词性类别选择,可多选,用半角逗号(,)分隔,当前有以下类别:'."\n"
."\n"
.'- name:人名'."\n"
."\n"
.'- location:地名'."\n"
."\n"
.'- organization:机构名'."\n"
."\n"
.'- other:其他'."\n"
."\n"
.'> 当不传KeywordConfig时或者Keyword字段非法(不为JSON String)或者KeywordsConfig不包含type字段或者type字段非法时默认返回type全部类型关键词。',
'type' => 'string',
'required' => false,
'example' => '{ "type": "name,location,organization,other" }',
],
],
[
'name' => 'TemplateConfig',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8796E26\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5210DBB0-E327-4D45-ADBC-0B83C8796E26\\n","errorExample":""}]',
'title' => '更新模板',
'description' => '本接口更新的模板用于指定智能标签作业中的分析算法,可根据您的实际业务需求组合不同参数。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'DeleteSmarttagTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '需要删除的模板ID,可以从[添加模板](~~187759~~)的返回参数中获取。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '05de22f255284c7a8d2aab535dde****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5F37036F-5267-43F1-AE47-10A18E840739',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F37036F-5267-43F1-AE47-10A18E840739\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5F37036F-5267-43F1-AE47-10A18E840739\\n","errorExample":""}]',
'title' => '删除模板',
'summary' => '删除一个智能标签作业的分析模板。',
'description' => '本接口一次只能删除一个模板。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'RegisterCustomFace' => [
'summary' => '注册⼀张⾃定义⼈脸。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmtsS08B52',
],
],
'parameters' => [
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => [
'description' => '⼈物库ID,⽤于唯⼀标识⼀个⾃定义⼈物库。由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性(请妥善保存此ID便于后续调用其他接口时使用)。'."\n"
.'>不能与系统⼈物库ID相同,如果相同则默认使用系统人物库。最⻓⽀持120字符,不限中英文,不区分⼤⼩写。>',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CategoryId001-****',
],
],
[
'name' => 'PersonId',
'in' => 'query',
'schema' => [
'description' => '⼈物ID,⽤于唯⼀标识⼀个⾃定义⼈物。由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性(请妥善保存此ID便于后续调用其他接口时使用) 。'."\n"
.'> 最⻓⽀持120字符,不限中英文,不区分⼤⼩写,返回FaceId为String类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'PersonId001-****',
],
],
[
'name' => 'ImageUrl',
'in' => 'query',
'schema' => [
'description' => '需要注册的⼈脸图⽚公网地址,图⽚中有且仅包含⼀张正脸。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'http://example-****.jpeg',
],
],
[
'name' => 'PersonName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'FaceId' => [
'description' => '⼈脸ID。',
'type' => 'string',
'example' => 'c6cc71cb44a9491093818faf9d60****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '91AEA76D-25B5-50DF-9126-AA6BB10FDAF4',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"FaceId\\": \\"c6cc71cb44a9491093818faf9d60****\\",\\n \\"RequestId\\": \\"91AEA76D-25B5-50DF-9126-AA6BB10FDAF4\\"\\n}","errorExample":""},{"type":"xml","example":"\\n c6cc71cb44a9491093818faf9d60****\\n 91AEA76D-25B5-50DF-9126-AA6BB10FDAF4\\n","errorExample":""}]',
'title' => '注册⾃定义⼈脸',
'description' => '- 本接口一次仅能注册一张自定义人脸。'."\n"
.'- 一个自定义人脸最多注册10张图像。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'UnregisterCustomFace' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => [
'description' => '⼈物库ID。⽤于唯⼀标识⼀个⾃定义⼈物库,由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。'."\n"
.'>不能与系统⼈物库ID相同 ,如相同则默认使用系统人物库。最⻓⽀持120字符,不限中英文,不区分⼤⼩写。可以通过[列出人物库所有人物和人脸信息](~~187787~~)接口查询。>',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CategoryId001-****',
],
],
[
'name' => 'PersonId',
'in' => 'query',
'schema' => [
'description' => '⼈物ID。用于唯一标识一个自定义人物。由调用者自己保证唯一性。'."\n"
."\n"
.'最⻓⽀持120字符,不限中英文,不区分⼤⼩写。可以通过[列出人物库所有人物和人脸信息](~~187787~~)接口查询。如果填“ALL”,表示注销该CategoryId下所有⼈脸,同时删除该人物库。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'PersonId001-****',
],
],
[
'name' => 'FaceId',
'in' => 'query',
'schema' => [
'description' => '人脸ID。用于唯一标识一张人脸,由调用者自己保证唯一性。'."\n"
."\n"
.'最⻓⽀持120字符,不限中英文,不区分⼤⼩写。可以通过[列出人物库所有人物和人脸信息](~~187787~~)接口查询。如果填“ALL”,表示注销该PersonId下所有⼈脸。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '15****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID'."\n",
'type' => 'string',
'example' => '1A3347BF-7BCE-40A6-B33E-43C2B8A9A278',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'errorMsg:%s',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A3347BF-7BCE-40A6-B33E-43C2B8A9A278\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1A3347BF-7BCE-40A6-B33E-43C2B8A9A278\\n","errorExample":""}]',
'title' => '注销⾃定义⼈脸',
'summary' => '注销⼀张⾃定义⼈脸,或者注销某个⾃定义⼈物下的所有⼈脸。',
'description' => '本接口可以注销一张自定义人脸,或者注销某个自定义人物库下的所有人脸或人物库。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'TagCustomPerson' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => [
'description' => '⼈物库ID。⽤于唯⼀标识⼀个⾃定义⼈物库,由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。'."\n"
."\n"
.'注意不能与系统⼈物库ID相同 ,如相同则默认使用系统人物库。最⻓⽀持120字符,不限中英文,不区分⼤⼩写。可以通过[列出人物库所有人物和人脸信息](~~187787~~)接口查询。',
'type' => 'string',
'required' => false,
'example' => 'CategoryId001-****',
],
],
[
'name' => 'CategoryName',
'in' => 'query',
'schema' => [
'description' => '⼈物库名称。最⻓⽀持512字符,不限中英文。'."\n",
'type' => 'string',
'required' => false,
'example' => 'CategoryNametest-****',
],
],
[
'name' => 'CategoryDescription',
'in' => 'query',
'schema' => [
'description' => '⼈物库描述。最⻓⽀持512字符,不限中英文。',
'type' => 'string',
'required' => false,
'example' => 'CategoryDescription001-****',
],
],
[
'name' => 'PersonId',
'in' => 'query',
'schema' => [
'description' => '⼈物ID。⽤于唯⼀标识⼀个⾃定义⼈物。由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。'."\n"
."\n"
.'最⻓⽀持120字符,不限中英文,不区分⼤⼩写。可以通过[列出人物库所有人物和人脸信息](~~187787~~)接口查询。返回FaceId为String类型。',
'type' => 'string',
'required' => false,
'example' => 'PersonId001-****',
],
],
[
'name' => 'PersonName',
'in' => 'query',
'schema' => [
'description' => '⼈物名称。最⻓⽀持512字符,不限中英文。',
'type' => 'string',
'required' => false,
'example' => 'PersonNametest-****',
],
],
[
'name' => 'PersonDescription',
'in' => 'query',
'schema' => [
'description' => '⼈物描述。最⻓⽀持512字符,不限中英文。',
'type' => 'string',
'required' => false,
'example' => 'PersonDescriptiontest-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD8B5B8C-0C3D-5776-B3B1-EE6AD11F905A',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD8B5B8C-0C3D-5776-B3B1-EE6AD11F905A\\"\\n}","type":"json"}]',
'title' => '添加⾃定义⼈物库或⼈物标签',
'summary' => '给⾃定义⼈物库或⼈物贴标签。',
'description' => '给⾃定义⼈物库或⼈物贴标签,有两种⽤法:'."\n"
."\n"
.'- 指定CategoryId,设置CategoryName和CategoryDesc 。'."\n"
.'- 指定PersonId,设置PersonName和PersonDesc 。'."\n"
."\n"
.'两种可以同时设置,也可⼀次设置⼀种。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'ListCustomPersons' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => [
'description' => '⼈物库ID,⽤于唯⼀标识⼀个⾃定义⼈物库,由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。若不填写,将列出所有⾃定义⼈物库。最⻓⽀持120字符,不区分⼤⼩写'."\n"
."\n"
.'> 不能与系统⼈物库ID相同。'."\n",
'type' => 'string',
'required' => false,
'example' => 'CategoryId-****',
],
],
[
'name' => 'PersonId',
'in' => 'query',
'schema' => [
'description' => '⼈物ID。⽤于唯⼀标识⼀个⾃定义⼈物,由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。若不填写,将列出CategoryId下所有⼈物。'."\n",
'type' => 'string',
'required' => false,
'example' => 'PersonId-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57',
],
'Categories' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Category' => [
'description' => '⼈物库数组。',
'type' => 'array',
'items' => [
'description' => '人物库数组详细信息。',
'type' => 'object',
'properties' => [
'Persons' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Person' => [
'description' => '⼈物数组。',
'type' => 'array',
'items' => [
'description' => '人物数组详细信息。',
'type' => 'object',
'properties' => [
'PersonName' => [
'description' => '⼈物名称。',
'type' => 'string',
'example' => 'PersonName-****',
],
'PersonDescription' => [
'description' => '⼈物描述。',
'type' => 'string',
'example' => 'PersonDescription-****',
],
'Faces' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Face' => [
'description' => '⼈脸数组。',
'type' => 'array',
'items' => [
'description' => '人脸数组详细信息。',
'type' => 'object',
'properties' => [
'ImageUrl' => [
'description' => '注册时的⼈脸图⽚URL。',
'type' => 'string',
'example' => 'http://example-****.jpeg',
],
'FaceId' => [
'description' => '⼈脸ID。',
'type' => 'string',
'example' => '15****',
],
],
],
],
],
],
'PersonId' => [
'description' => '⼈物ID。',
'type' => 'string',
'example' => 'PersonId-****',
],
],
],
],
],
],
'CategoryId' => [
'description' => '⼈物库ID。',
'type' => 'string',
'example' => 'CategoryId-****',
],
'CategoryName' => [
'description' => '⼈物库名称。',
'type' => 'string',
'example' => 'CategoryName-****',
],
'CategoryDescription' => [
'description' => '⼈物库描述。',
'type' => 'string',
'example' => 'CategoryDescription-****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57\\",\\n \\"Categories\\": {\\n \\"Category\\": [\\n {\\n \\"Persons\\": {\\n \\"Person\\": [\\n {\\n \\"PersonName\\": \\"PersonName-****\\",\\n \\"PersonDescription\\": \\"PersonDescription-****\\",\\n \\"Faces\\": {\\n \\"Face\\": [\\n {\\n \\"ImageUrl\\": \\"http://example-****.jpeg\\",\\n \\"FaceId\\": \\"15****\\"\\n }\\n ]\\n },\\n \\"PersonId\\": \\"PersonId-****\\"\\n }\\n ]\\n },\\n \\"CategoryId\\": \\"CategoryId-****\\",\\n \\"CategoryName\\": \\"CategoryName-****\\",\\n \\"CategoryDescription\\": \\"CategoryDescription-****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57\\n \\n \\n PersonName-****\\n PersonDescription-****\\n \\n http://example-****.jpeg\\n 15****\\n \\n PersonId-****\\n \\n CategoryId-****\\n CategoryName-****\\n CategoryDescription-****\\n \\n","errorExample":""}]',
'title' => '列出⼈物库所有⼈物和⼈脸信息',
'summary' => '列出指定⼈物库下的所有⼈物和⼈脸信息。',
'description' => '本接口通过人物ID和人物库ID进行查询,如果不传入,则默认列出当前RAM用户所有人物库和人脸信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '### SDK示例'."\n"
."\n"
.'- [Java SDK](~~188025~~)'."\n"
.'- [Python SDK](~~188026~~)'."\n"
.'- [Php SDK](~~188027~~)',
],
'CreateCustomGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupName',
'in' => 'query',
'schema' => [
'description' => '自定义库名称,最长支持64字节。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark测试库',
],
],
[
'name' => 'CustomGroupDescription',
'in' => 'query',
'schema' => [
'description' => '自定义库描述,最长支持128字节。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '用于landmark测试',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'CustomGroupId' => [
'description' => '自定义库ID。建议您保存此ID便于后续调用其他接口时使用。',
'type' => 'string',
'example' => '129****',
],
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'errorMsg:%s',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomGroupId\\": \\"129****\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 129****\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n","errorExample":""}]',
'title' => '创建自定义库',
'summary' => '创建自定义库。',
'description' => '- 本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
.'- 自注册object/landmark使用方法(以object为例):分别创建自定义object库、自定义obiect实体,创建完成后注册自定义object实体图片,注册完成后创建包含自注册object库的模板A,再使用模板A提交分析任务,最终查询结果。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'CreateCustomEntity' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupId',
'in' => 'query',
'schema' => [
'description' => '自定义库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CustomEntityName',
'in' => 'query',
'schema' => [
'description' => '自定义库实体名称,最长支持64字节。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '自定义库实体名称',
],
],
[
'name' => 'CustomEntityInfo',
'in' => 'query',
'schema' => [
'description' => '自定义实体的额外信息,JSON String类型,最长支持256字节。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '{ "finegrainName":"examplName" }',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'CustomEntityId' => [
'description' => '自定义库实体ID。',
'type' => 'string',
'example' => '1',
],
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'errorMsg:%s',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomEntityId\\": \\"1\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n","errorExample":""}]',
'title' => '创建自定义实体',
'summary' => '创建相应自定义库中自定义实体。',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'RegisterCustomView' => [
'summary' => '注册自定义实体照片。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmtsS08B52',
],
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupId',
'in' => 'query',
'schema' => [
'description' => '自定义库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CustomEntityId',
'in' => 'query',
'schema' => [
'description' => '自定义库实体ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'ImageUrl',
'in' => 'query',
'schema' => [
'description' => '图片URL。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'http://127.66.**.**/image.jpeg',
],
],
[
'name' => 'LabelPrompt',
'in' => 'query',
'schema' => [
'description' => '自定义标签文本提示词',
'type' => 'string',
'required' => false,
'example' => '小姐姐对着手机直播',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'CustomViewId' => [
'description' => '自定义库实体下的view图片ID。',
'type' => 'string',
'example' => '1',
],
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'errorMsg:%s',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomViewId\\": \\"1\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n","errorExample":""}]',
'title' => '注册自定义实体照片',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'DeleteCustomEntity' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupId',
'in' => 'query',
'schema' => [
'description' => '自定义库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CustomEntityId',
'in' => 'query',
'schema' => [
'description' => '自定义库实体entityID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'errorMsg:%s',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n","errorExample":""}]',
'title' => '删除自定义库实体',
'summary' => '删除自定义库实体。',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'DeleteCustomGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupId',
'in' => 'query',
'schema' => [
'description' => '自定义库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'errorMsg:%s',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n","errorExample":""}]',
'title' => '删除自定义库',
'summary' => '删除自定义库。',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'DeleteCustomView' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupId',
'in' => 'query',
'schema' => [
'description' => '自定义库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CustomEntityId',
'in' => 'query',
'schema' => [
'description' => '自定义库实体entityID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CustomViewId',
'in' => 'query',
'schema' => [
'description' => '自定义库实体下view图片ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'errorMsg:%s',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n","errorExample":""}]',
'title' => '删除自定义实体照片',
'summary' => '删除自定义实体照片。',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'ListCustomViews' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupId',
'in' => 'query',
'schema' => [
'description' => '自定义库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CustomEntityId',
'in' => 'query',
'schema' => [
'description' => '自定义库实体entityID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页数量。单页最大数量不超过50。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CustomViews' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomView' => [
'description' => '自定义库图片。',
'type' => 'array',
'items' => [
'description' => '图片详细信息。',
'type' => 'object',
'properties' => [
'CustomViewId' => [
'description' => '自定义库view图片ID。',
'type' => 'string',
'example' => '1',
],
'ImageUrl' => [
'description' => '图片URL。',
'type' => 'string',
'example' => 'http://127.66.**.**/photo.jpeg',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"CustomViews\\": {\\n \\"CustomView\\": [\\n {\\n \\"CustomViewId\\": \\"1\\",\\n \\"ImageUrl\\": \\"http://127.66.**.**/photo.jpeg\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n 1\\n 10\\n 1\\n \\n 1\\n http://127.66.**.**/photo.jpeg\\n \\n","errorExample":""}]',
'title' => '获取自定义库实体不同view图片列表',
'summary' => '获取自定义库实体不同view图片列表。',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'ListCustomEntities' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'CustomGroupId',
'in' => 'query',
'schema' => [
'description' => '自定义库ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页数量。单页最大数量不超过50。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CustomEntities' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomEntity' => [
'description' => '自定义库实体列表。',
'type' => 'array',
'items' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'CustomEntityId' => [
'description' => '自定义库实体entityID。',
'type' => 'string',
'example' => '1',
],
'CustomEntityName' => [
'description' => '自定义库实体entity名称。',
'type' => 'string',
'example' => 'exampleName',
],
'CustomEntityInfo' => [
'description' => '自定义实体的额外信息,JSON String类型。',
'type' => 'string',
'example' => '{ "finegrainName":"example" }',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"CustomEntities\\": {\\n \\"CustomEntity\\": [\\n {\\n \\"CustomEntityId\\": \\"1\\",\\n \\"CustomEntityName\\": \\"exampleName\\",\\n \\"CustomEntityInfo\\": \\"{ \\\\\\"finegrainName\\\\\\":\\\\\\"example\\\\\\" }\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n 1\\n 10\\n 1\\n \\n 1\\n exampleName\\n { \\"finegrainName\\":\\"example\\" }\\n \\n","errorExample":""}]',
'title' => '获取自定义库下实体列表',
'summary' => '获取自定义库下实体列表。',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'ListCustomGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '自定义类型,取值:'."\n"
."\n"
.'- landmark:自定义地标。'."\n"
."\n"
.'- object:自定义物体。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'landmark',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页数量。单页数量最大不超过50。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID,具有唯一性。',
'type' => 'string',
'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5',
],
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CustomGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomGroup' => [
'description' => '自定义库。',
'type' => 'array',
'items' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'CustomGroupId' => [
'description' => '自定义库ID。',
'type' => 'string',
'example' => '1',
],
'CustomGroupName' => [
'description' => '自定义库名称。',
'type' => 'string',
'example' => '自定义库名称',
],
'CustomGroupDescription' => [
'description' => '自定义库描述。',
'type' => 'string',
'example' => '这是一个自定义库',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'errorMsg:%s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"CustomGroups\\": {\\n \\"CustomGroup\\": [\\n {\\n \\"CustomGroupId\\": \\"1\\",\\n \\"CustomGroupName\\": \\"自定义库名称\\",\\n \\"CustomGroupDescription\\": \\"这是一个自定义库\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\n 1\\n 10\\n 1\\n \\n 1\\n 自定义库名称\\n 这是一个自定义库\\n \\n","errorExample":""}]',
'title' => '获取自定义库列表',
'summary' => '获取自定义库列表。',
'description' => '本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'SubmitMediaCensorJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '23177',
'abilityTreeNodes' => [
'FEATUREmtsFCTHFB',
'FEATUREmtsGG7DI2',
'FEATUREmtsJSWAH9',
'FEATUREmtsIZYFIQ',
'FEATUREmtsZMZNBE',
'FEATUREmtsNP97O9',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '待审核的媒体文件OSS地址,支持视频文件、音频文件。可以通过**MPS控制台** > **媒体管理** > **媒体列表**获取。如需要审核图片文件请使用`CoverImage`参数传入。JSON对象,更多信息请参考参数详情中[Input详情](~~29253~~)参数。'."\n"
."\n"
.'- Bucket:输入文件OSS Bucket名称。'."\n"
.'- Location:OSS区域,必须和MPS服务所在区域一致。'."\n"
.'- Object:待检测OSS Object。'."\n"
."\n"
.' > Object不能以斜杠(/)开头,否则会导致接口调用失败。',
'type' => 'string',
'required' => false,
'example' => '{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}',
],
],
[
'name' => 'CoverImages',
'in' => 'query',
'schema' => [
'description' => '封面图片的OSS文件,可以通过**MPS控制台** > **媒体管理** > **媒体列表**获取。最多支持5个封面图片,JSON数组。'."\n"
."\n"
.'- Bucket:输入文件OSS Bucket名称。'."\n"
.'- Location:OSS区域,必须和MPS服务所在区域一致。'."\n"
.'- Object:待检测OSS Object。'."\n"
."\n"
.' > Object不能以斜杠(/)开头,否则会导致接口调用失败。',
'type' => 'string',
'required' => false,
'example' => '[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg"}]',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '视频标题,最大长度64个字节。',
'type' => 'string',
'required' => false,
'example' => 'Hello World',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '视频介绍,最大长度128个字节。',
'type' => 'string',
'required' => false,
'example' => 'example description',
],
],
[
'name' => 'Barrages',
'in' => 'query',
'schema' => [
'description' => '字符串。',
'type' => 'string',
'required' => false,
'example' => 'hello world',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,用于绑定消息通知。可以通过**MPS控制台** > **全局设置** > **管道**获取。不填表示使用默认的管道执行任务。默认管道并发为10,需要提升并发数请提交[工单](https://selfservice.console.aliyun.com/ticket/category/mts/recommend/1186)[工单](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.ditem-sub.35da7bbcitpQnr#/ticket/createIndex)。'."\n"
.'> 管道目前仅支持后台创建,相关查询、更新接口请参见[更新管道](~~188374~~)。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'b22c173cced04565b1f38f1ecc39****',
],
],
[
'name' => 'VideoCensorConfig',
'in' => 'query',
'schema' => [
'description' => '视频审核配置和输出截图的OSS地址。可以通过**MPS控制台** > **媒体管理** > **媒体列表**获取。'."\n"
."\n"
.'JSON对象。'."\n"
."\n"
.'- OutputFile:'."\n"
.' - Bucket:输出文件OSS Bucket名字。'."\n"
.' - Location:OSS区域,必须和MPS服务所在区域一致。'."\n"
.' - Object: 待检测OSS Object,其中{Count}为截帧图片序号替换符。'."\n"
."\n"
.' 其中,审核结果详细信息保存在OutputFile相同的文件夹下,命名为{jobId}.output,output文件具体字段格式,请参见[媒体审核结果文件字段](~~609186~~)。'."\n"
.'- StoreVideoTimeline: 审核是否要输出`{jobId}.video_timeline`文件,存储在OSS中。true:表示要输出,false表示不输出,不填默认不输出。文件格式,请参见,[查询媒体作业(videoTimeline示例)](~~91779~~)。'."\n"
.'- SaveType:输出模式。abnormal表示只输出有问题的截帧,all表示输出所有截帧。'."\n"
.'- Biztype:表示审核模版。common为默认模版,不填默认为common,如果需要自定义审核模版需要提工单,然后将用户的uid填入此项。'."\n"
.'- Scene:检测场景。Scenes可以选择检测场景,不填默认检测暴恐和涉黄。可选场景:'."\n"
."\n"
.' - porn:涉黄'."\n"
.' - terrorism:暴恐'."\n"
.' - ad:图文违规'."\n"
.' - live:不良场景'."\n"
.' - logo:图标'."\n"
."\n"
.' - audio:语音反垃圾'."\n"
."\n"
.' >对于有音频轨道的输入文件,audio场景会进行音频审核,没有音轨的输入文件不要填写audio。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"Scenes" : ["porn"], "OutputFile":{"Bucket": "example-001","Location": "oss-cn-hangzhou","Object": "test/example-{Count}.jpg"},"SaveType" : "abnormal","BizType":"common"}',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,最大长度128个字节。',
'type' => 'string',
'required' => false,
'example' => 'UserDatatestid-001-****',
],
],
[
'name' => 'ExternalUrl',
'in' => 'query',
'schema' => [
'description' => '视频的URL链接。',
'type' => 'string',
'required' => false,
'example' => 'http://www.example.com/video-****/test-****.mp4',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'JobId' => [
'description' => '视频审核作业ID。建议您保存此ID便于后续调用其他接口时使用。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n 88c6ca184c0e47098a5b665e2****\\n","errorExample":""}]',
'title' => '提交媒体审核作业',
'summary' => '提交媒体审核作业。',
'description' => '- 本接口提交的作业是异步执行方式,作业添加到管道中调度排队和执行。可以调用[查询媒体审核作业](~~91779~~)接口查询作业执行结果,也可以使用异步的消息通知机制。'."\n"
."\n"
.'- 媒体审核功能,目前开通的地域为华北2(北京)、华东2(上海)、亚太东南1(新加坡),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' **异步通知消息参数**'."\n"
."\n"
.'| 参数 | 类型 | 描述 |'."\n"
.'|:---------|:-------|:---------|'."\n"
.'| Type | String | 消息类型:MediaCensor |'."\n"
.'| MediaCensorJobNotify | AliyunMediaCensorJobNotify | 媒体审核作业通知 |'."\n"
.'| UserData | String | 用户自定义数据 |',
'extraInfo' => ' ',
],
'QueryMediaCensorJobDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '媒体审核作业ID。可以从[提交媒体审核作业](~~91774~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'example' => '2288c6ca184c0e47098a5b665e2a12****',
],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '下一页标识,第一次提交时为空即可。下一页标识将在第一次查询后返回。',
'type' => 'string',
'required' => false,
'example' => 'ae0fd49c0840e14daf0d66a75b83****',
],
],
[
'name' => 'MaximumPageSize',
'in' => 'query',
'schema' => [
'description' => '每页最大返回数。'."\n"
."\n"
.'- 默认:**30**'."\n"
.'- 取值:**1~300**',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '30',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA',
],
'MediaCensorJobDetail' => [
'description' => '媒体审核作业结果列表。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2018-09-13T16:32:24Z',
],
'FinishTime' => [
'description' => '完成时间。',
'type' => 'string',
'example' => '2018-09-21',
],
'Suggestion' => [
'description' => '作业整体审核结果。取值:'."\n"
."\n"
.'- **pass**:通过'."\n"
.'- **review**:人工重审'."\n"
.'- **block**:拦截'."\n"
."\n"
.'任何一种类型的审核结果是review时,整体结果为review,任何一种类型的审核结果是block时,整体结果为block 。',
'type' => 'string',
'example' => 'block',
],
'CoverImageCensorResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CoverImageCensorResult' => [
'description' => '封面审核结果。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '视频封面OSS Object。',
'type' => 'string',
'example' => 'test/ai/censor/v2/vme-****.jpg',
],
'Location' => [
'description' => '视频封面OSS Location。',
'type' => 'string',
'example' => 'oss-cn-shanghai',
],
'Bucket' => [
'description' => '视频封面OSS Bucket。',
'type' => 'string',
'example' => 'bucket-out-test-****',
],
'Results' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Result' => [
'description' => '审核结果。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。取值:'."\n"
."\n"
.'- **pass**:通过'."\n"
.'- **review**:人工重审'."\n"
.'- **block**:拦截',
'type' => 'string',
'example' => 'pass',
],
'Label' => [
'description' => '审核结果的标签,多个使用半角逗号(,)分隔。'."\n"
."\n"
.'- 图片智能鉴黄(porn)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **sexy**:性感。'."\n"
.' - **porn**:色情。'."\n"
."\n"
.'- 图片暴恐涉政(terrorism)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **bloody**:血腥。'."\n"
.' - **explosion**:爆炸烟光。'."\n"
.' - **outfit**:特殊装束。'."\n"
.' - **logo**:特殊标识。'."\n"
.' - **weapon**:武器。'."\n"
.' - **politics**:涉政。'."\n"
.' - **violence**:打斗。'."\n"
.' - **crowd**:聚众。'."\n"
.' - **parade**:游行。'."\n"
.' - **carcrash**:车祸现场。'."\n"
.' - **flag**:旗帜。'."\n"
.' - **location**:地标。'."\n"
.' - **others**:其他。'."\n"
."\n"
.'- 图文违规(ad)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **ad**:其他广告。'."\n"
.' - **politics**:文字含涉政内容。'."\n"
.' - **porn**:文字含涉黄内容。'."\n"
.' - **abuse**:文字含辱骂内容。'."\n"
.' - **terrorism**:文字含暴恐内容。'."\n"
.' - **contraband**:文字含违禁内容。'."\n"
.' - **spam**:文字含其他垃圾内容。'."\n"
.' - **npx**:牛皮藓广告。'."\n"
.' - **qrcode**:含二维码。'."\n"
.' - **programCode**:含小程序码。'."\n"
."\n"
.'- 图片不良场景(live)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **meaningless**:图片中无内容(例如黑屏、白屏)。'."\n"
.' - **PIP**:画中画。'."\n"
.' - **smoking**:吸烟。'."\n"
.' - **drivelive**:车内直播。'."\n"
."\n"
.'- 图片Logo(Logo)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **TV**:含受管控的Logo。'."\n"
.' - **trademark**:含商标。',
'type' => 'string',
'example' => 'normal',
],
'Scene' => [
'description' => '审核场景。'."\n"
."\n"
.'- **porn**:鉴黄。'."\n"
.'- **terrorism**:暴恐涉政。'."\n"
.'- **ad**:图文违规。'."\n"
.'- **live**:不良场景。'."\n"
.'- **logo**:图片Logo。',
'type' => 'string',
'example' => 'porn',
],
'Rate' => [
'description' => '分值。取值:**0~100**',
'type' => 'string',
'example' => '100',
],
],
],
],
],
],
],
],
],
],
],
'State' => [
'description' => '作业状态。',
'type' => 'string',
'example' => 'Success',
],
'TitleCensorResult' => [
'description' => '标题审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。取值:'."\n"
."\n"
.'- **pass**:通过,'."\n"
.'- **review**:人工重审,'."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'block',
],
'Label' => [
'description' => '审核结果的标签。'."\n"
."\n"
.'- **normal**:普通'."\n"
.'- **spam**:含垃圾信息'."\n"
.'- **ad**:广告'."\n"
.'- **politics**:涉政'."\n"
.'- **terrorism**:暴恐'."\n"
.'- **abuse**:辱骂'."\n"
.'- **porn**:色情'."\n"
.'- **flood**:灌水'."\n"
.'- **contraband**:违禁'."\n"
.'- **meaningless**:无意义'."\n"
.'- **harmful**:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'meaningless',
],
'Scene' => [
'description' => '审核场景。取固定值:**antispam**,文本反垃圾。',
'type' => 'string',
'example' => 'antispam',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '99.91',
],
],
],
'Message' => [
'description' => '作业失败时错误信息。执行成功时不返回此参数。',
'type' => 'string',
'example' => 'The resource operated cannot be found',
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'test/ai/censor/test-****.mp4',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-shanghai',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'bucket-test-in-****',
],
],
],
'BarrageCensorResult' => [
'description' => '弹幕审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。可取值:'."\n"
."\n"
.'- **pass**:通过'."\n"
.'- **review**:人工重审'."\n"
.'- **block**:拦截',
'type' => 'string',
'example' => 'pass',
],
'Label' => [
'description' => '审核结果分类,多个使用半角逗号(,)分隔。取值:'."\n"
.'- **normal**:普通'."\n"
.'- **spam**:含垃圾信息'."\n"
.'- **ad**:广告'."\n"
.'- **politics**:涉政'."\n"
.'- **terrorism**:暴恐'."\n"
.'- **abuse**:辱骂'."\n"
.'- **porn**:色情'."\n"
.'- **flood**:灌水'."\n"
.'- **contraband**:违禁'."\n"
.'- **meaningless**:无意义'."\n"
.'- **harmful**:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'normal',
],
'Scene' => [
'description' => '审核场景。固定取值:**antispam**,文本反垃圾。',
'type' => 'string',
'example' => 'antispam',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '99.91',
],
],
],
'DescCensorResult' => [
'description' => '描述审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。可取值:'."\n"
."\n"
.'- **pass**:通过'."\n"
.'- **review**:人工重审'."\n"
.'- **block**:拦截',
'type' => 'string',
'example' => 'review',
],
'Label' => [
'description' => '审核结果分类。取值:'."\n"
.'- **normal**:普通'."\n"
.'- **spam**:含垃圾信息'."\n"
.'- **ad**:广告'."\n"
.'- **politics**:涉政'."\n"
.'- **terrorism**:暴恐'."\n"
.'- **abuse**:辱骂'."\n"
.'- **porn**:色情'."\n"
.'- **flood**:灌水'."\n"
.'- **contraband**:违禁'."\n"
.'- **meaningless**:无意义'."\n"
.'- **harmful**:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'normal',
],
'Scene' => [
'description' => '审核场景。固定取值:**antispam**,文本反垃圾。',
'type' => 'string',
'example' => 'antispam',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '100',
],
],
],
'VideoCensorConfig' => [
'description' => '视频审查配置。',
'type' => 'object',
'properties' => [
'OutputFile' => [
'description' => '视频截图结果的保存地址。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '截图输出文件 (OSS Object)。'."\n"
."\n"
.'> 示例中{Count}是占位符,图片Object依次为`output00001-****.jpg`,`output00002-****.jpg`等。',
'type' => 'string',
'example' => 'output{Count}.jpg',
],
'Location' => [
'description' => '截图输出OSS Bucket所在数据中心(OSS Location)。',
'type' => 'string',
'example' => 'oss-cn-shanghai',
],
'Bucket' => [
'description' => '截图输出文件所在OSS Bucket。',
'type' => 'string',
'example' => 'test-bucket-****',
],
],
],
'VideoCensor' => [
'description' => '是否需要审核视频内容。默认值:**true**。可取值:'."\n"
."\n"
.'- **true**:审核。'."\n"
."\n"
.'- **false**:不审核。',
'type' => 'string',
'example' => 'true',
],
'BizType' => [
'description' => '定制业务类型。默认common。',
'type' => 'string',
'example' => 'common',
],
],
],
'JobId' => [
'description' => '媒体审核作业ID。',
'type' => 'string',
'example' => 'f8f166eea7a44e9bb0a4aecf9543****',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'example userdata ****',
],
'Code' => [
'description' => '作业失败时错误码。执行成功时此参数不返回。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
'VensorCensorResult' => [
'description' => '视频审核结果。',
'type' => 'object',
'properties' => [
'VideoTimelines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoTimeline' => [
'description' => '详细时间点的审核结果,按照时间从小到大排序。由于详细时间点内容较多,查询仅保留10天,超过则自行查看保存在OutputFile相同的文件夹下,命名为{jobId}.output文件。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '视频中的位置。'."\n"
.'格式:`hh:mm:ss[.SSS]`。',
'type' => 'string',
'example' => '00:02:59.999',
],
'Object' => [
'description' => '截图输出文件 (OSS Object)。'."\n"
."\n"
.'> 示例中{Count}是占位符,图片Object依次为`output00001-****.jpg`,`output00002-****.jpg`等。',
'type' => 'string',
'example' => 'output{Count}.jpg',
],
'CensorResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CensorResult' => [
'description' => '包含多种类型审核结果的标签、分值等。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。取值:'."\n"
."\n"
.'- **pass**:通过,'."\n"
.'- **review**:人工重审,'."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'block',
],
'Label' => [
'description' => '审核结果分类,多个使用半角逗号(,)分隔。取值:'."\n"
."\n"
.'- 图片鉴黄(porn)审核结果分类:'."\n"
.' - **porn**:色情。'."\n"
.' - **sexy**:性感。'."\n"
.' - **normal**:通过。'."\n"
.'- 暴恐涉政(terrorism)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **bloody**:血腥。'."\n"
.' - **explosion**:爆炸烟光。'."\n"
.' - **outfit**:特殊装束。'."\n"
.' - **logo**:特殊标识。'."\n"
.' - **weapon**:武器。'."\n"
.' - **politics**:涉政。'."\n"
.' - **violence**:打斗。'."\n"
.' - **crowd**:聚众。'."\n"
.' - **parade**:游行。'."\n"
.' - **carcrash**:车祸现场。'."\n"
.' - **flag**:旗帜。'."\n"
.' - **location**:地标。'."\n"
.' - **others**:其他。'."\n"
."\n"
.'- 广告(ad)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **ad**:其他广告。'."\n"
.' - **politics**:文字含涉政内容。'."\n"
.' - **porn**:文字含涉黄内容。'."\n"
.' - **abuse**:文字含辱骂内容。'."\n"
.' - **terrorism**:文字含暴恐内容。'."\n"
.' - **contraband**:文字含违禁内容。'."\n"
.' - **spam**:文字含其他垃圾内容。'."\n"
.' - **npx**:牛皮藓广告。'."\n"
.' - **qrcode**:含二维码。'."\n"
.' - **programCode**:含小程序码。'."\n"
.'- 不良场景(live)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **meaningless**:图片中无内容(例如黑屏、白屏)。'."\n"
.' - **PIP**:画中画。'."\n"
.' - **smoking**:吸烟。'."\n"
.' - **drivelive**:车内直播。'."\n"
.'- Logo(logo)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **TV**:含受管控的Logo。'."\n"
.' - **trademark**:含商标。',
'type' => 'string',
'example' => 'porn,ad',
],
'Scene' => [
'description' => '审核场景。'."\n"
."\n"
.'- **porn**:鉴黄。'."\n"
.'- **terrorism**:暴恐涉政。'."\n"
.'- **ad**:图文违规。'."\n"
.'- **live**:不良场景。'."\n"
.'- **logo**:图片Logo。',
'type' => 'string',
'example' => 'porn',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '99.99',
],
],
],
],
],
],
],
],
],
],
],
'NextPageToken' => [
'description' => '下一页标识。',
'type' => 'string',
'example' => 'ea04afcca7cd4e80b9ece8fbb251****',
],
'CensorResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CensorResult' => [
'description' => '审核结果集合,包含各种场景(黄、暴、恐、政)的概要信息。',
'type' => 'array',
'items' => [
'description' => '审核结果详情。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。取值:'."\n"
."\n"
.'- **pass**:通过,'."\n"
.'- **review**:人工重审,'."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'review',
],
'Label' => [
'description' => '审核结果分类,多个使用半角逗号(,)分隔。取值:'."\n"
."\n"
.'- 图片鉴黄(porn)审核结果分类:'."\n"
.' - **porn**:色情。'."\n"
.' - **sexy**:性感。'."\n"
.' - **normal**:通过。'."\n"
.'- 暴恐涉政(terrorism)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **bloody**:血腥。'."\n"
.' - **explosion**:爆炸烟光。'."\n"
.' - **outfit**:特殊装束。'."\n"
.' - **logo**:特殊标识。'."\n"
.' - **weapon**:武器。'."\n"
.' - **politics**:涉政。'."\n"
.' - **violence**:打斗。'."\n"
.' - **crowd**:聚众。'."\n"
.' - **parade**:游行。'."\n"
.' - **carcrash**:车祸现场。'."\n"
.' - **flag**:旗帜。'."\n"
.' - **location**:地标。'."\n"
.' - **others**:其他。'."\n"
."\n"
.'- 广告(ad)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **ad**:其他广告。'."\n"
.' - **politics**:文字含涉政内容。'."\n"
.' - **porn**:文字含涉黄内容。'."\n"
.' - **abuse**:文字含辱骂内容。'."\n"
.' - **terrorism**:文字含暴恐内容。'."\n"
.' - **contraband**:文字含违禁内容。'."\n"
.' - **spam**:文字含其他垃圾内容。'."\n"
.' - **npx**:牛皮藓广告。'."\n"
.' - **qrcode**:含二维码。'."\n"
.' - **programCode**:含小程序码。'."\n"
.'- 不良场景(live)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **meaningless**:图片中无内容(例如黑屏、白屏)。'."\n"
.' - **PIP**:画中画。'."\n"
.' - **smoking**:吸烟。'."\n"
.' - **drivelive**:车内直播。'."\n"
.'- Logo(logo)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **TV**:含受管控的Logo。'."\n"
.' - **trademark**:含商标。',
'type' => 'string',
'example' => 'meaningless',
],
'Scene' => [
'description' => '审核场景。'."\n"
."\n"
.'- **porn**:鉴黄。'."\n"
.'- **terrorism**:暴恐涉政。'."\n"
.'- **ad**:图文违规。'."\n"
.'- **live**:不良场景。'."\n"
.'- **logo**:图片Logo。',
'type' => 'string',
'example' => 'terrorism',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '100',
],
],
],
],
],
],
],
],
'AudioCensorResult' => [
'description' => '音频审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。可取值:'."\n"
."\n"
.'- **pass**:通过。'."\n"
.'- **review**:人工重审。'."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'pass',
],
'Label' => [
'description' => '检测结果的分类。取值:'."\n"
."\n"
.'- normal:正常文本'."\n"
."\n"
.'- spam:含垃圾信息'."\n"
."\n"
.'- ad:广告'."\n"
."\n"
.'- politics:涉政'."\n"
."\n"
.'- terrorism:暴恐'."\n"
.'- abuse:辱骂'."\n"
.'- porn:色情'."\n"
.'- flood:灌水'."\n"
.'- contraband:违禁'."\n"
.'- meaningless:无意义'."\n"
.'- harmful:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'normal',
],
'AudioDetailResultList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AudioDetailResult' => [
'description' => '音频审核具体结果。',
'type' => 'array',
'items' => [
'description' => '结果内容。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '句子开始的时间,单位:秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'EndTime' => [
'description' => '句子结束的时间,单位:秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'Text' => [
'description' => '语音转换成文本的结果。',
'type' => 'string',
'example' => '测试一下',
],
'Label' => [
'description' => '检测结果的分类。取值:'."\n"
."\n"
.'- normal:正常文本'."\n"
."\n"
.'- spam:含垃圾信息'."\n"
."\n"
.'- ad:广告'."\n"
."\n"
.'- politics:涉政'."\n"
."\n"
.'- terrorism:暴恐'."\n"
.'- abuse:辱骂'."\n"
.'- porn:色情'."\n"
.'- flood:灌水'."\n"
.'- contraband:违禁'."\n"
.'- meaningless:无意义'."\n"
.'- harmful:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'normal',
],
],
],
],
],
],
],
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA\\",\\n \\"MediaCensorJobDetail\\": {\\n \\"CreationTime\\": \\"2018-09-13T16:32:24Z\\",\\n \\"FinishTime\\": \\"2018-09-21\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"CoverImageCensorResults\\": {\\n \\"CoverImageCensorResult\\": [\\n {\\n \\"Object\\": \\"test/ai/censor/v2/vme-****.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-out-test-****\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"porn\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"Success\\",\\n \\"TitleCensorResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"Message\\": \\"The resource operated cannot be found\\",\\n \\"Input\\": {\\n \\"Object\\": \\"test/ai/censor/test-****.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-test-in-****\\"\\n },\\n \\"BarrageCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"DescCensorResult\\": {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"VideoCensorConfig\\": {\\n \\"OutputFile\\": {\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"test-bucket-****\\"\\n },\\n \\"VideoCensor\\": \\"true\\",\\n \\"BizType\\": \\"common\\"\\n },\\n \\"JobId\\": \\"f8f166eea7a44e9bb0a4aecf9543****\\",\\n \\"UserData\\": \\"example userdata ****\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"VensorCensorResult\\": {\\n \\"VideoTimelines\\": {\\n \\"VideoTimeline\\": [\\n {\\n \\"Timestamp\\": \\"00:02:59.999\\",\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"porn,ad\\",\\n \\"Scene\\": \\"porn\\",\\n \\"Rate\\": \\"99.99\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"NextPageToken\\": \\"ea04afcca7cd4e80b9ece8fbb251****\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"terrorism\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n },\\n \\"AudioCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"AudioDetailResultList\\": {\\n \\"AudioDetailResult\\": [\\n {\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 30,\\n \\"Text\\": \\"测试一下\\",\\n \\"Label\\": \\"normal\\"\\n }\\n ]\\n }\\n },\\n \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA\\n \\n 2018-09-13T16:32:24Z\\n 2018-09-21\\n block\\n \\n \\n oss-cn-shanghai\\n bucket-out-test-****\\n \\n pass\\n \\n porn\\n 100\\n \\n \\n Success\\n \\n block\\n \\n antispam\\n 99.91\\n \\n The resource operated cannot be found\\n \\n \\n oss-cn-shanghai\\n bucket-test-in-****\\n \\n \\n pass\\n \\n antispam\\n 99.91\\n \\n \\n review\\n \\n antispam\\n 100\\n \\n \\n \\n \\n oss-cn-shanghai\\n test-bucket-****\\n \\n true\\n common\\n \\n f8f166eea7a44e9bb0a4aecf9543****\\n example userdata ****\\n InvalidParameter.ResourceNotFound\\n \\n \\n 00:02:59.999\\n \\n \\n block\\n \\n porn\\n 99.99\\n \\n \\n ea04afcca7cd4e80b9ece8fbb251****\\n \\n review\\n \\n terrorism\\n 100\\n \\n \\n c5b30b7c0d0e4a0abde1d5f9e751****\\n \\n","errorExample":""}]',
'title' => '查询媒体审核作业详情',
'summary' => '查询媒体审核作业的详细信息。',
'description' => '媒体审核结果中视频部分是按照时间点从小到大排序组成一个时间线,如果视频时间非常长,查询时按分页返回第1页信息,如果需要详细查询视频部分的全量结果,可单独调用本接口。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMediaCensorJobList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobIds',
'in' => 'query',
'schema' => [
'description' => '媒体审核作业ID。可以从[提交媒体审核作业](~~91779~~)的返回参数中获取,多个使用半角逗号(,)分隔。',
'type' => 'string',
'required' => false,
'example' => 'fa9c34be3bcf42919ac4d1775239****,78dc866518b843259669df58ed30****',
],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '下一页标识,第一次提交时为空即可。下一页标识将在第一次查询后返回。',
'type' => 'string',
'required' => false,
'example' => '79aff3eee82242e092899db5f669****',
],
],
[
'name' => 'MaximumPageSize',
'in' => 'query',
'schema' => [
'description' => '每页最大返回数。'."\n"
."\n"
.'- 默认:**30**'."\n"
.'- 取值:**1~300**',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '需要查询的作业状态。取值:'."\n"
."\n"
.'- **All**:全部。'."\n"
."\n"
.'- **Queuing**:排队中。'."\n"
."\n"
.'- **Analysing**:分析中。'."\n"
."\n"
.'- **Fail**:失败。'."\n"
."\n"
.'- **Success**:成功。',
'type' => 'string',
'required' => false,
'example' => 'All',
'default' => 'All',
],
],
[
'name' => 'StartOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '最早任务创建时间。'."\n"
."\n"
.'- 日期格式按照ISO8601标准表示,并需要使用UTC时间。'."\n"
.'- 格式为:YYYY-MM-DDThh:mm:ssZ 。',
'type' => 'string',
'required' => false,
'example' => '2021-12-22T03:48:05Z',
],
],
[
'name' => 'EndOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '最晚任务创建时间。'."\n"
."\n"
.'- 日期格式按照ISO8601标准表示,并需要使用UTC时间。'."\n"
.'- 格式为:YYYY-MM-DDThh:mm:ssZ 。',
'type' => 'string',
'required' => false,
'example' => '2022-02-14T02:16:07Z',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID。可以通过[**媒体处理控制台**](https://mps.console.aliyun.com/overview) > **全局设置** > **管道及回调**获取。',
'type' => 'string',
'required' => false,
'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'MediaCensorJobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaCensorJob' => [
'description' => '媒体审核作业列表。',
'type' => 'array',
'items' => [
'description' => '媒体审核作业详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => '2021-11-04T07:25:48Z',
],
'FinishTime' => [
'description' => '完成时间。',
'type' => 'string',
'example' => '2021-11-04T07:25:48Z',
],
'Suggestion' => [
'description' => '处理建议。可取值:'."\n"
."\n"
.'- **pass**:通过。'."\n"
.'- **review**:人工重审。'."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'pass',
],
'CoverImageCensorResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CoverImageCensorResult' => [
'description' => '封面图片审查结果列表。',
'type' => 'array',
'items' => [
'description' => '封面图片审查结果详细信息。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '封面图片的OSS Object。',
'type' => 'string',
'example' => 'test/ai/censor/v2/vme-****.jpg',
],
'Location' => [
'description' => '封面图片的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-shanghai',
],
'Bucket' => [
'description' => '封面图片的OSS Bucket。',
'type' => 'string',
'example' => 'example-Bucket-****',
],
'Results' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Result' => [
'description' => '作业审核结果。',
'type' => 'array',
'items' => [
'description' => '作业审核结果详细信息。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '作业整体审核结果。取值:'."\n"
."\n"
.'- **pass**:通过。'."\n"
.'- **review**:人工重审。'."\n"
.'- **block**:拦截。'."\n"
."\n"
.'> 任何一种类型的审核结果是Review时,整体结果为Review,任何一种类型的审核结果是Block时,整体结果为Block。',
'type' => 'string',
'example' => 'pass',
],
'Label' => [
'description' => '审核结果的标签,多个使用半角逗号(,)分隔。'."\n"
."\n"
.'- 图片智能鉴黄(porn)审核结果分类:'."\n"
.' - **nomal**:正常。'."\n"
.' - **sexy**:性感。'."\n"
.' - **porn**:色情。'."\n"
."\n"
.'- 图片暴恐涉政(terrorism)结果分类:'."\n"
.' - **naomal**:正常。'."\n"
.' - **bloody**:血腥。'."\n"
.' - **explosion**:爆炸烟光。'."\n"
.' - **outfit**:特殊装束。'."\n"
.' - **logo**:特殊标识。'."\n"
.' - **weapon**:武器。'."\n"
.' - **politics**:涉政。'."\n"
.' - **violence**:打斗。'."\n"
.' - **crowd**:聚众。'."\n"
.' - **parade**:游行。'."\n"
.' - **carcrash**:车祸现场。'."\n"
.' - **flag**:旗帜。'."\n"
.' - **location**:地标。'."\n"
.' - **others**:其他。'."\n"
."\n"
.'- 图文违规(ad)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **ad**:其他广告。'."\n"
.' - **politics**:文字含涉政内容。'."\n"
.' - **porn**:文字含涉黄内容。'."\n"
.' - **abuse**:文字含辱骂内容。'."\n"
.' - **terrorism**:文字含暴恐内容。'."\n"
.' - **contraband**:文字含违禁内容。'."\n"
.' - **spam**:文字含其他垃圾内容。'."\n"
.' - **npx**:牛皮藓广告。'."\n"
.' - **qrcode**:含二维码。'."\n"
.' - **programCode**:含小程序码。'."\n"
."\n"
.'- 图片不良场景(live)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **meaningless**:图片中无内容(例如黑屏、白屏)。'."\n"
.' - **PIP**:画中画。'."\n"
.' - **smoking**:吸烟。'."\n"
.' - **drivelive**:车内直播。'."\n"
."\n"
.'- 图片Logo(Logo)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **TV**:含受管控的Logo。'."\n"
.' - **trademark**:含商标。'."\n",
'type' => 'string',
'example' => 'normal',
],
'Scene' => [
'description' => '审核场景。'."\n"
."\n"
.'- **porn**:鉴黄。'."\n"
.'- **terrorism**:暴恐涉政。'."\n"
.'- **ad**:图文违规。'."\n"
.'- **live**:不良场景。'."\n"
.'- **Logo**:图片Logo。',
'type' => 'string',
'example' => 'live',
],
'Rate' => [
'description' => '分值。可取值:0~100。',
'type' => 'string',
'example' => '100',
],
],
],
],
],
],
],
],
],
],
],
'State' => [
'description' => '作业状态。',
'type' => 'string',
'example' => 'Success',
],
'TitleCensorResult' => [
'description' => '标题审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。取值:'."\n"
."\n"
.'- **pass**:通过。'."\n"
."\n"
.'- **review**:人工重审。'."\n"
."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'block',
],
'Label' => [
'description' => '审核结果的标签,多个使用半角逗号(,)分隔。'."\n"
."\n"
.'- **normal**:普通'."\n"
.'- **spam**:含垃圾信息'."\n"
.'- **ad**:广告'."\n"
.'- **politics**:涉政'."\n"
.'- **terrorism**:暴恐'."\n"
.'- **abuse**:辱骂'."\n"
.'- **porn**:色情'."\n"
.'- **flood**:灌水'."\n"
.'- **contraband**:违禁'."\n"
.'- **meaningless**:无意义'."\n"
.'- **harmful**:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'meaningless',
],
'Scene' => [
'description' => '审核场景。取固定值:**antispam**,文本反垃圾。',
'type' => 'string',
'example' => 'antispam',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '99.91',
],
],
],
'Message' => [
'description' => '作业失败时错误信息。执行成功时不返回此参数。',
'type' => 'string',
'example' => 'The resource operated cannot be found',
],
'Input' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'test/ai/censor/test-****.mp4',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-shanghai',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'bucket-test-in-****',
],
],
],
'BarrageCensorResult' => [
'description' => '弹幕审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。可取值:'."\n"
."\n"
.'- **pass**:通过。'."\n"
."\n"
.'- **review**:人工重审。'."\n"
."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'pass',
],
'Label' => [
'description' => '审核结果分类,多个使用半角逗号(,)分隔。取值:'."\n"
.'- **normal**:普通'."\n"
.'- **spam**:含垃圾信息'."\n"
.'- **ad**:广告'."\n"
.'- **politics**:涉政'."\n"
.'- **terrorism**:暴恐'."\n"
.'- **abuse**:辱骂'."\n"
.'- **porn**:色情'."\n"
.'- **flood**:灌水'."\n"
.'- **contraband**:违禁'."\n"
.'- **meaningless**:无意义'."\n"
.'- **harmful**:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'normal',
],
'Scene' => [
'description' => '审核场景。固定取值:**antispam**,文本反垃圾。',
'type' => 'string',
'example' => 'antispam',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '99.91',
],
],
],
'DescCensorResult' => [
'description' => '描述审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。可取值:'."\n"
."\n"
.'- **pass**:通过。'."\n"
."\n"
.'- **review**:人工重审。'."\n"
."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'pass',
],
'Label' => [
'description' => '审核结果分类,多个使用半角逗号(,)分隔。取值:'."\n"
.'- **normal**:普通'."\n"
.'- **spam**:含垃圾信息'."\n"
.'- **ad**:广告'."\n"
.'- **politics**:涉政'."\n"
.'- **terrorism**:暴恐'."\n"
.'- **abuse**:辱骂'."\n"
.'- **porn**:色情'."\n"
.'- **flood**:灌水'."\n"
.'- **contraband**:违禁'."\n"
.'- **meaningless**:无意义'."\n"
.'- **harmful**:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'ad',
],
'Scene' => [
'description' => '审核场景。固定取值:**antispam**,文本反垃圾。',
'type' => 'string',
'example' => 'antispam',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '100',
],
],
],
'VideoCensorConfig' => [
'description' => '视频审查配置。',
'type' => 'object',
'properties' => [
'OutputFile' => [
'description' => '视频截图结果的保存地址。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '截图输出文件 (OSS Object)。'."\n"
."\n"
.'> 示例中{Count}是占位符,图片Object依次为`output00001-****.jpg,output00002-****.jpg`等。',
'type' => 'string',
'example' => 'output{Count}.jpg',
],
'Location' => [
'description' => '截图输出OSS Bucket所在的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-shanghai',
],
'Bucket' => [
'description' => '截图输出文件所在OSS Bucket。',
'type' => 'string',
'example' => 'test-bucket-****',
],
],
],
'VideoCensor' => [
'description' => '是否需要审核视频内容。默认值:true。可取值:'."\n"
."\n"
.'- **true**:审核。'."\n"
."\n"
.'- **false**:不审核。',
'type' => 'string',
'example' => 'true',
],
'BizType' => [
'description' => '审核模板。默认common(默认模板)。'."\n"
."\n"
.'> 不填默认为common,如果是通过提交工单自定义的审核模板,此项返回UID。',
'type' => 'string',
'example' => 'common',
],
],
],
'JobId' => [
'description' => '媒体审核作业ID。',
'type' => 'string',
'example' => 'f8f166eea7a44e9bb0a4aecf9543****',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'example userdata ****',
],
'Code' => [
'description' => '作业失败时错误码。执行成功时此参数不返回。',
'type' => 'string',
'example' => 'InvalidParameter.ResourceNotFound',
],
'VensorCensorResult' => [
'description' => '视频审查结果。',
'type' => 'object',
'properties' => [
'VideoTimelines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VideoTimeline' => [
'description' => '详细时间点的审核结果,按照时间从小到大排序。',
'type' => 'array',
'items' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '视频中的位置。格式:`hh:mm:ss[.SSS]`。',
'type' => 'string',
'example' => '00:02:59.999',
],
'Object' => [
'description' => '截图输出文件(OSS Object)。'."\n"
."\n"
.'> 示例中{Count}是占位符,图片Object依次为`output00001-****.jpg,output00002-****.jpg`等。',
'type' => 'string',
'example' => 'output{Count}.jpg',
],
'CensorResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CensorResult' => [
'description' => '包含多种类型审核结果的标签、分值等。',
'type' => 'array',
'items' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。取值:'."\n"
."\n"
.'- **pass**:通过,'."\n"
."\n"
.'- **review**:人工重审,'."\n"
."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'block',
],
'Label' => [
'description' => '审核结果分类,多个使用半角逗号(,)分隔。取值:'."\n"
."\n"
.'- 图片鉴黄(porn)审核结果分类:'."\n"
.' - **porn**:色情。'."\n"
.' - **sexy**:性感。'."\n"
.' - **normal**:通过。'."\n"
.'- 暴恐涉政(terrorism)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **bloody**:血腥。'."\n"
.' - **explosion**:爆炸烟光。'."\n"
.' - **outfit**:特殊装束。'."\n"
.' - **logo**:特殊标识。'."\n"
.' - **weapon**:武器。'."\n"
.' - **politics**:涉政。'."\n"
.' - **violence**:打斗。'."\n"
.' - **crowd**:聚众。'."\n"
.' - **parade**:游行。'."\n"
.' - **carcrash**:车祸现场。'."\n"
.' - **flag**:旗帜。'."\n"
.' - **location**:地标。'."\n"
.' - **others**:其他。'."\n"
."\n"
.'- 广告(ad)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **ad**:其他广告。'."\n"
.' - **politics**:文字含涉政内容。'."\n"
.' - **porn**:文字含涉黄内容。'."\n"
.' - **abuse**:文字含辱骂内容。'."\n"
.' - **terrorism**:文字含暴恐内容。'."\n"
.' - **contraband**:文字含违禁内容。'."\n"
.' - **spam**:文字含其他垃圾内容。'."\n"
.' - **npx**:牛皮藓广告。'."\n"
.' - **qrcode**:含二维码。'."\n"
.' - **programCode**:含小程序码。'."\n"
.'- 不良场景(live)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **meaningless**:图片中无内容(例如黑屏、白屏)。'."\n"
.' - **PIP**:画中画。'."\n"
.' - **smoking**:吸烟。'."\n"
.' - **drivelive**:车内直播。'."\n"
.'- Logo(logo)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **TV**:含受管控的Logo。'."\n"
.' - **trademark**:含商标。',
'type' => 'string',
'example' => 'normal',
],
'Scene' => [
'description' => '审核场景。'."\n"
."\n"
.'- **porn**:鉴黄。'."\n"
.'- **terrorism**:暴恐涉政。'."\n"
.'- **ad**:图文违规。'."\n"
.'- **live**:不良场景。'."\n"
.'- **logo**:图片Logo。',
'type' => 'string',
'example' => 'pron',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '99.99',
],
],
],
],
],
],
],
],
],
],
],
'NextPageToken' => [
'description' => '下一页标识。',
'type' => 'string',
'example' => 'ea04afcca7cd4e80b9ece8fbb251****',
],
'CensorResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CensorResult' => [
'description' => '审核结果集合,包含各种场景(黄、暴、恐、政)的概要信息。',
'type' => 'array',
'items' => [
'description' => '审核结果详细信息。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。取值:'."\n"
."\n"
.'- **pass**:通过。'."\n"
."\n"
.'- **review**:人工重审。'."\n"
."\n"
.'- **block**:拦截。',
'type' => 'string',
'example' => 'review',
],
'Label' => [
'description' => '审核结果分类,多个使用半角逗号(,)分隔。取值:'."\n"
."\n"
.'- 图片鉴黄(porn)审核结果分类:'."\n"
.' - **porn**:色情。'."\n"
.' - **sexy**:性感。'."\n"
.' - **normal**:通过。'."\n"
.'- 暴恐涉政(terrorism)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **bloody**:血腥。'."\n"
.' - **explosion**:爆炸烟光。'."\n"
.' - **outfit**:特殊装束。'."\n"
.' - **logo**:特殊标识。'."\n"
.' - **weapon**:武器。'."\n"
.' - **politics**:涉政。'."\n"
.' - **violence**:打斗。'."\n"
.' - **crowd**:聚众。'."\n"
.' - **parade**:游行。'."\n"
.' - **carcrash**:车祸现场。'."\n"
.' - **flag**:旗帜。'."\n"
.' - **location**:地标。'."\n"
.' - **others**:其他。'."\n"
."\n"
.'- 广告(ad)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **ad**:其他广告。'."\n"
.' - **politics**:文字含涉政内容。'."\n"
.' - **porn**:文字含涉黄内容。'."\n"
.' - **abuse**:文字含辱骂内容。'."\n"
.' - **terrorism**:文字含暴恐内容。'."\n"
.' - **contraband**:文字含违禁内容。'."\n"
.' - **spam**:文字含其他垃圾内容。'."\n"
.' - **npx**:牛皮藓广告。'."\n"
.' - **qrcode**:含二维码。'."\n"
.' - **programCode**:含小程序码。'."\n"
.'- 不良场景(live)结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **meaningless**:图片中无内容(例如黑屏、白屏)。'."\n"
.' - **PIP**:画中画。'."\n"
.' - **smoking**:吸烟。'."\n"
.' - **drivelive**:车内直播。'."\n"
.'- Logo(logo)审核结果分类:'."\n"
.' - **normal**:正常。'."\n"
.' - **TV**:含受管控的Logo。'."\n"
.' - **trademark**:含商标。',
'type' => 'string',
'example' => 'meaningless',
],
'Scene' => [
'description' => '审核场景。'."\n"
."\n"
.'- **porn**:鉴黄。'."\n"
.'- **terrorism**:暴恐涉政。'."\n"
.'- **ad**:图文违规。'."\n"
.'- **live**:不良场景。'."\n"
.'- **logo**:图片Logo。',
'type' => 'string',
'example' => 'terrorism',
],
'Rate' => [
'description' => '分值。',
'type' => 'string',
'example' => '100',
],
],
],
],
],
],
],
],
'AudioCensorResult' => [
'description' => '音频审核结果。',
'type' => 'object',
'properties' => [
'Suggestion' => [
'description' => '处理建议。可取值:'."\n"
."\n"
.'- **pass**:通过'."\n"
.'- **review**:人工重审'."\n"
.'- **block**:拦截',
'type' => 'string',
'example' => 'pass',
],
'Label' => [
'description' => '检测结果的分类。取值:'."\n"
."\n"
.'- normal:正常文本'."\n"
."\n"
.'- spam:含垃圾信息'."\n"
."\n"
.'- ad:广告'."\n"
."\n"
.'- politics:涉政'."\n"
."\n"
.'- terrorism:暴恐'."\n"
.'- abuse:辱骂'."\n"
.'- porn:色情'."\n"
.'- flood:灌水'."\n"
.'- contraband:违禁'."\n"
.'- meaningless:无意义'."\n"
.'- harmful:不良场景(支持拜金炫富、追星应援、负面情绪、负面诱导等检测场景)',
'type' => 'string',
'example' => 'normal',
],
],
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B',
],
'NextPageToken' => [
'description' => '下一页标识,32位UUID。查询结果大于一页时返回,每次查询值都会更新。',
'type' => 'string',
'example' => '9b1a42bc6e8d46e6a1383b7e7f01****',
],
'NonExistIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的作业ID列表。如果为空则不返回此参数。',
'type' => 'array',
'items' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '78dc866518b843259669df58ed30****',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaCensorJobList\\": {\\n \\"MediaCensorJob\\": [\\n {\\n \\"CreationTime\\": \\"2021-11-04T07:25:48Z\\",\\n \\"FinishTime\\": \\"2021-11-04T07:25:48Z\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"CoverImageCensorResults\\": {\\n \\"CoverImageCensorResult\\": [\\n {\\n \\"Object\\": \\"test/ai/censor/v2/vme-****.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"example-Bucket-****\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"live\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"Success\\",\\n \\"TitleCensorResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"Message\\": \\"The resource operated cannot be found\\",\\n \\"Input\\": {\\n \\"Object\\": \\"test/ai/censor/test-****.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-test-in-****\\"\\n },\\n \\"BarrageCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"DescCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"ad\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"VideoCensorConfig\\": {\\n \\"OutputFile\\": {\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"test-bucket-****\\"\\n },\\n \\"VideoCensor\\": \\"true\\",\\n \\"BizType\\": \\"common\\"\\n },\\n \\"JobId\\": \\"f8f166eea7a44e9bb0a4aecf9543****\\",\\n \\"UserData\\": \\"example userdata ****\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"VensorCensorResult\\": {\\n \\"VideoTimelines\\": {\\n \\"VideoTimeline\\": [\\n {\\n \\"Timestamp\\": \\"00:02:59.999\\",\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"pron\\",\\n \\"Rate\\": \\"99.99\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"NextPageToken\\": \\"ea04afcca7cd4e80b9ece8fbb251****\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"terrorism\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n },\\n \\"AudioCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\"\\n },\\n \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\",\\n \\"NextPageToken\\": \\"9b1a42bc6e8d46e6a1383b7e7f01****\\",\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"78dc866518b843259669df58ed30****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2021-11-04T07:25:48Z\\n 2021-11-04T07:25:48Z\\n pass\\n \\n \\n oss-cn-shanghai\\n example-Bucket-****\\n \\n pass\\n \\n live\\n 100\\n \\n \\n Success\\n \\n block\\n \\n Antispam\\n 99.91\\n \\n The resource operated cannot be found\\n \\n \\n oss-cn-shanghai\\n bucket-test-in-****\\n \\n \\n pass\\n \\n antispam\\n 99.91\\n \\n \\n pass\\n \\n antispam\\n 100\\n \\n \\n \\n \\n oss-cn-shanghai\\n test-bucket-****\\n \\n true\\n common\\n \\n f8f166eea7a44e9bb0a4aecf9543****\\n example userdata ****\\n InvalidParameter.ResourceNotFound\\n \\n \\n 00:02:59.999\\n \\n \\n block\\n \\n pron\\n 99.99\\n \\n \\n ea04afcca7cd4e80b9ece8fbb251****\\n \\n review\\n \\n terrorism\\n 100\\n \\n \\n c5b30b7c0d0e4a0abde1d5f9e751****\\n \\n D1D5C080-8E2F-5030-8AB4-13092F17631B\\n 9b1a42bc6e8d46e6a1383b7e7f01****\\n 78dc866518b843259669df58ed30****\\n","errorExample":""}]',
'title' => '查询媒体审核作业列表',
'summary' => '查询媒体审核作业列表。',
'description' => '本接口只支持查询三个月内的媒体审核作业列表。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'ImAudit' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'Images',
'in' => 'query',
'schema' => [
'description' => '图片URL的JSON数组,默认最多处理5张。可以通过**MPS控制台** > **媒体管理** > **媒体列表**获取。图片和文本至少填写一个。待审核图片文件需要符合下述限制,否则可能导致任务失败:'."\n"
."\n"
.'- 图片大小不超过20 MB,高度或宽度不超过30000px,且图片总像素不超过2.5亿px。'."\n"
."\n"
.'- (建议)图片像素不低于256×256px,像素过低可能会影响审核效果。',
'type' => 'string',
'required' => false,
'example' => '["http://127.66.**.**/image.jpeg","http://127.66.**.**/photo.jpeg"]',
],
],
[
'name' => 'Contents',
'in' => 'query',
'schema' => [
'description' => '文本JSON数组,用户自定义数组,默认最多处理5段文本,每段文本最长10,000个字符(包含标点)。图片和文本至少填写一个。',
'type' => 'string',
'required' => false,
'example' => '["你好呀","你是谁","我在哪里"]',
],
],
[
'name' => 'Scenes',
'in' => 'query',
'schema' => [
'description' => '场景说明,用于指定审核场景。支持指定多个场景,用半角逗号(,)分隔。例如,{"porn","terrorism"}表示对图片同时进行智能鉴黄和暴恐涉政检测。取值:'."\n"
."\n"
.'- porn:图片智能鉴黄。'."\n"
."\n"
.'- terrorism:图片暴恐涉政。'."\n"
."\n"
.'- ad:图文违规。'."\n"
."\n"
.'- qrcode:图片二维码。'."\n"
."\n"
.'- live:图片不良场景。'."\n"
."\n"
.'- logo:图片logo。'."\n"
."\n"
.'- antispam:文本反垃圾(仅对文本生效)。',
'type' => 'string',
'required' => true,
'example' => '["porn","terrorism","ad"]',
],
],
[
'name' => 'BizType',
'in' => 'query',
'schema' => [
'description' => '默认为公共配置。',
'type' => 'string',
'required' => false,
'example' => '139440480445****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'TextQuotaExceed' => [
'description' => '文本审核QPS是否超过限制,取值:true(超过)、false(不超过)。默认文本审核的QPS是5。',
'type' => 'boolean',
'example' => 'false',
],
'ImageQuotaExceed' => [
'description' => '图片审核QPS是否超过限制。取值:true(超过)、false(不超过)。默认图片审核QPS是5。',
'type' => 'boolean',
'example' => 'false',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5210DBB0-E327-4D45-ADBC-0B83C8793421',
],
'ImageResults' => [
'description' => '图片审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见[图文审核接口返回数据](~~268644~~)。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '图片审核结果。',
'type' => 'array',
'items' => [
'description' => '图片审核结果详细信息。',
'type' => 'object',
'properties' => [
'code' => [
'description' => '错误码,和HTTP状态码一致。如果执行成功则此参数不返回。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'dataId' => [
'description' => '检测对象对应的数据ID。'."\n"
."\n"
.'> 如果在检测请求参数中传入了dataId,则此处返回对应的dataId。',
'type' => 'string',
'example' => 'uuid-1234-1234-1234',
],
'extras' => [
'description' => '额外附加信息。图文违规(ad)场景中,该参数可能返回以下内容。'."\n"
.'hitLibInfo:如果图片中的文字命中了自定义文本库,则返回命中的文本库信息。格式为数组,更多结构描述请参见[hitLibInfo](~~268644~~)。',
'type' => 'object',
'example' => '{"hitLibInfo":[{"context":"检测视频","libCode":"1234567","libName":"相似文本库a"}]}',
],
'msg' => [
'description' => '请求信息的响应信息。',
'type' => 'string',
'example' => 'ok',
],
'results' => [
'description' => '返回结果。调用成功时,返回结果中包含一个或多个元素。每个元素是一个结构体。',
'type' => 'array',
'items' => [
'description' => '返回结果详细信息。',
'type' => 'object',
'properties' => [
'Label' => [
'description' => '检测结果的分类。不同检测场景的结果分类不同,具体如下:'."\n"
."\n"
.'- 图片智能鉴黄(porn)结果分类:'."\n"
."\n"
.' - normal:正常。'."\n"
."\n"
.' - sexy:性感。'."\n"
."\n"
.' - porn:色情。'."\n"
."\n"
.'- 图片暴恐涉政(terrorism)结果分类:'."\n"
."\n"
.' - normal:正常。'."\n"
."\n"
.' - bloody:血腥。'."\n"
."\n"
.' - explosion:爆炸烟光。'."\n"
."\n"
.' - outfit:特殊装束。'."\n"
."\n"
.' - logo:特殊标识。'."\n"
."\n"
.' - weapon:武器。'."\n"
."\n"
.' - politics:涉政。'."\n"
."\n"
.' - violence:打斗。'."\n"
.' '."\n"
.' - crowd:聚众。'."\n"
."\n"
.' - parade:游行。'."\n"
."\n"
.' - carcrash:车祸现场。'."\n"
."\n"
.' - flag:旗帜。'."\n"
."\n"
.' - location:地标。'."\n"
."\n"
.' - others:其他。'."\n"
."\n"
.'- 图文违规(ad)结果分类:'."\n"
."\n"
.' - normal:正常。'."\n"
."\n"
.' - ad:其他广告。'."\n"
."\n"
.' - politics:文字含涉政内容。'."\n"
."\n"
.' - porn:文字含涉黄内容。'."\n"
."\n"
.' - abuse:文字含辱骂内容。'."\n"
."\n"
.' - terrorism:文字含暴恐内容。'."\n"
."\n"
.' - contraband:文字含违禁内容。'."\n"
."\n"
.' - spam:文字含其他垃圾内容。'."\n"
."\n"
.' - npx:牛皮癣广告。'."\n"
."\n"
.' - qrcode:含二维码。'."\n"
."\n"
.' - programCode:含小程序码。'."\n"
."\n"
.'- 图片二维码(qrcode)结果分类:'."\n"
."\n"
.' - normal:正常。'."\n"
."\n"
.' - qrcode:含二维码。'."\n"
."\n"
.' - programCode:含小程序码。'."\n"
."\n"
.'- 图片不良场景(live)结果分类:'."\n"
."\n"
.' - normal:正常。'."\n"
."\n"
.' - meaningless:图片中无内容(例如,黑屏、白屏)。'."\n"
."\n"
.' - PIP:画中画。'."\n"
."\n"
.' - smoking:吸烟。'."\n"
."\n"
.' - drivelive:车内直播。'."\n"
."\n"
.'- 图片logo(logo)结果分类:'."\n"
."\n"
.' - normal:正常。'."\n"
."\n"
.' - TV:含受管控的logo。'."\n"
."\n"
.' - trademark:含商标。',
'type' => 'string',
'example' => 'sexy',
],
'Rate' => [
'description' => '置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果suggestion为pass,则置信度越高,表示内容正常的可能性越高;如果suggestion为review或block,则置信度越低,表示内容违规的可能性越高。'."\n"
."\n"
.'> 该值仅作为参考,强烈建议您不要在业务中使用。建议您参考suggestion和label(或者部分接口返回的sublabel)结果用于内容违规判定。',
'type' => 'number',
'format' => 'double',
'example' => '91.54',
],
'Scene' => [
'description' => '图片检测场景。可取值:'."\n"
."\n"
.'- porn:图片智能鉴黄。'."\n"
."\n"
.'- terrorism:图片暴恐涉政。'."\n"
."\n"
.'- ad:图文违规。'."\n"
."\n"
.'- qrcode:图片二维码。'."\n"
."\n"
.'- live:图片不良场景。'."\n"
."\n"
.'- logo:图片logo。',
'type' => 'string',
'example' => 'porn',
],
'Suggestion' => [
'description' => '建议您执行的后续操作。可取值:'."\n"
."\n"
.'- pass:结果正常,无需进行其余操作。'."\n"
."\n"
.'- review:结果不确定,需要进行人工审核。'."\n"
."\n"
.'- block:结果违规,建议直接删除或者限制公开。',
'type' => 'string',
'example' => 'block',
],
'hintWordsInfo' => [
'description' => '图片中含有广告或文字违规信息时,返回图片中广告文字命中的风险关键词信息。',
'type' => 'array',
'items' => [
'description' => 'hintWordsInfo',
'type' => 'object',
'properties' => [
'context' => [
'description' => '文字命中的风险关键词内容。',
'type' => 'string',
'example' => '敏感词',
],
],
],
],
'qrcodeData' => [
'description' => '图片中含有二维码时,返回图片中所有二维码包含的文本信息。',
'type' => 'array',
'items' => [
'description' => '二维码包含的文本信息。',
'type' => 'string',
'example' => '"http://example.com/01ZZOliO"',
],
],
'qrcodeLocations' => [
'description' => '返回图片中识别到的二维码的坐标信息。',
'type' => 'array',
'items' => [
'description' => 'qrcodeLocation',
'type' => 'object',
'properties' => [
'x' => [
'description' => '以图片左上角为坐标原点,二维码区域左上角到y轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '11',
],
'y' => [
'description' => '以图片左上角为坐标原点,二维码区域左上角到x轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'w' => [
'description' => '二维码区域宽度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '402.0',
],
'h' => [
'description' => '二维码区域高度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '413.0',
],
'qrcode' => [
'description' => '识别到的二维码链接。',
'type' => 'string',
'example' => 'http://xxx',
],
],
],
],
'programCodeData' => [
'description' => '图片中含有小程序码时,返回小程序码的位置信息。',
'type' => 'array',
'items' => [
'description' => '小程序码列表。',
'type' => 'object',
'properties' => [
'x' => [
'description' => '以图片左上角为坐标原点,小程序码区域左上角到y轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '11.0',
],
'y' => [
'description' => '以图片左上角为坐标原点,小程序码区域左上角到x轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '0.0',
],
'w' => [
'description' => '小程序码区域宽度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '402.0',
],
'h' => [
'description' => '小程序码区域高度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '413.0',
],
],
],
],
'logoData' => [
'description' => '图片中含有logo时,返回识别出来的logo信息。',
'type' => 'array',
'items' => [
'description' => '识别出的logo列表。',
'type' => 'object',
'properties' => [
'type' => [
'description' => '识别出的logo类型,取值为TV (台标)。',
'type' => 'string',
'example' => 'TV',
],
'name' => [
'description' => '识别出的logo名称。',
'type' => 'string',
'example' => '湖南台',
],
'x' => [
'description' => '以图片左上角为坐标原点,logo区域左上角到y轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '140',
],
'y' => [
'description' => '以图片左上角为坐标原点,logo区域左上角到x轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '68',
],
'w' => [
'description' => 'logo区域宽度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '106',
],
'h' => [
'description' => 'logo区域高度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '106',
],
],
],
],
'sfaceData' => [
'description' => '图片中包含暴恐识涉政内容时,返回识别出来的暴恐涉政信息。',
'type' => 'array',
'items' => [
'description' => '暴恐涉政信息列表。',
'type' => 'object',
'properties' => [
'x' => [
'description' => '以图片左上角为坐标原点,人脸区域左上角到y轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '49',
],
'y' => [
'description' => '以图片左上角为坐标原点,人脸区域左上角到y轴距离,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '39',
],
'w' => [
'description' => '人脸区域宽度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '47',
],
'h' => [
'description' => '人脸区域高度,单位:像素。',
'type' => 'number',
'format' => 'float',
'example' => '121',
],
'faces' => [
'description' => '识别出的人脸信息。',
'type' => 'array',
'items' => [
'description' => '人脸信息。',
'type' => 'object',
'properties' => [
'name' => [
'description' => '字符串类型,相似人物的名称。',
'type' => 'string',
'example' => '命中人名',
],
're' => [
'description' => '浮点数类型,置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。置信度越高表示人物识别结果的可信度越高。',
'type' => 'number',
'format' => 'float',
'example' => '91.54',
],
'idid' => [
'description' => '字符串类型,人脸ID。',
'type' => 'string',
'example' => 'AliFace_0001234',
],
],
],
],
],
],
],
'ocrData' => [
'description' => 'ocrData',
'type' => 'array',
'items' => [
'description' => '识别到的图片中的完整文字信息。',
'type' => 'string',
'example' => '识别结果',
],
],
'frames' => [
'description' => '如果待检测图片因为过长被截断,该参数返回截断后的每一帧图像的临时访问地址。',
'type' => 'array',
'items' => [
'description' => 'frame',
'type' => 'object',
'properties' => [
'rate' => [
'description' => '置信度分数,取值范围:0~100,置信度越高表示检测结果的可信度越高。建议您不要在业务中使用该分数。',
'type' => 'number',
'format' => 'float',
'example' => '89.85',
],
'url' => [
'description' => '被截断的图片的临时访问URL,地址有效期是5分钟。',
'type' => 'string',
'example' => 'http://example.com/test-01.jpg',
],
],
],
],
],
],
],
'taskId' => [
'description' => '检测任务的ID。',
'type' => 'string',
'example' => 'img4wlJcb7p4wH4lAP3111111-12****',
],
'url' => [
'description' => '检测对象的URL。',
'type' => 'string',
'example' => 'http://example.com/example-****.jpg',
],
],
],
],
],
],
'TextResults' => [
'description' => '文本审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见[图文审核接口返回数据](~~268644~~)。',
'type' => 'object',
'properties' => [
'result' => [
'description' => '文本审核结果。',
'type' => 'array',
'items' => [
'description' => '文本审核结果详细信息。',
'type' => 'object',
'properties' => [
'code' => [
'description' => '错误码,和HTTP状态码一致。更多信息,请参见[错误码表](~~29254~~)。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'content' => [
'description' => '被检测文本,和调用请求中的待检测文本对应。',
'type' => 'string',
'example' => '这是一段测试文本',
],
'dataId' => [
'description' => '文字的顺序号。',
'type' => 'string',
'example' => 'cfd33235-71a4-468b-8137-a5ffe323****',
],
'msg' => [
'description' => '请求消息的响应消息。',
'type' => 'string',
'example' => 'OK',
],
'results' => [
'description' => '返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体。',
'type' => 'array',
'items' => [
'description' => '返回结果详细信息。',
'type' => 'object',
'properties' => [
'details' => [
'description' => '命中风险信息,一条文本可能命中多条风险详情。',
'type' => 'array',
'items' => [
'description' => '命中风险信息详情。',
'type' => 'object',
'properties' => [
'Label' => [
'description' => '文本命中风险的分类。取值:'."\n"
."\n"
.'- spam:含垃圾信息。'."\n"
."\n"
.'- ad:广告。'."\n"
."\n"
.'- politics:涉政。'."\n"
."\n"
.'- terrorism:暴恐。'."\n"
."\n"
.'- abuse:辱骂。'."\n"
."\n"
.'- porn:色情。'."\n"
."\n"
.'- flood:灌水。'."\n"
."\n"
.'- contraband:违禁。'."\n"
."\n"
.'- meaningless:无意义。',
'type' => 'string',
'example' => 'porn',
],
'contexts' => [
'description' => '命中该风险的上下文信息。',
'type' => 'array',
'items' => [
'description' => '命中该风险的上下文信息。',
'type' => 'object',
'properties' => [
'context' => [
'description' => '检测文本命中的风险关键词,如果命中了关键词会返回该内容,如果命中了算法模型,则不会返回该字段。',
'type' => 'string',
'example' => '上门服务',
],
'positions' => [
'description' => '如果命中关键词,会返回该词在原始文本中的位置。',
'type' => 'array',
'items' => [
'description' => '关键词在原始文本中的位置。',
'type' => 'string',
'example' => '{"startPos":1, "endPos":10}',
],
],
'libName' => [
'description' => '命中自定义词库时,才会返回当前字段。取值为创建词库时设置的词库名称。',
'type' => 'string',
'example' => '您自定义的词库名称',
],
'libCode' => [
'description' => '命中您自定义文本库时,才会返回当前字段。取值为创建风险文本库后系统返回的文本库code。',
'type' => 'string',
'example' => '123456',
],
'ruleType' => [
'description' => '命中行为规则时,才会返回当前字段。取值:'."\n"
.'- user_id'."\n"
.'- ip'."\n"
.'- umid'."\n"
.'- content'."\n"
.'- similar_content'."\n"
.'- imei'."\n"
.'- imsi',
'type' => 'string',
'example' => 'ip',
],
],
],
],
],
],
],
'label' => [
'description' => '文本垃圾检测结果的分类。取值:'."\n"
."\n"
.'- normal:正常文本。'."\n"
."\n"
.'- spam:含垃圾信息。'."\n"
."\n"
.'- ad:广告。'."\n"
."\n"
.'- politics:涉政。'."\n"
."\n"
.'- terrorism:暴恐。'."\n"
."\n"
.'- abuse:辱骂。'."\n"
."\n"
.'- porn:色情。'."\n"
."\n"
.'- flood:灌水。'."\n"
."\n"
.'- contraband:违禁。'."\n"
."\n"
.'- meaningless:无意义。'."\n"
."\n"
.'- customized:自定义(例如命中自定义关键词)。',
'type' => 'string',
'example' => 'porn',
],
'rate' => [
'description' => '置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果suggestion为pass,则置信度越高,表示内容正常的可能性越高;如果suggestion为review或block,则置信度越低,表示内容违规的可能性越高。'."\n"
."\n"
.'> 该值仅作为参考,强烈建议您不要在业务中使用。建议您参考suggestion和label(或者部分接口返回的sublabel)结果用于内容违规判定。',
'type' => 'number',
'format' => 'double',
'example' => '99.90',
],
'scene' => [
'description' => '检测场景。',
'type' => 'string',
'example' => 'antispam',
],
'suggestion' => [
'description' => '建议您执行的后续操作。取值:'."\n"
."\n"
.'- pass:文本正常,可以直接放行。'."\n"
."\n"
.'- review:文本需要进一步人工审核。'."\n"
."\n"
.'- block:文本违规,可以直接删除或者限制公开。',
'type' => 'string',
'example' => 'block',
],
],
],
],
'taskId' => [
'description' => '检测任务的ID。',
'type' => 'string',
'example' => 'txt6HB8NQoEbU@5fosnj2xVEM-1t****',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TextQuotaExceed\\": false,\\n \\"ImageQuotaExceed\\": false,\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8793421\\",\\n \\"ImageResults\\": {\\n \\"result\\": [\\n {\\n \\"code\\": 200,\\n \\"dataId\\": \\"uuid-1234-1234-1234\\",\\n \\"extras\\": {\\n \\"hitLibInfo\\": [\\n {\\n \\"context\\": \\"检测视频\\",\\n \\"libCode\\": \\"1234567\\",\\n \\"libName\\": \\"相似文本库a\\"\\n }\\n ]\\n },\\n \\"msg\\": \\"ok\\",\\n \\"results\\": [\\n {\\n \\"Label\\": \\"sexy\\",\\n \\"Rate\\": 91.54,\\n \\"Scene\\": \\"porn\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"hintWordsInfo\\": [\\n {\\n \\"context\\": \\"敏感词\\"\\n }\\n ],\\n \\"qrcodeData\\": [\\n \\"\\\\\\"http://example.com/01ZZOliO\\\\\\"\\"\\n ],\\n \\"qrcodeLocations\\": [\\n {\\n \\"x\\": 11,\\n \\"y\\": 0,\\n \\"w\\": 402,\\n \\"h\\": 413,\\n \\"qrcode\\": \\"http://xxx\\"\\n }\\n ],\\n \\"programCodeData\\": [\\n {\\n \\"x\\": 11,\\n \\"y\\": 0,\\n \\"w\\": 402,\\n \\"h\\": 413\\n }\\n ],\\n \\"logoData\\": [\\n {\\n \\"type\\": \\"TV\\",\\n \\"name\\": \\"湖南台\\",\\n \\"x\\": 140,\\n \\"y\\": 68,\\n \\"w\\": 106,\\n \\"h\\": 106\\n }\\n ],\\n \\"sfaceData\\": [\\n {\\n \\"x\\": 49,\\n \\"y\\": 39,\\n \\"w\\": 47,\\n \\"h\\": 121,\\n \\"faces\\": [\\n {\\n \\"name\\": \\"命中人名\\",\\n \\"re\\": 91.54,\\n \\"idid\\": \\"AliFace_0001234\\"\\n }\\n ]\\n }\\n ],\\n \\"ocrData\\": [\\n \\"识别结果\\"\\n ],\\n \\"frames\\": [\\n {\\n \\"rate\\": 89.85,\\n \\"url\\": \\"http://example.com/test-01.jpg\\"\\n }\\n ]\\n }\\n ],\\n \\"taskId\\": \\"img4wlJcb7p4wH4lAP3111111-12****\\",\\n \\"url\\": \\"http://example.com/example-****.jpg\\"\\n }\\n ]\\n },\\n \\"TextResults\\": {\\n \\"result\\": [\\n {\\n \\"code\\": 200,\\n \\"content\\": \\"这是一段测试文本\\",\\n \\"dataId\\": \\"cfd33235-71a4-468b-8137-a5ffe323****\\",\\n \\"msg\\": \\"OK\\",\\n \\"results\\": [\\n {\\n \\"details\\": [\\n {\\n \\"Label\\": \\"porn\\",\\n \\"contexts\\": [\\n {\\n \\"context\\": \\"上门服务\\",\\n \\"positions\\": [\\n \\"{\\\\\\"startPos\\\\\\":1, \\\\\\"endPos\\\\\\":10}\\"\\n ],\\n \\"libName\\": \\"您自定义的词库名称\\",\\n \\"libCode\\": \\"123456\\",\\n \\"ruleType\\": \\"ip\\"\\n }\\n ]\\n }\\n ],\\n \\"label\\": \\"porn\\",\\n \\"rate\\": 99.9,\\n \\"scene\\": \\"antispam\\",\\n \\"suggestion\\": \\"block\\"\\n }\\n ],\\n \\"taskId\\": \\"txt6HB8NQoEbU@5fosnj2xVEM-1t****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n false\\n false\\n 5210DBB0-E327-4D45-ADBC-0B83C8793421\\n \\n \\n 200\\n uuid-1234-1234-1234\\n ok\\n \\n \\n 91.54\\n porn\\n block\\n \\n img4wlJcb7p4wH4lAP3111111-12****\\n http://example.com/example-****.jpg\\n \\n \\n \\n \\n 200\\n 这是一段测试文本\\n cfd33235-71a4-468b-8137-a5ffe323****\\n OK\\n \\n \\n \\n \\n \\n 99.9\\n antispam\\n block\\n \\n txt6HB8NQoEbU@5fosnj2xVEM-1t****\\n \\n \\n","errorExample":""}]',
'title' => '提交图文审核作业',
'summary' => '进行图片、文本内容审核,审核结果同步返回。',
'description' => '- 本接口审核完成后审核结果同步返回。'."\n"
.'- 图文审核功能,目前开通的地域为华北2(北京)、华东2(上海)、亚太东南1(新加坡),其他地域暂不支持。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'SubmitFpShotJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '作业输入文件地址,支持 OSS 地址、HTTP 地址、视频点播(VoD)媒资等形式。'."\n"
."\n"
.'- OSS 地址:OSS三元组,JSONString。例如:{\\"Bucket\\":\\"test-bucket\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"Object\\":\\"test.mp4\\"}'."\n"
."\n"
.'- HTTP地址:公网可下载的地址。例如:http://example-test-****.mp4。'."\n"
."\n"
.'- 视频点播(VOD)媒资地址:媒资Id,JSONString。例如:{\\"MediaId\\":\\"99238***321\\"}'."\n"
."\n\n"
."\n\n"
.'> OSS的地域和媒资存储地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,用于绑定消息通知。可通过**媒体处理控制台**>**全局设置**>**管道**获取。',
'type' => 'string',
'required' => false,
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
],
[
'name' => 'FpShotConfig',
'in' => 'query',
'schema' => [
'description' => '视频DNA配置,JSON对象。更多信息,请参见[FpShotConfig详情](~~93568~~)。',
'type' => 'string',
'required' => true,
'example' => '{'."\n"
.' "PrimaryKey": "12345****",'."\n"
.' "SaveType": "save",'."\n"
.' "FpDBId": "417f2ada5999daf****"'."\n"
.'}',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,最大长度128个字节,不能以特殊字符开头。',
'type' => 'string',
'required' => false,
'example' => 'testid-****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'JobId' => [
'description' => '视频DNA作业ID。建议您保存此ID便于后续调用其他相关接口时使用。',
'type' => 'string',
'example' => '2a0697e35a7342859f733a9190c4****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"2a0697e35a7342859f733a9190c4****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n 2a0697e35a7342859f733a9190c4****\\n","errorExample":""}]',
'title' => '提交DNA作业',
'summary' => '查询DNA底库中是否存在相同或者相近的DNA结果。',
'description' => '- 本接口可以提交视频、音频、图片和文本DNA作业。'."\n"
.'- 本接口为异步接口。不保证接口返回时结果已经生成,结果完成后将发送异步消息。'."\n"
.'- DNA相关接口功能,目前开通的地域为华北2(北京)、华东2(上海)、华东1(杭州)、亚太东南1(新加坡)、沙特(利雅得)由合作伙伴运营,其他地域暂不支持。其中,文本DNA相关功能,目前仅支持华东2(上海)地域使用。'."\n"
.'- 输入文件格式限制如下:'."\n"
.' - 图片格式:jpeg、png、bmp。'."\n"
.' - 视频格式:mp4、avi、mkv、mpg、ts、mov、flv、mxf。'."\n"
.' - 视频编码:MPEG2、MPEG4、H264、HEVC、WMV。'."\n"
.'- 文本DNA使用场景:底库仅支持入库TextType=Text的长文本字符串,搜索指定TextType=ASR的输入是ASR识别结果,包含start、end、text的JSON字符串数组。'."\n"
."\n\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '**异步通知消息参数**'."\n"
.'|名称| 类型| 描述|'."\n"
.'|:---------|:-------|:---------|'."\n"
.'|Type| String| 消息类型。|'."\n"
.'|FpShotJobNotify| AliyunFpShotJobNotify | 视频DNA作业,参见[数据类型AliyunFpShotJobNotify](~~29251~~)。|'."\n"
.'|UserData| String| 用户自定义数据。|',
'extraInfo' => ' ',
],
'QueryFpShotJobList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobIds',
'in' => 'query',
'schema' => [
'description' => '需要查询的DNA作业ID列表,可以通过[MPS控制台](https://mps.console.aliyun.com/overview) > **任务管理** > **视频DNA**获取。一次最多查询10个,用半角逗号(,)分隔。',
'type' => 'string',
'required' => false,
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '下一页标识。第一次请求无需传入,服务会返回,第二次请求传入即可。',
'type' => 'string',
'required' => false,
'example' => '16f01ad6175e4230ac42bb5182cd****',
],
],
[
'name' => 'MaximumPageSize',
'in' => 'query',
'schema' => [
'description' => '每页最大返回数。'."\n"
."\n"
.'- 默认:10'."\n"
.'- 取值:1~100',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '需要查询的作业状态。取值:'."\n"
.'- All:全部。'."\n"
.'- Queuing:排队中。'."\n"
.'- Analysing:分析中。'."\n"
.'- Fail:失败。'."\n"
.'- Success:成功。',
'type' => 'string',
'required' => false,
'example' => 'All',
'default' => 'All',
],
],
[
'name' => 'StartOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '最早任务创建时间。'."\n"
."\n"
.'- 日期格式按照ISO8601标准表示,并需要使用UTC时间。'."\n"
.'- 格式为:YYYY-MM-DDThh:mm:ssZ 。',
'type' => 'string',
'required' => false,
'example' => '2021-12-22T03:48:05Z',
],
],
[
'name' => 'EndOfJobCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '最晚任务创建时间。'."\n"
."\n"
.'- 日期格式按照ISO8601标准表示,并需要使用UTC时间。'."\n"
.'- 格式为:YYYY-MM-DDThh:mm:ssZ 。',
'type' => 'string',
'required' => false,
'example' => '2022-02-14T02:16:07Z',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID。可以通过[**媒体处理控制台**](https://mps.console.aliyun.com/overview) > **全局设置** > **管道及回调**获取。',
'type' => 'string',
'required' => false,
'example' => 'b11c171cced04565b1f38f1ecc39**** ',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'NextPageToken' => [
'description' => '下一页标识。需记录下来,在下一次请求时传入即可。',
'type' => 'string',
'example' => 'b11c171cced04565b1f38f1ecc39****',
],
'FpShotJobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpShotJob' => [
'description' => 'DNA作业信息。',
'type' => 'array',
'items' => [
'description' => 'DNA作业信息详情。',
'type' => 'object',
'properties' => [
'FpShotResult' => [
'description' => 'DNA作业查询结果。',
'type' => 'object',
'properties' => [
'AudioFpShots' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpShot' => [
'description' => '音频DNA查询结果。',
'type' => 'array',
'items' => [
'description' => '音频DNA查询结果详细信息。',
'type' => 'object',
'properties' => [
'PrimaryKey' => [
'description' => '唯一主键。',
'type' => 'string',
'example' => '498ac941373341599c4777c8d884****',
],
'FpShotSlices' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpShotSlice' => [
'description' => '相似音频。',
'type' => 'array',
'items' => [
'description' => '相似音频详细信息。',
'type' => 'object',
'properties' => [
'Duplication' => [
'description' => 'DNA库中音频的开始时间和时长。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '3',
],
],
],
'Similarity' => [
'description' => '音频片段相似度。',
'type' => 'string',
'example' => '0',
],
'Input' => [
'description' => '输入音频的开始时间和时长。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '0',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '5',
],
],
],
],
],
],
],
],
'Similarity' => [
'description' => '音频整体相似度。',
'type' => 'string',
'example' => '0',
],
],
],
],
],
],
'FpShots' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpShot' => [
'description' => '视频DNA查询结果。',
'type' => 'array',
'items' => [
'description' => '视频DNA查询结果详细信息。',
'type' => 'object',
'properties' => [
'PrimaryKey' => [
'description' => '视频唯一主键。',
'type' => 'string',
'example' => '498ac941373341599c4777c8d884****',
],
'FpShotSlices' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpShotSlice' => [
'description' => '相似视频。',
'type' => 'array',
'items' => [
'description' => '相似视频详情。',
'type' => 'object',
'properties' => [
'Duplication' => [
'description' => 'DNA库中视频的开始时间和时长。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '1260',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '48',
],
],
],
'Similarity' => [
'description' => '视频片段相似度。',
'type' => 'string',
'example' => '0',
],
'Input' => [
'description' => '输入视频的开始时间和时长。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '46',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '48',
],
],
],
],
],
],
],
],
'Similarity' => [
'description' => '视频整体相似度。'."\n"
."\n"
.'> 整体相似度是片段相似度的平均值。如果DNA库中存在多个相似段,会返回多个命中结果。',
'type' => 'string',
'example' => '0.8914769887924194',
],
],
],
],
],
],
'TextFpShots' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TextFpShot' => [
'description' => '文本DNA查询结果。',
'type' => 'array',
'items' => [
'description' => '文本DNA查询结果详细信息。',
'type' => 'object',
'properties' => [
'PrimaryKey' => [
'description' => '文本唯一主键。',
'type' => 'string',
'example' => '3e34ac649945b53a1b0f863ce030****',
],
'Similarity' => [
'description' => '文本相似度。',
'type' => 'string',
'example' => '1.0',
],
'TextFpShotSlices' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TextFpShotSlice' => [
'description' => '重复文本。',
'type' => 'array',
'items' => [
'description' => '重复文本详细信息。',
'type' => 'object',
'properties' => [
'Similarity' => [
'description' => '匹配片段的置信度。',
'type' => 'string',
'example' => '1.0',
],
'InputText' => [
'description' => '查询匹配的文本片段。',
'type' => 'string',
'example' => '今天下雪了',
],
'DuplicationText' => [
'description' => '底库匹配的文本片段。',
'type' => 'string',
'example' => '今天下雪了',
],
'InputFragment' => [
'description' => '查询匹配片段起始时间和时长。',
'type' => 'object',
'properties' => [
'Start' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '0',
],
'Duration' => [
'description' => '时长。',
'type' => 'string',
'example' => '3',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-01-10T12:00:00Z',
],
'FinishTime' => [
'description' => '完成时间。',
'type' => 'string',
'example' => '0',
],
'State' => [
'description' => '作业状态,可取值:'."\n"
."\n"
.'- **Queuing**:排队中。'."\n"
."\n"
.'- **Analysing**:分析中。'."\n"
."\n"
.'- **Success**:成功。'."\n"
."\n"
.'- **Fail**:失败。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '分析失败时错误信息。如果执行成功则不返回此参数。',
'type' => 'string',
'example' => 'The parameter \\"Id\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long',
],
'FpShotConfig' => [
'description' => '配置。',
'type' => 'object',
'properties' => [
'PrimaryKey' => [
'description' => '唯一的视频主键,唯一性由用户保证。',
'type' => 'string',
'example' => '3ca84a39a9024f19853b21be9cf9****',
],
'SaveType' => [
'description' => '存储类型,取值:'."\n"
."\n"
.'- **nosave**:不入库。'."\n"
."\n"
.'- **save**:去重入库。'."\n"
."\n"
.'- **forcesave**:强制入库。',
'type' => 'string',
'example' => 'save',
],
'FpDBId' => [
'description' => 'DNA库ID。',
'type' => 'string',
'example' => '2288c6ca184c0e47098a5b665e2a12****',
],
],
],
'FileId' => [
'description' => '文件ID。',
'type' => 'string',
'example' => 'ebb51ee30f0b49aba959823fa991****',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'testid-001',
],
'Duration' => [
'description' => '输入文件时长,单位秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'Code' => [
'description' => '分析失败时错误码。',
'type' => 'string',
'example' => 'InvalidParameter.UUIDFormatInvalid',
],
'InputFile' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '作业输入所在的OSS Object。',
'type' => 'string',
'example' => 'test.mp4',
],
'Location' => [
'description' => '作业输入所在的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-beiing',
],
'Bucket' => [
'description' => '作业输入所在的OSS Bucket。',
'type' => 'string',
'example' => 'oss-test',
],
],
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'Id' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'Input' => [
'description' => '作业输入。',
'type' => 'string',
'example' => '{"Bucket":"oss-test","Location":"oss-cn-beiing","Object":"test.mp4"}',
],
],
],
],
],
],
'NonExistIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的作业ID列表。',
'type' => 'array',
'items' => [
'description' => '不存在的作业ID列表,无数据时该参数不返回。',
'type' => 'string',
'example' => 'ae687c02fe944327ba9631e50da23128****',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NextPageToken\\": \\"b11c171cced04565b1f38f1ecc39****\\",\\n \\"FpShotJobList\\": {\\n \\"FpShotJob\\": [\\n {\\n \\"FpShotResult\\": {\\n \\"AudioFpShots\\": {\\n \\"FpShot\\": [\\n {\\n \\"PrimaryKey\\": \\"498ac941373341599c4777c8d884****\\",\\n \\"FpShotSlices\\": {\\n \\"FpShotSlice\\": [\\n {\\n \\"Duplication\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"3\\"\\n },\\n \\"Similarity\\": \\"0\\",\\n \\"Input\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"5\\"\\n }\\n }\\n ]\\n },\\n \\"Similarity\\": \\"0\\"\\n }\\n ]\\n },\\n \\"FpShots\\": {\\n \\"FpShot\\": [\\n {\\n \\"PrimaryKey\\": \\"498ac941373341599c4777c8d884****\\",\\n \\"FpShotSlices\\": {\\n \\"FpShotSlice\\": [\\n {\\n \\"Duplication\\": {\\n \\"Start\\": \\"1260\\",\\n \\"Duration\\": \\"48\\"\\n },\\n \\"Similarity\\": \\"0\\",\\n \\"Input\\": {\\n \\"Start\\": \\"46\\",\\n \\"Duration\\": \\"48\\"\\n }\\n }\\n ]\\n },\\n \\"Similarity\\": \\"0.8914769887924194\\"\\n }\\n ]\\n },\\n \\"TextFpShots\\": {\\n \\"TextFpShot\\": [\\n {\\n \\"PrimaryKey\\": \\"3e34ac649945b53a1b0f863ce030****\\",\\n \\"Similarity\\": \\"1.0\\",\\n \\"TextFpShotSlices\\": {\\n \\"TextFpShotSlice\\": [\\n {\\n \\"Similarity\\": \\"1.0\\",\\n \\"InputText\\": \\"今天下雪了\\",\\n \\"DuplicationText\\": \\"今天下雪了\\",\\n \\"InputFragment\\": {\\n \\"Start\\": \\"0\\",\\n \\"Duration\\": \\"3\\"\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n },\\n \\"CreationTime\\": \\"2017-01-10T12:00:00Z\\",\\n \\"FinishTime\\": \\"0\\",\\n \\"State\\": \\"Success\\",\\n \\"Message\\": \\"The parameter \\\\\\\\\\\\\\"Id\\\\\\\\\\\\\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long\\",\\n \\"FpShotConfig\\": {\\n \\"PrimaryKey\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"SaveType\\": \\"save\\",\\n \\"FpDBId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\"\\n },\\n \\"FileId\\": \\"ebb51ee30f0b49aba959823fa991****\\",\\n \\"UserData\\": \\"testid-001\\",\\n \\"Duration\\": 5,\\n \\"Code\\": \\"InvalidParameter.UUIDFormatInvalid\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"test.mp4\\",\\n \\"Location\\": \\"oss-cn-beiing\\",\\n \\"Bucket\\": \\"oss-test\\"\\n },\\n \\"PipelineId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Id\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Input\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"oss-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-beiing\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"test.mp4\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"ae687c02fe944327ba9631e50da23128****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n \\n \\n \\n 498ac941373341599c4777c8d884****\\n \\n \\n 0\\n 3\\n \\n 0\\n \\n 0\\n 5\\n \\n \\n 0\\n \\n \\n 498ac941373341599c4777c8d884****\\n \\n \\n 1260\\n 48\\n \\n 0\\n \\n 46\\n 48\\n \\n \\n 0.8914769887924194\\n \\n \\n 3e34ac649945b53a1b0f863ce030****\\n 1.0\\n \\n 1.0\\n 今天下雪了\\n 今天下雪了\\n \\n 0\\n 3\\n \\n \\n \\n \\n 2017-01-10T12:00:00Z\\n 0\\n Success\\n The parameter \\\\\\"Id\\\\\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long\\n \\n 3ca84a39a9024f19853b21be9cf9****\\n save\\n 2288c6ca184c0e47098a5b665e2a12****\\n \\n ebb51ee30f0b49aba959823fa991****\\n testid-001\\n InvalidParameter.UUIDFormatInvalid\\n \\n \\n oss-cn-beiing\\n oss-test\\n \\n 88c6ca184c0e47098a5b665e2a12****\\n 88c6ca184c0e47098a5b665e2a12****\\n {\\"Bucket\\":\\"oss-test\\",\\"Location\\":\\"oss-cn-beiing\\",\\"Object\\":\\"test.mp4\\"}\\n \\n ae687c02fe944327ba9631e50da23128****\\n","errorExample":""}]',
'title' => '查询DNA作业结果',
'summary' => '查询DNA作业结果,本接口支持查询所有类型的DNA作业结果。',
'description' => '- 提交DNA作业后,DNA服务会进行DNA对比,通过本接口可以查询作业结果。'."\n"
.'- 查询文本DNA作业目前仅支持华东2(上海)地域使用。'."\n"
.'- 本接口只支持查询六个月以内的DNA任务信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateFpShotDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => 'DNA库名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example name',
],
],
[
'name' => 'ModelId',
'in' => 'query',
'schema' => [
'description' => 'DNA库模型ID。'."\n"
."\n"
.'- 文本DNA Modelld为**11**'."\n"
."\n"
.'- 视频DNA ModelId为**12**'."\n"
."\n"
.'- 音频DNA ModelId为**13**'."\n"
."\n"
.'- 图片DNA ModelId为**14**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
'default' => '12',
],
],
[
'name' => 'Config',
'in' => 'query',
'schema' => [
'description' => '指纹库配置。默认为空,做定制化配置。字符串类型,JSON格式。',
'type' => 'string',
'required' => false,
'example' => 'null',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => 'DNA库描述。',
'type' => 'string',
'required' => false,
'example' => '这是一个文本DNA库',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'FpShotDB' => [
'description' => 'DNA库详细信息。',
'type' => 'object',
'properties' => [
'Description' => [
'description' => 'DNA库描述。',
'type' => 'string',
'example' => '这是一个文本DNA库',
],
'State' => [
'description' => 'DNA库的状态。新建成功后默认为**offline**状态,待后台处理完成后会自动转换成**active**状态。',
'type' => 'string',
'example' => 'offline',
],
'Name' => [
'description' => 'DNA库名称。',
'type' => 'string',
'example' => 'example-name-****',
],
'FpDBId' => [
'description' => 'DNA库ID。建议您保存此ID便于后续调用其他相关接口时使用。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'ModelId' => [
'description' => 'DNA库模型ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'Config' => [
'description' => 'DNA库配置。',
'type' => 'string',
'example' => 'null',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"FpShotDB\\": {\\n \\"Description\\": \\"这是一个文本DNA库\\",\\n \\"State\\": \\"offline\\",\\n \\"Name\\": \\"example-name-****\\",\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"ModelId\\": 11,\\n \\"Config\\": \\"null\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n \\n 这是一个文本DNA库\\n offline\\n example-name-****\\n 88c6ca184c0e47098a5b665e2a12****\\n 11\\n null\\n \\n","errorExample":""}]',
'title' => '创建DNA库',
'summary' => '提交新建DNA库作业。',
'description' => '- 本接口可以新建视频、音频、图片和文本DNA库。'."\n"
.'- 文本DNA相关接口目前仅支持华东2(上海)地域使用。'."\n"
.'- 单个用户默认可以创建指纹库个数为 5 个,如需提高,请提交工单申请。无用指纹库可以调用 SubmitFpDBDeleteJob 接口删除。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'ListFpShotDB' => [
'summary' => '查询DNA库。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREmtsVN28MX',
'FEATUREmtsVAD950',
'FEATUREmtsQLY5GJ',
'FEATUREmtsMX6OH3',
],
],
'parameters' => [
[
'name' => 'FpDBIds',
'in' => 'query',
'schema' => [
'description' => 'DNA库ID列表,可以从[提交新建DNA库](~~170149~~)的返回参数中获取。⼀次最多查10个,ID之间⽤半角逗号(,)分隔。'."\n",
'type' => 'string',
'required' => false,
'example' => '2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'FpShotDBList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpShotDB' => [
'description' => 'DNA库列表。',
'type' => 'array',
'items' => [
'description' => 'DNA库详细信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => 'DNA库的状态。默认值:**offline**(离线)。**active**表示DNA库可用。可取值:'."\n"
."\n"
.'- **offline**:离线。'."\n"
."\n"
.'- **active**:在线。'."\n"
."\n"
.'- **paused**:暂停。'."\n"
."\n"
.'- **deleted**:删除。',
'type' => 'string',
'example' => 'active',
],
'Description' => [
'description' => 'DNA库描述。',
'type' => 'string',
'example' => '这是一个文本DNA库',
],
'Name' => [
'description' => 'DNA库名称。',
'type' => 'string',
'example' => 'test-****',
],
'ModelId' => [
'description' => 'DNA库模型ID。⽂本DNA ModelId为**11**,视频DNA ModelId为**12**,音频DNA ModelId为**13**,图片DNA ModelId为**14**。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'FpDBId' => [
'description' => 'DNA库ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'NonExistIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的DNA库ID列表。',
'type' => 'array',
'items' => [
'description' => '不存在的DNA库ID,无数据时该参数不返回。',
'type' => 'string',
'example' => 'ae687c02fe944327ba9631e50da2****',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"FpShotDBList\\": {\\n \\"FpShotDB\\": [\\n {\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"这是一个文本DNA库\\",\\n \\"Name\\": \\"test-****\\",\\n \\"ModelId\\": 11,\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"ae687c02fe944327ba9631e50da2****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n active\\n 这是一个文本DNA库\\n test-****\\n 11\\n 88c6ca184c0e47098a5b665e2a12****\\n \\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n ae687c02fe944327ba9631e50da2****\\n","errorExample":""}]',
'title' => '查询DNA库',
'description' => '- 本接口根据DNA库ID返回DNA库的状态、信息等。'."\n"
.'- 文本DNA相关功能目前仅支持华东2(上海)地域使用。'."\n"
.'- 本接口一次最多查询10个DNA库。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'ImportFpShotJob' => [
'summary' => '提交文本导库任务。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '导库⽂件的OSS地址,JSON对象。例如:`{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.txt"}`。'."\n"
."\n"
.'> OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.txt"}',
],
],
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,可以通过**MPS控制台** > **全局设置** > **管道**获取。⽤于区分业务,绑定消息通知。若不传,则使⽤默认管道,不绑定消息通知。',
'type' => 'string',
'required' => false,
'example' => 'ae687c02fe944327ba9631e50da2****',
],
],
[
'name' => 'FpImportConfig',
'in' => 'query',
'schema' => [
'description' => '导库配置,JSON对象。 例如:`{"SaveType":"onlysave"}`。其中`SaveType`表示存储类型,取值包括:'."\n"
."\n"
.'- **save**:去重入库。'."\n"
."\n"
.'- **onlysave**:仅入库。',
'type' => 'string',
'required' => true,
'example' => '{"SaveType":"onlysave"}',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,支持中英文、数字、特殊符号。最大长度128字节。',
'type' => 'string',
'required' => false,
'example' => '{"Chapter":"平凡的****/平凡的****第⼆部/第⼆部第47章.txt"}',
],
],
[
'name' => 'FpDBId',
'in' => 'query',
'schema' => [
'description' => 'DNA库ID,⽤于批量导⼊⽂本特征,⼀个库只能并⾏处理⼀个导库任务。可以从[提交新建DNA库](~~170149~~)的返回参数中获取。'."\n",
'type' => 'string',
'required' => true,
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'JobId' => [
'description' => '批量导库作业ID。建议您保存此ID便于后续调用其他接口时使用。',
'type' => 'string',
'example' => 'c074b118ace44395a02063a5ab94****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"c074b118ace44395a02063a5ab94****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n c074b118ace44395a02063a5ab94****\\n","errorExample":""}]',
'title' => '提交文本导库任务',
'description' => '- 本接口将文本批量导入文本DNA库,通过提取文本特征进行保存。'."\n"
.'- 文本DNA相关功能目前仅支持华东2(上海)地域使用。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => '其中,输入文件内容为所有待导入的文件信息,一行一条信息结构体,JSON结构,包含如下参数:'."\n"
.'| 名称 | 类型 |是否必选|描述|'."\n"
.'|---------------|---------|------------|-------|'."\n"
.'|PrimaryKey| String |是|唯⼀的⽂本主键,唯⼀性由⽤户保证。|'."\n"
.'|Bucket |String|是|⽂本⽂件所在OSS Bucket,遵守OSS Bucket定义,详情请参见[术语表Bucket](~~29212~~)。|'."\n"
.'| Location| String|是|⽂本⽂件OSS Bucket所在数据中⼼(OSSLocation),遵守OSS Location定义。详情请参见[术语表Location](~~29212~~)。目前仅支持oss-cn-shanghai。|'."\n"
.'| Object|String |是|⽂本⽂件(OSSObject),遵循RFC 2396(UTF-8编码,并进行URLEncode。更多信息,请参见[URLEncode说明](~~423796~~)),遵守OSSObject定义,更多信息请参见[术语表Object](~~29212~~)。|'."\n"
.'| UserData| String |否|⽤户⾃定义数据,JSON格式,可以设置底库书名+章节名,如:{"Chapter":"平凡的****/平凡的****第⼆部/第⼆部第47章.txt"};最⼤⻓度128个字节。|',
],
'ListFpShotFiles' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => [
'description' => '分页查询。请求第一页时,NextPageToken为空;请求后续文件时需传入前一页查询结果中的NextPageToken值。',
'type' => 'string',
'required' => false,
'example' => 'ae0fd49c0840e14daf0d66a75b83****',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '单页数据个数,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'FpDBId',
'in' => 'query',
'schema' => [
'description' => '需要查询的DNA库ID。可以从[提交新建DNA库](~~170149~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2288c6ca184c0e47098a5b665e2a12****',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '入库时间范围开始时间。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为`YYYY-MM-DDThh:mm:ssZ`。'."\n"
."\n"
.'> 此参数支持使用的地域为华北2(北京)、华东1(杭州)、华东2(上海),暂不支持亚太东南1(新加坡)地域使用。',
'type' => 'string',
'required' => false,
'example' => '2022-09-01T00:00:28Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '入库时间范围结束时间。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为`YYYY-MM-DDThh:mm:ssZ`。'."\n"
.'> 此参数支持使用的地域为华北2(北京)、华东1(杭州)、华东2(上海),暂不支持亚太东南1(新加坡)地域使用。',
'type' => 'string',
'required' => false,
'example' => '2022-09-08T23:32:56Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'NextPageToken' => [
'description' => '下一页Token。',
'type' => 'string',
'example' => 'ae0fd49c0840e14daf0d66a75b83****',
],
'FpShotFileList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpShotFile' => [
'description' => '视频DNA文件列表。更多信息请参见[数据类型FpShotFile](~~29251~~)。',
'type' => 'array',
'items' => [
'description' => '视频DNA文件详细信息。',
'type' => 'object',
'properties' => [
'PrimaryKey' => [
'description' => '视频唯一主键。',
'type' => 'string',
'example' => 'fb712a6890464059b1b2ea7c8647****',
],
'InputFile' => [
'description' => '作业输入。',
'type' => 'object',
'properties' => [
'Object' => [
'description' => '输入文件的OSS Object。',
'type' => 'string',
'example' => 'example-****.mp4',
],
'Location' => [
'description' => '输入文件的OSS Location。',
'type' => 'string',
'example' => 'oss-cn-beijing',
],
'Bucket' => [
'description' => '输入文件的OSS Bucket。',
'type' => 'string',
'example' => 'example-bucket-****',
],
],
],
'FileId' => [
'description' => '视频文件ID。',
'type' => 'string',
'example' => '41e6536e4f2250e2e9bf26cdea19****',
],
'StoreTime' => [
'description' => '入库时间。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为`YYYY-MM-DDThh:mm:ssZ`。'."\n"
.'> 此参数支持使用的地域为华北2(北京)、华东1(杭州)、华东2(上海),暂不支持亚太东南1(新加坡)地域使用。',
'type' => 'string',
'example' => '2022-09-08T23:32:56Z',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter.OutOfRange',
'errorMessage' => 'The specified parameter %s is out of range.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NextPageToken\\": \\"ae0fd49c0840e14daf0d66a75b83****\\",\\n \\"FpShotFileList\\": {\\n \\"FpShotFile\\": [\\n {\\n \\"PrimaryKey\\": \\"fb712a6890464059b1b2ea7c8647****\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-****.mp4\\",\\n \\"Location\\": \\"oss-cn-beijing\\",\\n \\"Bucket\\": \\"example-bucket-****\\"\\n },\\n \\"FileId\\": \\"41e6536e4f2250e2e9bf26cdea19****\\",\\n \\"StoreTime\\": \\"2022-09-08T23:32:56Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n ae0fd49c0840e14daf0d66a75b83****\\n \\n fb712a6890464059b1b2ea7c8647****\\n \\n \\n oss-cn-beijing\\n example-bucket-****\\n \\n 41e6536e4f2250e2e9bf26cdea19****\\n 2022-09-08T23:32:56Z\\n \\n","errorExample":""}]',
'title' => '查询DNA库文件列表',
'summary' => '查询DNA库文件列表。',
'description' => '- 本接口通过DNA库ID查询文件列表,支持分页查询。'."\n"
.'- 本接口目前支持使用的地域为华北2(北京)、华东1(杭州)、华东2(上海)、亚太东南1(新加坡)、沙特(利雅得)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitFpFileDeleteJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,用于绑定消息通知,可以通过**MPS控制台** > **全局设置** > **管道**获取。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ed450ea0bfbd41e29f80a401fb4d****',
],
],
[
'name' => 'FpDBId',
'in' => 'query',
'schema' => [
'description' => 'DNA库ID,可以从[提交新建DNA库](~~170149~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '88c6ca184c0e432bbf5b665e2a15****',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,支持中英文、数字等,最大长度128个字节。',
'type' => 'string',
'required' => false,
'example' => 'example data',
],
],
[
'name' => 'FileIds',
'in' => 'query',
'schema' => [
'description' => '需要删除的文件ID,用半角逗号(,)分隔,一次最多删除200个。可以从[查询DNA库文件列表](~~209266~~)的返回参数中获取。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '41e6536e4f2250e2e9bf26cdea19****',
],
],
[
'name' => 'PrimaryKeys',
'in' => 'query',
'schema' => [
'description' => '需要删除的文件PrimaryKey,用半角逗号(,)分隔,一次最多删除200个。可以从[查询DNA库文件列表](~~209266~~)的返回参数中获取。'."\n"
."\n"
.'> 此参数当前仅支持华北2(北京)、华东1(杭州)、华东2(上海)地域使用。',
'type' => 'string',
'required' => false,
'example' => '24e0fba7188fae707e146esa54****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12',
],
'JobId' => [
'description' => 'DNA文件删除作业ID。',
'type' => 'string',
'example' => '39f8e0bc005e4f309379701645f4****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter.DBNotExist',
'errorMessage' => 'The DNA database does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D127C68E-F1A1-4CE5-A874-8FF724881A12\\",\\n \\"JobId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D127C68E-F1A1-4CE5-A874-8FF724881A12\\n 39f8e0bc005e4f309379701645f4****\\n","errorExample":""}]',
'title' => '提交删除DNA文件',
'summary' => '提交删除DNA文件作业。',
'description' => '- 本接口一次最多删除200个DNA文件。'."\n"
."\n"
.'- 本接口当前支持地域为华北2(北京)、华东1(杭州)、华东2(上海)、亚太东南1(新加坡)、沙特(利雅得)。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFpFileDeleteJobList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobIds',
'in' => 'query',
'schema' => [
'description' => 'DNA删除作业ID,可以从[提交删除DNA文件作业](~~209274~~)的返回参数中获取。以半角逗号(,)分隔,如果为空则返回最近20个作业列表。',
'type' => 'string',
'required' => false,
'example' => 'd98459323c024947a104f6a50cbf****,c2dc694696f1441591c5012a73c1****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12',
],
'FpFileDeleteJobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpFileDeleteJob' => [
'description' => '删除的DNA作业列表。更多信息请参见[数据类型FpFileDeleteJob](~~93555~~)。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-06-30T00:33:18Z',
],
'Status' => [
'description' => '作业状态。可取值:'."\n"
."\n"
.'- **Queuing**:排队中。'."\n"
."\n"
.'- **Analysing**:分析中。'."\n"
."\n"
.'- **Success**:成功。'."\n"
."\n"
.'- **Fail**:失败。',
'type' => 'string',
'example' => 'Success',
],
'FinishTime' => [
'description' => '完成时间。',
'type' => 'string',
'example' => '2020-06-30T00:34:02Z',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'example data',
],
'Code' => [
'description' => '分析失败时错误码。如果执行成功则不返回。',
'type' => 'string',
'example' => 'ServiceUnavailable',
],
'Message' => [
'description' => '分析失败时错误信息。如果执行成功则不返回。',
'type' => 'string',
'example' => 'The request has failed due to a temporary failure of the server.',
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'fb712a6890464059b1b2ea7c8647****',
],
'FpDBId' => [
'description' => 'DNA库ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'Id' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '25bacf2824614bcf9273dc0744db****',
],
'FileIds' => [
'description' => '文件ID。',
'type' => 'string',
'example' => '41e6536e4f2250e2e9bf26cdea19****',
],
],
],
],
],
],
'NonExistIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '返回参数。',
'type' => 'array',
'items' => [
'description' => '不存在的作业ID列表。',
'type' => 'string',
'example' => 'c2dc694696f1441591c5012a73c1****',
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D127C68E-F1A1-4CE5-A874-8FF724881A12\\",\\n \\"FpFileDeleteJobList\\": {\\n \\"FpFileDeleteJob\\": [\\n {\\n \\"CreationTime\\": \\"2020-06-30T00:33:18Z\\",\\n \\"Status\\": \\"Success\\",\\n \\"FinishTime\\": \\"2020-06-30T00:34:02Z\\",\\n \\"UserData\\": \\"example data\\",\\n \\"Code\\": \\"ServiceUnavailable\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"PipelineId\\": \\"fb712a6890464059b1b2ea7c8647****\\",\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Id\\": \\"25bacf2824614bcf9273dc0744db****\\",\\n \\"FileIds\\": \\"41e6536e4f2250e2e9bf26cdea19****\\"\\n }\\n ]\\n },\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"c2dc694696f1441591c5012a73c1****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D127C68E-F1A1-4CE5-A874-8FF724881A12\\n \\n 2020-06-30T00:33:18Z\\n Success\\n 2020-06-30T00:34:02Z\\n example data\\n ServiceUnavailable\\n The request has failed due to a temporary failure of the server.\\n fb712a6890464059b1b2ea7c8647****\\n 88c6ca184c0e47098a5b665e2a12****\\n 25bacf2824614bcf9273dc0744db****\\n 41e6536e4f2250e2e9bf26cdea19****\\n \\n c2dc694696f1441591c5012a73c1****\\n","errorExample":""}]',
'title' => '查询删除DNA文件',
'summary' => '查询删除DNA文件作业。',
'description' => '本接口通过DNA文件删除作业ID查询作业详情,如果为空则返回最近20个作业列表。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitFpDBDeleteJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'query',
'schema' => [
'description' => '管道ID,用于绑定消息通知。可以通过**MPS控制台** > **全局设置** > **管道**获取。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'fb712a6890464059b1b2ea7c8647****',
],
],
[
'name' => 'FpDBId',
'in' => 'query',
'schema' => [
'description' => 'DNA库ID,可以从[提交新建DNA库](~~170149~~)的返回参数中获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,支持中英文、数字等,最大长度128个字节。',
'type' => 'string',
'required' => false,
'example' => 'example data',
],
],
[
'name' => 'DelType',
'in' => 'query',
'schema' => [
'description' => '操作类型,支持类型:'."\n"
."\n"
.'- **Purge**:清空DNA库,即删除DNA库中所有内容,不会删除DNA库。'."\n"
."\n"
.'- **Delete**:删除DNA库,即删除此DNA库。其中,modelId在[11, 14]内的新版本指纹库仅支持删除操作。'."\n"
."\n"
.'- 默认值:**Purge**。',
'type' => 'string',
'required' => false,
'example' => 'Purge',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4247B23C-26DE-529F-8D9F-FD6811AE979B',
],
'JobId' => [
'description' => '清空或删除DNA库作业ID。建议您保存此ID便于后续使用其他接口时使用。',
'type' => 'string',
'example' => 'd98459323c024947a104f6a50cbf****',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4247B23C-26DE-529F-8D9F-FD6811AE979B\\",\\n \\"JobId\\": \\"d98459323c024947a104f6a50cbf****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4247B23C-26DE-529F-8D9F-FD6811AE979B\\n d98459323c024947a104f6a50cbf****\\n","errorExample":""}]',
'title' => '提交清空或删除DNA库',
'summary' => '提交清空或删除DNA库作业。',
'description' => '本接口通过指定DNA库ID实现清空(删除DNA库中所有内容,不会删除DNA库)或删除(直接删除DNA库)操作,如果不指定操作类型,则默认清空DNA库。其中,modelId在[11, 14]内的新版本指纹库仅支持删除操作,即DelType=Delete。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFpDBDeleteJobList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobIds',
'in' => 'query',
'schema' => [
'description' => '清空或删除DNA库作业ID,可以从[提交清空或删除DNA库作业](~~209341~~)的返回参数中获取。以半角逗号(,)分隔,如果为空则返回最近20个作业列表。',
'type' => 'string',
'required' => false,
'example' => '2288c6ca184c0e47098a5b665e2a12****,78dc866518b843259669df58ed30****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4247B23C-26DE-529F-8D9F-FD6811AE979B',
],
'FpDBDeleteJobList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FpDBDeleteJob' => [
'description' => '删除DNA库作业列表。参见[数据类型FpDBDeleteJob](~~93555~~)。',
'type' => 'array',
'items' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-06-30T00:33:18Z',
],
'Status' => [
'description' => '作业状态。可取值:'."\n"
."\n"
.'- **Queuing**:排队中。'."\n"
."\n"
.'- **Analysing**:分析中。'."\n"
."\n"
.'- **Success**:成功。'."\n"
."\n"
.'- **Fail**:失败。',
'type' => 'string',
'example' => 'Success',
],
'FinishTime' => [
'description' => '完成时间。',
'type' => 'string',
'example' => '2020-06-30T00:34:02Z',
],
'DelType' => [
'description' => '操作类型。',
'type' => 'string',
'example' => 'Purge',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => 'example data',
],
'Code' => [
'description' => '分析失败时错误码。如果执行成功则不返回。',
'type' => 'string',
'example' => 'ServiceUnavailable',
],
'Message' => [
'description' => '分析失败时错误信息。如果执行成功则不返回。',
'type' => 'string',
'example' => 'The request has failed due to a temporary failure of the server.',
],
'PipelineId' => [
'description' => '管道ID。',
'type' => 'string',
'example' => 'fb712a6890464059b1b2ea7c8647****',
],
'FpDBId' => [
'description' => 'DNA库ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
'Id' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '25bacf2824614bcf9273dc0744db****',
],
],
],
],
],
],
'NonExistIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '不存在的ID列表。',
'type' => 'array',
'items' => [
'description' => '不存在的作业ID列表。如果为空则不返回此参数。',
'type' => 'string',
'example' => '78dc866518b843259669df58ed30****',
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4247B23C-26DE-529F-8D9F-FD6811AE979B\\",\\n \\"FpDBDeleteJobList\\": {\\n \\"FpDBDeleteJob\\": [\\n {\\n \\"CreationTime\\": \\"2020-06-30T00:33:18Z\\",\\n \\"Status\\": \\"Success\\",\\n \\"FinishTime\\": \\"2020-06-30T00:34:02Z\\",\\n \\"DelType\\": \\"Purge\\",\\n \\"UserData\\": \\"example data\\",\\n \\"Code\\": \\"ServiceUnavailable\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"PipelineId\\": \\"fb712a6890464059b1b2ea7c8647****\\",\\n \\"FpDBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Id\\": \\"25bacf2824614bcf9273dc0744db****\\"\\n }\\n ]\\n },\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"78dc866518b843259669df58ed30****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4247B23C-26DE-529F-8D9F-FD6811AE979B\\n \\n 2020-06-30T00:33:18Z\\n Success\\n 2020-06-30T00:34:02Z\\n Purge\\n example data\\n fb712a6890464059b1b2ea7c8647****\\n 88c6ca184c0e47098a5b665e2a12****\\n 25bacf2824614bcf9273dc0744db****\\n \\n 78dc866518b843259669df58ed30****\\n","errorExample":""}]',
'title' => '查询清空或删除DNA库',
'summary' => '查询清空或删除DNA库作业。',
'description' => '本接口通过清空或删除DNA库作业ID进行查询,如果不传入ID则默认返回最近20个作业列表。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListFpShotImportJob' => [
'summary' => '查询文本导库作业。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobIds',
'in' => 'query',
'schema' => [
'description' => '作业ID列表,可以从[提交文本导库作业](~~312262~~)的返回参数中获取。一次最多查询10个,用半角逗号(,)分隔。',
'type' => 'string',
'required' => true,
'example' => '88c6ca184c0e47098a5b665e2a12****,c074b118ace44395a02063a5ab94****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '25818875-5F78-4A13-BEF6-D7393642CA58',
],
'NonExistIds' => [
'description' => '不存在的作业ID列表,无数据时该结构不返回。',
'type' => 'array',
'items' => [
'description' => '不存在的作业ID。',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
],
'FpShotImportJobList' => [
'description' => '文本DNA导库作业。',
'type' => 'array',
'items' => [
'description' => '文本DNA导库作业详细信息。',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '导库ID。',
'type' => 'string',
'example' => '25bacf2824614bcf9273dc0744db****',
],
'FpDBId' => [
'description' => 'DNA库ID。',
'type' => 'string',
'example' => '2288c6ca184c0e47098a5b665e2a12****',
],
'PipelineId' => [
'description' => '作业管道ID。',
'type' => 'string',
'example' => 'ebb51ee30f0b49aba959823fa991****',
],
'FpImportConfig' => [
'description' => '导库配置。',
'type' => 'string',
'example' => '""',
],
'Status' => [
'description' => '导库作业状态。可取值:'."\n"
."\n"
.'- Processing:处理中。'."\n"
."\n"
.'- Fail:失败。'."\n"
."\n"
.'- Success:成功。',
'type' => 'string',
'example' => 'Success',
],
'Code' => [
'description' => '导库作业错误码。',
'type' => 'string',
'example' => '0',
],
'Message' => [
'description' => '导库作业错误信息。',
'type' => 'string',
'example' => 'Success',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-06-30T00:33:18Z',
],
'FinishTime' => [
'description' => '结束时间。',
'type' => 'string',
'example' => '2020-06-30T00:34:02Z',
],
'UserData' => [
'description' => '用户自定义数据。',
'type' => 'string',
'example' => '001',
],
'Input' => [
'description' => '输入文件。',
'type' => 'string',
'example' => '{\\"Bucket\\":\\"mts-example****\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"Object\\":\\"test-0828/video/test.mp4\\"}',
],
'ProcessMessage' => [
'description' => '导库任务处理信息。',
'type' => 'string',
'example' => 'http://testbucket.oss-cn-shanghai.aliyuncs.com/932ajjw***32ssoj_importResult.txt',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"NonExistIds\\": [\\n \\"88c6ca184c0e47098a5b665e2a12****\\"\\n ],\\n \\"FpShotImportJobList\\": [\\n {\\n \\"Id\\": \\"25bacf2824614bcf9273dc0744db****\\",\\n \\"FpDBId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\",\\n \\"PipelineId\\": \\"ebb51ee30f0b49aba959823fa991****\\",\\n \\"FpImportConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success\\",\\n \\"CreateTime\\": \\"2020-06-30T00:33:18Z\\",\\n \\"FinishTime\\": \\"2020-06-30T00:34:02Z\\",\\n \\"UserData\\": \\"001\\",\\n \\"Input\\": \\"{\\\\\\\\\\\\\\"Bucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mts-example****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-shanghai\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Object\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0828/video/test.mp4\\\\\\\\\\\\\\"}\\",\\n \\"ProcessMessage\\": \\"http://testbucket.oss-cn-shanghai.aliyuncs.com/932ajjw***32ssoj_importResult.txt\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 25818875-5F78-4A13-BEF6-D7393642CA58\\n 88c6ca184c0e47098a5b665e2a12****\\n \\n 25bacf2824614bcf9273dc0744db****\\n 2288c6ca184c0e47098a5b665e2a12****\\n ebb51ee30f0b49aba959823fa991****\\n \\"\\"\\n Success\\n 0\\n Success\\n 2020-06-30T00:33:18Z\\n 2020-06-30T00:34:02Z\\n 001\\n {\\\\\\"Bucket\\\\\\":\\\\\\"mts-example****\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"test-0828/video/test.mp4\\\\\\"}\\n \\n","errorExample":""}]',
'title' => '查询文本导库作业',
'description' => '文本DNA相关接口目前仅支持华东2(上海)地域使用。'."\n"
."\n"
.'## QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见[QPS限制](~~342832~~)。',
],
'SubmitCopyrightJob' => [
'summary' => '调用SubmitCopyrightJob提交视频版权水印任务。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '205603',
'abilityTreeNodes' => [
'FEATUREmtsRH229Z',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '待添加水印的媒体文件OSS地址,目前仅支持视频文件,JSON对象。详细信息请参见[Input详情](~~29253~~)。'."\n"
."\n"
.'> - OSS的地域需要与当前MPS所在地域保持一致。'."\n"
.' '."\n"
.'- Bucket:输入文件OSS Bucket名称。'."\n"
.'- Location:OSS所在地域,必须和MPS服务所在地域一致。'."\n"
.'- Object:待检测OSS Object。',
'type' => 'string',
'required' => false,
'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"}',
],
],
[
'name' => 'Output',
'in' => 'query',
'schema' => [
'description' => '文件输出OSS地址,JSON对象。'."\n"
."\n"
.'> - OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"}',
],
],
[
'name' => 'Message',
'in' => 'query',
'schema' => [
'title' => '水印信息',
'description' => '待添加的水印信息。',
'type' => 'string',
'required' => true,
'example' => '平头哥半导体公司',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '水印嵌入开始时间,单位为秒,不填写默认为0。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'TotalTime',
'in' => 'query',
'schema' => [
'description' => '水印嵌入总时间,单位为秒,不填写默认为视频时长。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'Level',
'in' => 'query',
'schema' => [
'description' => '水印级别,取值0/1/2,表示嵌入通道,0u,1uv,2yuv。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '水印信息描述。',
'type' => 'string',
'required' => false,
'example' => '地址 : 上海市浦东新区上科路川和路',
],
],
[
'name' => 'CallBack',
'in' => 'query',
'schema' => [
'description' => '任务结果回调URL,目前仅支持HTTP地址。',
'type' => 'string',
'required' => false,
'example' => 'http://example.com/callback',
],
],
[
'name' => 'Url',
'in' => 'query',
'schema' => [
'description' => '可公网访问的视频URL链接。填写后优先将其作为任务输入,其次再考虑Input输入。',
'type' => 'string',
'required' => false,
'example' => 'http://www.example.com/video/test.mp4',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,最大长度1024字节。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '水印任务参数,JSONString。目前支持设置参数如下:'."\n"
."\n"
.'- algoType:算法类型,默认值为v1。'."\n"
.' - v1:长视频版权水印,仅支持3min以上的。'."\n"
.' - v2:短视频版权水印。',
'type' => 'string',
'required' => false,
'example' => '{"algoType":"v2"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'JobId' => [
'title' => '任务id',
'description' => '任务id',
'type' => 'string',
'example' => 'bfb786c639894f4d80648792021e****',
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FA258E67-09B8-4EAA-8F33-BA567834A2C3\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '提交视频版权水印作业',
'description' => '- 提交视频版权水印作业默认仅支持3分钟及以上视频,视频时间过短会导致接口调用失败或无输出。如果需要对3分钟以内的短视频添加版权水印,可以通过Params参数指定,详见参数描述。'."\n"
."\n"
.'- 提交视频版权水印作业每次接口的调用,都是对独立视频进行添加水印,不支持多个视频同时提交。'."\n"
."\n"
.'- 目前数字水印相关接口只支持华东2(上海)、华北 2(北京)地域使用。',
],
'QueryCopyrightJob' => [
'summary' => '调用此接口查询视频版权水印作业。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '222519',
'abilityTreeNodes' => [
'FEATUREmtsRH229Z',
],
],
'parameters' => [
[
'name' => 'CreateTimeStart',
'in' => 'query',
'schema' => [
'description' => '起始创建时间,时间戳形式。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1627357322',
],
],
[
'name' => 'CreateTimeEnd',
'in' => 'query',
'schema' => [
'description' => '截止创建时间,时间戳形式。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1627357325',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '任务Id。',
'type' => 'string',
'required' => false,
'example' => '2a0697e35a7342859f733a9190c4****',
],
],
[
'name' => 'Level',
'in' => 'query',
'schema' => [
'description' => '水印级别,取值0/1/2,表示嵌入通道,0u,1uv,2yuv。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '翻页下标。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页数量。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '5CA6E020-4102-4FFF-AA56-5ED7ECD811A1',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Callback' => [
'title' => '回调url',
'description' => '回调url',
'type' => 'string',
'example' => 'http://callbacktest.com/callback',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1627357322',
],
'GmtModified' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1627357328',
],
'Input' => [
'title' => '水印视频输入',
'description' => '水印视频输入',
'type' => 'string',
'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"gambling.mp4"}',
],
'JobId' => [
'title' => '任务id',
'description' => '任务id',
'type' => 'string',
'example' => 'bfb786c639894f4d80648792021e****',
],
'Level' => [
'title' => '水印强度',
'description' => '水印强度',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'Message' => [
'title' => '水印信息',
'description' => '水印信息',
'type' => 'string',
'example' => '平头哥半导体(上海)',
],
'Output' => [
'title' => '水印视频输出',
'description' => '水印视频输出',
'type' => 'string',
'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}',
],
'Status' => [
'title' => '状态',
'description' => '状态',
'type' => 'string',
'example' => 'success',
],
'UserData' => [
'title' => '用户数据',
'description' => '用户数据',
'type' => 'string',
'example' => '123',
],
'UserId' => [
'title' => '用户ID',
'description' => '用户ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1346693***',
],
'Result' => [
'title' => '任务结果',
'description' => '任务结果',
'type' => 'string',
'example' => '{"Code":"success","Message":"ok"}',
],
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CA6E020-4102-4FFF-AA56-5ED7ECD811A1\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": [\\n {\\n \\"Callback\\": \\"http://callbacktest.com/callback\\",\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357328,\\n \\"Input\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"gambling.mp4\\\\\\"}\\",\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"Level\\": 2,\\n \\"Message\\": \\"平头哥半导体(上海)\\",\\n \\"Output\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"out.mp4\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0,\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\"\\n }\\n ],\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '查询视频版权水印作业',
'description' => '- 目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。 '."\n"
.'- 最大可查询历史数据(Job信息)的时间范围为6个月。',
],
'SubmitTraceAbJob' => [
'summary' => '通过调用SubmitTraceAbJob接口提交视频溯源水印ab流任务。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '222515',
'abilityTreeNodes' => [
'FEATUREmtsGVUB1B',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '溯源水印ab流处理视频输入OSS地址。OSS的地域需要与当前MPS所在地域保持一致。'."\n"
."\n\n"
.'> 提交视频溯源水印ab流作业目前仅支持3分钟及以上视频,视频时间过短会导致接口调用失败或无输出。',
'type' => 'string',
'required' => false,
'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"test.mp4"}',
],
],
[
'name' => 'Output',
'in' => 'query',
'schema' => [
'description' => '溯源水印ab流处理输出OSS地址。需要注意的是,配置的是输出目录Dir。',
'type' => 'string',
'required' => true,
'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Dir":"out/"}',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '水印嵌入开始时间。单位:秒。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'TotalTime',
'in' => 'query',
'schema' => [
'description' => '水印嵌入总时间。单位:秒。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '360',
],
],
[
'name' => 'Level',
'in' => 'query',
'schema' => [
'description' => '水印级别,取值0/1/2,表示嵌入通道,0u,1uv,2yuv。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'CallBack',
'in' => 'query',
'schema' => [
'description' => '任务结果回调URL,目前仅支持HTTP地址。',
'type' => 'string',
'required' => false,
'example' => 'http://example.com/callback',
],
],
[
'name' => 'Url',
'in' => 'query',
'schema' => [
'description' => '可公网访问的视频URL链接。填写后优先将其作为任务输入,其次再考虑Input输入。',
'type' => 'string',
'required' => false,
'example' => 'http://www.example.com/video/test.mp4',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,最大长度1024个字节。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'CipherBase64ed',
'in' => 'query',
'schema' => [
'description' => 'base64后的加密密钥。',
'type' => 'string',
'required' => false,
'example' => 'Qh6OdgIMcliQSI1fReOw****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '030E2671-806A-52AF-A93C-DA8E308603A6',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'JobId' => [
'title' => '任务Id',
'description' => '任务Id',
'type' => 'string',
'example' => 'bfb786c639894f4d80648792021e****',
],
'MediaId' => [
'title' => '媒体Id',
'description' => '媒体Id',
'type' => 'string',
'example' => '437bd2b516ffda105d07b12a9a82****',
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"030E2671-806A-52AF-A93C-DA8E308603A6\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"MediaId\\": \\"437bd2b516ffda105d07b12a9a82****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '提交视频溯源水印ab流作业',
'description' => '- 提交视频溯源水印ab流作业目前仅支持3分钟及以上视频,视频时间过短会导致接口调用失败或无输出。'."\n"
."\n"
.'- 目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。',
],
'QueryTraceAbJob' => [
'summary' => '调用此接口查询视频溯源水印ab流作业。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '222523',
'abilityTreeNodes' => [
'FEATUREmtsGVUB1B',
],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '任务ID。可以从提交视频溯源水印ab流的返回参数中获取。',
'type' => 'string',
'required' => false,
'example' => '31fa3c9ca8134fb4b0b0f7878301****',
],
],
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => '媒体ID。',
'type' => 'string',
'required' => false,
'example' => '3e6149d5a8c944c09b1a8d2dc3e4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Callback' => [
'title' => '回调url',
'description' => '回调url',
'type' => 'string',
'example' => 'http://callbacktest.com/callback',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1627357322',
],
'GmtModified' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1627357325',
],
'Input' => [
'title' => '水印视频输入',
'description' => '水印视频输入',
'type' => 'string',
'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"test.mp4"}',
],
'JobId' => [
'title' => '任务id',
'description' => '任务id',
'type' => 'string',
'example' => 'bfb786c639894f4d80648792021e****',
],
'Level' => [
'title' => '水印强度',
'description' => '水印强度',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'MediaId' => [
'title' => '媒体id',
'description' => '媒体id',
'type' => 'string',
'example' => '437bd2b516ffda105d07b12a9a82****',
],
'Output' => [
'title' => '水印视频输出',
'description' => '水印视频输出',
'type' => 'string',
'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}',
],
'Status' => [
'title' => '状态',
'description' => '状态',
'type' => 'string',
'example' => 'success',
],
'UserData' => [
'title' => '用户数据',
'description' => '用户数据',
'type' => 'string',
'example' => '123',
],
'UserId' => [
'title' => '用户ID',
'description' => '用户ID',
'type' => 'integer',
'format' => 'int64',
'example' => '13466****',
],
'Result' => [
'title' => '任务结果',
'description' => '任务结果',
'type' => 'string',
'example' => '{"Code":"success","Message":"ok"}',
],
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": [\\n {\\n \\"Callback\\": \\"http://callbacktest.com/callback\\",\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357325,\\n \\"Input\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"test.mp4\\\\\\"}\\",\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"Level\\": 2,\\n \\"MediaId\\": \\"437bd2b516ffda105d07b12a9a82****\\",\\n \\"Output\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"out.mp4\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0,\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\"\\n }\\n ],\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '查询视频溯源水印ab流作业',
'description' => '目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。',
],
'SubmitTraceM3u8Job' => [
'summary' => '调用此接口提交视频溯源水印m3u8任务。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '222530',
'abilityTreeNodes' => [
'FEATUREmtsGVUB1B',
],
],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'query',
'schema' => [
'description' => 'ab流处理后的媒体ID。可以从提交视频溯源水印ab流接口的返回参数中获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '437bd2b516ffda105d07b12a9a82****',
],
],
[
'name' => 'Output',
'in' => 'query',
'schema' => [
'description' => 'm3u8文件输出OSS地址。'."\n"
."\n\n"
.'> OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"Bucket":"exampleBucket","Location":"oss-cn-shanghai","Object":"out.m3u8"}',
],
],
[
'name' => 'Trace',
'in' => 'query',
'schema' => [
'description' => '溯源水印信息。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '今天星期一'."\n",
],
],
[
'name' => 'KeyUri',
'in' => 'query',
'schema' => [
'description' => '密钥服务器uri。',
'type' => 'string',
'required' => false,
'example' => 'https://cipher.abc.com'."\n",
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '水印任务参数,JSONString。目前支持设置参数如下:'."\n"
."\n"
.'- m3u8Type:算法类型,默认值为v1。'."\n"
."\n"
.' - v1:生成绝对路径的m3u8,可直接播放。签名鉴权有效期为24小时,过期后需重新提交任务获取m3u8。'."\n"
."\n"
.' - v2:生成相对路径的m3u8,需要和ts文件放在相同路径下。',
'type' => 'string',
'required' => false,
'example' => '{"m3u8Type":"v1"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'DEB915C5-D001-5C17-AF65-FF8A65DFE432',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'JobId' => [
'title' => '任务id',
'description' => '任务id',
'type' => 'string',
'example' => 'bfb786c639894f4d80648792021e****',
],
],
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DEB915C5-D001-5C17-AF65-FF8A65DFE432\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\"\\n}","type":"json"}]',
'title' => '提交视频溯源水印m3u8作业',
'description' => '- 使用本接口前需先调用提交视频溯源水印ab流,获取到ab流处理后的媒体ID,再调用本接口进行处理。'."\n"
."\n"
.'- 目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。'."\n"
."\n"
.'- 经过视频溯源水印m3u8作业处理生成的m3u8文件签名鉴权有效期为24小时(从处理完成开始计时),请尽快查询,签名鉴权过期后将无法查询到该次作业的水印信息。如签名鉴权过期后需要,请重新提交视频溯源水印m3u8作业。',
],
'QueryTraceM3u8Job' => [
'summary' => '调用此接口查询视频溯源水印m3u8作业。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '222524',
'abilityTreeNodes' => [
'FEATUREmtsGVUB1B',
],
],
'parameters' => [
[
'name' => 'CreateTimeStart',
'in' => 'query',
'schema' => [
'description' => '起始创建时间,时间戳形式。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1527441300'."\n",
],
],
[
'name' => 'CreateTimeEnd',
'in' => 'query',
'schema' => [
'description' => '截止创建时间,时间戳形式。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1527441303',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '任务ID。可以从提交视频溯源水印m3u8的返回参数中获取。',
'type' => 'string',
'required' => false,
'example' => '88c6ca184c0e47098a5b665e2a12****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '翻页下标。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页数量。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '5CA6E020-4102-4FFF-AA56-5ED7ECD8****',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'description' => '返回数据',
'type' => 'array',
'items' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1627357322',
],
'GmtModified' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1627357327',
],
'MediaId' => [
'description' => '媒体ID',
'type' => 'string',
'example' => '437bd2b516ffda105d07b12a9a82****',
],
'JobId' => [
'title' => '任务id',
'description' => '任务id',
'type' => 'string',
'example' => '88c6ca184c0e47098a5b665e2a12****'."\n",
],
'Trace' => [
'title' => '水印信息',
'description' => '水印信息',
'type' => 'string',
'example' => '平头哥半导体(上海)',
],
'Output' => [
'title' => '水印视频输出',
'description' => '水印视频输出',
'type' => 'string',
'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}',
],
'Status' => [
'title' => '状态',
'description' => '状态',
'type' => 'string',
'example' => 'success',
],
'UserData' => [
'title' => '用户数据',
'description' => '用户数据',
'type' => 'string',
'example' => '123',
],
'UserId' => [
'title' => '用户ID',
'description' => '用户ID',
'type' => 'integer',
'format' => 'int64',
'example' => '13466****',
],
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CA6E020-4102-4FFF-AA56-5ED7ECD8****\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357327,\\n \\"MediaId\\": \\"437bd2b516ffda105d07b12a9a82****\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2a12****\\\\n\\",\\n \\"Trace\\": \\"平头哥半导体(上海)\\",\\n \\"Output\\": \\"{\\\\\\"Bucket\\\\\\":\\\\\\"ivison-test\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"Object\\\\\\":\\\\\\"out.mp4\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '查询视频溯源水印m3u8作业',
'description' => '- 目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。'."\n"
."\n"
.'- 经过视频溯源水印m3u8作业处理生成的绝对路径的m3u8文件签名鉴权有效期为24小时(从处理完成开始计时),请尽快查询,签名鉴权过期后将无法查询到该次作业的水印信息。如签名鉴权过期后需要,请重新提交视频溯源水印m3u8作业。'."\n"
."\n"
.'- 最大可查询历史数据(Job信息)的时间范围为6个月。',
],
'SubmitCopyrightExtractJob' => [
'summary' => '调用此接口提交版权水印提取作业。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '222529',
'abilityTreeNodes' => [
'FEATUREmtsRH229Z',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '待提取版权水印文件的输入OSS地址。',
'type' => 'string',
'required' => false,
'example' => '{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}',
],
],
[
'name' => 'CallBack',
'in' => 'query',
'schema' => [
'description' => '任务结果回调URL,目前仅支持HTTP地址。',
'type' => 'string',
'required' => false,
'example' => 'http://example.com/callback'."\n",
],
],
[
'name' => 'Url',
'in' => 'query',
'schema' => [
'description' => '可公网访问的视频URL链接。填写后优先将其作为任务输入,其次再考虑Input输入。',
'type' => 'string',
'required' => false,
'example' => 'http://www.example.com/video/test.mp4'."\n",
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,最大长度1024字节。',
'type' => 'string',
'required' => false,
'example' => '123'."\n",
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '水印任务参数,JSONString。目前支持设置参数如下:'."\n"
."\n"
.'- algoType:算法类型,默认值为v1。'."\n"
."\n"
.' - v1:长视频版权提取接口。'."\n"
.' - v2:短视频版权提取接口。',
'type' => 'string',
'required' => false,
'example' => '{"algoType":"v1"}'."\n"
."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'JobId' => [
'title' => '任务id',
'description' => '任务id',
'type' => 'string',
'example' => 'ebbfe90c63b54ed4b61acb2f6c44****',
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05F8B913-E9F3-4A6F-9922-48CADA0FFAAD\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"ebbfe90c63b54ed4b61acb2f6c44****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => ' 提交版权水印提取作业',
'description' => '目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。',
],
'QueryCopyrightExtractJob' => [
'summary' => '调用此接口查询版权水印提取信息作业。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '222525',
'abilityTreeNodes' => [
'FEATUREmtsRH229Z',
],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '任务ID。可以通过提交版权水印提取作业的返回参数中获取。',
'type' => 'string',
'required' => true,
'example' => '2288c6ca184c0e47098a5b665e2a12****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'F24EAE86-5356-528E-A2B1-FEDE269F42DD',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '版权水印信息',
'description' => '版权水印信息',
'type' => 'string',
'example' => 'example water mark'."\n",
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F24EAE86-5356-528E-A2B1-FEDE269F42DD\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"Message\\": \\"example water mark\\\\n\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '查询版权水印提取作业',
'description' => '目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。',
],
'SubmitTraceExtractJob' => [
'summary' => '调用此接口提交溯源水印提取作业。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '222528',
'abilityTreeNodes' => [
'FEATUREmtsGVUB1B',
],
],
'parameters' => [
[
'name' => 'Input',
'in' => 'query',
'schema' => [
'description' => '待提取溯源水印文件的输入OSS地址。',
'type' => 'string',
'required' => false,
'example' => '{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}'."\n",
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => [
'description' => '用户自定义数据,最大长度1024字节。',
'type' => 'string',
'required' => false,
'example' => '123'."\n",
],
],
[
'name' => 'CallBack',
'in' => 'query',
'schema' => [
'description' => '任务结果回调URL,目前仅支持HTTP地址。',
'type' => 'string',
'required' => false,
'example' => 'http://example.com/callback'."\n",
],
],
[
'name' => 'Url',
'in' => 'query',
'schema' => [
'description' => '可公网访问的视频URL链接。填写后优先将其作为任务输入,其次再考虑Input输入。',
'type' => 'string',
'required' => false,
'example' => 'http://www.example.com/video/test.mp4'."\n",
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '提取任务参数,JSONString。目前支持设置参数如下:'."\n"
."\n"
.'- m3u8Type:算法类型,默认值为v1。'."\n"
."\n"
.' - v1:提取绝对路径的m3u8。'."\n"
.' - v2:提取相对路径的m3u8。',
'type' => 'string',
'required' => false,
'example' => '{"m3u8Type":"v1"}'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A1326BD4-30B1-4CB6-Q123-3330B877B0D4',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'JobId' => [
'title' => '任务id',
'description' => '任务id',
'type' => 'string',
'example' => 'bfb786c639894f4d80648792021e****',
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1326BD4-30B1-4CB6-Q123-3330B877B0D4\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '提交溯源水印提取作业',
'description' => '目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。',
],
'QueryTraceExtractJob' => [
'summary' => '调用此接口查询溯源水印提取作业信息。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '222527',
'abilityTreeNodes' => [
'FEATUREmtsGVUB1B',
],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '任务ID。可以从提交溯源水印提取作业的返回参数中获取。',
'type' => 'string',
'required' => true,
'example' => '31fa3c9ca8134fb4b0b0f7878301****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '7D9F3008-9316-5817-BFA3-6180D752039D',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Trace' => [
'title' => '溯源水印信息',
'description' => '溯源水印信息',
'type' => 'string',
'example' => 'example water mark '."\n",
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D9F3008-9316-5817-BFA3-6180D752039D\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"Trace\\": \\"example water mark\\\\t\\\\n\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '查询溯源水印提取作业',
'description' => '目前数字水印相关接口只支持华东2(上海)、华北2(北京)地域使用。',
],
'SubmitImageCopyright' => [
'summary' => '调用此接口提交生成图片透明图水印。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '209015',
'abilityTreeNodes' => [
'FEATUREmtsRH229Z',
],
],
'parameters' => [
[
'name' => 'Output',
'in' => 'query',
'schema' => [
'description' => '水印图片输出OSS地址。'."\n"
."\n"
.'> OSS的地域需要与当前MPS所在地域保持一致。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"Bucket":"abc-test","Location":"oss-cn-shanghai","Object":"out.jpeg"}',
],
],
[
'name' => 'Message',
'in' => 'query',
'schema' => [
'title' => '水印信息',
'description' => '水印信息',
'type' => 'string',
'required' => true,
'example' => '平头哥半导体公司',
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '水印参数。参数说明:'."\n"
."\n"
.'- width:输出图像的宽。'."\n"
.'- height:输出图像的高。'."\n"
.'- afa:水印图片透明度,取值范围0~255。'."\n"
.'- type:水印类型,取值范围0(算法类型0,适用于游戏类的渲染)和1(算法类型1,适用于通用APP的渲染)。'."\n"
.'- version:水印版本,当前取值仅支持0。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"width":2999, "height":2999, "afa": 3, "type":1, "version":0}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B',
],
'Message' => [
'title' => '返回信息',
'description' => '返回信息。',
'type' => 'string',
'example' => 'ok',
],
'Data' => [
'title' => '返回数据',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'JobId' => [
'title' => '任务id',
'description' => '任务id。',
'type' => 'string',
'example' => 'bfb786c639894f4d80648792021e****',
],
],
],
'StatusCode' => [
'title' => '状态码',
'description' => '状态码。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '提交图片透明图水印',
'description' => '- 本接口目前支持的是透明图水印,是一张带有暗水印信息的透明图片,可以将该图片放置在一些页面中最顶端显示,可以对抗截图等攻击。需要填写Params、Output和Message三个参数。'."\n"
."\n"
.'- 本接口目前仅支持华东2(上海)地域使用。',
],
],
'endpoints' => [
[
'regionId' => 'cn-qingdao',
'endpoint' => 'mts.cn-qingdao.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'mts.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'mts.cn-zhangjiakou.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'mts.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'mts.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'mts.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'mts.cn-hongkong.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'mts.ap-northeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'mts.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'mts.ap-southeast-5.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'mts.us-west-1.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'mts.eu-west-1.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'mts.eu-central-1.aliyuncs.com',
],
],
];