'1.0', 'info' => ['style' => 'RPC', 'product' => 'Mts', 'version' => '2014-06-18'], 'directories' => [ [ 'children' => ['QueryMediaInfoJobList'], 'type' => 'directory', 'title' => 'Media information', ], [ 'children' => ['SubmitJobs', 'QueryJobList'], 'type' => 'directory', 'title' => 'Transcoding', ], [ 'children' => ['QuerySnapshotJobList'], 'type' => 'directory', 'title' => 'Snapshot', ], [ 'children' => ['QueryPipelineList', 'SearchPipeline', 'AddPipeline'], 'type' => 'directory', 'title' => 'MPS queue', ], [ 'children' => ['AddMediaWorkflow', 'UpdateMediaWorkflow'], 'type' => 'directory', 'title' => 'Media workflow', ], [ 'children' => ['UnbindOutputBucket'], 'type' => 'directory', 'title' => 'Media bucket', ], [ 'children' => ['AddMedia', 'QueryMediaList', 'QueryMediaListByURL'], 'type' => 'directory', 'title' => 'Media', ], [ 'children' => ['ImAudit'], 'type' => 'directory', 'title' => 'Content moderation', ], [ 'children' => ['SubmitFpShotJob', 'QueryFpShotJobList', 'CreateFpShotDB', 'ListFpShotDB', 'ImportFpShotJob', 'SubmitFpDBDeleteJob', 'QueryFpDBDeleteJobList'], 'type' => 'directory', 'title' => 'Video DNA', ], [ 'children' => ['SubmitImageCopyright'], 'type' => 'directory', 'title' => 'Digital watermark', ], [ 'children' => [ 'ActivateMediaWorkflow', 'AddMediaTag', 'AddSmarttagTemplate', 'AddTemplate', 'AddWaterMarkTemplate', 'BindInputBucket', 'BindOutputBucket', 'CancelJob', 'CreateCustomEntity', 'CreateCustomGroup', 'DeactivateMediaWorkflow', 'DeleteCustomEntity', 'DeleteCustomGroup', 'DeleteCustomView', 'DeleteMedia', 'DeleteMediaTag', 'DeleteMediaWorkflow', 'DeletePipeline', 'DeleteSmarttagTemplate', 'DeleteTemplate', 'DeleteWaterMarkTemplate', 'ListAllMediaBucket', 'ListCustomEntities', 'ListCustomGroups', 'ListCustomPersons', 'ListCustomViews', 'ListFpShotFiles', 'ListFpShotImportJob', 'ListJob', 'ListMediaWorkflowExecutions', 'QueryAnalysisJobList', 'QueryCopyrightExtractJob', 'QueryCopyrightJob', 'QueryFpFileDeleteJobList', 'QueryIProductionJob', 'QueryMediaCensorJobDetail', 'QueryMediaCensorJobList', 'QueryMediaWorkflowExecutionList', 'QueryMediaWorkflowList', 'QuerySmarttagJob', 'QuerySmarttagTemplateList', 'QueryTemplateList', 'QueryTraceAbJob', 'QueryTraceExtractJob', 'QueryTraceM3u8Job', 'QueryWaterMarkTemplateList', 'RegisterCustomFace', 'RegisterCustomView', 'SearchMediaWorkflow', 'SearchTemplate', 'SearchWaterMarkTemplate', 'SubmitAnalysisJob', 'SubmitCopyrightExtractJob', 'SubmitCopyrightJob', 'SubmitFpFileDeleteJob', 'SubmitIProductionJob', 'SubmitMediaCensorJob', 'SubmitMediaInfoJob', 'SubmitSmarttagJob', 'SubmitSnapshotJob', 'SubmitTraceAbJob', 'SubmitTraceExtractJob', 'SubmitTraceM3u8Job', 'TagCustomPerson', 'UnbindInputBucket', 'UnregisterCustomFace', 'UpdateMedia', 'UpdateMediaCategory', 'UpdateMediaCover', 'UpdateMediaPublishState', 'UpdateMediaWorkflowTriggerMode', 'UpdatePipeline', 'UpdateSmarttagTemplate', 'UpdateTemplate', 'UpdateWaterMarkTemplate', ], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ActivateMediaWorkflow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaWorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media workflow. You can obtain the ID from the response of the [AddMediaWorkflow](~~44437~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => '93ab850b4f6f44eab54b6e9181d4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A1326BD4-30B1-4CB6-Q123-3330B877B0D4', 'title' => ''], 'MediaWorkflow' => [ 'description' => 'The details of the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '2016-04-01T05:29:37Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow.'."\n", 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e9181d4****', 'title' => ''], 'State' => ['description' => 'The status of the media workflow. The value is **Active**.'."\n", 'type' => 'string', 'example' => 'Active', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'mediaworkflow-example', 'title' => ''], 'Topology' => ['description' => 'The topology of the media workflow.'."\n", '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\\"]}}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'ActivateMediaWorkflow', 'summary' => 'Activates a media workflow.', 'description' => 'You can call this operation to activate a media workflow that has been deactivated. After you activate a media workflow, you cannot modify the workflow information, such as the name, topology, or trigger mode. A media workflow is activated by default after it is created.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateMediaWorkflow'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:ActivateMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'AddMedia' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'FileURL', 'in' => 'query', 'schema' => ['description' => 'The OSS URL of the input file. You can obtain this URL from the MPS console or the OSS console. For details about trigger rules, see the **Workflow trigger matching rules**.'."\n" ."\n" .'- Only OSS HTTP URLs are supported. CDN and HTTPS URLs are not supported.'."\n" ."\n" .'- The URL can be up to 3,200 bytes in length.'."\n" ."\n" .'- The URL must be URL-encoded, in UTF-8, and compliant with RFC 2396. For more information, see [URL Encoding](~~423796~~).', 'type' => 'string', 'required' => true, 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the media file.'."\n" ."\n" .'- Maximum length: 128 bytes.'."\n" ."\n" .'- UTF-8 encoded.', 'type' => 'string', 'required' => false, 'example' => 'mytest', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the media file.'."\n" ."\n" .'- Maximum length: 1,024 bytes.'."\n" ."\n" .'- UTF-8 encoded.', 'type' => 'string', 'required' => false, 'example' => 'A test video', 'title' => ''], ], [ 'name' => 'CoverURL', 'in' => 'query', 'schema' => ['description' => 'The URL of the media cover. You can obtain the URL in the **MPS console** (**Workflow Management** > **Media Buckets**) or the **OSS console** (**My Access Paths**).'."\n" ."\n" .'- The URL can be up to 3,200 bytes in length.'."\n" ."\n" .'- The URL must be URL-encoded, in UTF-8, and compliant with RFC 2396. For more information, see [URL Encoding](~~423796~~).', 'type' => 'string', 'required' => false, 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'A list of tags.'."\n" ."\n" .'> In ApsaraVideo for Media Processing, each tag for a media file is independent. You can search the media library to find all media files that have the same tag.'."\n" ."\n" .'- Separate multiple tags with a comma (,). You can add up to 16 tags.'."\n" ."\n" .'- Each tag can be up to 32 bytes long.'."\n" ."\n" .'- UTF-8 encoded.', 'type' => 'string', 'required' => false, 'example' => 'tag1,tag2', 'title' => ''], ], [ 'name' => 'MediaWorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media workflow. You can find this ID in the MPS console or obtain it by calling the [AddMediaWorkflow](~~44437~~) operation.'."\n" ."\n" .'> - This parameter queues an [asynchronous task](~~3027615~~) for background execution.', 'type' => 'string', 'required' => false, 'example' => '07da6c65da7f458997336e0de192****', 'title' => ''], ], [ 'name' => 'MediaWorkflowUserData', 'in' => 'query', 'schema' => ['description' => 'User-defined data for the media workflow.'."\n" ."\n" .'- Maximum length: 1,024 bytes.'."\n" ."\n" .'- UTF-8 encoded.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'InputUnbind', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to check if the specified workflow supports the input path. Set this parameter to `true` to prevent errors from an invalid path. Valid values:'."\n" ."\n" .'- **true**: Checks if the workflow supports the input path.'."\n" ."\n" .'- **false**: Does not check if the workflow supports the input path.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the category for the media file. This value cannot be negative.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'OverrideParams', 'in' => 'query', 'schema' => ['description' => 'The override parameters, specified as a JSON string.'."\n" ."\n" .'- Example 1: To override subtitles for HLS packaging: `{“WebVTTSubtitleOverrides”,[{“RefActivityName”:”subtitleNode”,”WebVTTSubtitleURL”:”http://test.oss-cn-hangzhou.aliyuncs.com/example1.vtt"}]}`.'."\n" ."\n" .'- Example 2: To override subtitles for DASH packaging: `{“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"}}}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD', 'title' => ''], 'Media' => [ 'description' => 'Details of the media object.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2016-09-20T03:02:40Z', 'title' => ''], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Height' => ['description' => 'The height of the media file, in pixels.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'CensorState' => ['description' => 'The moderation status. Valid values:'."\n" ."\n" .'- **Initiated**: The media is uploaded, but moderation is pending.'."\n" ."\n" .'- **Pass**: The media is uploaded and has passed moderation.', 'type' => 'string', 'example' => 'Initiated', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tags.', 'type' => 'array', 'items' => ['description' => 'A list of tags.', 'type' => 'string', 'example' => 'tag,tag2', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => 'The tags.', 'title' => '', 'example' => '', ], 'Bitrate' => ['description' => 'The bitrate of the media file, in Kbit/s.', 'type' => 'string', 'example' => '1148.77', 'title' => ''], 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', 'title' => ''], 'File' => [ 'description' => 'The source file.', 'type' => 'object', 'properties' => [ 'State' => ['description' => 'The status of the file. Default value: **Normal**.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PublishState' => ['description' => 'The publication status of the media, which indicates whether the media is publicly available. Valid values:'."\n" ."\n" .'- **Initiated**: The initial state.'."\n" ."\n" .'- **UnPublish**: The media is unpublished. The corresponding file in OSS has Private permissions.'."\n" ."\n" .'- **Published**: The media is published. The corresponding file in OSS has Default permissions.', 'type' => 'string', 'example' => 'Published', 'title' => ''], 'Description' => ['description' => 'The description. The value can be up to 1,024 bytes in length.', 'type' => 'string', 'example' => 'A test video', 'title' => ''], 'Width' => ['description' => 'The width of the media file, in pixels.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'Size' => ['description' => 'The size of the media file, in bytes.', 'type' => 'string', 'example' => '379860', 'title' => ''], 'CoverURL' => ['description' => 'The cover URL.', 'type' => 'string', 'example' => 'http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png', 'title' => ''], 'RunIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RunId' => [ 'description' => 'The IDs of the media workflow execution instances.', 'type' => 'array', 'items' => ['description' => 'The IDs of the executed media workflow instances. Multiple IDs are separated by commas (,).', 'type' => 'string', 'example' => '{"RunId":["cbad98d35629470fa05ff393d347****"]}', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => 'The IDs of the media workflow execution instances.', 'title' => '', 'example' => '', ], 'Duration' => ['description' => 'The duration of the media file, in seconds.', 'type' => 'string', 'example' => '2.645333', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the media file.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Title' => ['description' => 'The title of the media. The value can be up to 128 bytes in length.', 'type' => 'string', 'example' => 'mytest.mp4', 'title' => ''], 'Format' => ['description' => 'The format. Supported formats include mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'AddMedia', 'summary' => 'Creates a new media job.', 'description' => '- This API processes existing media files in OSS, eliminating the need to re-upload them. If you have configured a workflow, OSS automatically notifies MPS when a media file is uploaded to OSS. MPS then automatically executes a matching, active workflow based on the specified OSS bucket and Object. Therefore, you typically do not need to manually call the `AddMedia` API to process files.'."\n" ."\n" .'- An active workflow automatically retrieves media information when processing a media file. If you specify an inactive workflow or no workflow, media information is not retrieved.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The QPS limit for this API is 100 requests per second for a single user. If you exceed this limit, the system throttles your API calls. This may impact your business, so please plan your calls accordingly. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => '**Workflow trigger matching rules**'."\n" ."\n" .'A workflow is triggered by prefix matching. The system compares the path of a newly added file against the path prefix configured for the workflow. If the file path starts with the configured prefix, it triggers the workflow. For example, for a file with the path `http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test1.flv`, the following rules apply:'."\n" ."\n" .'```'."\n" .'1. http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/ Match'."\n" .'2. http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/ Match'."\n" .'3. http://bucket.oss-cn-hangzhou.aliyuncs.com/A/ Match'."\n" .'4. http://bucket.oss-cn-hangzhou.aliyuncs.com/ Match'."\n" .'5. http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.flv Match'."\n" .'6. http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/CC/ Does not match'."\n" .'7. http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/ Does not match'."\n" .'8. http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/ Does not match'."\n" .'```'."\n" ."\n" .'> To prevent a single file from triggering multiple workflow executions, do not configure the input path of one workflow as a prefix of another. For example, if you configure two workflows with the input paths `test` and `test1`, a file uploaded to the `test1` directory will also match the `test` prefix, triggering both workflows.'."\n" ."\n" .'**Matching file extensions**'."\n" ."\n" .'ApsaraVideo Media Processing triggers workflows for multimedia files only. It identifies file types by their file extension. A file triggers a workflow if its extension is on the supported list, or if it has no extension (meaning the filename does not contain a period).'."\n" ."\n" .'> For SWF files, the quality of snapshots and the transcoding service cannot be guaranteed.'."\n" ."\n" .'| Type | File extensions |'."\n" .'| :---- | :------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| Video | 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" .'| Audio | aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff |'."\n" ."\n" .'**Media workflow messages**'."\n" ."\n" .'A media workflow uses [Message Service (MNS)](https://www.aliyun.com/product/mns?spm=a2c4g.11186623.2.10.6c44478epkHm97) to send notifications to your video cloud service application. The system sends a message when a Start or Report activity node completes. To receive these messages, you must specify a queue or topic name in the Start activity node. These messages are stored in the specified queue or topic, and you can retrieve them using the [MNS SDK](~~27508~~). The message format is as follows:'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| :--------------------- | :--------------------- | :--------------------------------------------------------------------------- |'."\n" .'| RunId | String | The ID of the workflow execution. |'."\n" .'| Name | String | The name of the activity node. |'."\n" .'| Type | String | The type of the activity node. Valid values: `Start` and `Report`. |'."\n" .'| State | String | The state of the activity node. Valid values: `Success` and `Fail`. |'."\n" .'| Code | String | The error code. This field is present only when the `State` is `Fail`. |'."\n" .'| Message | String | A detailed description of the error, provided only if the `State` is `Fail`. |'."\n" .'| MediaWorkflowExecution | MediaWorkflowExecution | Information about the media workflow execution. |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMedia'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'AddMediaTag' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media file to which you want to add tags.'."\n" ."\n" .'> To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the file that you want to manage and click **Manage** in the Actions column. The ID of the file is displayed on the Basics tab.'."\n", 'type' => 'string', 'required' => true, 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => ['description' => 'The tag that you want to add to the medial file. The value is encoded in UTF-8 and can be up to 32 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '91B6CAB9-034C-4E4E-A40B-E7F5C81E1A2K', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'AddMediaTag', 'summary' => 'Adds a tag to a media file.', 'description' => 'You can call this operation to add only one tag. To add multiple tags at a time, you can call the [UpdateMedia](~~44464~~) operation.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMediaTag'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddMediaTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"91B6CAB9-034C-4E4E-A40B-E7F5C81E1A2K\\"\\n}","type":"json"}]', ], 'AddMediaWorkflow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the media workflow.'."\n" ."\n" .'* The value cannot be empty.'."\n" .'* The name cannot be the same as that of an existing media workflow within the current Alibaba Cloud account.'."\n" .'* The name can be up to 64 characters in length.'."\n" .'* The value must be encoded in the UTF-8 format.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mediaworkflow-example', 'title' => ''], ], [ 'name' => 'Topology', 'in' => 'query', 'schema' => ['description' => 'The topology of the media workflow. The value must be a JSON object that contains the activities and activity dependencies. For more information, see the **Sample topology** section of this topic.'."\n" ."\n" .'> The Object Storage Service (OSS) bucket must reside in the same region as your MPS service.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"Activities": {"mediaworkflow-example": {"Parameters": {"Outputs": "[{\\"OutputObject\\":\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\",\\"TemplateId\\":\\"S00000001-200010\\",\\"TemplateName\\":\\"MP4-LD\\"}]","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": []}}', 'title' => ''], ], [ 'name' => 'TriggerMode', 'in' => 'query', 'schema' => ['description' => 'The triggering mode of the media workflow. Valid values:'."\n" ."\n" .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OssAutoTrigger', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F1D21261-ADB9-406A-1234-491382139D59', 'title' => ''], 'MediaWorkflow' => [ 'description' => 'The information about the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '016-04-01T05:29:37Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow. We recommend that you keep this ID for later operations on this workflow.'."\n", 'type' => 'string', 'example' => 'e00732b977da427d9177a4deb1aa****', 'title' => ''], 'State' => ['description' => 'The state of the media workflow. By default, the created workflow is in the **Active** state.'."\n", 'type' => 'string', 'example' => 'Active', 'title' => ''], 'TriggerMode' => ['description' => 'The triggering mode of the media workflow. Valid values:'."\n" ."\n" .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", 'type' => 'string', 'example' => 'OssAutoTrigger', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'mediaworkflow-example', 'title' => ''], 'Topology' => ['description' => 'The topology of the media workflow. The value is a JSON object that contains the activities and activity dependencies.'."\n", '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": []}}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], '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":"","errorExample":""}]', 'title' => 'AddMediaWorkflow', 'summary' => 'Creates a media workflow.', 'description' => '* You can call this operation to define the topology, activities, and dependencies of a media workflow. The topology is represented by a directed acyclic graph (DAG) in the console. For more information, see [Workflow activities](~~68494~~). You can view and run the workflows that are created by calling this operation in the ApsaraVideo Media Processing (MPS) console.'."\n" .'* MPS media workflows can be automatically triggered only by using the prefix of the file path. Automatic triggering by using the suffix is not supported. For more information about the trigger rules, see [Workflow triggering rules for files](~~68574~~).'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", 'requestParamsDescription' => '**Sample topology**'."\n" ."\n" .'> The OSS bucket must reside in the same region as your MPS service.'."\n" ."\n" .' {'."\n" .' "Activities": {'."\n" .' "mediaworkflow-example": {'."\n" .' "Parameters": {'."\n" .' "Outputs": "[{\\"OutputObject\\":\\"examplebucket/output/{RunId}/TRANSCODE_165941222****/{FileName}\\",\\"TemplateId\\":\\"S00000001-200010\\",\\"TemplateName\\":\\"MP4-Low definition\\"}]",'."\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' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMediaWorkflow'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'AddPipeline' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the MPS queue. The name can be up to 128 bytes in size.', 'type' => 'string', 'required' => true, 'example' => 'test-pipeline', 'title' => ''], ], [ 'name' => 'Speed', 'in' => 'query', 'schema' => ['description' => 'The type of the MPS queue. Valid values:'."\n" ."\n" .'- **Boost**: MPS queue with transcoding speed boosted.'."\n" ."\n" .'- **Standard**: standard MPS queue.'."\n" ."\n" .'- **NarrowBandHDV2**: MPS queue that supports Narrowband HD 2.0.'."\n" ."\n" .'- **AIVideoCover**: MPS queue for intelligent snapshot capture.'."\n" ."\n" .'- **AIVideoTag**: MPS queue for video tagging. The supported regions are China (Shanghai), China (Beijing), and China (Hangzhou).'."\n" ."\n" .'Default value: **Standard**.', 'type' => 'string', 'required' => false, 'default' => 'Standard', 'example' => 'Standard', 'title' => ''], ], [ 'name' => 'SpeedLevel', 'in' => 'query', 'schema' => ['description' => 'The level of the MPS queue. Valid values: **1 to 3**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'NotifyConfig', 'in' => 'query', 'schema' => ['description' => 'The Message Service (MNS) configuration.', 'type' => 'string', 'required' => false, 'example' => '{"Topic":"mts-topic-1"}', 'title' => ''], ], [ 'name' => 'Role', 'in' => 'query', 'schema' => ['description' => 'The role.', 'type' => 'string', 'required' => false, 'example' => 'AliyunMTSDefaultRole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CFEA608A-5A1C-4C83-A54B-6197BC250D23', 'title' => ''], 'Pipeline' => [ 'description' => 'The MPS queue.', 'type' => 'object', 'properties' => [ 'Speed' => ['description' => 'The type of the MPS queue.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'State' => ['description' => 'The state of the MPS queue.'."\n" ."\n" .'- Active: The MPS queue is active. The jobs in the MPS queue are scheduled and transcoded by MPS.'."\n" ."\n" .'- Paused: The MPS queue is paused. Jobs in the MPS queue are no longer scheduled for transcoding by MPS. All of the jobs in the MPS queue remain in the Submitted state. Jobs that are being transcoded are not affected.', 'type' => 'string', 'example' => 'Active', 'title' => ''], 'SpeedLevel' => ['description' => 'The level of the MPS queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'NotifyConfig' => [ 'description' => 'The MNS configuration.', 'type' => 'object', 'properties' => [ 'MqTopic' => ['description' => 'The queue of messages that are received.', 'type' => 'string', 'example' => 'example1', 'title' => ''], 'QueueName' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'mts-queue-1', 'title' => ''], 'MqTag' => ['description' => 'The tag string.', 'type' => 'string', 'example' => 'mts-test', 'title' => ''], 'Topic' => ['description' => 'The name of the topic.', 'type' => 'string', 'example' => 'mts-topic-1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Role' => ['description' => 'The role.', 'type' => 'string', 'example' => 'AliyunMTSDefaultRole', 'title' => ''], 'Name' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'example' => 'Video DNA', 'title' => ''], 'Id' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'example' => 'ed450ea0bfbd41e29f80a401fb4d****', 'title' => ''], 'QuotaAllocate' => ['description' => 'The quota that is allocated to the MPS queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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\\": \\"Video DNA\\",\\n \\"Id\\": \\"ed450ea0bfbd41e29f80a401fb4d****\\",\\n \\"QuotaAllocate\\": 10\\n }\\n}","type":"json"}]', 'title' => 'AddPipeline', 'summary' => 'Adds an ApsaraVideo Media Processing (MPS) queue.', 'changeSet' => [ ['createdAt' => '2023-09-21T09:56:40.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-21T08:15:35.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPipeline'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddPipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AddSmarttagTemplate' => [ 'summary' => 'Add an analysis template for a DataQ - Smart Tag Service job.', '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' => 'Custom template name. The string can contain letters and Chinese characters. Maximum length: 120 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'template-example-****', 'title' => ''], ], [ 'name' => 'Industry', 'in' => 'query', 'schema' => ['description' => 'Industry of the file to analyze. Default value: **common** (general industry). Select the appropriate industry so the backend can match the best algorithm combination. Valid values:'."\n" ."\n" .'- **microVideo**: Short video industry.'."\n" ."\n" .'- **common**: General industry.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'common', 'title' => ''], ], [ 'name' => 'Scene', 'in' => 'query', 'schema' => ['description' => 'Usage scenario of the file to analyze. Select the appropriate scenario so the backend can match the best algorithm combination. Valid values:'."\n" ."\n" .'- **search**: Search scenario.'."\n" ."\n" .'- **recommend**: Recommendation scenario.'."\n" ."\n" .'- Default value: **search**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'search', 'title' => ''], ], [ 'name' => 'AnalyseTypes', 'in' => 'query', 'schema' => ['description' => 'Analysis types. You can select multiple types separated by commas (,). Supported types:'."\n" ."\n" .'> Make sure your file contains results for the selected analysis types. Otherwise, queries may return empty results. For example, if you select ocr but the uploaded image contains no text, the query returns no results.'."\n" ."\n" .'- **ocr**: Detect labels from text in images.'."\n" ."\n" .'- **asr**: Detect labels from speech in audio.'."\n" ."\n" .'- **classification**: Video classification.'."\n" ."\n" .'- **shows**: Detect TV programs in videos.'."\n" ."\n" .'- **face**: Detect faces in videos or images.'."\n" ."\n" .'- **role**: Detect character roles in videos.'."\n" ."\n" .'- **object**: Detect objects in videos.'."\n" ."\n" .'- **tvstation**: Detect TV station logos in videos.'."\n" ."\n" .'- **action**: Detect action events in videos.'."\n" ."\n" .'- **emotion**: Detect facial expressions in videos.'."\n" ."\n" .'- **landmark**: Detect landmarks in videos.'."\n" ."\n" .'- **scene**: Detect scenes in videos.'."\n" ."\n" .'- **movieIp**: Detect film and TV intellectual property (IP) in videos. This type is only available in the China (Beijing) region.'."\n" ."\n" .'- **subtitle**: Extract subtitles.'."\n" ."\n" .'The relationship between analysis types and billing items is as follows:'."\n" ."\n" .'> Enabling analysis types through this API incurs charges. For pricing details, see [Billing items](~~299952~~).'."\n" ."\n" .'- Video classification + structured tags: All analysis types except face, ocr, and asr fall under this billing item. Charges do not stack.'."\n" ."\n" .'- Video facial recognition: Enable face.'."\n" ."\n" .'- Video text recognition tags: Enable ocr.'."\n" ."\n" .'- Video speech recognition tags: Enable asr.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ocr', 'title' => ''], ], [ 'name' => 'FaceCategoryIds', 'in' => 'query', 'schema' => ['description' => 'List of face library IDs to use for recognition. You can select multiple IDs separated by commas (,). You can specify system face library IDs and custom face library IDs. System face library IDs include the following:'."\n" ."\n" .'- **celebrity**: Celebrity figures.'."\n" ."\n" .'- **politician**: Political figures.'."\n" ."\n" .'- **sensitive**: Sensitive figures.'."\n" ."\n" .'- For custom face library IDs, see [Register custom face library](~~187777~~).', 'type' => 'string', 'required' => false, 'example' => 'celebrity', 'title' => ''], ], [ 'name' => 'FaceCustomParamsConfig', 'in' => 'query', 'schema' => ['description' => 'Parameters for facial recognition algorithms, formatted as a JSON string. Currently supports adjusting face detection and recognition thresholds.'."\n" ."\n" .'- **faceDetThreshold**: Face detection threshold. Default: 0.999. Applies only to unknown faces.'."\n" ."\n" .'- **faceRegThreshold**: Face recognition threshold. Default: 0.9.', 'type' => 'string', 'required' => false, 'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }', 'title' => ''], ], [ 'name' => 'ObjectGroupIds', 'in' => 'query', 'schema' => ['description' => 'List of object library IDs to use for recognition. You can select multiple IDs separated by commas (,). You can specify system object library IDs and custom object library IDs. System object library IDs include the following:'."\n" ."\n" .'- **general**: General objects.'."\n" ."\n" .'- **item**: Products.'."\n" ."\n" .'- **weapon**: Weapons.'."\n" ."\n" .'- **animal**: Animals.'."\n" ."\n" .'- For custom object library IDs, see [Register custom entity](~~451180~~).', 'type' => 'string', 'required' => false, 'example' => 'general,item,weapon,animal', 'title' => ''], ], [ 'name' => 'LandmarkGroupIds', 'in' => 'query', 'schema' => ['description' => 'List of landmark library IDs to use for recognition. You can select multiple IDs separated by commas (,). You can specify system landmark library IDs and custom landmark library IDs. System landmark library IDs include the following:'."\n" ."\n" .'- common: General landmarks.'."\n" ."\n" .'- For custom landmark library IDs, see [Register custom entity photos](~~451182~~).', 'type' => 'string', 'required' => false, 'example' => 'common', 'title' => ''], ], [ 'name' => 'IsDefault', 'in' => 'query', 'schema' => ['description' => 'Set as the default template. If set to true, this template is used automatically when transcoding if no template is specified. Valid values: **true** (yes), **false** (no). Default: **false**. Each Alibaba Cloud account can have only one default template. Setting another default template returns an error.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'LabelType', 'in' => 'query', 'schema' => ['description' => 'Annotation type. Supported types:'."\n" ."\n" .'- **auto**: Machine-generated tags.'."\n" ."\n" .'- **hmi**: Human-in-the-loop tagging.', 'type' => 'string', 'required' => false, 'example' => 'hmi', 'title' => ''], ], [ 'name' => 'LabelVersion', 'in' => 'query', 'schema' => ['description' => 'Specify the DataQ - Smart Tag Service version. Default: "1.0".'."\n" ."\n" .'- 1.0: DataQ - Smart Tag Service 1.0'."\n" ."\n" .'- 2.0: DataQ - Smart Tag Service 2.0 (CPV tags)'."\n" ."\n" .'- 2.0-custom: DataQ - Smart Tag Service 2.0-custom (CPV custom model)', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], [ 'name' => 'KnowledgeConfig', 'in' => 'query', 'schema' => ['description' => 'In DataQ - Smart Tag Service 2.0 and 2.0-custom modes, specify the knowledge graph fields to return in tag results. For more information about knowledge graph fields, see [Knowledge graph fields in DataQ - Smart Tag Service](~~356383~~). If KnowledgeConfig is empty, missing, or not a valid JSON string, the following fields are returned by default:'."\n" ."\n" .'- movie:'."\n" ."\n" .' - name: IP name'."\n" ."\n" .' - alias: IP alias'."\n" ."\n" .' - chnl: Category'."\n" ."\n" .' - genre: Genre'."\n" ."\n" .' - country: Production country or region'."\n" ."\n" .' - language: Language'."\n" ."\n" .' - releaseYear: Release year'."\n" ."\n" .'- music:'."\n" ."\n" .' - songName: Song name'."\n" ."\n" .' - artistName: Artist name'."\n" ."\n" .' - artistArea: Artist region (Chinese, Japanese, Korean, Western, or Other)'."\n" ."\n" .' - albumName: Album name'."\n" ."\n" .'- person:'."\n" ."\n" .' - name: Name'."\n" ."\n" .' - gender: Gender'."\n" ."\n" .' - citizenship: Nationality'."\n" ."\n" .' - occupation: Occupation'."\n" ."\n" .' - classification: Type'."\n" ."\n" .' - nationality: Ethnicity'."\n" ."\n" .' - birthPlace: Birthplace'."\n" ."\n" .' - birthDate: Birth date'."\n" ."\n" .'- landmark'."\n" ."\n" .' - name: Name'."\n" ."\n" .' - nameEn: English name'."\n" ."\n" .' - description: Description'."\n" ."\n" .' - address: Address'."\n" ."\n" .'- item'."\n" ."\n" .' - brandName: Brand'."\n" ."\n" .' - finegrainName: Fine-grained description', 'type' => 'string', 'required' => false, 'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }', 'title' => ''], ], [ 'name' => 'KeywordConfig', 'in' => 'query', 'schema' => ['description' => 'Keyword tag configuration. **type** specifies part-of-speech categories. You can select multiple categories separated by commas (,). Supported categories:'."\n" ."\n" .'- **name**: Person names'."\n" ."\n" .'- **location**: Place names'."\n" ."\n" .'- **organization**: Organization names'."\n" ."\n" .'- **other**: Other'."\n" ."\n" .'> If KeywordConfig is missing, invalid (not a JSON string), or lacks a valid type field, all keyword types are returned by default.', 'type' => 'string', 'required' => false, 'example' => '"type": "name,location,organization,other" }', 'title' => ''], ], [ 'name' => 'LabelCustomCategoryIds', 'in' => 'query', 'schema' => ['description' => 'List of custom tag library IDs to use for recognition. You can select multiple IDs separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'ab***cd,ef***hi', 'title' => ''], ], [ 'name' => 'LabelCustomParamsConfig', 'in' => 'query', 'schema' => ['description' => 'Additional parameter settings for custom tag libraries. Currently supports only threshold configuration.'."\n" .'{"threshold": xxx}', 'type' => 'string', 'required' => false, 'example' => '{"threshold": 0.4}', 'title' => ''], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175EDAS3Q', 'title' => ''], 'TemplateId' => ['description' => 'Template ID. Save this ID for future API calls.', 'type' => 'string', 'example' => '05de22f255284c7a8d2aab535dde****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175EDAS3Q\\",\\n \\"TemplateId\\": \\"05de22f255284c7a8d2aab535dde****\\"\\n}","type":"json"}]', 'title' => 'Add Template ', 'description' => 'This API adds an analysis template that specifies the algorithms used in a DataQ - Smart Tag Service job. Configure parameters as needed to meet your business requirements.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'This API supports up to 100 requests per second per user. Exceeding this limit triggers rate limiting, which may affect your business. Use this API responsibly. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### software development kit Sample'."\n" ."\n" .'- [Java software development kit](~~188025~~)'."\n" .'- [Python software development kit](~~188026~~)'."\n" .'- [Php software development kit](~~188027~~)', 'changeSet' => [ ['createdAt' => '2025-05-12T11:50:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-17T08:47:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-06T14:35:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-12-17T01:58:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-28T13:32:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-26T10:17:50.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSmarttagTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddSmarttagTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'AddTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the transcoding template. The name can be up to 128 bytes in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mps-example', 'title' => ''], ], [ 'name' => 'Container', 'in' => 'query', 'schema' => ['description' => 'The container format. The value must be a JSON object that contains the Format parameter. If you do not specify this parameter, the transcoded media file is in MP4 format by default. This parameter is required if you want to use the transcoding template to generate media files in other formats. For more information, see [Container](~~29253~~).'."\n" ."\n" .'* Default value: MP4.'."\n" .'* Video transcoding supports the following formats: FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4).'."\n" ."\n" .'> If the container format is FLV, the video codec cannot be set to H.265.'."\n" ."\n" .'* Audio transcoding supports the following formats: MP3, MP4, OGG, FLAC, and M4A.'."\n" .'* Image transcoding supports the GIF and WebP formats.'."\n" ."\n" .'> '."\n" ."\n" .'* If the container format is GIF, the video codec must be set to GIF.'."\n" ."\n" .'* If the container format is WebP, the video codec must be set to WebP.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Format":"mp4"}', 'title' => ''], ], [ 'name' => 'Video', 'in' => 'query', 'schema' => ['description' => 'The video stream settings. The value must be a JSON object. For more information, see [Video](~~29253~~).'."\n" ."\n" .'> If you do not specify this parameter, output files do not contain video streams. This parameter is required if you want to retain the video streams.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10s"}', 'title' => ''], ], [ 'name' => 'Audio', 'in' => 'query', 'schema' => ['description' => 'The audio stream settings. The value must be a JSON object. For more information, see [Audio](~~29253~~).'."\n" ."\n" .'> If you do not specify this parameter, output files do not contain audio streams. This parameter is required if you want to retain the audio streams.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Codec":"H.264","Samplerate":"44100","Bitrate":"500","Channels":"2"}', 'title' => ''], ], [ 'name' => 'TransConfig', 'in' => 'query', 'schema' => ['description' => 'The general transcoding settings. The value must be a JSON object. For more information, see [TransConfig](~~29253~~). If you do not specify this parameter, the default settings are used. This parameter is required if the default settings cannot meet your business requirements.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"TransMode":"onepass"}', 'title' => ''], ], [ 'name' => 'MuxConfig', 'in' => 'query', 'schema' => ['description' => 'The segment settings. The value must be a JSON object. For more information, see [MuxConfig](~~29253~~). If you do not specify this parameter, media segment files are not generated. This parameter is required if you want to generate media segment files.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Segment":{"Duration":"10"}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3', 'title' => ''], 'Template' => [ 'description' => 'The details of the transcoding template.'."\n", 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Bufsize' => ['description' => 'The size of the buffer.'."\n" ."\n" .'* Default value: **6000**.'."\n" .'* Unit: KB.'."\n", 'type' => 'string', 'example' => '6000', 'title' => ''], 'LongShortMode' => ['description' => 'Indicates whether the auto-rotate screen feature is enabled. Default value: **false**. Valid values:'."\n" ."\n" .'* **true**: The auto-rotate screen feature is enabled.'."\n" .'* **false**: The auto-rotate screen feature is disabled.'."\n" ."\n" .'> If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Degrain' => ['description' => 'The level of quality control on the video.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'BitrateBnd' => [ 'description' => 'The bitrate range of the video.'."\n", 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'The maximum bitrate.'."\n", 'type' => 'string', 'example' => '1500', 'title' => ''], 'Min' => ['description' => 'The minimum bitrate.'."\n", 'type' => 'string', 'example' => '800', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'The pixel format. Standard pixel formats such as yuv420p and yuvj420p are supported. The default pixel format can be **yuv420p** or the pixel format of the input video.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Pad' => ['description' => 'The black borders to be added to the video. The value is in the width:height:left:top format.'."\n", 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Codec' => ['description' => 'The video codec. Valid values: H.264, H.265, GIF, and WebP. Default value: **H.264**.'."\n", 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The height of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: the height of the input video.'."\n", 'type' => 'string', 'example' => '800', 'title' => ''], 'Qscale' => ['description' => 'The level of the independent denoising algorithm.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Crop' => ['description' => 'The method of video cropping. Valid values:'."\n" ."\n" .'* **border**: automatically detects and removes borders.'."\n" .'* **Value in the format of width:height:left:top**: crops the video image based on the custom settings. Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => 'border', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the output video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'Maxrate' => ['description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'MaxFps' => ['description' => 'The maximum frame rate.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], 'Profile' => ['description' => 'The codec profile.'."\n" ."\n" .'* **baseline**: suitable for mobile devices'."\n" .'* **main**: suitable for standard-definition devices'."\n" .'* **high**: suitable for high-definition devices'."\n" .'* Default value: **high**.'."\n" ."\n" .'If multiple definitions are available, we recommend that you set this parameter to baseline for the lowest definition to ensure normal playback on low-end devices. Set this parameter to main or high for other definitions.'."\n" ."\n" .'> This parameter is valid only if the Codec parameter is set to H.264.'."\n", 'type' => 'string', 'example' => 'high', 'title' => ''], 'Crf' => ['description' => 'The constant rate factor. Default value if the video codec is set to H.264: **23**. Default value if the video codec is set to H.265: **26**.'."\n" ."\n" .'> If this parameter is specified, the setting of the Bitrate parameter becomes invalid.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Remove' => ['description' => 'Indicates whether the video stream is deleted.'."\n" ."\n" .'* **true**: The video stream is deleted.'."\n" .'* **false**: The video stream is retained.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Gop' => ['description' => 'The GOP size. The GOP size can be the maximum interval of keyframes or the maximum number of frames in a frame group. If the maximum interval is specified, the value contains the unit (s). If the maximum number of frames is specified, the value does not contain a unit. Default value: **10s**.'."\n", 'type' => 'string', 'example' => '10s', 'title' => ''], 'Width' => ['description' => 'The width of the video.'."\n" ."\n" .'* Default value: the width of the input video.****'."\n" .'* Unit: pixel.'."\n", 'type' => 'string', 'example' => '256', 'title' => ''], 'Fps' => ['description' => 'The frame rate. Default value: the frame rate of the input file. The value is 60 if the frame rate of the input file exceeds 60. Unit: frames per second.'."\n", 'type' => 'string', 'example' => '25', 'title' => ''], 'Preset' => ['description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" ."\n" .'* **veryfast**'."\n" .'* **fast**'."\n" .'* **medium**'."\n" .'* **slow**'."\n" .'* **slower**'."\n" ."\n" .'> This parameter is valid only if the Codec parameter is set to H.264.'."\n", 'type' => 'string', 'example' => 'fast', 'title' => ''], 'ScanMode' => ['description' => 'The scan mode. Valid values:'."\n" ."\n" .'* **interlaced**'."\n" .'* **progressive**'."\n", 'type' => 'string', 'example' => 'interlaced', 'title' => ''], 'ResoPriority' => ['description' => 'The policy of resolution adjustment.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Hdr2sdr' => ['description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'NarrowBand' => [ 'description' => 'The Narrowband HD settings.'."\n", 'type' => 'object', 'properties' => [ 'Version' => ['description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", 'type' => 'string', 'example' => '1.0', 'title' => ''], 'Abrmax' => ['description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '3000', 'title' => ''], 'MaxAbrRatio' => ['description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'The general transcoding settings.'."\n", 'type' => 'object', 'properties' => [ 'IsCheckAudioBitrate' => ['description' => 'Indicates whether the audio bitrate is checked.'."\n" ."\n" .'If this feature is enabled and the system detects that the audio bitrate of the output file is greater than that of the input file, the audio bitrate of the input file is retained after transcoding.'."\n" ."\n" .'* **true**: The audio bitrate is checked.'."\n" .'* **false**: The audio bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'TransMode' => ['description' => 'The transcoding mode. Valid values:'."\n" ."\n" .'* **onepass**'."\n" .'* **twopass**'."\n" .'* **CBR**'."\n" .'* Default value: **onepass**.'."\n", 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Indicates whether the resolution is checked.'."\n" ."\n" .'* **true**: The resolution is checked.'."\n" .'* **false**: The resolution is not checked.'."\n" .'* Default value: **false**.'."\n" ."\n" .'> If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, the resolution of the input file is retained after transcoding.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Indicates whether the video bitrate is checked. If this feature is enabled and the system detects that the video bitrate of the output file is higher than that of the input file, the input file is not transcoded. This parameter has a higher priority than the IsCheckVideoBitrate parameter.'."\n" ."\n" .'* **true**: The video bitrate is checked. In this case, if the video bitrate of the output file is higher than that of the input file, the input file is not transcoded.'."\n" .'* **false**: The video bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'AdjDarMethod' => ['description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" ."\n" .'* **rescale**: The input video is rescaled.'."\n" .'* **crop**: The input video is cropped.'."\n" .'* **none**: No change is made.'."\n", 'type' => 'string', 'example' => 'rescale', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Indicates whether the video bitrate is checked.'."\n" ."\n" .'* **true**: The video bitrate is checked.'."\n" .'* **false**: The video bitrate is not checked.'."\n" .'* Default value: **false**.'."\n" ."\n" .'> If this feature is enabled and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Indicates whether the resolution is checked.'."\n" ."\n" .'* **true**: The resolution is checked.'."\n" .'* **false**: The resolution is not checked.'."\n" .'* Default value: **false**.'."\n" ."\n" .'> If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Indicates whether the audio bitrate is checked. If this feature is enabled and the system detects that the audio bitrate of the output file is higher than that of the input file, the input file is not transcoded. This parameter has a higher priority than the **IsCheckAudioBitrate** parameter. Valid values:'."\n" ."\n" .'* **true**: The audio bitrate is checked. In this case, if the audio bitrate of the output file is higher than that of the input file, the input file is not transcoded.'."\n" .'* **false**: The audio bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The status of the template. Valid values:'."\n" ."\n" .'* **Normal**: The template is normal.'."\n" .'* **Deleted**: The template is deleted.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'MuxConfig' => [ 'description' => 'The transmuxing settings.'."\n", 'type' => 'object', 'properties' => [ 'Webp' => [ 'description' => 'The transmuxing settings for WebP.'."\n", 'type' => 'object', 'properties' => [ 'Loop' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gif' => [ 'description' => 'The transmuxing settings for GIF.'."\n", 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'The duration for which the final frame is paused. Unit: centiseconds.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'DitherMode' => ['description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", 'type' => 'string', 'example' => 'sierra', 'title' => ''], 'Loop' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'IsCustomPalette' => ['description' => 'Indicates whether the custom palette is used.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'The segment settings.'."\n", 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The length of the segment. Unit: seconds.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the transcoding template.'."\n", 'type' => 'string', 'example' => 'mps-example', 'title' => ''], 'Audio' => [ 'description' => 'The audio codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The codec profile of the audio. Valid values if the **Codec** parameter is set to **AAC**:'."\n" ."\n" .'* **aac_low**'."\n" .'* **aac_he**'."\n" .'* **aac_he_v2**'."\n" .'* **aac_ld**'."\n" .'* **aac_eld**'."\n", 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Remove' => ['description' => 'Indicates whether the audio stream is deleted.'."\n" ."\n" .'* **true**: The audio stream is deleted.'."\n" .'* **false**: The audio stream is retained.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'Codec' => ['description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" ."\n" .'* **aac**'."\n" .'* **mp3**'."\n" .'* **vorbis**'."\n" .'* **flac**'."\n", 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Samplerate' => ['description' => 'The sampling rate.'."\n" ."\n" .'* Unit: Hz.'."\n" .'* Default value: **44100**.'."\n", 'type' => 'string', 'example' => '44100', 'title' => ''], 'Qscale' => ['description' => 'The level of the independent denoising algorithm.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels. Default value: **2**.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'Volume' => [ 'description' => 'The volume control configurations'."\n", 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'The volume adjustment method. Valid values:'."\n" ."\n" .'* **auto**: The volume is automatically adjusted.'."\n" .'* **dynamic**: The volume is dynamically adjusted.'."\n" .'* **linear**: The volume is linearly adjusted.'."\n", 'type' => 'string', 'example' => 'auto', 'title' => ''], 'Level' => ['description' => 'The volume adjustment range.'."\n" ."\n" .'* Default value: **-20**.'."\n" .'* Unit: dB.'."\n", 'type' => 'string', 'example' => '-20', 'title' => ''], 'IntegratedLoudnessTarget' => ['title' => '', 'description' => 'The output volume.'."\n" ."\n" .'This parameter takes effect only when the value of Method is dynamic.'."\n" ."\n" .'Unit: dB.'."\n" ."\n" .'Valid values: \\[-70,-5].'."\n" ."\n" .'Default value: -6.'."\n", 'type' => 'string', 'example' => '-6'], 'TruePeak' => ['title' => '', 'description' => 'The peak volume.'."\n" ."\n" .'This parameter takes effect only when the value of Method is dynamic.'."\n" ."\n" .'Unit: dB.'."\n" ."\n" .'Valid values: \\[-9,0].'."\n" ."\n" .'Default value: -1.'."\n", 'type' => 'string', 'example' => '0'], 'LoudnessRangeTarget' => ['title' => '', 'description' => 'The range of the volume relative to the output volume.'."\n" ."\n" .'This parameter takes effect only when the value of Method is dynamic.'."\n" ."\n" .'Unit: dB.'."\n" ."\n" .'Valid values: \\[1,20].'."\n" ."\n" .'Default value: 8.'."\n", 'type' => 'string', 'example' => '8'], 'PeakLevel' => ['title' => '', 'description' => 'The volume adjustment coefficient.'."\n" ."\n" .'This parameter takes effect only when the value of Method is adaptive.'."\n" ."\n" .'Valid values: \\[0,1].'."\n" ."\n" .'Default value: 0.9.'."\n", 'type' => 'string', 'example' => '0.9'], ], 'title' => '', 'example' => '', ], 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Unit: Kbit/s.'."\n" .'* Default value: **128**.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'The ID of the transcoding template. We recommend that you keep this ID for subsequent operation calls.'."\n", 'type' => 'string', 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], 'Container' => [ 'description' => 'The container format settings.'."\n", 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The container format.'."\n", 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'AddTemplate', 'summary' => 'Creates a custom transcoding template. You need to configure the information such as the container format, video stream settings, and audio stream settings.', 'description' => 'When you call this operation, you need to set transcoding parameters such as those related to the container format, video stream, and audio stream. If you do not specify some parameters, streams that are generated by using the template do not contain the information specified by those parameters.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => '**Container**'."\n" ."\n" .'|Parameter|Type|Required|Description|'."\n" .'|---|---|---|---|'."\n" .'|Format|String|No|The default value of this parameter is MP4. Video transcoding supports the following formats: FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4). Audio transcoding supports the following formats: MP3, MP4, OGG, FLAC, and M4A. Image transcoding supports the GIF and WebP formats. If you set the container format to GIF, the video codec must be set to GIF. If you set the container format to WebP, the video codec must be set to WebP. If you set the container format to FLV, the video codec cannot be set to H.265.|'."\n" ."\n\n" .'**Video**'."\n" .'|Parameter|Type|Required|Description|'."\n" .'|---|---|---|---|'."\n" .'| Codec | String | No | The video codec. Valid values: H.264, H.265, GIF, and WebP. Default value: H.264. | '."\n" .'| Profile | String | No | The codec profile. Valid values: baseline, main, and high. Default value: high. A value of baseline specifies that media files are transcoded for mobile devices. A value of main specifies that media files are transcoded for standard-resolution devices. A value of high specifies that media files are transcoded for high-resolution devices. If multiple definitions are available, we recommend that you set this parameter to baseline for the lowest definition to ensure normal playback on low-end devices. Set this parameter to main or high for other definitions. This parameter is valid only if the Codec parameter is set to H.264. |'."\n" .'| Bitrate | String | No | Valid values: 10 to 50000. Unit: Kbit/s.|'."\n" .'| Crf | String | No | The constant rate factor. Valid values: 0 to 51. Default value: 26. If you specify this parameter, the setting of the Bitrate parameter becomes invalid. | '."\n" .'| Width | String | No | The width of the video. Valid values: 128 to 4096. Default value: the width of the input video. Unit: pixel.|'."\n" .'| Height | String | No | The height of the video. Valid values: 128 to 4096. Default value: the height of the input video. Unit: pixel. | '."\n" .'| Fps | String | No | The frame rate of the video. Default value: the frame rate of the input file. The value is 60 if the frame rate of the input file exceeds 60. Valid values: 0 to 60.Unit: frames per second. | '."\n" .'| Gop | String | No | The group of pictures (GOP) size. The GOP size can be the maximum interval of keyframes or the maximum number of frames in a frame group. If you specify the maximum interval of keyframes, the unit (s) is required. Default value: 10s. If you specify the maximum number of frames, the value has no unit. Valid values: 1 to 100000. |'."\n" .'| Preset | String | No | The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium. This parameter is valid only if the Codec parameter is set to H.264. |'."\n" .'| ScanMode | String | No | The scan mode. Valid values: interlaced and progressive. | '."\n" .'| Bufsize | String | No | The size of the buffer. Valid values: 1000 to 128000. Default value: 6000. Unit: KB. |'."\n" .'| Maxrate | String | No | The maximum bitrate of the video. Valid values: 10 to 50000. Unit: Kbit/s. |'."\n" .'| PixFmt | String | No | The pixel format of the video. Standard pixel formats such as yuv420p and yuvj420p are supported. By default, yuv420p or the pixel format of the input video is used. |'."\n" .'| Remove | String | No | Specifies whether to delete the video stream. A value of true specifies to delete the video stream. A value of false specifies to retain the video stream. Default value: false. |'."\n" .'| Crop | String | No | The method for cropping the video. A value of border specifies to automatically detect and crop the black borders. A value in the format of width:height:left:top specifies to crop the video image based on the custom settings. Example: 1280:800:0:140. |'."\n" .'| Pad | String | No | The black borders to be added to the video. The value must be in the width:height:left:top format. Example: 1280:800:0:140. |'."\n" .'| LongShortMode | String | No | Specifies whether to enable the auto-rotate screen feature. If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode. A value of true specifies to enable the auto-rotate screen feature. A value of false specifies to disable the auto-rotate screen feature. Default value: false. |'."\n" ."\n" .'The following table describes the supported combinations of container formats, video codecs, and audio codecs.'."\n" ."\n" .'|Container format|Audio codec|Video codec|'."\n" .'|:---|:---|:---|'."\n" .'|FLV|AAC and MP3|H.264|'."\n" .'|MP4|AAC and MP3|H.264 and H.265|'."\n" .'|TS|AAC and MP3|H.264 and H.265|'."\n" .'|M3U8|AAC and MP3|H.264 and H.265|'."\n" .'|GIF|Not supported|GIF|'."\n" ."\n\n" .'The following table describes the video stream parameters that are supported by different video codecs. A value of Y specifies that a parameter is supported. A value of N specifies that a parameter is not supported.'."\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\n" .'**Audio**'."\n" ."\n" .'|Parameter|Type|Required|Description|'."\n" .'|:---|:---|:---|:---|'."\n" .'|Codec|String|No|The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.|'."\n" .'|Profile|String|No|The codec profile of the audio. Valid values if the Codec parameter is set to AAC: aac\\_low, aac\\_he, aac\\_he\\_v2, aac\\_ld, and aac\\_eld.|'."\n" .'|Samplerate|String|No|The sampling rate. Valid values: 22050, 32000, 44100, 48000, and 96000. Default value: 44100. Unit: Hz. If the video container format is FLV and the audio codec is MP3, the sampling rate cannot be 32000, 48000, or 96000. If the audio codec is MP3, the sampling rate cannot be 96000.|'."\n" .'|Bitrate|String|No|The audio bitrate of the output file. Valid values: 8 to 1000. Default value: 128. Unit: Kbit/s.|'."\n" .'|Channels|String|No|The number of sound channels. Default value: 2. Valid values if the Codec parameter is set to MP3: 1 and 2. Valid values if the Codec parameter is set to AAC: 1, 2, 4, 5, 6, and 8.|'."\n" .'|Remove|String|No|Specifies whether to delete the audio stream. A value of true specifies to delete the audio stream. A value of false specifies to retain the audio stream. Default value: false.|'."\n" ."\n\n" .'The following table describes the supported combinations of audio codecs and container formats.'."\n" ."\n" .'|Container format|Audio codec|'."\n" .'|:---|:---|'."\n" .'|MP3|MP3|'."\n" .'|MP4|AAC|'."\n" .'|OGG|VORBIS and FLAC|'."\n" .'|FLAC|FLAC|'."\n" ."\n\n" .'**TransConfig**'."\n" ."\n" .'|Parameter|Type|Required|Description|'."\n" .'|:---|:---|:---|:---|'."\n" .'|TransMode|String|No|The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: onepass.|'."\n" .'|AdjDarMethod|String|No|The method of resolution adjustment. Valid values: rescale, crop, pad, and none. Default value: none.|'."\n" .'|IsCheckReso|String|No|Specifies whether to check the resolution. If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, the resolution of the input file is retained after transcoding. A value of true specifies to check the resolution. A value of false specifies not to check the resolution. Default value: false.|'."\n" .'|IsCheckResoFail|String|No|Specifies whether to check the resolution. If this feature is enabled and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned. A value of true specifies to check the resolution. A value of false specifies not to check the resolution. Default value: false.|'."\n" .'|IsCheckVideoBitrate|String|No|Specifies whether to check the video bitrate. If this feature is enabled and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding. A value of true specifies to check the video bitrate. A value of false specifies not to check the video bitrate. Default value: false.|'."\n" .'|IsCheckAudioBitrate|String|No|Specifies whether to check the audio bitrate. If this feature is enabled and the system detects that the audio bitrate of the output file is greater than that of the input file, the audio bitrate of the input file is retained after transcoding. A value of true specifies to check the audio bitrate. A value of false specifies not to check the audio bitrate. Default value: false.|'."\n" .'|IsCheckAudioBitrateFail|String|No|Specifies whether to check the audio bitrate. If this feature is enabled and the system detects that the bitrate of the output audio is higher than that of the input audio, the input audio is not transcoded. A value of true specifies to check the audio bitrate. A value of false specifies not to check the audio bitrate. Default value: false. This parameter takes precedence over the IsCheckAudioBitrate parameter.|'."\n" .'|IsCheckVideoBitrateFail|String|No|Specifies whether to check the video bitrate. If this feature is enabled and the system detects that the bitrate of the output video is higher than that of the input video, the input video is not transcoded. A value of true specifies to check the video bitrate. A value of false specifies not to check the video bitrate. Default value: false. This parameter takes precedence over the IsCheckVideoBitrate parameter.|'."\n" ."\n\n" .'**MuxConfig**'."\n" ."\n" .'|Parameter|Type|Required|Description|'."\n" .'|:---|:---|:---|:---|'."\n" .'|Segment|String|No|The segment settings. The value must be a JSON object. For more information, see the following section.|'."\n" ."\n\n" .'**Segment**'."\n" ."\n" .'|Parameter|Type|Required|Description|'."\n" .'|:---|:---|:---|:---|'."\n" .'|Duration|String|No|The length of the segment. The value must be an integer. Unit: seconds. Valid values: 1 to 60. Default value: 10.|'."\n" .'|ForceSegTime|String|No|The points in time at which you want to segment the media file. You can specify up to 10 points in time. Separate the points in time with commas (,). The points in time can be accurate to three decimal places. Unit: seconds. For example, if you set this parameter to 23,55,60, the media file will be segmented at the 23rd, 55th, and 60th seconds.|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-03-13T07:14:49.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-04T02:22:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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\\": \\"-6\\",\\n \\"TruePeak\\": \\"0\\",\\n \\"LoudnessRangeTarget\\": \\"8\\",\\n \\"PeakLevel\\": \\"0.9\\"\\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","errorExample":""}]', ], 'AddWaterMarkTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the watermark template. The value can contain letters and digits and can be up to 128 bytes in size.'."\n", 'type' => 'string', 'required' => true, 'example' => 'example-watermark-****', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The configuration of the watermark template. The value is a JSON object. For more information, see the "WaterMarks" section of the [Parameter details](~~29253~~) topic.'."\n" ."\n" .'> If you do not require a positive correlation between the size of text in the watermark and the resolution, you can enable adaptation for the watermark. To do so, add `[\'adaptive\']=true` to the TextWaterMark parameter.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'WaterMarkTemplate' => [ 'description' => 'The details of the watermark template.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the watermark. Valid values:'."\n" ."\n" .'* Image: an image watermark.'."\n" .'* Text: a text watermark.'."\n", 'type' => 'string', 'example' => 'Image', 'title' => ''], 'RatioRefer' => [ 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" ."\n" .'* **Width**: the width edge.'."\n" .'* **Height**: the height edge.'."\n" .'* **Long**: the long edge.'."\n" .'* **Short**: the short edge.'."\n", 'type' => 'object', 'properties' => [ 'Dx' => ['description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.51', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.36', 'title' => ''], 'Height' => ['description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.33', 'title' => ''], 'Dy' => ['description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.28', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ReferPos' => ['description' => 'The position of the watermark. Valid values:'."\n" ."\n" .'* **TopRight**: the upper-right corner.'."\n" .'* **TopLeft**: the upper-left corner.'."\n" .'* **BottomRight**: the lower-right corner.'."\n" .'* **BottomLeft**: the lower-left corner.'."\n", 'type' => 'string', 'example' => 'TopRight', 'title' => ''], 'State' => ['description' => 'The status of the watermark template.'."\n" ."\n" .'* **Normal**: The watermark template is normal.'."\n" .'* **Deleted**: The watermark template is deleted.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Dx' => ['description' => 'The horizontal offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Height' => ['description' => 'The height of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], 'Timeline' => [ 'description' => 'The timeline of the watermark.'."\n", 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The beginning of the time range during which the watermark is displayed.'."\n" ."\n" .'* Unit: seconds.'."\n" .'* Default value: **0**.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", 'type' => 'string', 'example' => 'ToEND', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the watermark template.'."\n", 'type' => 'string', 'example' => 'example-watermark-****', 'title' => ''], 'Dy' => ['description' => 'The vertical offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'Id' => ['description' => 'The ID of the watermark template. We recommend that you keep this ID for subsequent operation calls.'."\n", 'type' => 'string', 'example' => '3780bd69b2b74540bc7b1096f564****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '54BB917F-DD35-4F32-BABA-E60E31B21W63', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'AddWaterMarkTemplate', 'summary' => 'Creates a watermark template.', 'description' => 'After you create a watermark template by calling this operation, you can specify the watermark template and watermark asset when you [submit a transcoding job](~~29226~~). This allows you to add watermark information to the output video.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddWaterMarkTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'BindInputBucket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Bucket', 'in' => 'query', 'schema' => ['description' => 'The name of the input media bucket to be bound. The name can be up to 64 bytes in size. To obtain the media bucket name, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Media Buckets** in the left-side navigation pane.'."\n" ."\n" .'> The bucket name can contain lowercase letters, digits, and hyphens (-), and cannot start or end with a hyphen (-).'."\n", 'type' => 'string', 'required' => true, 'example' => 'example-bucket-****', 'title' => ''], ], [ 'name' => 'Referer', 'in' => 'query', 'schema' => ['description' => 'The settings of Object Storage Service (OSS) hotlink protection. For more information, see [Hotlink protection](~~31869~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'BindInputBucket', 'summary' => 'Binds an input media bucket.', 'description' => 'Before you call this operation to bind an input media bucket, you must create a media bucket. For more information, see [Add media buckets](~~42430~~).'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindInputBucket'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:BindInputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\n","errorExample":""}]', ], 'BindOutputBucket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Bucket', 'in' => 'query', 'schema' => ['description' => 'The name of the Object Storage Service (OSS) bucket that you want to bind. The name can be up to 64 bytes in size and can contain letters, digits, and hyphens (-). The name cannot start with a special character.'."\n", 'type' => 'string', 'required' => true, 'example' => 'example-bucket-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D0F80646-90D4-402F-9D56-CEFEAA6BCC9B', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'BindOutputBucket', 'summary' => 'Binds an output media bucket. Media buckets are Object Storage Service (OSS) buckets that are used by ApsaraVideo Media Processing (MPS) to store media resources. After you bind an OSS bucket to MPS as an input media bucket or output media bucket, MPS has the permissions to listen to the messages of the bucket, which indicate that files are uploaded to the bucket. This way, MPS can trigger workflows and return files that are processed. You can all this operation to bind an output media bucket to the media library.', 'description' => 'Before you call this operation to bind an output media bucket to the media library, you must create a media bucket. For more information, see [Add media buckets](~~42430~~).'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindOutputBucket'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:BindOutputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0F80646-90D4-402F-9D56-CEFEAA6BCC9B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D0F80646-90D4-402F-9D56-CEFEAA6BCC9B\\n","errorExample":""}]', ], 'CancelJob' => [ 'summary' => 'Cancels a transcoding job.', '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' => 'The ID of the transcoding job to be canceled. You can log on to the **MPS console** and click **Tasks** in the left-side navigation pane to obtain job IDs. Alternatively, you can obtain job IDs from the response of the [SubmitJobs](~~29226~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5', 'title' => ''], 'JobId' => ['description' => 'The ID of the job.'."\n", 'type' => 'string', 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'CancelJob', 'description' => '* You can cancel a transcoding job only if the job is in the Submitted state.'."\n" .'* We recommend that you call the **UpdatePipeline** operation to set the status of the ApsaraVideo Media Processing (MPS) queue to Paused before you cancel a job. This suspends job scheduling in the MPS queue. After the job is canceled, you must set the status of the MPS queue back to Active so that the other jobs in the MPS queue can be scheduled.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelJob'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:CancelJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'CreateCustomEntity' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The custom type. Valid values: '."\n" ."\n" .'- landmark: Custom landmark. '."\n" ."\n" .'- object: Custom object. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom library. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'CustomEntityName', 'in' => 'query', 'schema' => ['description' => 'The name of the custom entity. The maximum length is 64 bytes. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Custom library entity name', 'title' => ''], ], [ 'name' => 'CustomEntityInfo', 'in' => 'query', 'schema' => ['description' => 'Additional information about the custom entity, in JSON string format. The maximum length is 256 bytes. ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{ "finegrainName":"examplName" }', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters. ', 'type' => 'object', 'properties' => [ 'CustomEntityId' => ['description' => 'The entity ID of the custom library. ', 'type' => 'string', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID, which is unique. ', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CustomEntityId\\": \\"1\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","type":"json"}]', 'title' => 'Create a custom entity ', 'summary' => 'Create a custom entity in the corresponding custom library. ', 'description' => 'This API currently supports the following regions: China (Beijing), China (Shanghai), and China (Hangzhou). Other regions are not supported at this time. '."\n" ."\n" .'## Queries per second (QPS) limit '."\n" .'The queries per second (QPS) limit for this API is 50 requests per second per user. If you exceed this limit, your API calls will be subject to rate limiting, which may impact your business. Please invoke the API appropriately. For more information, see [QPS limits](~~342832~~). ', 'changeSet' => [ ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomEntity'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:CreateCustomEntity', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateCustomGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'Custom type. Valid values: '."\n" ."\n" .'- landmark: Custom landmark. '."\n" ."\n" .'- object: Custom object.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupName', 'in' => 'query', 'schema' => ['description' => 'Custom library name. The name can be up to 64 bytes in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Landmark test library', 'title' => ''], ], [ 'name' => 'CustomGroupDescription', 'in' => 'query', 'schema' => ['description' => 'Custom library description. The description can be up to 128 bytes in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Used for landmark test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'CustomGroupId' => ['description' => 'Custom library ID. We recommend that you save this ID for use when calling other APIs later.', 'type' => 'string', 'example' => '129****', 'title' => ''], 'RequestId' => ['description' => 'Request ID, which is unique.', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CustomGroupId\\": \\"129****\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","type":"json"}]', 'title' => 'Create a custom library', 'summary' => 'Create a custom library.', 'description' => '- This API currently supports the following regions: China (Beijing), China (Shanghai), and China (Hangzhou). Other regions are not supported at this time. '."\n" .'- Procedure for self-registering objects or landmarks (using object as an example): Create a custom object library and a custom object entity. After creation, register images of the custom object entity. Once registration is complete, create a template A that includes the self-registered object library, then submit an analysis job using template A, and finally query the result.'."\n" ."\n" .'## queries per second (QPS) limit'."\n" .'The per-user QPS limit for this API is 50 requests per second. If you exceed this limit, your API calls will be subject to rate limiting, which may impact your business. Please invoke the API appropriately. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:CreateCustomGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateFpShotDB' => [ 'summary' => 'Submits a job to create a media fingerprint library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREmtsVN28MX', 'FEATUREmtsVAD950', 'FEATUREmtsQLY5GJ', 'FEATUREmtsMX6OH3'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the media fingerprint library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example name', 'title' => ''], ], [ 'name' => 'ModelId', 'in' => 'query', 'schema' => ['description' => 'The model ID of the media fingerprint library.'."\n" ."\n" .'- The model ID for a text media fingerprint library is **11** (deprecated).'."\n" ."\n" .'- The model ID for a video media fingerprint library is **12**.'."\n" ."\n" .'- The model ID for an audio media fingerprint library is **13**.'."\n" ."\n" .'- The model ID for an image media fingerprint library is **14** (deprecated).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '12', 'example' => '12', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The configuration of the media fingerprint library, specified as a JSON-formatted string. Leave this parameter empty for default settings.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the media fingerprint library.', 'type' => 'string', 'required' => false, 'example' => '这是一个文本DNA库', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'FpShotDB' => [ 'description' => 'The details of the media fingerprint library.', 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'The description of the media fingerprint library.', 'type' => 'string', 'example' => '这是一个文本DNA库', 'title' => ''], 'State' => ['description' => 'The state of the media fingerprint library. The library is created in the *offline* state and automatically transitions to *active* after backend processing is complete.', 'type' => 'string', 'example' => 'offline', 'title' => ''], 'Name' => ['description' => 'The name of the media fingerprint library.', 'type' => 'string', 'example' => 'example-name-****', 'title' => ''], 'FpDBId' => ['description' => 'The ID of the media fingerprint library. Save this ID for subsequent API calls.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'ModelId' => ['description' => 'The model ID of the media fingerprint library.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'Config' => ['description' => 'The configuration of the media fingerprint library.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'CreateFpShotDB', 'description' => '- This operation creates media fingerprint libraries for video, audio, images, and text.'."\n" ."\n" .'- You can create text media fingerprint libraries only in the China (Shanghai) region.'."\n" ."\n" .'- By default, each user can create up to five media fingerprint libraries. To increase the limit, submit a ticket. To delete unneeded libraries, call the `SubmitFpDBDeleteJob` operation.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The queries per second (QPS) limit for this operation is 100 per user. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you call this operation at a reasonable rate. For more information, see [QPS limit](~~342832~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFpShotDB'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:CreateFpShotDB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeactivateMediaWorkflow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaWorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media workflow that is deactivated.'."\n", 'type' => 'string', 'required' => true, 'example' => '93ab850b4f6f44eab54b6e9181d4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The name of the media workflow that is deactivated.'."\n", 'type' => 'string', 'example' => '16CD0CDD-457E-420D-9755-8385075A1234', 'title' => ''], 'MediaWorkflow' => [ 'description' => 'The topology of the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => '* After you deactivate a media workflow, you can modify the workflow information.'."\n" .'* After you delete or deactivate a media workflow, the workflow cannot be used. In this case, the workflow is not automatically triggered when you upload a file to the bucket specified by the workflow.'."\n" ."\n" .'## Limits on QPS'."\n" ."\n" .'You can call this operation up to 100 times per second. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limits](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', 'type' => 'string', 'example' => '2016-04-01T05:29:37Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow that you want to deactivate. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e9181d4****', 'title' => ''], 'State' => ['description' => 'The topology of the media workflow.The status of the media workflow. The value is **Inactive**.', 'type' => 'string', 'example' => 'Inactive', 'title' => ''], 'Name' => ['description' => 'The details of the media workflow.'."\n", 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'Topology' => ['description' => 'The status of the media workflow. The value is **Inactive**.'."\n", '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"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'DeactivateMediaWorkflow', 'summary' => 'Disables a media workflow.', 'description' => 'The time when the media workflow was created.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeactivateMediaWorkflow'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:DeactivateMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'DeleteCustomEntity' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The custom type. Valid values: '."\n" ."\n" .'- landmark: Custom landmark. '."\n" ."\n" .'- object: Custom object. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupId', 'in' => 'query', 'schema' => ['description' => 'The custom library ID. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'CustomEntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID of the custom library entity. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters. ', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID, which is unique. ', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","type":"json"}]', 'title' => 'Delete a custom library entity ', 'summary' => 'Delete a custom library entity. ', 'description' => 'This API currently supports the China (Beijing), China (Shanghai), and China (Hangzhou) regions. Other regions are not supported yet. '."\n" ."\n" .'## Queries per second (QPS) limit '."\n" .'The QPS limit for this API is 50 queries per second (QPS) per user. If you exceed this limit, your API calls will be rate-limited, which may impact your business. Invoke the API appropriately. For more information, see [QPS limits](~~342832~~). ', 'changeSet' => [ ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomEntity'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteCustomEntity', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteCustomGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The custom type of the image library. Valid values:'."\n" ."\n" .'* landmark: custom landmarks.'."\n" .'* object: custom objects.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom image library.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. This parameter is unique.'."\n", 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], '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' => 'DeleteCustomGroup', 'summary' => 'Delete a custom image library.', 'description' => 'You can call this operation only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteCustomGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomGroup'], ], ], ], 'DeleteCustomView' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The custom type. Valid values:'."\n" ."\n" .'- landmark: Custom landmark.'."\n" ."\n" .'- object: Custom object.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupId', 'in' => 'query', 'schema' => ['description' => 'The custom library ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'CustomEntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID of the custom library entity.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'CustomViewId', 'in' => 'query', 'schema' => ['description' => 'The view image ID under the custom library entity.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID, which is unique.', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","type":"json"}]', 'title' => 'Delete a custom entity image', 'summary' => 'Delete a custom entity image.', 'description' => 'This API currently supports the following regions: China (Beijing), China (Shanghai), and China (Hangzhou). Other regions are not supported yet.'."\n" ."\n" .'## Queries per second (QPS) limit'."\n" .'The queries per second (QPS) limit for this API is 50 requests per second per user. If you exceed this limit, your API calls will be subject to rate limiting, which may impact your business. Please invoke the API appropriately. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomView'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteCustomView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteMedia' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the media files that you want to remove. Separate multiple IDs with commas (,). You can remove up to 10 media files at a time.'."\n" ."\n" .'> You can obtain the ID of the media file from the response parameters of the [AddMedia](~~44458~~) operation. Alternatively, you can log on to the MPS console. In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage** in the Actions column. The ID of the video is displayed on the Basics tab.'."\n", 'type' => 'string', 'required' => true, 'example' => '3e1cd21131a94525be55acf65888****,3e6149d5a8c944c09b1a8d2dc3e4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'DeleteMedia', 'summary' => 'Deletes media files from ApsaraVideo Media Processing (MPS).', 'description' => 'This operation allows you to logically delete a media file. The media file can no longer be processed, but the corresponding objects in the input and output Object Storage Service (OSS) buckets are retained.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMedia'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteMediaTag' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media file for which you want to remove a tag. To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage** in the Actions column. The ID of the video is displayed on the Basics tab.'."\n", 'type' => 'string', 'required' => true, 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => ['description' => 'The media tag that you want to remove. The value is encoded in UTF-8 and can be up to 32 bytes in length.'."\n" ."\n" .'> You can remove only one tag at a time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '283DC68C-146F-4489-A2A1-2F88F1472A56', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteMediaTag', 'summary' => 'Removes a tag for a media file.', 'description' => 'You can call this operation to remove only one tag at a time.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaTag'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteMediaTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"283DC68C-146F-4489-A2A1-2F88F1472A56\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 283DC68C-146F-4489-A2A1-2F88F1472A56\\n","errorExample":""}]', ], 'DeleteMediaWorkflow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'MediaWorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media workflow that you want to delete. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => '93ab850b4f6f44eab54b6e9181d4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7D752035-97DA-54E5-88E2-E8405EEA4394', 'title' => ''], 'MediaWorkflow' => [ 'description' => 'The information about the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '2016-04-01T05:29:37Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow that is deleted.'."\n", 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e9181d4****', 'title' => ''], 'State' => ['description' => 'The status of the media workflow. The value is **Deleted**.'."\n", 'type' => 'string', 'example' => 'Deleted', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow that is deleted.'."\n", 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'Topology' => ['description' => 'The topology of the media workflow.'."\n", '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"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteMediaWorkflow', 'summary' => 'Deletes a media workflow. This does not affect workflow instances that are running.', 'description' => 'After you delete or disable a workflow, the workflow cannot be used. In this case, the workflow is not automatically triggered when you upload a file to the bucket specified by the workflow.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaWorkflow'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'DeletePipeline' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue that you want to delete. To obtain the ID of the MPS queue, you can log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the MPS queue that is deleted.'."\n", 'type' => 'string', 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], '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' => 'DeletePipeline', 'summary' => 'Deletes an ApsaraVideo Media Processing (MPS) queue.', 'description' => 'You can call this operation to delete only one MPS queue at a time.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'changeSet' => [ ['createdAt' => '2024-01-30T11:50:44.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeletePipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteSmarttagTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the template that you want to delete. You can obtain the template ID from the response of the [AddSmarttagTemplate](~~187759~~) operation.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05de22f255284c7a8d2aab535dde****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5F37036F-5267-43F1-AE47-10A18E840739', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], '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' => 'DeleteSmarttagTemplate', 'summary' => 'Deletes a template.', 'description' => 'You can call this operation to delete only one template at a time.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### Sample SDKs'."\n" ."\n" .'* [SDK for Java](~~188025~~)'."\n" .'* [SDK for Python](~~188026~~)'."\n" .'* [SDK for PHP](~~188027~~)'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteSmarttagTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmarttagTemplate'], ], ], ], 'DeleteTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom transcoding template that you want to delete. To obtain the ID of the custom transcoding template, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Encoding Templates** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2247541A-9F27-47EE-B6EC-484B5475****', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the custom transcoding template that is deleted.'."\n", 'type' => 'string', 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteTemplate', 'summary' => 'Deletes a custom transcoding template.', 'description' => 'A custom transcoding template cannot be deleted if it is being used by a job that has been submitted.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-01-30T11:50:43.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'DeleteWaterMarkTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'WaterMarkTemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the watermark template that you want to delete. To obtain the template ID, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Watermark Templates** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => '3780bd69b2b74540bc7b1096f564****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '030E2671-806A-52AF-A93C-DA8E308603A6', 'title' => ''], 'WaterMarkTemplateId' => ['description' => 'The ID of the deleted watermark template.'."\n", 'type' => 'string', 'example' => '3780bd69b2b74540bc7b1096f564****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], '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' => 'DeleteWaterMarkTemplate', 'summary' => 'Deletes a watermark template.', 'description' => 'A watermark template cannot be deleted if it is being used by a submitted job.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaterMarkTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ImAudit' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [], 'parameters' => [ [ 'name' => 'Images', 'in' => 'query', 'schema' => ['description' => 'The image URLs. You can specify up to 5 image URLs. The value must be a JSON array. To view the URLs of the images, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Media Management** > **Media List** in the left-side navigation pane. You must set at least one of the Images and Contents parameters. The image to be moderated must meet the following limits. Otherwise, the moderation task may fail.'."\n" ."\n" .'* The image size cannot exceed 20 MB, the height or width of the image cannot exceed 30,000 pixels, and the image cannot exceed 0.25 billion pixels.'."\n" .'* We recommend that you upload images of at least 256 × 256 pixels to ensure required moderation result.', 'type' => 'string', 'required' => false, 'example' => '["http://127.66.**.**/image.jpeg","http://127.66.**.**/photo.jpeg"]', 'title' => ''], ], [ 'name' => 'Contents', 'in' => 'query', 'schema' => ['description' => 'The custom text entries. You can specify up to 5 text entries. The value must be a JSON array. You must specify at least one of the Images and Contents parameters.', 'type' => 'string', 'required' => false, 'example' => '["Hello","Who are you","Where am I"]', 'title' => ''], ], [ 'name' => 'Scenes', 'in' => 'query', 'schema' => ['description' => 'The moderation scenarios. Separate multiple scenarios with commas (,). For example, if you specify {"porn","terrorism"} for this parameter, both pornographic content detection and terrorist content detection are performed on the images and text. Valid values:'."\n" ."\n" .'* porn: pornography'."\n" .'* terrorism: terrorist content'."\n" .'* ad: ad violation'."\n" .'* qrcode: QR code'."\n" .'* live: undesirable scene'."\n" .'* logo: special logo'."\n" .'* antispam: text anti-spam (valid only for text)'."\n", 'type' => 'string', 'required' => true, 'example' => '["porn","terrorism","ad"]', 'title' => ''], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => ['description' => 'The business type. By default, the public business type is used.'."\n", 'type' => 'string', 'required' => false, 'example' => '139440480445****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TextQuotaExceed' => ['description' => 'Indicates whether the text moderation QPS exceeds the limit. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ImageQuotaExceed' => ['description' => 'Indicates whether the image moderation QPS exceeds the limit. Valid values: true and false. A value of true indicates that the QPS does not exceed the limit. A value of false indicates that the QPS exceeds the limit.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8793421', 'title' => ''], 'ImageResults' => [ 'description' => 'The image moderation results. If the HTTP status code 200 is returned, the array in the returned results contains one or more elements. For more information about the parameters, see [Data returned by the ImAudit operation](~~268644~~).'."\n", 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'The image moderation results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the image moderation results.'."\n", 'type' => 'object', 'properties' => [ 'code' => ['description' => 'The error code. The error code is the same as the HTTP status code. This parameter is not returned if the request is successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'dataId' => ['description' => 'The ID of the moderated object.'."\n" ."\n" .'> If you set the dataId parameter in the moderation request, the dataId parameter is returned in the response.'."\n", 'type' => 'string', 'example' => 'uuid-1234-1234-1234', 'title' => ''], 'extras' => ['description' => 'The additional information about the image. If ad is specified for the Scenes parameter, the following content may be returned for this parameter: hitLibInfo: the information about the custom text library that is hit by the text in the image. The value of this parameter is an array. For more information about the structure, see [hitLibInfo](~~268644~~).'."\n", 'type' => 'object', 'example' => '{"hitLibInfo":[{"context":"检测视频","libCode":"1234567","libName":"相似文本库a"}]}', 'title' => ''], 'msg' => ['description' => 'The message that is returned for the request.'."\n", 'type' => 'string', 'example' => 'ok', 'title' => ''], 'results' => [ 'description' => 'The returned data. If the call is successful, the array in the returned results contains one or more elements. Each element is a struct.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the returned result.'."\n", 'type' => 'object', 'properties' => [ 'Label' => ['description' => 'The category of the moderation results. Valid values vary based on the specified moderation scenario.'."\n" ."\n" .'* If the Scenes parameter is set to porn, the valid values are:'."\n" ."\n" .' * normal: no pornographic content'."\n" .' * sexy: sexy content'."\n" .' * porn: pornographic content'."\n" ."\n" .'* If the Scenes parameter is set to terrorism, the valid values are:'."\n" ."\n" .' * normal: no pornographic content'."\n" .' * bloody: bloody content'."\n" .' * explosion: explosions and smoke'."\n" .' * outfit: special costume'."\n" .' * logo: special logo'."\n" .' * weapon: weapon'."\n" .' * politics: political content'."\n" .' * violence: violence'."\n" .' * crowd: crowd'."\n" .' * parade: parade'."\n" .' * carcrash: car accident'."\n" .' * flag: flag'."\n" .' * location: landmark'."\n" .' * others: other content'."\n" ."\n" .'* If the Scenes parameter is set to ad, the valid values are:'."\n" ."\n" .' * normal: no pornographic content'."\n" .' * ad: ad violation'."\n" .' * politics: politically sensitive content in text'."\n" .' * porn: pornographic content in text'."\n" .' * abuse: abuse in text'."\n" .' * terrorism: terrorist content in text'."\n" .' * contraband: prohibited content in text'."\n" .' * spam: junk content in text'."\n" .' * npx: illegal ad'."\n" .' * qrcode: QR code'."\n" .' * programCode: mini program code'."\n" ."\n" .'* If the Scenes parameter is set to qrcode, the valid values are:'."\n" ."\n" .' * normal: no pornographic content'."\n" .' * qrcode: QR code'."\n" .' * programCode: mini program code'."\n" ."\n" .'* If the Scenes parameter is set to live, the valid values are:'."\n" ."\n" .' * normal: no pornographic content'."\n" .' * meaningless: no content in the image, such as black or white screen'."\n" .' * PIP: picture-in-picture'."\n" .' * smoking: smoking'."\n" .' * drivelive: live broadcasting in a running vehicle'."\n" ."\n" .'* If the Scenes parameter is set to logo, the valid values are:'."\n" ."\n" .' * normal: no pornographic content'."\n" .' * TV: controlled logo'."\n" .' * trademark: trademark'."\n", 'type' => 'string', 'example' => 'sexy', 'title' => ''], 'Rate' => ['description' => 'The score of the confidence level. Valid values: 0 to 100. A greater value indicates a higher confidence level. If a value of pass is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content is normal. If a value of review or block is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content contains violations.'."\n" ."\n" .'> This score is for reference only. We strongly recommend that you do not use this score in your business. We recommend that you use the values that are returned for the suggestion, label, and sublabel parameters to determine whether the content contains violations. The sublabel parameter is returned by some operations.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '91.54', 'title' => ''], 'Scene' => ['description' => 'The image moderation scenario. Valid values:'."\n" ."\n" .'* porn: pornography'."\n" .'* terrorism: terrorist content'."\n" .'* ad: ad violation'."\n" .'* qrcode: QR code'."\n" .'* live: undesirable scene'."\n" .'* logo: special logo'."\n", 'type' => 'string', 'example' => 'porn', 'title' => ''], 'Suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'* pass: The content passes the moderation. No further actions are required.'."\n" .'* review: The moderation object contains suspected violations and requires human review.'."\n" .'* block: The moderation object contains violations. We recommend that you delete or block the object.'."\n", 'type' => 'string', 'example' => 'block', 'title' => ''], 'hintWordsInfo' => [ 'description' => 'The information about the term hit by the ad or violation text detected in the moderated image.'."\n", 'type' => 'array', 'items' => [ 'description' => 'hintWordsInfo'."\n", 'type' => 'object', 'properties' => [ 'context' => ['description' => 'The term hit by the detected text.'."\n", 'type' => 'string', 'example' => 'Sensitive keyword', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'qrcodeData' => [ 'description' => 'The information about the text that is included in the QR code detected in the moderated image.'."\n", 'type' => 'array', 'items' => ['description' => 'The text included in the QR code.'."\n", 'type' => 'string', 'example' => '"http://example.com/01ZZOliO"', 'title' => ''], 'title' => '', 'example' => '', ], 'qrcodeLocations' => [ 'description' => 'The coordinates of the QR code detected in the image.'."\n", 'type' => 'array', 'items' => [ 'description' => 'qrcodeLocation'."\n", 'type' => 'object', 'properties' => [ 'x' => ['description' => 'The distance between the upper-left corner of the QR code area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '11', 'title' => ''], 'y' => ['description' => 'The distance between the upper-left corner of the QR code area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'w' => ['description' => 'The width of the QR code area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '402.0', 'title' => ''], 'h' => ['description' => 'The height of the QR code area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '413.0', 'title' => ''], 'qrcode' => ['description' => 'The URL that the detected QR code points to.'."\n", 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'programCodeData' => [ 'description' => 'The location information of the mini program code detected in the moderated image.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The mini program codes.'."\n", 'type' => 'object', 'properties' => [ 'x' => ['description' => 'The distance between the upper-left corner of the mini program code area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '11.0', 'title' => ''], 'y' => ['description' => 'The distance between the upper-left corner of the mini program code area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], 'w' => ['description' => 'The width of the mini program code area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '402.0', 'title' => ''], 'h' => ['description' => 'The height of the mini program code area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '413.0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'logoData' => [ 'description' => 'The information about the logo detected in the moderated image.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detected logos.'."\n", 'type' => 'object', 'properties' => [ 'type' => ['description' => 'The type of the detected logo. For example, a value of TV indicates a controlled media logo.'."\n", 'type' => 'string', 'example' => 'TV', 'title' => ''], 'name' => ['description' => 'The name of the detected logo.'."\n", 'type' => 'string', 'example' => 'Hunan TV', 'title' => ''], 'x' => ['description' => 'The distance between the upper-left corner of the logo area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '140', 'title' => ''], 'y' => ['description' => 'The distance between the upper-left corner of the logo area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '68', 'title' => ''], 'w' => ['description' => 'The width of the logo area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '106', 'title' => ''], 'h' => ['description' => 'The height of the logo area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '106', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'sfaceData' => [ 'description' => 'The information about the terrorist content detected in the moderated image.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detected terrorist content.'."\n", 'type' => 'object', 'properties' => [ 'x' => ['description' => 'The distance between the upper-left corner of the face area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '49', 'title' => ''], 'y' => ['description' => 'The distance between the upper-left corner of the face area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '39', 'title' => ''], 'w' => ['description' => 'The width of the face area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '47', 'title' => ''], 'h' => ['description' => 'The height of the face area. Unit: pixel.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '121', 'title' => ''], 'faces' => [ 'description' => 'The information about the face detected in the moderated image.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the face detected in the moderated image.'."\n", 'type' => 'object', 'properties' => [ 'name' => ['description' => 'This value is a string, which indicates the name of a similar person.'."\n", 'type' => 'string', 'example' => 'Matched person name', 'title' => ''], 're' => ['description' => 'The score of the confidence level. The value is a float point number. Valid values: 0 to 100. A greater value indicates a higher confidence level for facial recognition.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '91.54', 'title' => ''], 'idid' => ['description' => 'The ID of the detected face. The value is a string.'."\n", 'type' => 'string', 'example' => 'AliFace_0001234', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ocrData' => [ 'description' => 'ocrData'."\n", 'type' => 'array', 'items' => ['description' => 'The information about the complete text detected in the moderated image.'."\n", 'type' => 'string', 'example' => '识别结果', 'title' => ''], 'title' => '', 'example' => '', ], 'frames' => [ 'description' => 'If the temporary access URL of the image is too long, a truncated temporary access URL is returned for each frame.'."\n", 'type' => 'array', 'items' => [ 'description' => 'frame'."\n", 'type' => 'object', 'properties' => [ 'rate' => ['description' => 'The score of the confidence level. Valid values: 0 to 100. A higher confidence level indicates higher reliability of the moderation result. We recommend that you do not use this score in your business.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '89.85', 'title' => ''], 'url' => ['description' => 'The temporary access URL of the truncated frame. The URL is valid for 5 minutes.'."\n", 'type' => 'string', 'example' => 'http://example.com/test-01.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'taskId' => ['description' => 'The ID of the moderation task.'."\n", 'type' => 'string', 'example' => 'img4wlJcb7p4wH4lAP3111111-12****', 'title' => ''], 'url' => ['description' => 'The URL of the moderated object.'."\n", 'type' => 'string', 'example' => 'http://example.com/example-****.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'TextResults' => [ 'description' => 'The text moderation results. If the HTTP status code 200 is returned, the array in the returned results contains one or more elements. For more information about the parameters, see [Data returned by the ImAudit operation](~~268644~~).'."\n", 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'The text moderation results.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the text moderation results.'."\n", 'type' => 'object', 'properties' => [ 'code' => ['description' => 'The error code. The error code is the same as the HTTP status code. For more information, see [Error codes](~~29254~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'content' => ['description' => 'The text that you specify in the moderation request.'."\n", 'type' => 'string', 'example' => 'This is a test text.', 'title' => ''], 'dataId' => ['description' => 'The sequence number of the text.'."\n", 'type' => 'string', 'example' => 'cfd33235-71a4-468b-8137-a5ffe323****', 'title' => ''], 'msg' => ['description' => 'The message that is returned for the request.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], 'results' => [ 'description' => 'The returned data. If the HTTP status code 200 is returned, the array in the returned results contains one or more elements. Each element is a struct.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the returned result.'."\n", 'type' => 'object', 'properties' => [ 'details' => [ 'description' => 'The risky content that the moderated text hits. A text entry can hit multiple pieces of risky content.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the risky content that the moderated text hits.'."\n", 'type' => 'object', 'properties' => [ 'Label' => ['description' => 'The category of the risky content that the moderated text hits. Valid values:'."\n" ."\n" .'* spam: spam'."\n" .'* ad: ad'."\n" .'* politics: political content'."\n" .'* terrorism: terrorist content'."\n" .'* abuse: abuse'."\n" .'* porn: pornographic content'."\n" .'* flood: excessive junk content'."\n" .'* contraband: prohibited content'."\n" .'* meaningless: meaningless content'."\n" .'* customized: custom content, such as a custom keyword'."\n", 'type' => 'string', 'example' => 'porn', 'title' => ''], 'contexts' => [ 'description' => 'The context information of the risky content that the moderated text hits.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The context information of the risky content that the moderated text hits.'."\n", 'type' => 'object', 'properties' => [ 'context' => ['description' => 'The term that the moderated text hits. If the text hits a term, the term is returned. If the text hits the algorithmic model, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'Door-to-door service', 'title' => ''], 'positions' => [ 'description' => 'The position of the term that the moderated text hits in the original text.'."\n", 'type' => 'array', 'items' => ['description' => 'The position of the term that the moderated text hits in the original text.'."\n", 'type' => 'string', 'example' => '{"startPos":1, "endPos":10}', 'title' => ''], 'title' => '', 'example' => '', ], 'libName' => ['description' => 'The name of the custom text library. This parameter is returned if the moderated text hits a term in the custom text library.'."\n", 'type' => 'string', 'example' => 'Your custom dictionary name.', 'title' => ''], 'libCode' => ['description' => 'The code of the custom text library. This parameter is returned if the moderated text hits a term in the custom text library.'."\n", 'type' => 'string', 'example' => '123456', 'title' => ''], 'ruleType' => ['description' => 'The behavior rule. This parameter is returned if the moderated text hits the behavior rule. Valid values:'."\n" ."\n" .'* user_id'."\n" .'* ip'."\n" .'* umid'."\n" .'* content'."\n" .'* similar_content'."\n" .'* imei'."\n" .'* imsi'."\n", 'type' => 'string', 'example' => 'ip', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'label' => ['description' => 'The category of the moderation result for the moderated text. Valid values:'."\n" ."\n" .'* normal: normal content'."\n" .'* spam: spam'."\n" .'* ad: ad'."\n" .'* politics: political content'."\n" .'* terrorism: terrorist content'."\n" .'* abuse: abuse'."\n" .'* porn: pornographic content'."\n" .'* flood: excessive junk content'."\n" .'* contraband: prohibited content'."\n" .'* meaningless: meaningless content'."\n" .'* customized: custom content, such as a custom keyword'."\n", 'type' => 'string', 'example' => 'porn', 'title' => ''], 'rate' => ['description' => 'The score of the confidence level. Valid values: 0 to 100. A greater value indicates a higher confidence level. If a value of pass is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content is normal. If a value of review or block is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content contains violations.'."\n" ."\n" .'> This score is for reference only. We strongly recommend that you do not use this score in your business. We recommend that you use the values that are returned for the suggestion, label, and sublabel parameters to determine whether the content contains violations. The sublabel parameter is returned by some operations.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '99.90', 'title' => ''], 'scene' => ['description' => 'The moderation scenario.'."\n", 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'* pass: The content passes the moderation.'."\n" .'* review: The content needs to be manually reviewed again.'."\n" .'* block: The content contains violations. We recommend that you delete or block the content.'."\n", 'type' => 'string', 'example' => 'block', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'taskId' => ['description' => 'The ID of the moderation task.'."\n", 'type' => 'string', 'example' => 'txt6HB8NQoEbU@5fosnj2xVEM-1t****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], '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\\": \\"Sensitive keyword\\"\\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\\": \\"Hunan TV\\",\\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\\": \\"Matched person 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\\": \\"This is a test text.\\",\\n \\"dataId\\": \\"cfd33235-71a4-468b-8137-a5ffe323****\\",\\n \\"msg\\": \\"OK\\",\\n \\"results\\": [\\n {\\n \\"details\\": [\\n {\\n \\"Label\\": \\"porn\\",\\n \\"contexts\\": [\\n {\\n \\"context\\": \\"Door-to-door service\\",\\n \\"positions\\": [\\n \\"{\\\\\\"startPos\\\\\\":1, \\\\\\"endPos\\\\\\":10}\\"\\n ],\\n \\"libName\\": \\"Your custom dictionary name.\\",\\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":"","errorExample":""}]', 'title' => 'ImAudit', 'summary' => 'Reviews images and text and returns the review results.', 'description' => '* The moderation results are synchronously returned after the moderation is complete.'."\n" .'* You can use the image and text moderation feature only in the China (Beijing), China (Shanghai), and Singapore regions.'."\n" ."\n" .'### QPS limits'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'changeSet' => [ ['createdAt' => '2022-08-30T02:26:27.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-07T09:23:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-04T03:06:08.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImAudit'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:ImAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ImportFpShotJob' => [ 'summary' => 'Submits a job of importing text files to a text fingerprint library.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The Object Storage Service (OSS) URL of the text file to be imported to the text fingerprint library. The value must be a JSON object. Example: {"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.flv"}.'."\n" ."\n" .'> The OSS bucket must reside in the same region as your MPS service.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.txt"}', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue. To view the ID of the MPS queue, perform the following steps: Log on to the **MPS console**. In the left-side navigation pane, choose **Global Settings** > **Pipelines**. The MPS queue is associated with a specified Message Service (MNS) topic. You can submit jobs for different services to different MPS queues. If you do not specify this parameter, the job is submitted to the default MPS queue and no MNS topic is associated with the MPS queue.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ae687c02fe944327ba9631e50da2****', 'title' => ''], ], [ 'name' => 'FpImportConfig', 'in' => 'query', 'schema' => ['description' => 'The job configurations. The value must be a JSON object. Example: `{"SaveType":"onlysave"}`. The `SaveType` field indicates the storage type. Valid values of the SaveType field:'."\n" ."\n" .'* **save**: The fingerprints of the text file are saved to the text fingerprint library only if the text file is not duplicated with content in the text fingerprint library.'."\n" .'* **onlysave**: The fingerprints of the text file are saved to the text fingerprint library.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"SaveType":"onlysave"}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data. The value can contain letters, digits, and special characters. The value can be up to 128 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Chapter":"Ordinary****/Ordinary****Part2/Part2Chapter47.txt"}', 'title' => ''], ], [ 'name' => 'FpDBId', 'in' => 'query', 'schema' => ['description' => 'The ID of the text fingerprint library to which the text file is imported. You can specify only one job of importing text files to a text fingerprint library at a time. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58'], 'JobId' => ['description' => 'The ID of the import job. We recommend that you save this ID for subsequent operations.'."\n", 'type' => 'string', 'example' => 'c074b118ace44395a02063a5ab94****', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'ImportFpShotJob', 'description' => '* You can call this operation to import multiple text files to a text fingerprint library at a time. The system extracts fingerprints from the text files and saves the fingerprints to the text fingerprint library.'."\n" .'* You can call this operation only in the China (Shanghai) region.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => 'When you call this operation, you must enter the JSON-formatted information about the text files. Each row can contain the information about only one text file. In the information, specify the parameters in the following table.'."\n" ."\n" .'|Parameter|Type|Required|Description|'."\n" .'|---|---|---|---|'."\n" .'|PrimaryKey|String|Yes|The unique primary key of the text file.|'."\n" .'|Bucket|String|Yes|The OSS bucket in which the text file resides. For more information, see the definition of an [OSS bucket](~~29212~~).|'."\n" .'|Location|String|Yes|The region in which the data center of the OSS bucket that stores the text file resides. For more information, see the definition of an [OSS region](~~29212~~). Set the value to oss-cn-shanghai.|'."\n" .'|Object|String|Yes|The OSS object that is used as the input text file. The URL of the OSS object must be encoded in UTF-8, with reserved characters being percent-encoded. For more information, see [URL encoding](~~423796~~) and the definition of an [OSS object](~~29212~~).|'."\n" .'|UserData|String|No|The custom data. The value must be in the JSON format. You can include the book name, volume number, and chapter number in the custom data. Example: {"Chapter":"Ordinary\\*\\*\\*\\*/Ordinary\\*\\*\\*\\*Volume 2/Volume 2 Chapter 47.txt"}. The custom data can be up to 128 bytes in length.|', 'changeSet' => [ ['createdAt' => '2022-03-01T01:49:40.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportFpShotJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:ImportFpShotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListAllMediaBucket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. The response to the first request contains this parameter, which is added to the next request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The maximum number of media buckets to return. Valid values: 1 to 100. Default value: 50.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '79760D91-D3CF-4165-****-B7E2836EF62A', 'title' => ''], 'NextPageToken' => ['description' => 'The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => 'P2Zqo1PLGhZdygo-ajSsjUX5zrBHCgXy6j4hEvv****', 'title' => ''], 'MediaBucketList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaBucket' => [ 'description' => 'The media buckets returned.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the media bucket.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media bucket. Valid values:'."\n" ."\n" .'* Input: input media bucket'."\n" .'* Output: output media bucket'."\n", 'type' => 'string', 'example' => 'Input', 'title' => ''], 'Bucket' => ['description' => 'The name of the media bucket.'."\n", 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], 'Referer' => ['description' => 'The settings of Object Storage Service (OSS) hotlink protection. For more information, see [Hotlink protection](~~31869~~).'."\n", 'type' => 'string', 'example' => 'http://www.example.com', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'ListAllMediaBucket', 'summary' => 'Queries all media buckets bound to the media library.', 'description' => 'A maximum of 100 media buckets can be returned.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllMediaBucket'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListAllMediaBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'ListCustomEntities' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'Custom type. Valid values: '."\n" ."\n" .'- landmark: Custom landmark. '."\n" ."\n" .'- object: Custom object. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupId', 'in' => 'query', 'schema' => ['description' => 'Custom group ID. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Quantity per page. The maximum Quantity per page cannot exceed 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID, which is Unique.', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Quantity per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total Quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'CustomEntities' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CustomEntity' => [ 'description' => 'List of entities in the custom library.', 'type' => 'array', 'items' => [ 'description' => 'Detailed information.', 'type' => 'object', 'properties' => [ 'CustomEntityId' => ['description' => 'Entity ID of the custom library entity.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CustomEntityName' => ['description' => 'Entity Name of the custom library entity.', 'type' => 'string', 'example' => 'exampleName', 'title' => ''], 'CustomEntityInfo' => ['description' => 'Additional information about the custom entity, in JSON String format.', 'type' => 'string', 'example' => '{ "finegrainName":"example" }', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Obtain the list of entities under a custom library', 'summary' => 'Obtain the list of entities under a custom library. ', 'description' => 'This API currently supports the following regions: China (Beijing), China (Shanghai), and China (Hangzhou). Other regions are not supported at this time.'."\n" ."\n" .'## queries per second (QPS) limit'."\n" .'The QPS limit for this API is 50 queries per second (QPS) per User. If you exceed this limit, your API Calls will be subject to Rate Limiting, which may Impact your business. Please invoke the API appropriately. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomEntities'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomEntities', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListCustomGroups' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'Custom type. Valid values:'."\n" ."\n" .'- landmark: Custom landmark.'."\n" ."\n" .'- object: Custom object.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of entries per page. The maximum number per page is 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID, which is unique.', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'CustomGroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CustomGroup' => [ 'description' => 'Custom library.', 'type' => 'array', 'items' => [ 'description' => 'Detailed information.', 'type' => 'object', 'properties' => [ 'CustomGroupId' => ['description' => 'Custom library ID.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CustomGroupName' => ['description' => 'Custom library name.', 'type' => 'string', 'example' => 'Custom library name', 'title' => ''], 'CustomGroupDescription' => ['description' => 'Custom library description.', 'type' => 'string', 'example' => 'This is a custom library.', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","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\\": \\"Custom library name\\",\\n \\"CustomGroupDescription\\": \\"This is a custom library.\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Retrieve the list of custom libraries', 'summary' => 'Retrieve the list of custom libraries.', 'description' => 'This API currently supports the China (Beijing), China (Shanghai), and China (Hangzhou) regions. Other regions are not supported at this time.'."\n" ."\n" .'## Queries per second (QPS) limit'."\n" .'The queries per second (QPS) limit for this API is 50 requests per second per user. If you exceed this limit, your API calls will be subject to rate limiting, which may impact your business. Please invoke the API appropriately. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomGroups'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListCustomPersons' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the figure library about which you want to query information. The ID is used to uniquely identify a custom figure library. Make sure that the ID is unique. If you do not specify this parameter, the operation returns all the custom figure libraries. The ID can be up to 120 characters in length and is not case-sensitive.'."\n" ."\n" .'> You cannot specify the ID of the system figure library for this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CategoryId-****', 'title' => ''], ], [ 'name' => 'PersonId', 'in' => 'query', 'schema' => ['description' => 'The ID of the figure about which you want to query information. The ID is used to uniquely identify a figure. Make sure that the ID is unique. If you do not specify this parameter, the operation returns the information about all the figures in the specified figure library.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PersonId-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57', 'title' => ''], 'Categories' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Category' => [ 'description' => 'The array of the figure libraries.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the figure libraries.'."\n", 'type' => 'object', 'properties' => [ 'Persons' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Person' => [ 'description' => 'The array of the figures.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the figures.'."\n", 'type' => 'object', 'properties' => [ 'PersonName' => ['description' => 'The name of the figure.'."\n", 'type' => 'string', 'example' => 'PersonName-****', 'title' => ''], 'PersonDescription' => ['description' => 'The description of the figure.'."\n", 'type' => 'string', 'example' => 'PersonDescription-****', 'title' => ''], 'Faces' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Face' => [ 'description' => 'The array of the faces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the faces.'."\n", 'type' => 'object', 'properties' => [ 'ImageUrl' => ['description' => 'The URL of the facial image that was registered for the figure.'."\n", 'type' => 'string', 'example' => 'http://example-****.jpeg', 'title' => ''], 'FaceId' => ['description' => 'The ID of the face.'."\n", 'type' => 'string', 'example' => '15****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PersonId' => ['description' => 'The ID of the figure.'."\n", 'type' => 'string', 'example' => 'PersonId-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'CategoryId' => ['description' => 'The ID of the figure library.'."\n", 'type' => 'string', 'example' => 'CategoryId-****', 'title' => ''], 'CategoryName' => ['description' => 'The name of the figure library.'."\n", 'type' => 'string', 'example' => 'CategoryName-****', 'title' => ''], 'CategoryDescription' => ['description' => 'The description of the figure library.'."\n", 'type' => 'string', 'example' => 'CategoryDescription-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], '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' => 'ListCustomPersons', 'summary' => 'Queries the information about all figures and faces in a specific figure library.', 'description' => 'You can specify the ID of a figure or a figure library to query the corresponding information. If neither the figure ID nor figure library ID is specified, the operation returns the information about all figures and faces in all figure libraries within the current RAM user.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### SDK sample code'."\n" ."\n" .'* [Java SDK](~~188025~~)'."\n" .'* [Python SDK](~~188026~~)'."\n" .'* [Php SDK](~~188027~~)'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomPersons', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomPersons'], ], ], ], 'ListCustomViews' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The custom type. Valid values:'."\n" ."\n" .'- landmark: a custom landmark.'."\n" ."\n" .'- object: a custom object.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'CustomEntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID in the custom library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The maximum value is 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'CustomViews' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CustomView' => [ 'description' => 'The images in the custom library.', 'type' => 'array', 'items' => [ 'description' => 'The details of the image.', 'type' => 'object', 'properties' => [ 'CustomViewId' => ['description' => 'The ID of the view image in the custom library.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ImageUrl' => ['description' => 'The URL of the image.', 'type' => 'string', 'example' => 'http://127.66.**.**/photo.jpeg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Obtain a list of images for different views of a Custom library entity ', 'summary' => 'Retrieves a list of images for different views of an entity in a custom library.', 'description' => 'This API is available in the China North 2 (Beijing), China East 2 (Shanghai), and China East 1 (Hangzhou) regions. It is not available in other regions.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'You can make up to 50 queries per second (QPS) to this API. If you exceed the limit, rate limiting is applied to your API calls, which may affect your services. Make API calls only as needed. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomViews'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomViews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListFpShotDB' => [ 'summary' => 'Query DNA databases.', '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' => 'The IDs of the media fingerprinting libraries that you want to query. To obtain the library IDs, call the [SubmitFpShotDB](~~170149~~) operation. You can specify up to 10 IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'FpShotDBList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpShotDB' => [ 'description' => 'A list of media fingerprint libraries.', 'type' => 'array', 'items' => [ 'description' => 'The details of the media fingerprinting library.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the media fingerprinting library. Valid values:'."\n" ."\n" .'- **offline**: The library is offline.'."\n" ."\n" .'- **active**: The library is active.'."\n" ."\n" .'- **paused**: The library is paused.'."\n" ."\n" .'- **deleted**: The library is deleted.', 'type' => 'string', 'example' => 'active', 'title' => ''], 'Description' => ['description' => 'The description of the media fingerprinting library.', 'type' => 'string', 'example' => 'This is a text DNA library.', 'title' => ''], 'Name' => ['description' => 'The name of the media fingerprinting library.', 'type' => 'string', 'example' => 'test-****', 'title' => ''], 'ModelId' => ['description' => 'The model ID of the media fingerprinting library. The model ID for text fingerprinting is **11**, for video fingerprinting is **12**, for audio fingerprinting is **13**, and for image fingerprinting is **14**.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'FpDBId' => ['description' => 'The ID of the media fingerprinting library.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'NonExistIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The IDs of the media fingerprinting libraries that do not exist.', 'type' => 'array', 'items' => ['description' => 'The ID of a media fingerprinting library that does not exist. This parameter is not returned if all specified library IDs exist.', 'type' => 'string', 'example' => 'ae687c02fe944327ba9631e50da2****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FpShotDBList\\": {\\n \\"FpShotDB\\": [\\n {\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"This is a text DNA library.\\",\\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}","type":"json"}]', 'title' => 'ListFpShotDB', 'description' => '- This operation returns the status and information of one or more media fingerprinting libraries based on their IDs.'."\n" ."\n" .'- The text fingerprinting feature is available only in the China (Shanghai) region.'."\n" ."\n" .'- This operation queries a maximum of 10 media fingerprinting libraries at a time.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'The limit on calls to this operation is 100 queries per second (QPS) per user. If you exceed the limit, API calls are throttled. This can impact your business. Call this operation at a reasonable rate. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFpShotDB'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListFpShotDB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListFpShotFiles' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ae0fd49c0840e14daf0d66a75b83****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20', 'title' => ''], ], [ 'name' => 'FpDBId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media fingerprint library whose files you want to query. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The media files to be returned must be stored after the specified start time. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-09-01T00:00:28Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The media files to be returned must be stored before the specified end time. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-09-08T23:32:56Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'NextPageToken' => ['description' => 'The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => 'ae0fd49c0840e14daf0d66a75b83****', 'title' => ''], 'FpShotFileList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpShotFile' => [ 'description' => 'The media fingerprint files. For more information, see the "FpShotFile" section of the [Data types](~~29251~~) topic.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the media fingerprint file.'."\n", 'type' => 'object', 'properties' => [ 'PrimaryKey' => ['description' => 'The unique primary key of the input video.'."\n", 'type' => 'string', 'example' => 'fb712a6890464059b1b2ea7c8647****', 'title' => ''], 'InputFile' => [ 'description' => 'The information about the input file.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the input file.'."\n", 'type' => 'string', 'example' => 'example-****.mp4', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region in which the input file resides.'."\n", 'type' => 'string', 'example' => 'oss-cn-beijing', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'FileId' => ['description' => 'The ID of the video file.'."\n", 'type' => 'string', 'example' => '41e6536e4f2250e2e9bf26cdea19****', 'title' => ''], 'StoreTime' => ['description' => 'The time when the media fingerprint file was stored. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n" ."\n" .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", 'type' => 'string', 'example' => '2022-09-08T23:32:56Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter.OutOfRange', 'errorMessage' => 'The specified parameter %s is out of range.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], 'title' => 'ListFpShotFiles', 'summary' => 'Queries media files in a media fingerprint library.', 'description' => '* You can call this operation to query media files in a specific media fingerprint library based on the library ID. This operation supports paged queries.'."\n" .'* You can call this operation only in the China (Beijing), China (Hangzhou), China (Shanghai), and Singapore regions.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-09-08T09:16:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-30T10:53:44.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFpShotFiles'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListFpShotFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'ListFpShotImportJob' => [ 'summary' => 'Queries jobs of importing text files to a text fingerprint library.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The job IDs. You can obtain the job IDs from the response to the [ImportFpShotJob](~~312262~~) operation. You can specify a maximum of 10 job IDs in a request. Separate multiple job IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '88c6ca184c0e47098a5b665e2a12****,c074b118ace44395a02063a5ab94****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58'], 'NonExistIds' => [ 'description' => 'The job IDs that do not exist. This parameter is not returned if all specified job IDs exist.'."\n", 'type' => 'array', 'items' => ['description' => 'The job ID that does not exist.'."\n", 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'title' => '', 'example' => '', ], 'FpShotImportJobList' => [ 'description' => 'The jobs of importing text files to a text fingerprint library.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the import job.'."\n", 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => '25bacf2824614bcf9273dc0744db****', 'title' => ''], 'FpDBId' => ['description' => 'The ID of the text fingerprint library.'."\n", 'type' => 'string', 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is submitted.'."\n", 'type' => 'string', 'example' => 'ebb51ee30f0b49aba959823fa991****', 'title' => ''], 'FpImportConfig' => ['description' => 'The import configuration.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], 'Status' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'* Processing: The job is in progress.'."\n" .'* Fail: The job fails.'."\n" .'* Success: The job is successful.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Code' => ['description' => 'The error code returned when the job fails.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Message' => ['description' => 'The error message returned when the job fails.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2020-06-30T00:33:18Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was completed.'."\n", 'type' => 'string', 'example' => '2020-06-30T00:34:02Z', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.'."\n", 'type' => 'string', 'example' => '001', 'title' => ''], 'Input' => ['description' => 'The input file.'."\n", 'type' => 'string', 'example' => '{\\"Bucket\\":\\"mts-example****\\",\\"Location\\":\\"oss-cn-shanghai\\",\\"Object\\":\\"test-0828/video/test.mp4\\"}', 'title' => ''], 'ProcessMessage' => ['description' => 'The processing information of the job.'."\n", 'type' => 'string', 'example' => 'http://testbucket.oss-cn-shanghai.aliyuncs.com/932ajjw***32ssoj_importResult.txt', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'ListFpShotImportJob', 'description' => 'You can call this operation only in the China (Shanghai) region.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'changeSet' => [ ['createdAt' => '2021-09-28T06:57:12.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFpShotImportJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListFpShotImportJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The token that is used to retrieve the next page of the query results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextPageToken.'."\n", 'type' => 'string', 'required' => false, 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.'."\n" ."\n" .'* Default value: **10**.'."\n" .'* Valid values: **1 to 100**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The state of the transcoding job. Default value: **All**. Valid values:'."\n" ."\n" .'* **All**'."\n" .'* **Submitted**'."\n" .'* **Transcoding**'."\n" .'* **TranscodeSuccess**'."\n" .'* **TranscodeFail**'."\n" .'* **TranscodeCancelled**'."\n", 'type' => 'string', 'required' => false, 'example' => 'All', 'default' => 'All', 'title' => ''], ], [ 'name' => 'StartOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2014-01-10T12:00:00Z', 'title' => ''], ], [ 'name' => 'EndOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2014-01-11T12:00:00Z', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue to which the job is submitted. To obtain the ID of an MPS queue, you can log on to the [MPS console](https://mps.console.aliyun.com/overview) and choose **Global Settings** > **MPS Queue and Callback** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e424d5w5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BC860F04-778A-472F-AB39-E1BF329C1EA8', 'title' => ''], 'NextPageToken' => ['description' => 'The pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], 'JobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Job' => [ 'description' => 'The transcoding jobs.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2014-01-10T12:00:00Z', 'title' => ''], 'Percent' => ['description' => 'The transcoding progress.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.'."\n", 'type' => 'string', 'example' => '2014-01-10T12:20:25Z', 'title' => ''], 'State' => ['description' => 'The state of the job. Valid values:'."\n" ."\n" .'* **Submitted**'."\n" .'* **Transcoding**'."\n" .'* **TranscodeSuccess**'."\n" .'* **TranscodeFail**'."\n" .'* **TranscodeCancelled**'."\n", 'type' => 'string', 'example' => 'TranscodeSuccess', 'title' => ''], 'JobId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '31fa3c9ca8134fb4b0b0f7878301****', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'InternalError', 'title' => ''], 'Message' => ['description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'The operation has failed due to some unknown error, exception or failure.', 'title' => ''], 'Output' => [ 'description' => 'The output of the job.'."\n", 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'The video configurations.'."\n", 'type' => 'object', 'properties' => [ 'Bufsize' => ['description' => 'The size of the buffer.'."\n", 'type' => 'string', 'example' => '6000', 'title' => ''], 'Degrain' => ['description' => 'The strength of the independent noise reduction algorithm.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'BitrateBnd' => [ 'description' => 'The bitrate range of the video.'."\n", 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'The maximum bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '1000', 'title' => ''], 'Min' => ['description' => 'The minimum bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Pad' => ['description' => 'The black borders that are added to the video. Unit: pixel.'."\n" ."\n" .'* Format: width:height:left:top.'."\n" .'* Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Codec' => ['description' => 'The video codec. Valid values: **H.264**, **H.265**, **GIF**, and **WEBP**.'."\n", 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The height of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: the height of the input video.'."\n", 'type' => 'string', 'example' => '720', 'title' => ''], 'Qscale' => ['description' => 'The level of quality control on the video.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Crop' => ['description' => 'The video cropping mode. Valid values:'."\n" ."\n" .'* **border**: automatically detects and removes black borders.'."\n" .'* A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => 'border', 'title' => ''], 'Bitrate' => ['description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '428', 'title' => ''], 'Maxrate' => ['description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '1000', 'title' => ''], 'MaxFps' => ['description' => 'The maximum frame rate.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], 'Profile' => ['description' => 'The codec profile. Valid values:'."\n" ."\n" .'* **baseline**: applicable to mobile devices.'."\n" .'* **main**: applicable to standard-definition devices.'."\n" .'* **high**: applicable to high-definition devices.'."\n" .'* Default value: **high**.'."\n", 'type' => 'string', 'example' => 'high', 'title' => ''], 'Crf' => ['description' => 'The constant rate factor. If this parameter is returned, the value of Bitrate is invalid. Default value: **26**.'."\n", 'type' => 'string', 'example' => '26', 'title' => ''], 'Gop' => ['description' => 'The maximum number of frames between two keyframes. Default value: 250.'."\n", 'type' => 'string', 'example' => '250', 'title' => ''], 'Width' => ['description' => 'The width of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: the width of the input video.'."\n", 'type' => 'string', 'example' => '1280', 'title' => ''], 'Fps' => ['description' => 'The frame rate.'."\n" ."\n" .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" .'* Default value: the frame rate of the input file.'."\n", 'type' => 'string', 'example' => '25', 'title' => ''], 'Preset' => ['description' => 'The preset video algorithm. Default value: medium. Valid values:'."\n" ."\n" .'* **veryfast**'."\n" .'* **fast**'."\n" .'* **medium**'."\n" .'* **slow**'."\n" .'* **slower**'."\n", 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'The scan mode. Valid values:'."\n" ."\n" .'* If this parameter is **empty**, the scan mode of the input file is used.'."\n" .'* **auto**: automatic deinterlacing.'."\n" .'* **progressive**: progressive scan.'."\n" .'* **interlaced**: interlaced scan.'."\n" .'* **By default**, this parameter is empty.'."\n" ."\n" .'**Best practice**: Interlaced scan consumes less bandwidth than progressive scan, but the image quality is poor. Therefore, mainstream video production uses progressive scan.'."\n" ."\n" .'* If **progressive scan** or **interlaced scan** is used when the scan mode of the input file is neither of them, the transcoding job fails.'."\n" .'* We recommend that you use **the scan mode of the input file** or **automatic deinterlacing** to improve compatibility.'."\n", 'type' => 'string', 'example' => 'interlaced', 'title' => ''], 'ResoPriority' => ['description' => 'The priority of the resource.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'The general transcoding configurations. If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.'."\n", 'type' => 'object', 'properties' => [ 'IsCheckAudioBitrate' => ['description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" ."\n" .'* **true**'."\n" ."\n" .'* **false**'."\n" ."\n" .'* Default value:'."\n" ."\n" .' * If this parameter is empty and the codec of the output audio is different from the codec of the input audio, the default value is false.'."\n" .' * If this parameter is empty and the codec of the output audio is the same as the codec of the input audio, the default value is true.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'TransMode' => ['description' => 'The transcoding mode.'."\n" ."\n" .'* Valid values: onepass, twopass, and CBR.'."\n" .'* Default value: onepass.'."\n", 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, a transcoding failure is returned without transcoding the video. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: false.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'AdjDarMethod' => ['description' => 'The method of resolution adjustment. Default value: **none**. Valid values: rescale, crop, pad, and none.'."\n", 'type' => 'string', 'example' => 'none', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, a transcoding failure is returned without transcoding the audio. This parameter has a higher priority than IsCheckAudioBitrate. Valid values:'."\n" ."\n" .'* **false**: The audio bitrate is checked.'."\n" .'* **true**: The audio bitrate is not checked.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Encryption' => [ 'description' => 'The encryption configurations. Only outputs in the M3U8 format are supported.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The encryption type. Only hls-aes-128 may be returned.'."\n", 'type' => 'string', 'example' => 'hls-aes-128', 'title' => ''], 'Key' => ['description' => 'The key that is used to encrypt the video.'."\n", 'type' => 'string', 'example' => 'encryptionkey128', 'title' => ''], 'KeyType' => ['description' => 'The key encryption method. Valid values: Base64 and KMS.'."\n" ."\n" .'> For example, if the key is encryptionkey128, you can encrypt the key in the Base64 format or use Key Management Service (KMS) to encrypt the key.``````', 'type' => 'string', 'example' => 'Base64', 'title' => ''], 'Id' => ['description' => 'The encryption ID.'."\n", 'type' => 'string', 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', 'title' => ''], 'KeyUri' => ['description' => 'The URL that is used to request the key. The URL is Base64-encoded.'."\n", 'type' => 'string', 'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/', 'title' => ''], 'SkipCnt' => ['description' => 'The number of unencrypted frames at the beginning of the video. Leaving these frames unencrypted enables video playback to quickly start.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'WaterMarkList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'WaterMark' => [ 'description' => 'The watermarks.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. For more information, see [Parameter details](~~29253~~). Valid values:'."\n" ."\n" .'* **Image**'."\n" .'* **Text**'."\n", 'type' => 'string', 'example' => 'Image', 'title' => ''], 'ReferPos' => ['description' => 'The position of the watermark.'."\n" ."\n" .'* **TopRight**'."\n" .'* **TopLeft**'."\n" .'* **BottomRight**'."\n" .'* **BottomLeft**'."\n", 'type' => 'string', 'example' => 'TopRight', 'title' => ''], 'Dx' => ['description' => 'The horizontal offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Default value: 0. The value can be an integer or a decimal number.'."\n" ."\n" .'* An integer indicates the pixel value of the horizontal offset.'."\n" ."\n" .' * Valid values: \\[8,4096].'."\n" .' * Unit: pixel.'."\n" ."\n" .'* A decimal number indicates the ratio of the horizontal offset to the width in the output video resolution.'."\n" ."\n" .' * Valid values: (0,1).'."\n" .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" ."\n" .'* An integer indicates the pixel value of the watermark width.'."\n" ."\n" .' * Valid values: \\[8,4096].'."\n" .' * Unit: pixel.'."\n" ."\n" .'* A decimal indicates the ratio of the watermark width to the width in the output video resolution.'."\n" ."\n" .' * Valid values: (0,1).'."\n" .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", 'type' => 'string', 'example' => '50', 'title' => ''], 'Height' => ['description' => 'The height of the watermark. If this parameter is specified in the request, the corresponding parameter in the specified watermark template is overwritten. The value can be an integer or a decimal number.'."\n" ."\n" .'* An integer indicates the pixel value of the watermark height.'."\n" ."\n" .' * Valid values: \\[8,4096].'."\n" .' * Unit: pixel.'."\n" ."\n" .'* A decimal indicates the ratio of the watermark height to the height in the output video resolution.'."\n" ."\n" .' * Valid values: (0,1).'."\n" .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", 'type' => 'string', 'example' => '50', 'title' => ''], 'InputFile' => [ 'description' => 'The watermark input file.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the Object Storage Service (OSS) object that is used as the input file.'."\n", 'type' => 'string', 'example' => 'example-logo-****.png', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'WaterMarkTemplateId' => ['description' => 'The ID of the watermark template.'."\n", 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Dy' => ['description' => 'The vertical offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.'."\n" ."\n" .'* An integer indicates the pixel value of the vertical offset.'."\n" ."\n" .' * Valid values: \\[8,4096].'."\n" .' * Unit: pixel.'."\n" ."\n" .'* A decimal indicates the ratio of the vertical offset to the height in the output video resolution.'."\n" ."\n" .' * Valid values: (0,1).'."\n" .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'WaterMarkConfigUrl' => ['description' => 'The URL of the watermark configuration file.'."\n", 'type' => 'string', 'example' => 'http://example.com/configure', 'title' => ''], 'DeWatermark' => ['description' => 'The configurations of watermark blurring. The value is a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", '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}]}', 'title' => ''], 'M3U8NonStandardSupport' => [ 'description' => 'The non-standard support configuration for M3U8. The value must be a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", 'type' => 'object', 'properties' => [ 'TS' => [ 'description' => 'The non-standard support configurations for TS files. The value is a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", 'type' => 'object', 'properties' => [ 'SizeSupport' => ['description' => 'Indicates whether the size of the TS file is included in the M3U8 file.'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Md5Support' => ['description' => 'Indicates whether the MD5 value of the TS file is included in the M3U8 file. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Priority' => ['description' => 'The priority of the job in the MPS queue to which the job is added.'."\n" ."\n" .'* A value of 10 indicates the highest priority.'."\n" .'* Default value: **6**.'."\n", 'type' => 'string', 'example' => '6', 'title' => ''], 'Audio' => [ 'description' => 'The audio configurations.'."\n", 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The codec profile of the audio. Valid values if the value of Codec is aac: aaclow, aache, aachev2, aacld, and aaceld.'."\n", 'type' => 'string', 'example' => 'aaclow', 'title' => ''], 'Codec' => ['description' => 'The audio codec.'."\n" ."\n" .'* Valid values: aac, mp3, vorbis, and flac.'."\n" .'* Default value: **aac**.'."\n", 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Samplerate' => ['description' => 'The sampling rate.'."\n" ."\n" .'* Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" .'* Unit: Hz.'."\n" .'* Default value: 44100.'."\n" .'* If the video container format is FLV and the audio codec is MP3, the value of this parameter cannot be 32000, 48000, or 96000. If the audio codec is MP3, the value of this parameter cannot be 96000.'."\n", 'type' => 'string', 'example' => '44100', 'title' => ''], 'Qscale' => ['description' => 'The level of quality control on the audio.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.'."\n" ."\n" .'* If the value of Codec is mp3, the value of this parameter can only be 1 or 2.'."\n" .'* If the value of Codec is aac, the value of this parameter can only be 1, 2, 4, 5, 6, or 8.'."\n" .'* Default value: 2.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'Volume' => [ 'description' => 'The volume configurations.'."\n", 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'The method that is used to adjust the volume. Valid values:'."\n" ."\n" .'* **auto**'."\n" .'* **dynamic**'."\n" .'* **linear**'."\n", 'type' => 'string', 'example' => 'auto', 'title' => ''], 'Level' => ['description' => 'The volume adjustment range.'."\n" ."\n" .'* Unit: decibel.'."\n" .'* Default value: **-20**.'."\n", 'type' => 'string', 'example' => '-20', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Unit: Kbit/s.'."\n" .'* Default value: **128**.'."\n", 'type' => 'string', 'example' => '128', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AudioStreamMap' => ['description' => 'The sequence number of the audio stream.'."\n" ."\n" .'* Format: `0:a:{Sequence number}`.'."\n" .'* The sequence number is the index of the audio stream in the list and starts from 0. If no sequence number is specified, the default audio stream is used.'."\n", 'type' => 'string', 'example' => '0:a:0', 'title' => ''], 'MergeList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Merge' => [ 'description' => 'The configurations for merging clips.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start point in time of the clip.'."\n" ."\n" .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" .'* Examples: 01:59:59.999 and 32000.23.'."\n", 'type' => 'string', 'example' => '01:59:59.999或者32000.23', 'title' => ''], 'RoleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role used for delegated authorization.'."\n", 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], 'MergeURL' => ['description' => 'The OSS URL of the clip.'."\n" ."\n" .'* Example: `http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object.flv`.'."\n" .'* The object must be URL-encoded by using the UTF-8 standard.'."\n", 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv', 'title' => ''], 'Duration' => ['description' => 'The duration of the clip.'."\n" ."\n" .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" .'* Examples: 01:59:59.999 and 32000.23.'."\n", 'type' => 'string', 'example' => '01:59:59.999', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SuperReso' => [ 'description' => 'The configurations for using the resolution of the source video.'."\n", 'type' => 'object', 'properties' => [ 'IsHalfSample' => ['description' => 'Indicates whether parameters related to the sampling rate are obtained. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'The custom data.'."\n", 'type' => 'string', 'example' => 'test-001', 'title' => ''], 'OutSubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'OutSubtitle' => [ 'description' => 'The output subtitles.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Map' => ['description' => 'The video track. Format: 0:{Stream}:{Stream sequence number}, that is, 0:v:{video_index}. The value of Stream is v, which indicates a video stream. The sequence number is the index of the video stream in the list and starts from 0.'."\n", 'type' => 'string', 'example' => '0:v:0', 'title' => ''], 'OutSubtitleFile' => [ 'description' => 'The details of the output file.'."\n", 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the RAM role used for delegated authorization.'."\n", 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], 'Object' => ['description' => 'The name of the OSS object that is used as the output file.'."\n", 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region in which the output file is stored.'."\n", 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the job was created. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Message' => ['description' => 'The error message returned if the job failed to be created. This parameter is not returned if the job was created.'."\n", 'type' => 'string', 'example' => 'The specified parameter “%s” cannot be null.', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'VideoStreamMap' => ['description' => 'The sequence number of the video stream.'."\n" ."\n" .'* Format: 0:a:{Sequence number}. Example value: 0:a:0.'."\n" .'* The sequence number is the index of the video stream in the list and starts from 0.'."\n" .'* If no sequence number is specified, the default video stream is used.'."\n", 'type' => 'string', 'example' => '0:a:0', 'title' => ''], 'OutputFile' => [ 'description' => 'The details of the output file.'."\n", 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the RAM role used for delegated authorization.'."\n", 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], 'Object' => ['description' => 'The name of the OSS object that is used as the output file.'."\n", 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region in which the output file is stored.'."\n", 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Rotate' => ['description' => 'The rotation angle of the video.'."\n", 'type' => 'string', 'example' => '90', 'title' => ''], 'Container' => [ 'description' => 'The container format configurations.'."\n", 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The container format.'."\n" ."\n" .'* Default value: mp4.'."\n" .'* Video formats include FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4).'."\n" .'* Audio formats include MP3, MP4, Ogg, FLAC, and M4A.'."\n" .'* Image formats include GIF and WebP.'."\n" .'* If the container format is GIF, the video codec must be GIF.'."\n" .'* If the container format is WebP, the video codec must be WebP.'."\n" .'* If the container format is FLV, the video codec cannot be H.265.'."\n", 'type' => 'string', 'example' => 'flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Clip' => [ 'description' => 'The information about the clip.'."\n", 'type' => 'object', 'properties' => [ 'TimeSpan' => [ 'description' => 'The time span of the clip.'."\n", 'type' => 'object', 'properties' => [ 'Seek' => ['description' => 'The point in time when the clip starts.'."\n" ."\n" .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n" .'* Examples: 01:59:59.999 and 32000.23.'."\n", 'type' => 'string', 'example' => '01:00:59.999', 'title' => ''], 'Duration' => ['description' => 'The duration of the clip.'."\n" ."\n" .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n" .'* Examples: 01:00:59.999 and 32000.23.'."\n", 'type' => 'string', 'example' => '01:00:59.999', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MergeConfigUrl' => ['description' => 'The URL of the merging configuration file. You can specify either MergeList or MergeConfigUrl when you submit the transcoding job.'."\n" ."\n" .'* The configuration file specified by MergeConfigUrl can contain up to 50 clips.'."\n" .'* MergeConfigUrl indicates the URL of the configuration file for merging clips.'."\n" .'* Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details of merging parameters.'."\n" .'* Example of the content of the merging configuration file: `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`.'."\n", 'type' => 'string', 'example' => '{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}', 'title' => ''], 'OpeningList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Opening' => [ 'description' => 'The opening parts.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'openUrl' => ['description' => 'The OSS URL of the opening part.'."\n", 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', 'title' => ''], 'Start' => ['description' => 'The amount of time after which the opening part is played. The value starts from 0.'."\n" ."\n" .'* Unit: seconds.'."\n" .'* Default value: **0**.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Width' => ['description' => 'The width of the opening part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" ."\n" .'* Default value: **-1**.'."\n" .'* A value of -1 indicates that the width of the source of the opening part is retained.'."\n" .'* A value of full indicates that the width of the opening part equals the width of the main part.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], 'Height' => ['description' => 'The height of the opening part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" ."\n" .'* Default value: **-1**.'."\n" .'* A value of -1 indicates that the height of the source of the opening part is retained.'."\n" .'* A value of full indicates that the height of the opening part equals the height of the main part.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'MuxConfig' => [ 'description' => 'The transmuxing configurations.'."\n", 'type' => 'object', 'properties' => [ 'Webp' => [ 'description' => 'The transmuxing configurations for WebP.'."\n", 'type' => 'object', 'properties' => [ 'Loop' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gif' => [ 'description' => 'The transmuxing configurations for GIF.'."\n", 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'The duration for which the final frame is paused. Unit: centisecond.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'DitherMode' => ['description' => 'The color dithering algorithm of the palette. Valid values: **sierra** and **bayer**.'."\n", 'type' => 'string', 'example' => 'bayer', 'title' => ''], 'Loop' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'IsCustomPalette' => ['description' => 'Indicates whether a custom palette is used. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'The segment configurations. The value is a JSON object.'."\n", 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The length of the segment. The value must be an integer. Unit: seconds.'."\n" ."\n" .'* Valid values: \\[1,10].'."\n" .'* Default value: 10.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'TailSlateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TailSlate' => [ 'description' => 'The ending parts.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start time.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'BgColor' => ['description' => 'The color of the bars that are added to the ending part if the size of the ending part is smaller than that of the main part. Default value: **White**. For more information, see [Background colors](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).'."\n", 'type' => 'string', 'example' => 'White', 'title' => ''], 'IsMergeAudio' => ['description' => 'Indicates whether the audio content of the ending part is merged. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Width' => ['description' => 'The width of the ending part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" ."\n" .'* A value of -1 indicates that the width of the source of the ending part is retained. A value of full indicates that the width of the ending part equals the width of the main part.'."\n" .'* Default value: -1.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], 'Height' => ['description' => 'The height of the ending part. Valid values: values in the range of (0, 4096), -1, and full.'."\n" ."\n" .'* A value of -1 indicates that the height of the source of the ending part is retained.'."\n" .'* A value of full indicates that the height of the ending part equals the height of the main part.'."\n" .'* Default value: -1.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], 'BlendDuration' => ['description' => 'The duration of the transition between the main part and the ending part. A fade transition is used: The last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'TailUrl' => ['description' => 'The OSS URL of the ending part.'."\n", 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TemplateId' => ['description' => 'The template ID.'."\n", 'type' => 'string', 'example' => 'S00000000-000010', 'title' => ''], 'SubtitleConfig' => [ 'description' => 'The subtitle configurations.'."\n", 'type' => 'object', 'properties' => [ 'ExtSubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ExtSubtitle' => [ 'description' => 'The external subtitles. The value is a JSON array.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CharEnc' => ['description' => 'The character set used by the external subtitle.'."\n" ."\n" .'* Valid values: UTF-8, GBK, BIG5, and auto.'."\n" .'* Default value: **auto**.'."\n" ."\n" .'> If this parameter is set to auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.'."\n", 'type' => 'string', 'example' => 'auto', 'title' => ''], 'FontName' => ['description' => 'The font of the hardcoded subtitles converted from external subtitles.'."\n", 'type' => 'string', 'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"', 'title' => ''], 'Input' => [ 'description' => 'The input subtitle file.'."\n" ."\n" .'* Files in the SRT or ASS format are supported. For more information, see [Parameter details](~~29253~~).'."\n" .'* Example: `{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"}`.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the input file.'."\n", 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Subtitle' => [ 'description' => 'The subtitles.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Map' => ['description' => 'The sequence number of the video stream. The sequence number is the index of the video stream in the list and starts from 0. If you do not set the corresponding parameter in the request, the default video stream is selected.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Properties' => [ 'description' => 'The media properties.'."\n", 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'The width of the video.'."\n", 'type' => 'string', 'example' => '720', 'title' => ''], 'Height' => ['description' => 'The height of the video.'."\n", 'type' => 'string', 'example' => '1280', 'title' => ''], 'Duration' => ['description' => 'The duration of the video.'."\n", 'type' => 'string', 'example' => '17', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the video.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the video.'."\n", 'type' => 'string', 'example' => '490', 'title' => ''], 'FileFormat' => ['description' => 'The format of the video.'."\n", 'type' => 'string', 'example' => 'mp4', 'title' => ''], 'Streams' => [ 'description' => 'The stream information.'."\n", 'type' => 'object', 'properties' => [ 'VideoStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoStream' => [ 'description' => 'The video streams.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The sequence number of the video stream. The value indicates the position of the video stream in all video streams.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Timebase' => ['description' => 'The time base of the video stream.'."\n", 'type' => 'string', 'example' => '1/15360', 'title' => ''], 'AvgFPS' => ['description' => 'The average frame rate of the video stream.'."\n", 'type' => 'string', 'example' => '30.0', 'title' => ''], 'PixFmt' => ['description' => 'The pixel format of the video stream.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Sar' => ['description' => 'The sample aspect ratio (SAR) of the video stream.'."\n", 'type' => 'string', 'example' => '1:1', 'title' => ''], 'Lang' => ['description' => 'The language of the video stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", 'type' => 'string', 'example' => 'und', 'title' => ''], 'CodecLongName' => ['description' => 'The full name of the codec.'."\n", 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'title' => ''], 'Height' => ['description' => 'The height of the video stream in pixels.'."\n", 'type' => 'string', 'example' => '1280', 'title' => ''], 'NumFrames' => ['description' => 'The total frame rate.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the video stream.'."\n", 'type' => 'string', 'example' => '421.117', 'title' => ''], 'CodecTagString' => ['description' => 'The tag string of the codec.'."\n", 'type' => 'string', 'example' => 'avc1', 'title' => ''], 'HasBFrames' => ['description' => 'Indicates whether the video stream contains B-frames.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'Profile' => ['description' => 'The codec profile.'."\n", 'type' => 'string', 'example' => 'high', 'title' => ''], 'StartTime' => ['description' => 'The start time.'."\n", 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'NetworkCost' => [ 'description' => 'The network bandwidth that was consumed.'."\n", 'type' => 'object', 'properties' => [ 'PreloadTime' => ['description' => 'The amount of time consumed to preload the video stream.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'AvgBitrate' => ['description' => 'The average bitrate of the video stream.'."\n", 'type' => 'string', 'example' => '300', 'title' => ''], 'CostBandwidth' => ['description' => 'The maximum bandwidth that was consumed.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Dar' => ['description' => 'The display aspect ratio (DAR).'."\n", 'type' => 'string', 'example' => '9:16', 'title' => ''], 'CodecName' => ['description' => 'The short name of the codec.'."\n", 'type' => 'string', 'example' => 'h264', 'title' => ''], 'Width' => ['description' => 'The width of the video stream in pixels.'."\n", 'type' => 'string', 'example' => '720', 'title' => ''], 'Duration' => ['description' => 'The duration of the video stream.'."\n", 'type' => 'string', 'example' => '17.233333', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the video stream.'."\n", 'type' => 'string', 'example' => '30.0', 'title' => ''], 'CodecTag' => ['description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '0x31637661', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.'."\n", 'type' => 'string', 'example' => '1/60', 'title' => ''], 'Level' => ['description' => 'The codec level.'."\n", 'type' => 'string', 'example' => '31', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AudioStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AudioStream' => [ 'description' => 'The audio streams.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Timebase' => ['description' => 'The time base of the audio stream.'."\n", 'type' => 'string', 'example' => '1/32000', 'title' => ''], 'Index' => ['description' => 'The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'SampleFmt' => ['description' => 'The sampling format.'."\n", 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'ChannelLayout' => ['description' => 'The output layout of the sound channels.'."\n", 'type' => 'string', 'example' => 'mono', 'title' => ''], 'Lang' => ['description' => 'The language of the audio stream. For more information, see [FFmpeg documentation](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO\\_639-1\\_codes).'."\n", 'type' => 'string', 'example' => 'und', 'title' => ''], 'Samplerate' => ['description' => 'The sampling rate of the audio stream.'."\n", 'type' => 'string', 'example' => '32000', 'title' => ''], 'CodecLongName' => ['description' => 'The full name of the codec.'."\n", 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the audio stream.'."\n", 'type' => 'string', 'example' => '64.136', 'title' => ''], 'CodecTagString' => ['description' => 'The tag string of the codec.'."\n", 'type' => 'string', 'example' => 'mp4a', 'title' => ''], 'StartTime' => ['description' => 'The start time.'."\n", 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'CodecName' => ['description' => 'The short name of the codec.'."\n", 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Duration' => ['description' => 'The duration of the audio stream.'."\n", 'type' => 'string', 'example' => '17.223562', 'title' => ''], 'CodecTag' => ['description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '0x6134706d', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.'."\n", 'type' => 'string', 'example' => '1/32000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubtitleStream' => [ 'description' => 'The subtitle streams.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Lang' => ['description' => 'The language of the subtitle stream.'."\n", 'type' => 'string', 'example' => 'und', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Format' => [ 'description' => 'The format information.'."\n", 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The start time.'."\n", 'type' => 'string', 'example' => '0.064000', 'title' => ''], 'NumPrograms' => ['description' => 'The total number of program streams.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Size' => ['description' => 'The size of the file.'."\n", 'type' => 'string', 'example' => '1057273', 'title' => ''], 'NumStreams' => ['description' => 'The total number of media streams.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'FormatLongName' => ['description' => 'The full name of the container format.'."\n", 'type' => 'string', 'example' => 'QuickTime / MOV', 'title' => ''], 'Duration' => ['description' => 'The total duration.'."\n", 'type' => 'string', 'example' => '17.234000', 'title' => ''], 'Bitrate' => ['description' => 'The total bitrate.'."\n", 'type' => 'string', 'example' => '490.784', 'title' => ''], 'FormatName' => ['description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", 'type' => 'string', 'example' => 'mov', 'title' => ''], ], 'title' => '', 'example' => '', ], 'FileSize' => ['description' => 'The size of the file.'."\n", 'type' => 'string', 'example' => '1057273', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The ID of the MPS queue.'."\n", 'type' => 'string', 'example' => '88c6ca184c0e47b665e2a1267971****', 'title' => ''], 'Input' => [ 'description' => 'The information about the job input.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the job input.'."\n", 'type' => 'string', 'example' => 'example.flv', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region in which the job input is stored.'."\n", 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the job input is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MNSMessageResult' => [ 'description' => 'The message sent by Message Service (MNS) to notify users of the job result.'."\n", 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the message returned if the job was successful.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'The resource operated “%s” cannot be found.', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'ListJob', 'summary' => 'Traverses transcoding jobs', 'description' => '* By default, the returned transcoding jobs are sorted by CreationTime in descending order.'."\n" .'* You can call this operation to return transcoding jobs of the last 90 days. The jobs are returned based on the specified time range.'."\n" .'* You can filter query results by configuring request parameters such as job status, creation time interval, and ApsaraVideo Media Processing (MPS) queue for transcoding.'."\n" .'* By default, MPS does not allow you to access data across regions within the same account. Before you call this operation, make sure that the region that you specify is the same as the region of the transcoding jobs to be queried. Otherwise, this operation may fail to be called, or invalid information may be returned.'."\n" ."\n" .'### [](#qps)QPS limits'."\n" ."\n" .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":"","errorExample":""}]', ], 'ListMediaWorkflowExecutions' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'MediaWorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media workflow whose execution instances you want to query. To obtain the workflow ID, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings**.'."\n", 'type' => 'string', 'required' => false, 'example' => '43b7335a4b1d4fe883670036affb****', 'title' => ''], ], [ 'name' => 'MediaWorkflowName', 'in' => 'query', 'schema' => ['description' => 'The name of the media workflow. To obtain the workflow name, you can log on to the **MPS console** and choose **Workflows** > **Workflow Settings**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example-mediaworkflow-****', 'title' => ''], ], [ 'name' => 'InputFileURL', 'in' => 'query', 'schema' => ['description' => 'The Object Storage Service (OSS) URL of the input file of the media workflow. The URL complies with RFC 3986 and is encoded in UTF-8, with reserved characters being percent-encoded. For more information, see [URL encoding](~~423796~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://example-****.cn-hangzhou.aliyuncs.com/test****.flv', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. The value is a UUID that contains 32 characters. When you request the first page of query results, leave the NextPageToken parameter empty. When you request more query results, specify the value of the NextPageToken parameter returned in the query results on the previous page.'."\n", 'type' => 'string', 'required' => false, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The maximum number of media workflow execution instances to return. Valid values: `[1,100]`. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'default' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'MediaWorkflowExecutionList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaWorkflowExecution' => [ 'description' => 'The details of the media workflows.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '2016-04-01T06:53:43Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow.'."\n", 'type' => 'string', 'example' => '43b7335a4b1d4fe883670036affb****', 'title' => ''], 'State' => ['description' => 'The status of the media workflow. Valid values:'."\n" ."\n" .'* **running**: The execution is in progress.'."\n" .'* **Completed**: The execution is complete.'."\n" ."\n" .'> A value of Completed indicates that the execution is complete. For the information about whether each activity, such as Transcode or Snapshot, is successful, check the status of the activity.'."\n" ."\n" .'* **Fail**: The execution failed.'."\n" .'* **Success**: The execution was successful.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ActivityList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Activity' => [ 'description' => 'The activities that are executed in the media workflow.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the media workflow activity.'."\n", 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The end time of the activity.'."\n", 'type' => 'string', 'example' => '2016-04-01T06:54:00Z', 'title' => ''], 'Type' => ['description' => 'The type of the media workflow activity. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see [Methods supported for media workflows](~~68494~~).'."\n", 'type' => 'string', 'example' => 'Start', 'title' => ''], 'StartTime' => ['description' => 'The start time of the activity.'."\n", 'type' => 'string', 'example' => '2016-04-01T06:53:45Z', 'title' => ''], 'State' => ['description' => 'The status of the activity. Valid values:'."\n" ."\n" .'* **Running**: The activity is being executed.'."\n" .'* **Fail**: The activity failed to be executed.'."\n" .'* **Skipped**: The activity was skipped.'."\n" .'* **Success**: The activity was successfully executed.'."\n" ."\n" .'> For example, the high-definition and standard-definition transcoding activities are to be run after the analysis activity is complete. The system determines the activity to run based on the analysis result. If the definition of the input video content is insufficient, the high-definition transcoding activity may be skipped.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'JobId' => ['description' => 'The ID of the job generated when the activity is executed. We recommend that you keep this ID for subsequent operation calls.'."\n", 'type' => 'string', 'example' => '2376030d9d0849399cd20e20c876****', 'title' => ''], 'Code' => ['description' => 'The error code returned if the request failed.'."\n" ."\n" .'* The specific error code appears if the state of the activity is **Fail**.'."\n" .'* This parameter is not returned if the state of the activity is **Success**.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], 'Message' => ['description' => 'The error message returned if the request failed.'."\n" ."\n" .'* The detailed error message appears if the state of the activity is **Fail**.'."\n" .'* This parameter is not returned if the state of the activity is **Success**.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow activity.'."\n" ."\n" .'> The name of an activity in a media workflow is unique.'."\n", 'type' => 'string', 'example' => 'Act-2', 'title' => ''], 'MNSMessageResult' => [ 'description' => 'The message sent by Message Service (MNS) to notify the user of the job result.'."\n", 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the success message. If the job failed, this parameter is not returned.'."\n", 'type' => 'string', 'example' => '4f3bc83233de4e2f81c7dade443e****', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned if the job failed. If the job was successful, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'MessageConfigEmpty', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the job failed. If the job was successful, this parameter is not returned.'."\n", 'type' => 'string', 'example' => 'The Topic/Queue config is empty, not send message', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'Input' => [ 'description' => 'The custom data of the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'UserData' => ['description' => 'The custom data.'."\n", 'type' => 'string', 'example' => 'example data', 'title' => ''], 'InputFile' => [ 'description' => 'The information about the storage location of the input file of the media workflow in OSS.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the input media file.'."\n", 'type' => 'string', 'example' => 'example-mediaWorkflow-****/example-object-****/example.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS region in which the input file resides.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input media file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaId' => ['description' => 'The ID of the media file. A media file contains all the information about a media workflow.'."\n", 'type' => 'string', 'example' => '512046582a924698a41e0f8b0d2b****', 'title' => ''], 'RunId' => ['description' => 'The ID of the execution instance.'."\n", 'type' => 'string', 'example' => '48e33690ac19445488c706924321****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B', 'title' => ''], 'NextPageToken' => ['description' => 'The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'ListMediaWorkflowExecutions', 'summary' => 'Queries the execution instances of a media workflow.', 'description' => 'This operation returns execution instances only in the recent 90 days.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaWorkflowExecutions'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListMediaWorkflowExecutions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'QueryAnalysisJobList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AnalysisJobIds', 'in' => 'query', 'schema' => ['description' => 'The template analysis job ID list.', 'type' => 'string', 'required' => true, 'example' => 'bb558c1cc25b45309aab5be44d19****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'* **Submitted**: The job has been submitted.'."\n" .'* **Analyzing**: The job is being run.'."\n" .'* **Success**: The job is successful.'."\n" .'* **Fail**: The job fails.'."\n", 'type' => 'string', 'example' => '5CA6E020-4102-4FFF-AA56-5ED7ECD811A1', 'title' => ''], 'AnalysisJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AnalysisJob' => [ 'description' => 'The IDs of template analysis jobs.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2014-01-10T12:00:00Z', 'title' => ''], 'Percent' => ['description' => 'The transcoding progress.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '86', 'title' => ''], 'State' => ['description' => 'The job status.'."\n" ."\n" .'* **Submitted**: The job was submitted.'."\n" .'* **Analyzing**: The job is in progress.'."\n" .'* **Success**: The job was successful.'."\n" .'* **Fail**: The job failed.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'AnalysisConfig' => [ 'description' => 'The job configurations.'."\n", 'type' => 'object', 'properties' => [ 'QualityControl' => [ 'description' => 'The quality control on the job output.'."\n", 'type' => 'object', 'properties' => [ 'MethodStreaming' => ['description' => 'The playback mode. Valid values:'."\n" ."\n" .'* **network**: online playback.'."\n" .'* **local**: playback on on-premises devices.'."\n" .'* Default value: **network**.'."\n", 'type' => 'string', 'example' => 'network', 'title' => ''], 'RateQuality' => ['description' => 'The quality level of the job output. Default value: **25**.'."\n", 'type' => 'string', 'example' => '25', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PropertiesControl' => [ 'description' => 'The control on the attributes of the job output.'."\n", 'type' => 'object', 'properties' => [ 'Deinterlace' => ['description' => 'Specifies whether deinterlacing was forced to run. Valid values:'."\n" ."\n" .'* **Auto**: Deinterlacing was automatically run.'."\n" .'* **Force**: Deinterlacing was forced to run.'."\n" .'* **None**: Deinterlacing was forced not to run.'."\n", 'type' => 'string', 'example' => 'Auto', 'title' => ''], 'Crop' => [ 'description' => 'The cropping configuration of the video image.'."\n", 'type' => 'object', 'properties' => [ 'Top' => ['description' => 'The top margin to be cropped out.'."\n" ."\n" .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Width' => ['description' => 'The width of the video image after the margins are cropped out.'."\n" ."\n" .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Height' => ['description' => 'The height of the video image after the margins are cropped out.'."\n" ."\n" .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Left' => ['description' => 'The left margin to be cropped out.'."\n" ."\n" .'> This parameter is invalid if the Mode parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Mode' => ['description' => 'The cropping mode. Valid values:'."\n" ."\n" .'* **Auto**: Cropping was automatically run.'."\n" .'* **Force**: Cropping was forced to run.'."\n" .'* **None**: Cropping was forced not to run.'."\n" .'* This parameter is required if the value of the Crop parameter is not an empty JSON {}.'."\n", 'type' => 'string', 'example' => 'Auto', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The error message returned if the job failed.'."\n", 'type' => 'string', 'example' => 'The resource operated \\"PipelineId\\" cannot be found', 'title' => ''], 'Priority' => ['description' => 'The priority of the job in the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.'."\n" ."\n" .'* Valid values: **1 to 10**. The value 10 indicates the highest priority.'."\n" .'* Default value: **10**.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'MNSMessageResult' => [ 'description' => 'The message sent by Message Service (MNS) to notify users of the job result.'."\n", 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the message returned if the job was successful. This parameter is not returned if the job failed.'."\n", 'type' => 'string', 'example' => '3ca84a39a9024f19853b21be9cf9****', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'The resource operated \\"PipelineId\\" cannot be found', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TemplateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Template' => [ 'description' => 'The matched preset templates.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Bufsize' => ['description' => 'The buffer size.'."\n" ."\n" .'* Unit: KB.'."\n" .'* Default value: **6000**.'."\n", 'type' => 'string', 'example' => '6000', 'title' => ''], 'Degrain' => ['description' => 'The strength of the independent noise reduction algorithm.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'BitrateBnd' => [ 'description' => 'The average bitrate range of the video.'."\n", 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '1500', 'title' => ''], 'Min' => ['description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '800', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Codec' => ['description' => 'The codec. Valid values: H.264 and H.265. Default value: **H.264**.'."\n", 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The height of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: **the height of the input video**.'."\n", 'type' => 'string', 'example' => '720', 'title' => ''], 'Qscale' => ['description' => 'The level of quality control on the video.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Bitrate' => ['description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '1000', 'title' => ''], 'Maxrate' => ['description' => 'The maximum bitrate of the video.'."\n" ."\n" .'* Valid values: **10 to 50000**.'."\n" .'* Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '2000', 'title' => ''], 'Profile' => ['description' => 'The codec profile. Valid values:'."\n" ."\n" .'* **baseline**: applicable to mobile devices.'."\n" .'* **main**: applicable to standard-definition devices.'."\n" .'* **high**: applicable to high-definition devices.'."\n" .'* Default value: **high**.'."\n", 'type' => 'string', 'example' => 'high', 'title' => ''], 'Crf' => ['description' => 'The constant rate factor.'."\n" ."\n" .'* Default value when the the Codec parameter is set to H.264: **23**, default value when the the Codec parameter is set to H.265: **26**.'."\n" .'* If this parameter is specified, the value of the Bitrate parameter becomes invalid.'."\n", 'type' => 'string', 'example' => '26', 'title' => ''], 'Gop' => ['description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", 'type' => 'string', 'example' => '250', 'title' => ''], 'Width' => ['description' => 'The width of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: **the width of the input video**.'."\n", 'type' => 'string', 'example' => '1280', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the video.'."\n" ."\n" .'* The value is 60 if the frame rate of the input file exceeds 60.'."\n" .'* Default value: **the frame rate of the input video**.'."\n", 'type' => 'string', 'example' => '25', 'title' => ''], 'Preset' => ['description' => 'The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: **medium**.'."\n", 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'The scan mode. Valid values:'."\n" ."\n" .'* **interlaced**'."\n" .'* **progressive**'."\n", 'type' => 'string', 'example' => 'interlaced', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'The general transcoding configurations.'."\n", 'type' => 'object', 'properties' => [ 'TransMode' => ['description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" ."\n" .'* **onepass**'."\n" .'* **twopass**'."\n" .'* **CBR**'."\n", 'type' => 'string', 'example' => 'onepass', 'title' => ''], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The state of the template. Valid values:'."\n" ."\n" .'* **Normal**'."\n" .'* **Deleted**'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'MuxConfig' => [ 'description' => 'The transmuxing configurations.'."\n", 'type' => 'object', 'properties' => [ 'Gif' => [ 'description' => 'The transmuxing configurations for the GIF format.'."\n", 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'The interval between two consecutive loops for the GIF format. Unit: 0.01 second. For example, a value of 500 indicates 5 seconds.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Loop' => ['description' => 'The number of loops for the GIF or WebP format. Default value: 0.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'The segment configurations.'."\n", 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The segment length. Unit: seconds.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'FLV-UD', 'title' => ''], 'Audio' => [ 'description' => 'The audio codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The codec profile of the audio. Valid values when the **Codec** parameter is set to **aac**:'."\n" ."\n" .'* **aac_low**'."\n" .'* **aac_he**'."\n" .'* **aac_he_v2**'."\n" .'* **aac_ld**'."\n" .'* **aac_eld**'."\n", 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Codec' => ['description' => 'The audio codec. Default value: **aac**. Valid values:'."\n" ."\n" .'* **aac**'."\n" .'* **mp3**'."\n" .'* **vorbis**'."\n" .'* **flac**'."\n", 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Samplerate' => ['description' => 'The sampling rate.'."\n" ."\n" .'* Unit: Hz.'."\n" .'* Default value: **44100**.'."\n", 'type' => 'string', 'example' => '44100', 'title' => ''], 'Qscale' => ['description' => 'The level of quality control on the audio.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels. Default value: **2**.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Valid values: **8 to 1000**.'."\n" .'* Unit: Kbit/s.'."\n" .'* Default value: **128**.'."\n", 'type' => 'string', 'example' => '128', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'The transcoding template ID.'."\n", 'type' => 'string', 'example' => 'S00000000-00****', 'title' => ''], 'Container' => [ 'description' => 'The container format configurations.'."\n", 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The container format.'."\n", 'type' => 'string', 'example' => 'flv', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'The custom data.'."\n", 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job fails.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], 'InputFile' => [ 'description' => 'The information about the job input.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the Object Storage Service (OSS) object that is used as the input file.'."\n", 'type' => 'string', 'example' => 'example.flv', 'title' => ''], 'Location' => ['description' => 'The region in which OSS resides.'."\n", 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.'."\n", 'type' => 'string', 'example' => 'bb558c1cc25b45309aab5be44d19****', 'title' => ''], 'Id' => ['description' => 'The ID of the template analysis job.'."\n", 'type' => 'string', 'example' => '57f6aa3f84824309bcba67231b406****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NonExistAnalysisJobIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The message sent by Message Service (MNS) to notify the user of the job result.'."\n", 'type' => 'array', 'items' => ['description' => 'The operation that you want to perform. Set the value to **QueryAnalysisJobList**.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'QueryAnalysisJobList', 'summary' => 'Queries the template analysis job and returns a list of available preset templates when the template analysis job is complete.', 'description' => 'The time when the job was created.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAnalysisJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryAnalysisJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'QueryCopyrightExtractJob' => [ 'summary' => 'Invoke this API to query a job for fetching copyright watermark information. ', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222525', 'abilityTreeNodes' => ['FEATUREmtsRH229Z'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Job ID. You can obtain it from the response parameters after submitting a copyright watermark extraction job. ', 'type' => 'string', 'required' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], ], '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' => 'Return message ', 'type' => 'string', 'example' => 'ok'], 'Data' => [ 'title' => '', 'description' => 'Returned data ', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Copyright watermark information ', 'type' => 'string', 'example' => 'example water mark'."\n"], ], 'example' => '', ], 'StatusCode' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], ], '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' => 'Query a copyright watermark extraction job ', 'description' => 'Currently, digital watermarking-related APIs are only supported in the China (Shanghai) and China (Beijing) regions. ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightExtractJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryCopyrightExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryCopyrightJob' => [ 'summary' => 'Invoke this API to query video copyright watermarking jobs. ', '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' => 'The start of the creation time, in UNIX timestamp format. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1627357322', 'title' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', 'schema' => ['description' => 'The end of the creation time, in UNIX timestamp format. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1627357325', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Job ID. ', 'type' => 'string', 'required' => false, 'example' => '2a0697e35a7342859f733a9190c4****', 'title' => ''], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => ['description' => 'Watermark level. Valid values are 0, 1, or 2, indicating the embed channel: 0 for U, 1 for UV, and 2 for YUV. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page index for pagination. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of entries per page. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], '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' => 'Return message ', 'type' => 'string', 'example' => 'T-Head Semiconductor (Shanghai)'], 'Data' => [ 'description' => 'Returned data. ', 'type' => 'array', 'items' => [ 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'Callback' => ['title' => '', 'description' => 'Callback URL ', 'type' => 'string', 'example' => 'http://callbacktest.com/callback'], 'GmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322'], 'GmtModified' => ['title' => '', 'description' => 'Updated At ', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357328'], 'Input' => ['title' => '', 'description' => 'Watermarked video input ', 'type' => 'string', 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"gambling.mp4"}'], 'JobId' => ['title' => '', 'description' => 'Job ID ', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****'], 'Level' => ['title' => '', 'description' => 'Watermark strength ', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'Message' => ['title' => '', 'description' => 'Watermark information ', 'type' => 'string', 'example' => '平头哥半导体(上海)'], 'Output' => ['title' => '', 'description' => 'Watermarked video output ', 'type' => 'string', 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}'], 'Status' => ['title' => '', 'description' => 'Status ', 'type' => 'string', 'example' => 'success'], 'UserData' => ['title' => '', 'description' => 'User Data ', 'type' => 'string', 'example' => '123'], 'UserId' => ['title' => '', 'description' => 'User ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1346693***'], 'Result' => ['title' => '', 'description' => 'Task Result ', 'type' => 'string', 'example' => '{"Code":"success","Message":"ok"}'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'StatusCode' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CA6E020-4102-4FFF-AA56-5ED7ECD811A1\\",\\n \\"Message\\": \\"T-Head Semiconductor (Shanghai)\\",\\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' => 'Query video copyright watermark jobs ', 'description' => '- Currently, digital watermarking-related APIs are only supported in the China (Shanghai) and China (Beijing) regions. '."\n" .'- The maximum time range for querying historical data (job information) is six months. ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryCopyrightJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'QueryFpDBDeleteJobList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the jobs to query. You can get job IDs from the response of the [SubmitFpDBDeleteJob](~~209341~~) operation. To query multiple jobs, separate the IDs with a comma (,). If you omit this parameter, the operation returns the 20 most recent jobs.', 'type' => 'string', 'required' => false, 'example' => '2288c6ca184c0e47098a5b665e2a12****,78dc866518b843259669df58ed30****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4247B23C-26DE-529F-8D9F-FD6811AE979B', 'title' => ''], 'FpDBDeleteJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpDBDeleteJob' => [ 'description' => 'The list of FpDB deletion jobs. For more information, see [FpDBDeleteJob](~~93555~~).', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2020-06-30T00:33:18Z', 'title' => ''], 'Status' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'- **Queuing**: The job is in the queue.'."\n" ."\n" .'- **Analyzing**: The job is being analyzed.'."\n" ."\n" .'- **Success**: The job completed successfully.'."\n" ."\n" .'- **Fail**: The job failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was completed.', 'type' => 'string', 'example' => '2020-06-30T00:34:02Z', 'title' => ''], 'DelType' => ['description' => 'The operation type.', 'type' => 'string', 'example' => 'Purge', 'title' => ''], 'UserData' => ['description' => 'The custom data that was passed in the request.', 'type' => 'string', 'example' => 'example data', 'title' => ''], 'Code' => ['description' => 'The error code for a failed job.', 'type' => 'string', 'example' => 'ServiceUnavailable', 'title' => ''], 'Message' => ['description' => 'The error message for a failed job.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the pipeline.', 'type' => 'string', 'example' => 'fb712a6890464059b1b2ea7c8647****', 'title' => ''], 'FpDBId' => ['description' => 'The ID of the media fingerprint library.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Id' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '25bacf2824614bcf9273dc0744db****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => 'A list of jobs.', 'title' => '', 'example' => '', ], 'NonExistIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'A list of job IDs that do not exist.', 'type' => 'array', 'items' => ['description' => 'A job ID that could not be found.', 'type' => 'string', 'example' => '78dc866518b843259669df58ed30****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => 'A list of job IDs that do not exist.', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'QueryFpDBDeleteJobList', 'summary' => 'Queries the status of one or more jobs submitted to clear or delete a media fingerprint library (FpDB).', 'description' => 'You can call this operation to query jobs by specifying their job IDs. If you do not provide any job IDs, the operation returns a list of the 20 most recent jobs.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The QPS limit for this operation is 100 calls per second per account. Exceeding this limit triggers throttling, which may affect your business. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFpDBDeleteJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryFpDBDeleteJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryFpFileDeleteJobList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the jobs of deleting media files from a media fingerprint library. You can obtain the job IDs from the response parameters of the [SubmitFpFileDeleteJob](~~209274~~) operation. Separate multiple job IDs with commas (,). If you leave this parameter empty, the system returns the latest 20 jobs that are submitted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd98459323c024947a104f6a50cbf****,c2dc694696f1441591c5012a73c1****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12', 'title' => ''], 'FpFileDeleteJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpFileDeleteJob' => [ 'description' => 'The jobs of deleting media files from a media fingerprint library. For more information, see the "FpFileDeleteJob" section of the [Data types](~~93555~~) topic.', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2020-06-30T00:33:18Z', 'title' => ''], 'Status' => ['description' => 'The status of the job. Valid values: Valid values:'."\n" ."\n" .'* **Queuing**: The job is waiting in the queue.'."\n" .'* **Analysing**: The job is in progress.'."\n" .'* **Success**: The job is successful.'."\n" .'* **Fail**: The job fails.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.'."\n", 'type' => 'string', 'example' => '2020-06-30T00:34:02Z', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.'."\n", 'type' => 'string', 'example' => 'example data', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.'."\n", 'type' => 'string', 'example' => 'ServiceUnavailable', 'title' => ''], 'Message' => ['description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.'."\n", 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.'."\n", 'type' => 'string', 'example' => 'fb712a6890464059b1b2ea7c8647****', 'title' => ''], 'FpDBId' => ['description' => 'The ID of the media fingerprint library.'."\n", 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Id' => ['description' => 'The ID of the job.'."\n", 'type' => 'string', 'example' => '25bacf2824614bcf9273dc0744db****', 'title' => ''], 'FileIds' => ['description' => 'The ID of the file.'."\n", 'type' => 'string', 'example' => '41e6536e4f2250e2e9bf26cdea19****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NonExistIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The response parameters.'."\n", 'type' => 'array', 'items' => ['description' => 'The IDs of the jobs that do not exist.'."\n", 'type' => 'string', 'example' => 'c2dc694696f1441591c5012a73c1****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], 'title' => 'QueryFpFileDeleteJobList', 'summary' => 'Queries the jobs of deleting media files from a media fingerprint library.', 'description' => 'You can call this operation to query the specified jobs of deleting media files from a media fingerprint library based on the job IDs. If you do not specify job IDs, the system returns the latest 20 jobs that are submitted.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 500 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFpFileDeleteJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryFpFileDeleteJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'QueryFpShotJobList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the DNA jobs to query. Separate multiple IDs with a comma (,). You can specify up to 10 jobs at a time.', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token used to retrieve the next page of results. Omit this parameter for the first request. For subsequent requests, use the token returned in the previous response.', 'type' => 'string', 'required' => false, 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The maximum number of jobs to return on each page.'."\n" ."\n" .'- Default value: 10.'."\n" ."\n" .'- Valid values: 1 to 30.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The job status to query. Valid values:'."\n" ."\n" .'- All: All jobs.'."\n" ."\n" .'- Queuing: The job is awaiting processing.'."\n" ."\n" .'- Analysing: Analysis is in progress.'."\n" ."\n" .'- Fail: The job failed.'."\n" ."\n" .'- Success: The job was successful.', 'type' => 'string', 'required' => false, 'default' => 'All', 'example' => 'All', 'title' => ''], ], [ 'name' => 'StartOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The start of the time range for querying jobs by their creation time.'."\n" ."\n" .'- The time must be in UTC.'."\n" ."\n" .'- Use the ISO 8601 standard format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-12-22T03:48:05Z', 'title' => ''], ], [ 'name' => 'EndOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The end of the time range for querying jobs by their creation time.'."\n" ."\n" .'- The time must be in UTC.'."\n" ."\n" .'- Use the ISO 8601 standard format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2022-02-14T02:16:07Z', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The pipeline ID. You can obtain the ID from the [**Media Processing console**](https://mps.console.aliyun.com/overview) by navigating to **global settings** > **Pipelines and Callbacks**.', 'type' => 'string', 'required' => false, 'example' => 'b11c171cced04565b1f38f1ecc39**** ', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'NextPageToken' => ['description' => 'The token that is required to retrieve the next page of results. You can value of this parameter for the next request.', 'type' => 'string', 'example' => 'b11c171cced04565b1f38f1ecc39****', 'title' => ''], 'FpShotJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpShotJob' => [ 'description' => 'The DNA jobs.', 'type' => 'array', 'items' => [ 'description' => 'The details of a DNA job.', 'type' => 'object', 'properties' => [ 'FpShotResult' => [ 'description' => 'The query results for a DNA job.', 'type' => 'object', 'properties' => [ 'AudioFpShots' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpShot' => [ 'description' => 'The query results for audio DNA.', 'type' => 'array', 'items' => [ 'description' => 'The detailed query results for audio DNA.', 'type' => 'object', 'properties' => [ 'PrimaryKey' => ['description' => 'The primary key.', 'type' => 'string', 'example' => '498ac941373341599c4777c8d884****', 'title' => ''], 'FpShotSlices' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpShotSlice' => [ 'description' => 'The similar audio segments.', 'type' => 'array', 'items' => [ 'description' => 'The details of the similar audio segments.', 'type' => 'object', 'properties' => [ 'Duplication' => [ 'description' => 'The start time and duration of the audio segment in the DNA library.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Similarity' => ['description' => 'The similarity of the audio segment.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Input' => [ 'description' => 'The start time and duration of the input audio segment.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Similarity' => ['description' => 'The overall similarity of the audio.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'FpShots' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpShot' => [ 'description' => 'The query results for video DNA.', 'type' => 'array', 'items' => [ 'description' => 'The detailed query results for video DNA.', 'type' => 'object', 'properties' => [ 'PrimaryKey' => ['description' => 'The primary key of the video.', 'type' => 'string', 'example' => '498ac941373341599c4777c8d884****', 'title' => ''], 'FpShotSlices' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FpShotSlice' => [ 'description' => 'The similar video segments.', 'type' => 'array', 'items' => [ 'description' => 'The details of the similar video segments.', 'type' => 'object', 'properties' => [ 'Duplication' => [ 'description' => 'The start time and duration of the video segment in the DNA library.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start time.', 'type' => 'string', 'example' => '1260', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '48', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Similarity' => ['description' => 'The similarity of the video segment.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Input' => [ 'description' => 'The start time and duration of the input video segment.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start time.', 'type' => 'string', 'example' => '46', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '48', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Similarity' => ['description' => 'The overall similarity of the video.'."\n" ."\n" .'> The overall similarity is the average of the similarity values of individual segments. If multiple similar segments are found in the DNA library, multiple hits are returned.', 'type' => 'string', 'example' => '0.8914769887924194', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TextFpShots' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TextFpShot' => [ 'description' => 'The query results for text DNA.', 'type' => 'array', 'items' => [ 'description' => 'The detailed query results for text DNA.', 'type' => 'object', 'properties' => [ 'PrimaryKey' => ['description' => 'The primary key for the text.', 'type' => 'string', 'example' => '3e34ac649945b53a1b0f863ce030****', 'title' => ''], 'Similarity' => ['description' => 'The similarity of the text.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'TextFpShotSlices' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TextFpShotSlice' => [ 'description' => 'The duplicate text segments.', 'type' => 'array', 'items' => [ 'description' => 'The details of the duplicate text segments.', 'type' => 'object', 'properties' => [ 'Similarity' => ['description' => 'The confidence score for the matched segment.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'InputText' => ['description' => 'The text segment from the input that matched a segment in the base library.', 'type' => 'string', 'example' => '今天下雪了', 'title' => ''], 'DuplicationText' => ['description' => 'The text segment from the base library that was matched.', 'type' => 'string', 'example' => '今天下雪了', 'title' => ''], 'InputFragment' => [ 'description' => 'The start time and duration of the matched segment in the input file.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'CreationTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2017-01-10T12:00:00Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was completed.', 'type' => 'string', 'example' => '0', 'title' => ''], 'State' => ['description' => 'The job status. Valid values:'."\n" ."\n" .'- **Queuing**: The job is in the queue.'."\n" ."\n" .'- **Analyzing**: The job is being analyzed.'."\n" ."\n" .'- **Success**: The job is successful.'."\n" ."\n" .'- **Fail**: The job fails.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The error message returned when the analysis fails. This parameter is not returned if the job is successful.', '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', 'title' => ''], 'FpShotConfig' => [ 'description' => 'The configuration.', 'type' => 'object', 'properties' => [ 'PrimaryKey' => ['description' => 'The unique primary key of the video. You must ensure that this key is unique.', 'type' => 'string', 'example' => '3ca84a39a9024f19853b21be9cf9****', 'title' => ''], 'SaveType' => ['description' => 'The storage type. Valid values:'."\n" ."\n" .'- **nosave**: The DNA of the video is not added to the DNA library.'."\n" ."\n" .'- **save**: The DNA of the video is added to the DNA library after deduplication.'."\n" ."\n" .'- **forcesave**: The DNA of the video is forcibly added to the DNA library.', 'type' => 'string', 'example' => 'save', 'title' => ''], 'FpDBId' => ['description' => 'The ID of the DNA library.', 'type' => 'string', 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'ebb51ee30f0b49aba959823fa991****', 'title' => ''], 'UserData' => ['description' => 'The custom data.', 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'Duration' => ['description' => 'The duration of the input file. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Code' => ['description' => 'The error code returned when the analysis fails.', 'type' => 'string', 'example' => 'InvalidParameter.UUIDFormatInvalid', 'title' => ''], 'InputFile' => [ 'description' => 'The job input.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The OSS object that contains the job input.', 'type' => 'string', 'example' => 'test.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS location that contains the job input.', 'type' => 'string', 'example' => 'oss-cn-beiing', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket that contains the job input.', 'type' => 'string', 'example' => 'oss-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Id' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Input' => ['description' => 'The job input.', 'type' => 'string', 'example' => '{"Bucket":"oss-test","Location":"oss-cn-beiing","Object":"test.mp4"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NonExistIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The list of non-existent job IDs.', 'type' => 'array', 'items' => ['description' => 'The list of non-existent job IDs. This parameter is not returned if no data exists.', 'type' => 'string', 'example' => 'ae687c02fe944327ba9631e50da23128****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'QueryFpShotJobList', 'summary' => 'Retrieves the results of all types of DNA jobs.', 'description' => '- After you submit a DNA job, the DNA service performs a comparison. Call this API to query the job results.'."\n" ."\n" .'- You can query text DNA jobs only in the China (Shanghai) region.'."\n" ."\n" .'- This API queries DNA jobs created within the last six months.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The QPS limit for a single user of this API is 100 queries per second. API calls that exceed this limit are throttled, which may impact your business. Plan your calls accordingly. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-02-18T02:37:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-11-30T10:29:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-26T10:10:27.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-26T06:33:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFpShotJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryFpShotJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryIProductionJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the intelligent production job to query. Obtain it from the response parameters of [Submit an intelligent production job](~~170216~~).', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e432bbf5b665e2a15****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Returned parameters.', 'type' => 'object', 'properties' => [ 'FunctionName' => ['description' => 'Algorithm Name. Valid values:'."\n" ."\n" .'- **VideoH2V**: Video horizontal-to-vertical conversion.'."\n" ."\n" .'- **VideoDelogo**: Video icon removal.'."\n" ."\n" .'- **Cover**: Intelligent thumbnail.'."\n" ."\n" .'- **VideoClip**: Video synopsis.'."\n" ."\n" .'- **ImageH2V**: Image horizontal-to-vertical conversion.'."\n" ."\n" .'- **ImageDelogo**: Image icon removal.'."\n" ."\n" .'- **CaptionExtraction**: Caption extraction.'."\n" ."\n" .'- **VideoDetext**: Video caption removal.'."\n" ."\n" .'- **VideoGreenScreenMatting**: Green screen image matting.'."\n" ."\n" .'- **MusicSegmentDetect**: Chorus Detection.'."\n" ."\n" .'- **AudioMixing**: Audio mixing.'."\n" ."\n" .'- **AudioBeatDetection**: Beat Detection.'."\n" ."\n" .'- **ImageCartoonize**: 3D style and facial stylization (to use facial stylization, contact DingTalk ID: yuanzhigao1209).'."\n" ."\n" .'- **AudioQualityAssessment**: Audio quality assessment.'."\n" ."\n" .' > The audio input for audio quality assessment supports 16-bit quantized WAV audio files with mono or stereo sound channels and a sample rate ranging from 8000 Hz to 48000 Hz.', 'type' => 'string', 'example' => 'ImageCartoonize', 'title' => ''], 'Input' => ['description' => 'OSS Bucket of the input file.', 'type' => 'string', 'example' => 'oss://example-****.oss-cn-hangzhou.aliyuncs.com/example.mp4', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12', 'title' => ''], 'UserData' => ['description' => 'User Business Data.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'State' => ['description' => 'Job status. Valid values:'."\n" ."\n" .'- Queuing: Queuing.'."\n" ."\n" .'- Analysing: Analysis in progress.'."\n" ."\n" .'- Fail: Failed.'."\n" ."\n" .'- Success: Succeeded.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Output' => ['description' => 'OSS Bucket of the output file.', 'type' => 'string', 'example' => 'oss://example-****.oss-cn-hangzhou.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt', 'title' => ''], 'PipelineId' => ['description' => 'MPS queue ID.', 'type' => 'string', 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], 'JobParams' => ['description' => 'Algorithm job parameters.', 'type' => 'string', 'example' => '{mode:"gif"}', 'title' => ''], 'JobId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => '88c6ca184c0e432bbf5b665e2a15****', 'title' => ''], 'Result' => ['description' => 'Detailed job Result. For more information, see [Supplementary description of intelligent production API parameters](~~352026~~).', 'type' => 'string', 'example' => '{"Code":"Success","Data":"{\\"result\\":[{\\"file\\":\\"iproduction/test-result.jpg\\"},{\\"file\\":\\"iproduction/test-origin.jpg\\"}]}","Message":"Successful."}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Query an intelligent production job', 'summary' => 'Query an intelligent production job.', 'description' => 'The query result of this API includes the processing result of the corresponding requested algorithm.'."\n" ."\n" .'## QPS limit'."\n" .'The queries per second (QPS) limit for a single user on this API is 100 requests per second. If this limit is exceeded, API calls will be subject to Rate Limiting, which may Impact your Business Data. Please invoke the API appropriately. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2021-11-23T04:14:46.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryIProductionJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryIProductionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'translator' => 'machine', ], 'QueryJobList' => [ 'summary' => 'Batch query transcoding jobs by transcoding job IDs.', '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' => 'Transcoding job IDs.'."\n" .'- You can query up to 10 jobs at a time. Separate multiple IDs with commas (,).'."\n" .'- You can obtain job IDs from the [MPS console](https://mps.console.aliyun.com/overview) > **Task Management**, or from the response parameters of the [SubmitJobs](~~29226~~) API.'."\n" ."\n" .'> If this parameter is not specified, the `InvalidParameter` (invalid parameter) error code will be returned.', 'type' => 'string', 'required' => false, 'example' => 'bb558c1cc25b45309aab5be44d19****,d1ce4d3efcb549419193f50f1fcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'NonExistJobIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'Non-existent job IDs.', 'type' => 'array', 'items' => ['description' => 'List of non-existent transcoding job IDs. This structure is not returned when there is no data.', 'type' => 'string', 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '197ADF44-104C-514C-9F92-D8924CB34E2A', 'title' => ''], 'JobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Job' => [ 'description' => 'Collection of transcoding jobs.', 'type' => 'array', 'items' => [ 'description' => 'Detailed information of the transcoding job.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'Job creation time.', 'type' => 'string', 'example' => '2014-01-10T12:00:00Z', 'title' => ''], 'Percent' => ['description' => 'Transcoding progress.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'FinishTime' => ['description' => 'Job completion time.', 'type' => 'string', 'example' => '2014-01-10T12:20:25Z', 'title' => ''], 'State' => ['description' => 'Job status.'."\n" ."\n" .'- **Submitted**: The job has been submitted.'."\n" .'- **Transcoding**: Transcoding is in progress.'."\n" .'- **TranscodeSuccess**: Transcoding succeeded.'."\n" .'- **TranscodeFail**: Transcoding failed.'."\n" .'- **TranscodeCancelled**: Transcoding was cancelled.', 'type' => 'string', 'example' => 'TranscodeSuccess', 'title' => ''], 'JobId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '31fa3c9ca8134fb4b0b0f7878301****', 'title' => ''], 'Code' => ['description' => 'Error code when the task fails. This parameter is not returned on success.', 'type' => 'string', 'example' => 'InvalidParameter.NullValue', 'title' => ''], 'Message' => ['description' => 'Error message when the task fails. This parameter is not returned on success.', 'type' => 'string', 'example' => 'The specified parameter "%s" cannot be null.', 'title' => ''], 'Output' => [ 'description' => 'Job output.', 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'Video configuration.', 'type' => 'object', 'properties' => [ 'Bufsize' => ['description' => 'Buffer size.'."\n" ."\n" .'- Unit: Kb.'."\n" .'- Default value: **6000**.', 'type' => 'string', 'example' => '6000', 'title' => ''], 'Degrain' => ['description' => 'Independent denoising algorithm strength.', 'type' => 'string', 'example' => '5', 'title' => ''], 'BitrateBnd' => [ 'description' => 'Video average bitrate range.', 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'Maximum bitrate.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Min' => ['description' => 'Minimum bitrate.', 'type' => 'string', 'example' => '300', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'Video color format. Range: standard color formats such as yuv420p, yuvj420p.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Pad' => ['description' => 'Video padding (black bars).'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'- Parameter format: width:height:left:top.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Codec' => ['description' => 'Codec format.'."\n" ."\n" .'- Supports H.264 and H.265.'."\n" .'- Default value: H.264.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Unit: px.'."\n" .'- Default value: original video height.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Qscale' => ['description' => 'Video quality control factor.', 'type' => 'string', 'example' => '15', 'title' => ''], 'Crop' => ['description' => 'Video cropping. Two methods are supported:'."\n" .'- Auto-detect black bars and crop by setting the value to **border**.'."\n" .'- Custom cropping with the format width:height:left:top.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Bitrate' => ['description' => 'Video average bitrate. Unit: Kbps.', 'type' => 'string', 'example' => '500', 'title' => ''], 'Maxrate' => ['description' => 'Video peak bitrate. Unit: Kbps.', 'type' => 'string', 'example' => '3000', 'title' => ''], 'MaxFps' => ['description' => 'Maximum frame rate.', 'type' => 'string', 'example' => '60', 'title' => ''], 'Profile' => ['description' => 'Encoding profile. Supports baseline, main, and high.'."\n" ."\n" .'> If you have multiple resolutions, it is recommended to configure the lowest resolution as baseline to ensure playback on low-end devices. Configure other resolutions as main or high.'."\n" ."\n" .'- **baseline**: For mobile devices.'."\n" .'- **main**: For standard resolution devices.'."\n" .'- **high**: For high resolution devices.'."\n" .'- Default value: **high**.', 'type' => 'string', 'example' => 'high', 'title' => ''], 'Crf' => ['description' => 'Bitrate-quality control factor.'."\n" ."\n" .'- Default value: **23** for H.264 codec, **26** for H.265 codec.'."\n" .'- If Crf is set, the Bitrate setting will be overridden.', 'type' => 'string', 'example' => '26', 'title' => ''], 'Gop' => ['description' => 'Maximum time interval or maximum number of frames between keyframes. Unit: seconds.'."\n" ."\n" .'- Default value: **250**.'."\n" ."\n" .'- No unit when specifying the maximum number of frames.', 'type' => 'string', 'example' => '250', 'title' => ''], 'Width' => ['description' => 'Width.'."\n" ."\n" .'- Unit: px.'."\n" .'- Default value: original video width.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'Fps' => ['description' => 'Frame rate.'."\n" ."\n" .'- Unit: fps.'."\n" ."\n" .'- When the input file frame rate exceeds 60, it is set to 60.'."\n" .'- Default value: uses the input file frame rate.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Preset' => ['description' => 'Video algorithm preset. Default value: **medium**. Valid values:'."\n" ."\n" .'- **veryfast**: Very fast.'."\n" ."\n" .'- **fast**: Fast.'."\n" ."\n" .'- **medium**: Medium.'."\n" ."\n" .'- **slow**: Slow.'."\n" ."\n" .'- **slower**: Slower.', 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'Scan mode. Valid values:'."\n" .'- **Not set**: Uses the original mode of the input file.'."\n" .'- **auto**: Auto deinterlacing.'."\n" .'- **progressive**: Progressive scan.'."\n" .'- **interlaced**: Interlaced scan.'."\n" .'- **Default value**: Empty, meaning not set.'."\n" ."\n" .'**Best practice**: Although interlaced scanning saves more data than progressive scanning, the image quality is poor, so mainstream video production now uses progressive scanning.'."\n" .'- If you set **progressive** or **interlaced** but it does not match the original video mode, transcoding will fail.'."\n" .'- It is recommended to set the **original video mode** or **auto deinterlacing** to improve compatibility.', 'type' => 'string', 'example' => 'interlaced', 'title' => ''], 'ResoPriority' => ['description' => 'Resource priority.', 'type' => 'string', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'General transcoding configuration.'."\n" ."\n" .'> If this value is set in the request parameters, it overrides the corresponding parameter in the specified transcoding template.', 'type' => 'object', 'properties' => [ 'IsCheckAudioBitrate' => ['description' => 'Whether to check the audio bitrate. When the output audio bitrate exceeds the source audio bitrate, the output audio bitrate is treated as equal to the source audio bitrate, meaning the configured audio bitrate parameter will not take effect. This value has lower priority than IsCheckAudioBitrateFail.'."\n" .'- **true**: Check.'."\n" .'- **false**: Do not check.'."\n" .'- Default value:'."\n" .' - When the parameter is empty and the codec differs from the input source: false.'."\n" .' - When the parameter is empty and the codec is the same as the input source: true.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'TransMode' => ['description' => 'Transcoding mode.'."\n" ."\n" .'- Valid values: onepass, twopass, CBR.'."\n" .'- Default value: **onepass**.', 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Whether to check the resolution. If the output resolution exceeds the input resolution (determined by width or height), the output resolution is treated as equal to the input resolution.'."\n" .'- **true**: Check.'."\n" ."\n" .'- **false**: Do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Whether to check the bitrate. When the output video bitrate exceeds the source video bitrate, transcoding is not performed and a transcoding failure is returned directly. This value has higher priority than IsCheckVideoBitrate.'."\n" ."\n" .'- **true**: Check.'."\n" ."\n" .'- **false**: Do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'AdjDarMethod' => ['description' => 'Resolution rewriting method. Default value: **none**. Valid values: rescale, crop, pad, none.', 'type' => 'string', 'example' => 'none', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Whether to check the video bitrate. If the output video bitrate exceeds the input video bitrate, the output video bitrate is treated as equal to the input video bitrate.'."\n" .'- **true**: Check.'."\n" ."\n" .'- **false**: Do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Whether to check the resolution. If the output resolution exceeds the input resolution (determined by width or height), a transcoding failure is returned.'."\n" .'- **true**: Check.'."\n" ."\n" .'- **false**: Do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Whether to check the audio bitrate. When the output audio bitrate exceeds the source audio bitrate, transcoding is not performed and a transcoding failure is returned directly. This value has higher priority than IsCheckAudioBitrate.'."\n" .'- **true**: Check.'."\n" ."\n" .'- **false**: Do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Encryption' => [ 'description' => 'Data encryption, only supports m3u8 format output.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Encryption type. Valid value: **hls-aes-128**.', 'type' => 'string', 'example' => 'hls-aes-128', 'title' => ''], 'Key' => ['description' => 'Encryption key for the video.', 'type' => 'string', 'example' => 'encryptionkey128', 'title' => ''], 'KeyType' => ['description' => 'Key encryption method. Valid values: Base64, KMS.'."\n" ."\n" .'> For example, if the key is `"encryptionkey128"`, then `Base64("encryptionkey128")` or `KMS(Base64("encryptionkey128"))`.', 'type' => 'string', 'example' => 'Base64', 'title' => ''], 'Id' => ['description' => 'Encryption ID.', 'type' => 'string', 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', 'title' => ''], 'KeyUri' => ['description' => 'Access URL for the key, encoded using BASE64.', 'type' => 'string', 'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/', 'title' => ''], 'SkipCnt' => ['description' => 'Number of initial unencrypted segments (allows the video to start playing quickly).', 'type' => 'string', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'WaterMarkList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'WaterMark' => [ 'description' => 'Watermark list.', 'type' => 'array', 'items' => [ 'description' => 'Watermark details.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Watermark type. If this parameter is set in the request, it overrides the corresponding parameter in the watermark template. For more information, see [Parameter Details](~~29253~~). Valid values:'."\n" ."\n" .'- Image: Image watermark.'."\n" ."\n" .'- Text: Text watermark.', 'type' => 'string', 'example' => 'Image', 'title' => ''], 'ReferPos' => ['description' => 'Watermark position. If this value is set in the request parameters, it overrides the corresponding parameter in the watermark template. Valid values:'."\n" ."\n" .'- TopRight: Top right.'."\n" ."\n" .'- TopLeft: Top left.'."\n" ."\n" .'- BottomRight: Bottom right.'."\n" ."\n" .'- BottomLeft: Bottom left.', 'type' => 'string', 'example' => 'TopRight', 'title' => ''], 'Dx' => ['description' => 'Horizontal offset of the watermark image relative to the output video. If this value is set in the request parameters, it overrides the corresponding parameter in the watermark template. Default value: 0. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the offset in pixels.'."\n" ."\n" .' - Range: **\\[8,4096\\]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio of the horizontal offset to the output resolution width.'."\n" ."\n" .' - Range: (0,1).'."\n" ."\n" .' - Supports four decimal places, for example: 0.9999. Excess decimal places are automatically discarded.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Width' => ['description' => 'Watermark image width. If this value is set in the request parameters, it overrides the corresponding watermark image width in the watermark template. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the watermark image width in pixels.'."\n" ."\n" .' - Range: **\\[8, 4096\\]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio relative to the output video resolution width.'."\n" ."\n" .' - Range: **(0,1)**.'."\n" ."\n" .' - Supports 4 decimal places, for example: 0.9999. Excess decimal places are automatically discarded.', 'type' => 'string', 'example' => '50', 'title' => ''], 'Height' => ['description' => 'Watermark image height. If this value is set in the request parameters, it overrides the corresponding watermark image height in the watermark template. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the watermark image height in pixels.'."\n" ."\n" .' - Range: **\\[8, 4096\\]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio relative to the output video resolution height.'."\n" ."\n" .' - Range: **(0,1)**.'."\n" ."\n" .' - Supports 4 decimal places, for example: 0.9999. Excess decimal places are automatically discarded.', 'type' => 'string', 'example' => '50', 'title' => ''], 'InputFile' => [ 'description' => 'Watermark input file. Currently supports png images and mov files as input files.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'OSS Object of the input file.', 'type' => 'string', 'example' => 'example-logo-****.png', 'title' => ''], 'Location' => ['description' => 'OSS Location of the input file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'OSS Bucket of the input file.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'WaterMarkTemplateId' => ['description' => 'Watermark template ID.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Dy' => ['description' => 'Vertical offset of the watermark image relative to the output video. If this value is set in the request parameters, it overrides the corresponding vertical offset in the watermark template. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the vertical offset in pixels.'."\n" ."\n" .' - Range: **\\[8, 4096\\]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio of the vertical offset relative to the output video.'."\n" ."\n" .' - Range: **(0,1)**.'."\n" ."\n" .' - Supports 4 decimal places, for example: 0.9999. Excess decimal places are automatically discarded.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'WaterMarkConfigUrl' => ['description' => 'Watermark configuration file URL.', 'type' => 'string', 'example' => 'http://example.com/configure', 'title' => ''], 'DeWatermark' => ['description' => 'Dewatering (blur processing), JSON object. For more information, see the blur processing details in [Parameter Details](~~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}]}', 'title' => ''], 'M3U8NonStandardSupport' => [ 'description' => 'M3U8 non-standard support, JSON object. For more information, see the M3U8 non-standard parameter support details in [Parameter Details](~~29253~~).', 'type' => 'object', 'properties' => [ 'TS' => [ 'description' => 'JSON object, TS file related non-standard support. For more information, see the TS parameter support details in [Parameter Details](~~29253~~).', 'type' => 'object', 'properties' => [ 'SizeSupport' => ['description' => 'Whether to support outputting the TS file size in the m3u8 file. Valid values:'."\n" ."\n" .'- **true**: Supported.'."\n" ."\n" .'- **false**: Not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Md5Support' => ['description' => 'Whether to support outputting the TS MD5 value in the m3u8 file. Valid values:'."\n" ."\n" .'- **true**: Supported.'."\n" ."\n" .'- **false**: Not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Priority' => ['description' => 'Priority of the task within its corresponding pipeline.'."\n" ."\n" .'- Highest priority: 10.'."\n" ."\n" .'- Default value: **6**.', 'type' => 'string', 'example' => '6', 'title' => ''], 'Audio' => [ 'description' => 'Audio configuration.'."\n" ."\n" .'> If audio configuration is specified in the request parameters, it overrides the corresponding parameter in the specified transcoding template.', 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'Audio encoding preset. When Codec is aac, valid values are: aaclow, aache, aachev2, aacld, aaceld.', 'type' => 'string', 'example' => 'aaclow', 'title' => ''], 'Codec' => ['description' => 'Audio codec format.'."\n" ."\n" .'- Supports aac, mp3, vorbis, flac.'."\n" ."\n" .'- Default value: **aac**.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Samplerate' => ['description' => 'Sample rate.'."\n" ."\n" .'- Supports 22050, 32000, 44100, 48000, 96000.'."\n" ."\n" .'- Unit: Hz.'."\n" ."\n" .'- Default value: 44100.'."\n" ."\n" .'> When the video container format is flv and the audio codec is mp3, sample rates of 32000, 48000, and 96000 are not supported. When the audio codec is mp3, a sample rate of 96000 is not supported.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Qscale' => ['description' => 'Audio quality control factor.', 'type' => 'string', 'example' => '15', 'title' => ''], 'Channels' => ['description' => 'Number of audio channels.'."\n" ."\n" .'- Supports 1, 2, 3, 4, 5, 6, 7, 8.'."\n" .'- Default value: **2**.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Volume' => [ 'description' => 'Volume configuration.', 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'Volume adjustment method. Valid values:'."\n" ."\n" .'- **auto**: Auto adjustment.'."\n" ."\n" .'- **dynamic**: Dynamic adjustment.'."\n" ."\n" .'- **linear**: Linear adjustment.', 'type' => 'string', 'example' => 'auto', 'title' => ''], 'Level' => ['description' => 'Volume adjustment level. Default value: **-20db**.', 'type' => 'string', 'example' => '-20', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Bitrate' => ['description' => 'Audio bitrate of the output file.'."\n" ."\n" .'- Unit: Kbps.'."\n" .'- Default value: **128**.', 'type' => 'string', 'example' => '128', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AudioStreamMap' => ['description' => 'Audio stream index.'."\n" ."\n" .'- Format: 0:a:{index}, example: 0:a:0.'."\n" ."\n" .'- The index refers to the subscript of the audio stream list, starting from 0.'."\n" ."\n" .'- If not set, the default audio stream is selected.', 'type' => 'string', 'example' => '0:a:0', 'title' => ''], 'MergeList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Merge' => [ 'description' => 'Merge settings. Supports up to 4 MergeURLs.', 'type' => 'array', 'items' => [ 'description' => 'Merge details.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'Start time point.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" .'- Example: 01:59:59.999 or 32000.23.', 'type' => 'string', 'example' => '01:59:59.999', 'title' => ''], 'RoleArn' => ['description' => 'Role information used for delegated authorization.', 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], 'MergeURL' => ['description' => 'Merge segment address.'."\n" ."\n" .'- Example: `http://example-bucket-.oss-cn-hangzhou.aliyuncs.com/example-object.flv`.'."\n" .'- The Object must be URL-encoded using UTF-8 encoding. For more information, see [URL Encoding Description](~~423796~~).', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv', 'title' => ''], 'Duration' => ['description' => 'Duration.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" .'- Example: 01:59:59.999 or 32000.23.', 'type' => 'string', 'example' => '01:59:59.999', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SuperReso' => [ 'description' => 'Resolution follows source.', 'type' => 'object', 'properties' => [ 'IsHalfSample' => ['description' => 'Whether to obtain sample rate related parameters. Valid values:'."\n" ."\n" .'- **true**: Yes.'."\n" ."\n" .'- **false**: No.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'User-defined data.', 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'ExtendData' => ['title' => '', 'description' => 'User-defined extension field.', 'type' => 'string', 'example' => 'testid-002'], 'OutSubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'OutSubtitle' => [ 'description' => 'Output subtitle list.', 'type' => 'array', 'items' => [ 'description' => 'Output subtitle details.', 'type' => 'object', 'properties' => [ 'Map' => ['description' => 'Video track. Format: `0:{stream}:{stream_index}`, i.e., `0:v:{video_index}`. The stream value v indicates a video stream, and the index refers to the subscript of the stream list, starting from 0.', 'type' => 'string', 'example' => '0:v:0', 'title' => ''], 'OutSubtitleFile' => [ 'description' => 'Output file details.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'Role information used for delegated authorization.', 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], 'Object' => ['description' => 'OSS Object of the output file.', 'type' => 'string', 'example' => 'example.flv', 'title' => ''], 'Location' => ['description' => 'OSS Location of the output file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'OSS Bucket of the output file.', 'type' => 'string', 'example' => 'exampleBucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Whether successful. Valid values:'."\n" ."\n" .'- **true**: Succeeded.'."\n" ."\n" .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Message' => ['description' => 'Error message when job creation fails. This parameter is not returned when the job is created successfully.', 'type' => 'string', 'example' => 'The specified parameter “%s” cannot be null.', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'VideoStreamMap' => ['description' => 'Video stream index. The index starts from 0 and refers to the subscript of the video stream list. If not set, the default video stream is selected.', 'type' => 'string', 'example' => '0', 'title' => ''], 'OutputFile' => [ 'description' => 'Output file.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'Role information used for delegated authorization.', 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], 'Object' => ['description' => 'OSS Object of the output file.', 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], 'Location' => ['description' => 'OSS Location of the output file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'OSS Bucket of the output file.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Rotate' => ['description' => 'Video rotation angle.', 'type' => 'string', 'example' => '90', 'title' => ''], 'Container' => [ 'description' => 'Container.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'Container format.'."\n" ."\n" .'- Default value: mp4.'."\n" ."\n" .'- For video transcoding: flv, mp4, HLS (m3u8+ts), MPEG-DASH (MPD+fMP4).'."\n" ."\n" .'- For audio transcoding: mp3, mp4, ogg, flac, m4a.'."\n" ."\n" .'- For images: gif, WEBP. When the container format is gif, VideoCodec can only be set to GIF.'."\n" ."\n" .'- When the container format is webp, VideoCodec can only be set to WEBP.'."\n" ."\n" .'- When the container format is flv, VideoCodec cannot be set to H265.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Clip' => [ 'description' => 'Clip segment.', 'type' => 'object', 'properties' => [ 'TimeSpan' => [ 'description' => 'Clip time span.', 'type' => 'object', 'properties' => [ 'Seek' => ['description' => 'Start time point.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]`.'."\n" ."\n" .'- Example: 01:59:59.999.'."\n" ."\n" .'Or'."\n" ."\n" .'- Format: `sssss[.SSS]`.'."\n" ."\n" .'- Example: 32000.23.', 'type' => 'string', 'example' => '01:59:59.999', 'title' => ''], 'Duration' => ['description' => 'Duration.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]`.'."\n" .'- Example: 01:00:59.999.'."\n" ."\n" .'Or'."\n" ."\n" .'- Format: `sssss[.SSS]`.'."\n" .'- Example: 32000.23.', 'type' => 'string', 'example' => '01:00:59.999', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MergeConfigUrl' => ['description' => 'Merge configuration file URL. Only one of MergeList and MergeConfigUrl can be used.'."\n" ."\n" .'- The configuration file specified by MergeConfigUrl supports up to 50 merge segments.'."\n" ."\n" .'- MergeConfigUrl is the URL of the merge configuration file. Only configuration files stored on OSS are supported, and MPS must have access permissions. For the file content format, see the merge parameter details.'."\n" ."\n" .'- Example of mergeConfigfile content: `{"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', 'title' => ''], 'OpeningList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Opening' => [ 'description' => 'Opening slate list, JSON object.', 'type' => 'array', 'items' => [ 'description' => 'Opening slate details.', 'type' => 'object', 'properties' => [ 'openUrl' => ['description' => 'OSS URL of the opening slate video.', 'type' => 'string', 'example' => 'http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4', 'title' => ''], 'Start' => ['description' => 'Start time relative to the main video.'."\n" ."\n" .'- Delay from 0 before displaying the opening slate video.'."\n" .'- Unit: seconds.'."\n" .'- Default value: **0**.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Width' => ['description' => 'Width.'."\n" ."\n" .'- Range: (0,4096), -1, full.'."\n" .'- -1 represents the source value.'."\n" .'- full means fill the screen.'."\n" .'- Default value: **-1**.', 'type' => 'string', 'example' => '-1', 'title' => ''], 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Range: (0,4096), -1, full.'."\n" .'- -1 represents the source value.'."\n" .'- full means fill the screen.'."\n" .'- Default value: **-1**.', 'type' => 'string', 'example' => '-1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'MuxConfig' => [ 'description' => 'Transcoding mux configuration. If this parameter is set in the request parameters, it overrides the corresponding parameter in the specified transcoding template.', 'type' => 'object', 'properties' => [ 'Webp' => [ 'description' => 'Mux configuration for WebP.', 'type' => 'object', 'properties' => [ 'Loop' => ['description' => 'Loop count.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gif' => [ 'description' => 'Mux configuration for GIF.', 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'Final frame pause time. Unit: centiseconds.', 'type' => 'string', 'example' => '0', 'title' => ''], 'DitherMode' => ['description' => 'Palette color dithering mode. Valid values: sierra, bayer.', 'type' => 'string', 'example' => 'bayer', 'title' => ''], 'Loop' => ['description' => 'Loop count.', 'type' => 'string', 'example' => '0', 'title' => ''], 'IsCustomPalette' => ['description' => 'Custom palette feature. Valid values:'."\n" ."\n" .'- **true**: Custom.'."\n" ."\n" .'- **false**: Not custom.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'Segment configuration, JSON object.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'Segment duration. Unit: seconds.', 'type' => 'string', 'example' => '20', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'TailSlateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TailSlate' => [ 'description' => 'Tail slate list.', 'type' => 'array', 'items' => [ 'description' => 'Tail slate details.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'Tail slate video start time.', 'type' => 'string', 'example' => '00000.00', 'title' => ''], 'BgColor' => ['description' => 'Background color to fill blank areas when the tail slate video dimensions are smaller than the main video. Default value: White. For valid values, see [bgcolor](~~29253~~).', 'type' => 'string', 'example' => 'White', 'title' => ''], 'IsMergeAudio' => ['description' => 'Whether to merge the audio content of the tail slate video. Valid values:'."\n" ."\n" .'- **true**: Merge.'."\n" ."\n" .'- **false**: Do not merge.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Width' => ['description' => 'Width. Range: (0, 4096), -1, full.'."\n" ."\n" .'- -1 represents the source value.'."\n" .'- full means fill the screen.'."\n" .'- Default value: **-1**.', 'type' => 'string', 'example' => '-1', 'title' => ''], 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Range: (0, 4096), -1, full.'."\n" ."\n" .'- -1 represents the source value.'."\n" .'- full means fill the screen.'."\n" .'- Default value: **-1**.', 'type' => 'string', 'example' => '-1', 'title' => ''], 'BlendDuration' => ['description' => 'Duration of the transition between the main video and the tail slate video. The transition effect is a fade: the last frame of the main video is displayed while the tail slate video plays, with the last frame of the main video gradually darkening and the tail slate video gradually brightening. Unit: seconds. Default value: 0.', 'type' => 'string', 'example' => '0', 'title' => ''], 'TailUrl' => ['description' => 'OSS URL of the tail slate video.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => 'S00000001-200010', 'title' => ''], 'SubtitleConfig' => [ 'description' => 'Subtitle configuration.', 'type' => 'object', 'properties' => [ 'ExtSubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ExtSubtitle' => [ 'description' => 'External subtitle list.', 'type' => 'array', 'items' => [ 'description' => 'Subtitle details.', 'type' => 'object', 'properties' => [ 'CharEnc' => ['description' => 'External subtitle character encoding.'."\n" ."\n" .'- Valid values: UTF-8, GBK, BIG5, auto.'."\n" ."\n" .'- Default value: **auto**.'."\n" ."\n" .'> When external subtitle character encoding is set to auto, detection errors may occur. It is recommended to specify a specific character encoding.', 'type' => 'string', 'example' => 'auto', 'title' => ''], 'FontName' => ['description' => 'Font name for converting external subtitles to hardcoded subtitles. Default value: SimSum. For more information, see [Font List](~~59950~~).', 'type' => 'string', 'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"', 'title' => ''], 'Input' => [ 'description' => 'External input subtitle file.'."\n" ."\n" .'- Currently supports srt and ass formats. For more information, see the Input parameter in [Parameter Details](~~29253~~).'."\n" ."\n" .'- Example: `{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"}`.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'OSS Object of the input file.', 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], 'Location' => ['description' => 'OSS Location of the input file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'OSS Bucket of the input file.', 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Subtitle' => [ 'description' => 'Subtitle list.', 'type' => 'array', 'items' => [ 'description' => 'Subtitle details.', 'type' => 'object', 'properties' => [ 'Map' => ['description' => 'Audio track. Format: `0:{stream}:{stream_index}`, i.e., `0:a:{audio_index}`. The stream value a indicates an audio stream, and the index refers to the subscript of the audio stream list, starting from 0.', 'type' => 'string', 'example' => '0:a:0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Properties' => [ 'description' => 'Media properties.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'Video width.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Height' => ['description' => 'Video height.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'SourceLogos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SourceLogo' => [ 'description' => 'Keywords not from the engine layer.', 'type' => 'array', 'items' => [ 'description' => 'Keyword details.', 'type' => 'object', 'properties' => [ 'Source' => ['description' => 'Keyword.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Duration' => ['description' => 'Duration.', 'type' => 'string', 'example' => '17', 'title' => ''], 'Fps' => ['description' => 'Frame rate.', 'type' => 'string', 'example' => '30', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '490', 'title' => ''], 'FileFormat' => ['description' => 'File format.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], 'Streams' => [ 'description' => 'Stream information.', 'type' => 'object', 'properties' => [ 'VideoStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoStream' => [ 'description' => 'Video stream list.', 'type' => 'array', 'items' => [ 'description' => 'Video stream details.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Video stream index, identifying the position of the video stream in the overall media stream.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Timebase' => ['description' => 'Timebase.', 'type' => 'string', 'example' => '1/15360', 'title' => ''], 'AvgFPS' => ['description' => 'Average frame rate.', 'type' => 'string', 'example' => '30.0', 'title' => ''], 'PixFmt' => ['description' => 'Pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Sar' => ['description' => 'Sample aspect ratio (SAR).', 'type' => 'string', 'example' => '1:1', 'title' => ''], 'Lang' => ['description' => 'Language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'CodecLongName' => ['description' => 'Codec long name.', 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'title' => ''], 'Height' => ['description' => 'Video resolution height.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'NumFrames' => ['description' => 'Total number of frames.', 'type' => 'string', 'example' => '30', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '421.117', 'title' => ''], 'CodecTagString' => ['description' => 'Codec tag string.', 'type' => 'string', 'example' => 'avc1', 'title' => ''], 'HasBFrames' => ['description' => 'Whether B-frames are present.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Profile' => ['description' => 'Encoding preset.', 'type' => 'string', 'example' => 'high', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'NetworkCost' => [ 'description' => 'Network bandwidth consumption.', 'type' => 'object', 'properties' => [ 'PreloadTime' => ['description' => 'Preload time.', 'type' => 'string', 'example' => '8', 'title' => ''], 'AvgBitrate' => ['description' => 'Average bitrate.', 'type' => 'string', 'example' => '300', 'title' => ''], 'CostBandwidth' => ['description' => 'Maximum bandwidth consumption.', 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Dar' => ['description' => 'Display aspect ratio (DAR).', 'type' => 'string', 'example' => '9:16', 'title' => ''], 'CodecName' => ['description' => 'Codec short name.', 'type' => 'string', 'example' => 'h264', 'title' => ''], 'Width' => ['description' => 'Video resolution width, numeric value.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Duration' => ['description' => 'Duration.', 'type' => 'string', 'example' => '17.233333', 'title' => ''], 'Fps' => ['description' => 'Frame rate.', 'type' => 'string', 'example' => '30.0', 'title' => ''], 'CodecTag' => ['description' => 'Codec tag.', 'type' => 'string', 'example' => '0x31637661', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec timebase.', 'type' => 'string', 'example' => '1/60', 'title' => ''], 'Level' => ['description' => 'Encoding level.', 'type' => 'string', 'example' => '31', 'title' => ''], 'colorTransfer' => ['description' => 'Color transfer.', 'type' => 'string', 'example' => 'bt709', 'title' => ''], 'colorPrimaries' => ['description' => 'Color primaries.', 'type' => 'string', 'example' => 'bt709', 'title' => ''], 'bitsPerRawSample' => ['description' => 'Number of bits per raw sample.', 'type' => 'string', 'example' => '8', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AudioStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AudioStream' => [ 'description' => 'Audio stream list.', 'type' => 'array', 'items' => [ 'description' => 'Audio stream details.', 'type' => 'object', 'properties' => [ 'Timebase' => ['description' => 'Timebase.', 'type' => 'string', 'example' => '1/32000', 'title' => ''], 'Index' => ['description' => 'Audio stream index, identifying the position of the audio stream in the overall media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'SampleFmt' => ['description' => 'Sample format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'ChannelLayout' => ['description' => 'Channel layout.', 'type' => 'string', 'example' => 'mono', 'title' => ''], 'Lang' => ['description' => 'Language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).', 'type' => 'string', 'example' => 'und', 'title' => ''], 'Samplerate' => ['description' => 'Sample rate.', 'type' => 'string', 'example' => '32000', 'title' => ''], 'CodecLongName' => ['description' => 'Codec long name.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'Channels' => ['description' => 'Number of channels.', 'type' => 'string', 'example' => '1', 'title' => ''], 'NumFrames' => ['description' => 'Total number of frames.', 'type' => 'string', 'example' => '50', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '64.136', 'title' => ''], 'CodecTagString' => ['description' => 'Codec tag string.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.064000', 'title' => ''], 'CodecName' => ['description' => 'Codec short name.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Duration' => ['description' => 'Duration.', 'type' => 'string', 'example' => '17.223562', 'title' => ''], 'CodecTag' => ['description' => 'Codec tag.', 'type' => 'string', 'example' => '0x6134706d', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec timebase.', 'type' => 'string', 'example' => '1/32000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubtitleStream' => [ 'description' => 'Subtitle stream list.', 'type' => 'array', 'items' => [ 'description' => 'Subtitle stream details.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Subtitle stream index.'."\n" .'Identifies the position of the subtitle stream in the overall media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Lang' => ['description' => 'Language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).', 'type' => 'string', 'example' => 'eng', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Format' => [ 'description' => 'Format information.', 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '-0.064000', 'title' => ''], 'NumPrograms' => ['description' => 'Total number of program streams.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Size' => ['description' => 'File size.', 'type' => 'string', 'example' => '1057273', 'title' => ''], 'NumStreams' => ['description' => 'Total number of media streams.', 'type' => 'string', 'example' => '2', 'title' => ''], 'FormatLongName' => ['description' => 'Container/format long name.', 'type' => 'string', 'example' => 'QuickTime / MOV', 'title' => ''], 'Duration' => ['description' => 'Total duration.', 'type' => 'string', 'example' => '17.234000', 'title' => ''], 'Bitrate' => ['description' => 'Total bitrate.', 'type' => 'string', 'example' => '490.784', 'title' => ''], 'FormatName' => ['description' => 'Container/format short name. Valid values: mov, mp4, m4a, 3gp, 3g2, mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], ], 'title' => '', 'example' => '', ], 'FileMd5' => ['title' => '', 'description' => 'MD5 checksum of the result file', 'type' => 'string', 'example' => 'ad195fd1317a761d4425232867759d1e'], 'FileSize' => ['description' => 'File size.', 'type' => 'string', 'example' => '1057273', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MultiSpeedInfo' => [ 'description' => 'Speed-up job information. Only available for tasks submitted through the speed-up pipeline (not available for the legacy speed-up version).', 'type' => 'object', 'properties' => [ 'Enable' => ['description' => 'Whether the speed-up switch is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Error code (description when speed-up is not actually enabled).', 'type' => 'string', 'example' => 'Boost.NotNeedSpeed', 'title' => ''], 'Message' => ['description' => 'Error message (description when speed-up is not actually enabled).', 'type' => 'string', 'example' => 'success', 'title' => ''], 'SettingSpeed' => ['description' => 'Configured speed.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'DowngradePolicy' => ['description' => 'Downgrade policy when speed-up is not supported.', 'type' => 'string', 'example' => 'NormalSpeed', 'title' => ''], 'RealSpeed' => ['description' => 'Actual speed-up value.', 'type' => 'number', 'format' => 'double', 'example' => '6.576886940181647', 'title' => ''], 'Duration' => ['description' => 'Output video duration.', 'type' => 'number', 'format' => 'double', 'example' => '21.0', 'title' => ''], 'TimeCost' => ['description' => 'Task time cost.', 'type' => 'number', 'format' => 'double', 'example' => '3.193', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'Pipeline ID.', 'type' => 'string', 'example' => '88c6ca184c0e47b665e2a1267971****', 'title' => ''], 'Input' => [ 'description' => 'Job input.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'OSS Object of the input file.', 'type' => 'string', 'example' => 'video_01.mp4', 'title' => ''], 'Location' => ['description' => 'OSS Location of the input file.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'OSS Bucket of the input file.', 'type' => 'string', 'example' => 'exampleBucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MNSMessageResult' => [ 'description' => 'MNS message result notifying the user of job completion.', 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'Message ID on success.', 'type' => 'string', 'example' => '123', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message on failure. This parameter is not returned on success.', 'type' => 'string', 'example' => 'The resource operated “%s” cannot be found.', 'title' => ''], 'ErrorCode' => ['description' => 'Error code on failure. This parameter is not returned on success.', 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], ], 'title' => '', 'example' => '', ], 'SubmitTime' => ['title' => '', 'description' => 'Time when the task was dequeued and submitted for execution.', 'type' => 'string', 'example' => '2021-03-04T06:44:43Z'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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 \\"FileMd5\\": \\"ad195fd1317a761d4425232867759d1e\\",\\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}","type":"json"}]', 'title' => 'Query Transcoding Jobs', 'description' => '- This API allows you to query up to 10 transcoding jobs at a time.'."\n" .'- If the JobIds parameter is not specified, the `InvalidParameter` (invalid parameter) error code will be returned.'."\n" ."\n" .'## QPS Limit'."\n" .'The single-user QPS limit for this API is 100 calls per second. Exceeding the limit will result in throttling, which may affect your business. Please call this API appropriately. For more information, see [QPS Limit](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' **Callback Message Format Definition**'."\n" ."\n" .'When the execution status of a transcoding task changes, MPS will send a message to the queue specified by the user (for how to specify the callback queue, see the [UpdatePipeline API](~~188374~~)). The message body is a JSON string containing the following fields:'."\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" .'| Name | Type | Description |'."\n" .'|---------------|--------|-------------|'."\n" .'| Type | String | Fixed string "Transcode", indicating a transcoding task. |'."\n" .'| JobId | String | Unique task ID. |'."\n" .'| State | String | Current task state, consistent with the State in QueryJobList. |'."\n" .'| UserData | String | The UserData passed by the user in SubmitJobs. |', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-21T08:15:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-03T07:43:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-13T02:41:42.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-13T02:31:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryMediaCensorJobDetail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the content moderation job. You can obtain the job ID from the response parameters of the [SubmitMediaCensorJob](~~91774~~) operation.', 'type' => 'string', 'required' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. The token of the next page is returned after you call this operation to query the results of a content moderation job for the first time.', 'type' => 'string', 'required' => false, 'example' => 'ae0fd49c0840e14daf0d66a75b83****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return on each page.'."\n" ."\n" .'- Default value: **30**.'."\n" ."\n" .'- Valid values: **1 to 300**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA', 'title' => ''], 'MediaCensorJobDetail' => [ 'description' => 'The results of the content moderation job.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2018-09-13T16:32:24Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.', 'type' => 'string', 'example' => '2018-09-21', 'title' => ''], 'Suggestion' => ['description' => 'The overall result of the job. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed again.'."\n" ."\n" .'- **block**: The content needs to be blocked.'."\n" ."\n" .'If the moderation result of one type of the moderated content is review, the overall result is review. If the moderation result of one type of the moderated content is block, the overall result is block.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'CoverImageCensorResults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CoverImageCensorResult' => [ 'description' => 'The moderation results of thumbnails.', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The Object Storage Service (OSS) object that is used as the video thumbnail.', 'type' => 'string', 'example' => 'test/ai/censor/v2/vme-****.jpg', 'title' => ''], 'Location' => ['description' => 'The OSS region in which the video thumbnail resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket that stores the video thumbnail.', 'type' => 'string', 'example' => 'bucket-out-test-****', 'title' => ''], 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Result' => [ 'description' => 'The moderation results.', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed again.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Multiple labels are separated with commas (,).'."\n" ."\n" .'- Valid values in the pornographic content moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **sexy**: sexy content'."\n" ."\n" .' - **porn**: pornographic content'."\n" ."\n" .'- Valid values in the terrorist content moderation scenario:'."\n" ."\n" .' - **narmal**: normal content'."\n" ."\n" .' - **bloody**: bloody content'."\n" ."\n" .' - **explosion**: explosion and smoke'."\n" ."\n" .' - **outfit**: special costume'."\n" ."\n" .' - **logo**: special logo'."\n" ."\n" .' - **weapon**: weapon'."\n" ."\n" .' - **politics**: political content'."\n" ."\n" .' - **violence**: violence'."\n" ."\n" .' - **crowd**: crowd'."\n" ."\n" .' - **parade**: parade'."\n" ."\n" .' - **carcrash**: car accident'."\n" ."\n" .' - **flag**: flag'."\n" ."\n" .' - **location**: landmark'."\n" ."\n" .' - **others**: other content'."\n" ."\n" .'- Valid values in the ad moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **ad**: other ads'."\n" ."\n" .' - **politics**: political content in text'."\n" ."\n" .' - **porn**: pornographic content in text'."\n" ."\n" .' - **abuse**: abuse in text'."\n" ."\n" .' - **terrorism**: terrorist content in text'."\n" ."\n" .' - **contraband**: prohibited content in text'."\n" ."\n" .' - **spam**: spam in text'."\n" ."\n" .' - **npx**: illegal ads'."\n" ."\n" .' - **qrcode**: QR code'."\n" ."\n" .' - **programCode**: mini program code'."\n" ."\n" .'- Valid values in the live moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **meaningless**: meaningless content, such as a black or white screen'."\n" ."\n" .' - **PIP**: picture-in-picture'."\n" ."\n" .' - **smoking**: smoking'."\n" ."\n" .' - **drivelive**: live broadcasting in a running vehicle'."\n" ."\n" .'- Valid values in the logo moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **TV**: controlled TV station logo'."\n" ."\n" .' - **trademark**: trademark', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. Valid values:'."\n" ."\n" .'- **porn**: pornographic content moderation'."\n" ."\n" .'- **terrorism**: terrorist content moderation'."\n" ."\n" .'- **ad**: ad violation moderation'."\n" ."\n" .'- **live**: undesirable scene moderation'."\n" ."\n" .'- **logo**: logo moderation', 'type' => 'string', 'example' => 'porn', 'title' => ''], 'Rate' => ['description' => 'The score. Valid values: **0 to 100**.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'State' => ['description' => 'The status of the job. Valid values:', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'TitleCensorResult' => [ 'description' => 'The moderation result of the title.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed again.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Valid values:'."\n" ."\n" .'- **normal**: normal content'."\n" ."\n" .'- **spam**: spam'."\n" ."\n" .'- **ad**: ads'."\n" ."\n" .'- **abuse**: abuse'."\n" ."\n" .'- **flood**: excessive junk content'."\n" ."\n" .'- **contraband**: prohibited content'."\n" ."\n" .'- **meaningless**: meaningless content', 'type' => 'string', 'example' => 'meaningless', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. Valid values: The value is **antispam**.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '99.91', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The error message returned if the job fails. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'The resource operated cannot be found', 'title' => ''], 'Input' => [ 'description' => 'The information about the job input.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the input media file.', 'type' => 'string', 'example' => 'test/ai/censor/test-****.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS region in which the input media file resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input media file is stored.', 'type' => 'string', 'example' => 'bucket-test-in-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'BarrageCensorResult' => [ 'description' => 'The moderation result of live comments.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed again.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Multiple labels are separated with commas (,). Valid values:'."\n" ."\n" .'- **spam**: spam'."\n" ."\n" .'- **ad**: ads'."\n" ."\n" .'- **abuse**: abuse'."\n" ."\n" .'- **flood**: excessive junk content'."\n" ."\n" .'- **contraband**: prohibited content'."\n" ."\n" .'- **meaningless**: meaningless content'."\n" ."\n" .'- **normal**: normal content', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. Valid values: The value is **antispam**.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '99.91', 'title' => ''], ], 'title' => '', 'example' => '', ], 'DescCensorResult' => [ 'description' => 'The moderation result of the description.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed again.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'review', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Valid values:'."\n" ."\n" .'- **spam**: spam'."\n" ."\n" .'- **ad**: ads'."\n" ."\n" .'- **abuse**: abuse'."\n" ."\n" .'- **flood**: excessive junk content'."\n" ."\n" .'- **contraband**: prohibited content'."\n" ."\n" .'- **meaningless**: meaningless content'."\n" ."\n" .'- **normal**: normal content', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. Valid values: The value is **antispam**.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'VideoCensorConfig' => [ 'description' => 'The video moderation configurations.', 'type' => 'object', 'properties' => [ 'OutputFile' => [ 'description' => 'The information about output snapshots.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The one or more OSS objects that are generated as the output snapshots.'."\n" ."\n" .'> In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-****.jpg`, `output00002-****.jpg`, and so on.', 'type' => 'string', 'example' => 'output{Count}.jpg', 'title' => ''], 'Location' => ['description' => 'The region in which the OSS bucket that stores the output snapshot resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket that stores the output snapshots.', 'type' => 'string', 'example' => 'test-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'VideoCensor' => ['description' => 'Indicates whether the video content needs to be moderated. Default value: **true** Valid values:'."\n" ."\n" .'- **true**: The video content needs to be moderated.'."\n" ."\n" .'- **false**: The video content does not need to be moderated.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'BizType' => ['description' => 'The custom business type. Default value: common.', 'type' => 'string', 'example' => 'common', 'title' => ''], ], 'title' => '', 'example' => '', ], 'JobId' => ['description' => 'The ID of the content moderation job.', 'type' => 'string', 'example' => 'f8f166eea7a44e9bb0a4aecf9543****', 'title' => ''], 'UserData' => ['description' => 'The custom data.', 'type' => 'string', 'example' => 'example userdata ****', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job fails. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], 'VensorCensorResult' => [ 'description' => 'The moderation results of the video.', 'type' => 'object', 'properties' => [ 'VideoTimelines' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoTimeline' => [ 'description' => 'The moderation results that are sorted in ascending order by time.', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'Timestamp' => ['description' => 'The position in the video. Format: `hh:mm:ss[.SSS]`.', 'type' => 'string', 'example' => '00:02:59.999', 'title' => ''], 'Object' => ['description' => 'The one or more OSS objects that are generated as the output snapshots.'."\n" ."\n" .'> In the example, {Count} is a placeholder. The OSS objects that are generated as output snapshots are named `output00001-****.jpg`, `output00002-****.jpg`, and so on.', 'type' => 'string', 'example' => 'output{Count}.jpg', 'title' => ''], 'CensorResults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CensorResult' => [ 'description' => 'The moderation results that include information such as labels and scores.', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed again.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Multiple labels are separated with commas (,). Valid values:'."\n" ."\n" .'- Valid values in the pornographic content moderation scenario:'."\n" ."\n" .' - **porn**: pornographic content'."\n" ."\n" .' - **sexy**: sexy content'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .'- Valid values in the terrorist content moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **bloody**: bloody content'."\n" ."\n" .' - **explosion**: explosion and smoke'."\n" ."\n" .' - **outfit**: special costume'."\n" ."\n" .' - **logo**: special logo'."\n" ."\n" .' - **weapon**: weapon'."\n" ."\n" .' - **politics**: political content'."\n" ."\n" .' - **violence**: violence'."\n" ."\n" .' - **crowd**: crowd'."\n" ."\n" .' - **parade**: parade'."\n" ."\n" .' - **carcrash**: car accident'."\n" ."\n" .' - **flag**: flag'."\n" ."\n" .' - **location**: landmark'."\n" ."\n" .' - **others**: other content'."\n" ."\n" .'- Valid values in the ad moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **ad**: other ads'."\n" ."\n" .' - **politics**: political content in text'."\n" ."\n" .' - **porn**: pornographic content in text'."\n" ."\n" .' - **abuse**: abuse in text'."\n" ."\n" .' - **terrorism**: terrorist content in text'."\n" ."\n" .' - **contraband**: prohibited content in text'."\n" ."\n" .' - **spam**: spam in text'."\n" ."\n" .' - **npx**: illegal ads'."\n" ."\n" .' - **qrcode**: QR code'."\n" ."\n" .' - **programCode**: mini program code'."\n" ."\n" .'- Valid values in the live moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **meaningless**: meaningless content, such as a black or white screen'."\n" ."\n" .' - **PIP**: picture-in-picture'."\n" ."\n" .' - **smoking**: smoking'."\n" ."\n" .' - **drivelive**: live broadcasting in a running vehicle'."\n" ."\n" .'- Valid values in the logo moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **TV**: controlled TV station logo'."\n" ."\n" .' - **trademark**: trademark', 'type' => 'string', 'example' => 'porn,ad', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. Valid values:'."\n" ."\n" .'- **porn**: pornographic content moderation'."\n" ."\n" .'- **terrorism**: terrorist content moderation'."\n" ."\n" .'- **ad**: ad violation moderation'."\n" ."\n" .'- **live**: undesirable scene moderation'."\n" ."\n" .'- **logo**: logo moderation', 'type' => 'string', 'example' => 'porn', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '99.99', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'ea04afcca7cd4e80b9ece8fbb251****', 'title' => ''], 'CensorResults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CensorResult' => [ 'description' => 'A collection of the moderation results. The information includes the summary of various scenarios such as pornographic content and terrorist content.', 'type' => 'array', 'items' => [ 'description' => 'The moderation result of the video.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended subsequent operation. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed again.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'review', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Multiple labels are separated with commas (,). Valid values:'."\n" ."\n" .'- Valid values in the pornographic content moderation scenario:'."\n" ."\n" .' - **porn**: pornographic content'."\n" ."\n" .' - **sexy**: sexy content'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .'- Valid values in the terrorist content moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **bloody**: bloody content'."\n" ."\n" .' - **explosion**: explosion and smoke'."\n" ."\n" .' - **outfit**: special costume'."\n" ."\n" .' - **logo**: special logo'."\n" ."\n" .' - **weapon**: weapon'."\n" ."\n" .' - **politics**: political content'."\n" ."\n" .' - **violence**: violence'."\n" ."\n" .' - **crowd**: crowd'."\n" ."\n" .' - **parade**: parade'."\n" ."\n" .' - **carcrash**: car accident'."\n" ."\n" .' - **flag**: flag'."\n" ."\n" .' - **location**: landmark'."\n" ."\n" .' - **others**: other content'."\n" ."\n" .'- Valid values in the ad moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **ad**: other ads'."\n" ."\n" .' - **politics**: political content in text'."\n" ."\n" .' - **porn**: pornographic content in text'."\n" ."\n" .' - **abuse**: abuse in text'."\n" ."\n" .' - **terrorism**: terrorist content in text'."\n" ."\n" .' - **contraband**: prohibited content in text'."\n" ."\n" .' - **spam**: spam in text'."\n" ."\n" .' - **npx**: illegal ads'."\n" ."\n" .' - **qrcode**: QR code'."\n" ."\n" .' - **programCode**: mini program code'."\n" ."\n" .'- Valid values in the live moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **meaningless**: meaningless content, such as a black or white screen'."\n" ."\n" .' - **PIP**: picture-in-picture'."\n" ."\n" .' - **smoking**: smoking'."\n" ."\n" .' - **drivelive**: live broadcasting in a running vehicle'."\n" ."\n" .'- Valid values in the logo moderation scenario:'."\n" ."\n" .' - **normal**: normal content'."\n" ."\n" .' - **TV**: controlled TV station logo'."\n" ."\n" .' - **trademark**: trademark', 'type' => 'string', 'example' => 'meaningless', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. Valid values:'."\n" ."\n" .'- **porn**: pornographic content moderation'."\n" ."\n" .'- **terrorism**: terrorist content moderation'."\n" ."\n" .'- **ad**: ad violation moderation'."\n" ."\n" .'- **live**: undesirable scene moderation'."\n" ."\n" .'- **logo**: logo moderation', 'type' => 'string', 'example' => 'terrorism', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AudioCensorResult' => [ 'description' => 'Audio review result.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'Processing suggestion. Valid values:'."\n" ."\n" .'- **pass**: Pass'."\n" ."\n" .'- **review**: Review'."\n" ."\n" .'- **block**: Block', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'Categorization of the detection result. Valid values:'."\n" ."\n" .'- normal: Normal content'."\n" ."\n" .'- spam: Spam'."\n" ."\n" .'- ad: Advertisement'."\n" ."\n" .'- politics: Political content'."\n" ."\n" .'- terrorism: Terrorism-related content'."\n" ."\n" .'- abuse: Abusive language'."\n" ."\n" .'- porn: Pornographic content'."\n" ."\n" .'- flood: Flooding (excessive repetitive content)'."\n" ."\n" .'- contraband: Contraband-related content'."\n" ."\n" .'- meaningless: Meaningless content'."\n" ."\n" .'- harmful: Harmful scenario (supports detection scenarios such as materialism and flaunting wealth, celebrity fandom promotion, negative emotions, and negative inducement)', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'AudioDetailResultList' => [ 'itemNode' => true, 'description' => '', 'type' => 'object', 'properties' => [ 'AudioDetailResult' => [ 'description' => 'Detailed audio review results.', 'type' => 'array', 'items' => [ 'description' => 'Result content.', 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The time when the sentence starts, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'EndTime' => ['description' => 'The time when the sentence ends, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Text' => ['description' => 'The result of transforming speech into text.', 'type' => 'string', 'example' => '测试一下', 'title' => ''], 'Label' => ['description' => 'The categorization of the detection result. Valid values:'."\n" ."\n" .'- normal: Normal text'."\n" ."\n" .'- spam: Contains spam'."\n" ."\n" .'- ad: Advertisement'."\n" ."\n" .'- politics: Politically sensitive content'."\n" ."\n" .'- terrorism: Terrorist or violent content'."\n" ."\n" .'- abuse: Abusive language'."\n" ."\n" .'- porn: Pornographic content'."\n" ."\n" .'- flood: Flooding (repetitive or meaningless messages)'."\n" ."\n" .'- contraband: Prohibited content'."\n" ."\n" .'- meaningless: Meaningless content'."\n" ."\n" .'- harmful: Harmful scenario (supports detection scenarios such as materialism and flaunting wealth, celebrity fandom promotion, negative emotions, and negative inducement)', 'type' => 'string', 'example' => 'normal', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the content moderation job is submitted.', 'type' => 'string', 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Query content moderation job details', 'summary' => 'Query the details of a content moderation job.', 'description' => 'In the content moderation result, the video section is sorted by time points in ascending order to form a timeline. If the video duration is very long, the first page of results is returned when you query. To obtain the complete results for the video section, you can invoke this API separately.'."\n" ."\n" .'## queries per second (QPS) limit'."\n" ."\n" .'The QPS limit for this API is 100 queries per second (QPS) per user. If the limit is exceeded, API calls will be subject to Rate Limiting, which may Impact your business. Please invoke the API reasonably. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-12-07T09:55:24.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-07T09:23:17.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobDetail'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaCensorJobDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'QueryMediaCensorJobList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the content moderation job. You can obtain the job ID from the response parameters of the [SubmitMediaCensorJob](~~91779~~) operation. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'fa9c34be3bcf42919ac4d1775239****,78dc866518b843259669df58ed30****', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The token used to retrieve the next page of results. Leave this parameter empty for the first request. The token for the next page is returned in the response to the first request.', 'type' => 'string', 'required' => false, 'example' => '79aff3eee82242e092899db5f669****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return on each page.'."\n" ."\n" .'- Default: **30**.'."\n" ."\n" .'- Valid values: **1 to 300**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '20', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The state of the jobs to query. Valid values:'."\n" ."\n" .'- **All**: all jobs.'."\n" ."\n" .'- **Queuing**: jobs that are in the queue.'."\n" ."\n" .'- **Analysing**: jobs that are being analyzed.'."\n" ."\n" .'- **Fail**: failed jobs.'."\n" ."\n" .'- **Success**: successful jobs.', 'type' => 'string', 'required' => false, 'default' => 'All', 'example' => 'All', 'title' => ''], ], [ 'name' => 'StartOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query jobs by their creation time.'."\n" ."\n" .'- The date and time are in the ISO 8601 format and in UTC.'."\n" ."\n" .'- The format is YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-12-22T03:48:05Z', 'title' => ''], ], [ 'name' => 'EndOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query jobs by their creation time.'."\n" ."\n" .'- The date and time are in the ISO 8601 format and in UTC.'."\n" ."\n" .'- The format is YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2022-02-14T02:16:07Z', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue. To obtain the MPS queue ID, log on to the [**ApsaraVideo Media Processing console**](https://mps.console.aliyun.com/overview) and choose **Global Settings** > **MPS Queues and Callbacks**.', 'type' => 'string', 'required' => false, 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'MediaCensorJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaCensorJob' => [ 'description' => 'The list of content moderation jobs.', 'type' => 'array', 'items' => [ 'description' => 'The details of a content moderation job.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2021-11-04T07:25:48Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was completed.', 'type' => 'string', 'example' => '2021-11-04T07:25:48Z', 'title' => ''], 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'CoverImageCensorResults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CoverImageCensorResult' => [ 'description' => 'The list of moderation results for the thumbnails.', 'type' => 'array', 'items' => [ 'description' => 'The details of the moderation result for a thumbnail.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The OSS object of the thumbnail.', 'type' => 'string', 'example' => 'test/ai/censor/v2/vme-****.jpg', 'title' => ''], 'Location' => ['description' => 'The OSS location of the thumbnail.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket of the thumbnail.', 'type' => 'string', 'example' => 'example-Bucket-****', 'title' => ''], 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Result' => [ 'description' => 'The moderation results of the job.', 'type' => 'array', 'items' => [ 'description' => 'The details of a moderation result.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The overall moderation result of the job. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.'."\n" ."\n" .'> If the moderation result for any category is review, the overall result is review. If the moderation result for any category is block, the overall result is block.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Multiple labels are separated by commas (,).'."\n" ."\n" .'- Labels for pornography detection (porn) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **sexy**: sexy'."\n" ."\n" .' - **porn**: pornographic'."\n" ."\n" .'- Labels for terrorism and political content detection (terrorism) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **bloody**: bloody'."\n" ."\n" .' - **explosion**: explosion'."\n" ."\n" .' - **outfit**: special outfit'."\n" ."\n" .' - **logo**: special logo'."\n" ."\n" .' - **weapon**: weapon'."\n" ."\n" .' - **politics**: political content'."\n" ."\n" .' - **violence**: violence'."\n" ."\n" .' - **crowd**: crowd'."\n" ."\n" .' - **parade**: parade'."\n" ."\n" .' - **carcrash**: car crash'."\n" ."\n" .' - **flag**: flag'."\n" ."\n" .' - **location**: landmark'."\n" ."\n" .' - **others**: others'."\n" ."\n" .'- Labels for ad and text violation detection (ad) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **ad**: other ads'."\n" ."\n" .' - **politics**: text containing political content'."\n" ."\n" .' - **porn**: text containing pornographic content'."\n" ."\n" .' - **abuse**: text containing abusive content'."\n" ."\n" .' - **terrorism**: text containing terrorist content'."\n" ."\n" .' - **contraband**: text containing contraband content'."\n" ."\n" .' - **spam**: other spam'."\n" ."\n" .' - **npx**: skin-disease-like ads'."\n" ."\n" .' - **qrcode**: QR code'."\n" ."\n" .' - **programCode**: miniapp code'."\n" ."\n" .'- Labels for undesirable scene detection (live) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **meaningless**: no content in the image (for example, a black or white screen)'."\n" ."\n" .' - **PIP**: Picture-in-Picture (PiP)'."\n" ."\n" .' - **smoking**: smoking'."\n" ."\n" .' - **drivelive**: live streaming in a car'."\n" ."\n" .'- Labels for logo detection (Logo) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **TV**: contains a controlled logo'."\n" ."\n" .' - **trademark**: contains a trademark', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario.'."\n" ."\n" .'- **porn**: pornography detection'."\n" ."\n" .'- **terrorism**: terrorism and political content detection'."\n" ."\n" .'- **ad**: ad and text violation detection'."\n" ."\n" .'- **live**: undesirable scene detection'."\n" ."\n" .'- **Logo**: logo detection', 'type' => 'string', 'example' => 'live', 'title' => ''], 'Rate' => ['description' => 'The score. Valid values: 0 to 100.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'State' => ['description' => 'The state of the job.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'TitleCensorResult' => [ 'description' => 'The moderation result for the title.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The labels of the moderation result. Multiple labels are separated by commas (,).'."\n" ."\n" .'- **normal**: normal'."\n" ."\n" .'- **spam**: spam'."\n" ."\n" .'- **ad**: advertisement'."\n" ."\n" .'- **politics**: political content'."\n" ."\n" .'- **terrorism**: terrorist content'."\n" ."\n" .'- **abuse**: abuse'."\n" ."\n" .'- **porn**: pornographic content'."\n" ."\n" .'- **flood**: flooding'."\n" ."\n" .'- **contraband**: contraband'."\n" ."\n" .'- **meaningless**: meaningless'."\n" ."\n" .'- **harmful**: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)', 'type' => 'string', 'example' => 'meaningless', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. This is a static field. Value: **antispam**, which indicates text anti-spam.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '99.91', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The error message for a failed job. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'The resource operated cannot be found', 'title' => ''], 'Input' => [ 'description' => 'The job input.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The OSS object of the input file.', 'type' => 'string', 'example' => 'test/ai/censor/test-****.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS location of the input file.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket of the input file.', 'type' => 'string', 'example' => 'bucket-test-in-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'BarrageCensorResult' => [ 'description' => 'The moderation result for the live comments.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The category of the moderation result. Multiple categories are separated by commas (,). Valid values:'."\n" ."\n" .'- **normal**: normal'."\n" ."\n" .'- **spam**: spam'."\n" ."\n" .'- **ad**: advertisement'."\n" ."\n" .'- **politics**: political content'."\n" ."\n" .'- **terrorism**: terrorist content'."\n" ."\n" .'- **abuse**: abuse'."\n" ."\n" .'- **porn**: pornographic content'."\n" ."\n" .'- **flood**: flooding'."\n" ."\n" .'- **contraband**: contraband'."\n" ."\n" .'- **meaningless**: meaningless'."\n" ."\n" .'- **harmful**: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. This is a static field. Value: **antispam**, which indicates text anti-spam.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '99.91', 'title' => ''], ], 'title' => '', 'example' => '', ], 'DescCensorResult' => [ 'description' => 'The moderation result for the description.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The category of the moderation result. Multiple categories are separated by commas (,). Valid values:'."\n" ."\n" .'- **normal**: normal'."\n" ."\n" .'- **spam**: spam'."\n" ."\n" .'- **ad**: advertisement'."\n" ."\n" .'- **politics**: political content'."\n" ."\n" .'- **terrorism**: terrorist content'."\n" ."\n" .'- **abuse**: abuse'."\n" ."\n" .'- **porn**: pornographic content'."\n" ."\n" .'- **flood**: flooding'."\n" ."\n" .'- **contraband**: contraband'."\n" ."\n" .'- **meaningless**: meaningless'."\n" ."\n" .'- **harmful**: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)', 'type' => 'string', 'example' => 'ad', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. This is a static field. Value: **antispam**, which indicates text anti-spam.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'VideoCensorConfig' => [ 'description' => 'The video moderation configuration.', 'type' => 'object', 'properties' => [ 'OutputFile' => [ 'description' => 'The storage location of the video snapshot results.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The output file of the snapshot (an OSS object).'."\n" ."\n" .'> In the example, {Count} is a placeholder. The image objects are named in sequence, such as output00001-\\*\\*\\*\\*.jpg and `output00002-****.jpg`.', 'type' => 'string', 'example' => 'output{Count}.jpg', 'title' => ''], 'Location' => ['description' => 'The OSS location of the OSS bucket where the output snapshots are stored.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket where the output snapshots are stored.', 'type' => 'string', 'example' => 'test-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'VideoCensor' => ['description' => 'Indicates whether to moderate the video content. Default value: true. Valid values:'."\n" ."\n" .'- **true**: moderate the video content.'."\n" ."\n" .'- **false**: do not moderate the video content.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'BizType' => ['description' => 'The moderation template. Default value: common (the default template).'."\n" ."\n" .'> If you do not specify this parameter, the default value \\`common\\` is used. If you use a custom moderation template by submitting a ticket, the UID of the template is returned.', 'type' => 'string', 'example' => 'common', 'title' => ''], ], 'title' => '', 'example' => '', ], 'JobId' => ['description' => 'The ID of the content moderation job.', 'type' => 'string', 'example' => 'f8f166eea7a44e9bb0a4aecf9543****', 'title' => ''], 'UserData' => ['description' => 'The custom user data.', 'type' => 'string', 'example' => 'example userdata ****', 'title' => ''], 'Code' => ['description' => 'The error code for a failed job. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], 'VensorCensorResult' => [ 'description' => 'The video moderation result.', 'type' => 'object', 'properties' => [ 'VideoTimelines' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoTimeline' => [ 'description' => 'The moderation results at specific points in time, sorted in ascending order by time.', 'type' => 'array', 'items' => [ 'description' => 'The details.', 'type' => 'object', 'properties' => [ 'Timestamp' => ['description' => 'The position in the video. Format: `hh:mm:ss[.SSS]`.', 'type' => 'string', 'example' => '00:02:59.999', 'title' => ''], 'Object' => ['description' => 'The output file of the snapshot (an OSS object).'."\n" ."\n" .'> In the example, {Count} is a placeholder. The image objects are named in sequence, such as output00001-\\*\\*\\*\\*.jpg and `output00002-****.jpg`.', 'type' => 'string', 'example' => 'output{Count}.jpg', 'title' => ''], 'CensorResults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CensorResult' => [ 'description' => 'The labels and scores of different types of moderation results.', 'type' => 'array', 'items' => [ 'description' => 'The details.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The categories of the moderation result. Multiple categories are separated by commas (,). Valid values:'."\n" ."\n" .'- Labels for pornography detection (porn) results:'."\n" ."\n" .' - **porn**: pornographic'."\n" ."\n" .' - **sexy**: sexy'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .'- Labels for terrorism and political content detection (terrorism) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **bloody**: bloody'."\n" ."\n" .' - **explosion**: explosion'."\n" ."\n" .' - **outfit**: special outfit'."\n" ."\n" .' - **logo**: special logo'."\n" ."\n" .' - **weapon**: weapon'."\n" ."\n" .' - **politics**: political content'."\n" ."\n" .' - **violence**: violence'."\n" ."\n" .' - **crowd**: crowd'."\n" ."\n" .' - **parade**: parade'."\n" ."\n" .' - **carcrash**: car crash'."\n" ."\n" .' - **flag**: flag'."\n" ."\n" .' - **location**: landmark'."\n" ."\n" .' - **others**: others'."\n" ."\n" .'- Labels for ad detection (ad) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **ad**: other ads'."\n" ."\n" .' - **politics**: text containing political content'."\n" ."\n" .' - **porn**: text containing pornographic content'."\n" ."\n" .' - **abuse**: text containing abusive content'."\n" ."\n" .' - **terrorism**: text containing terrorist content'."\n" ."\n" .' - **contraband**: text containing contraband content'."\n" ."\n" .' - **spam**: other spam'."\n" ."\n" .' - **npx**: skin-disease-like ads'."\n" ."\n" .' - **qrcode**: QR code'."\n" ."\n" .' - **programCode**: miniapp code'."\n" ."\n" .'- Labels for undesirable scene detection (live) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **meaningless**: no content in the image (for example, a black or white screen)'."\n" ."\n" .' - **PIP**: Picture-in-Picture (PiP)'."\n" ."\n" .' - **smoking**: smoking'."\n" ."\n" .' - **drivelive**: live streaming in a car'."\n" ."\n" .'- Labels for logo detection (logo) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **TV**: contains a controlled logo'."\n" ."\n" .' - **trademark**: contains a trademark', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario.'."\n" ."\n" .'- **porn**: pornography detection'."\n" ."\n" .'- **terrorism**: terrorism and political content detection'."\n" ."\n" .'- **ad**: ad and text violation detection'."\n" ."\n" .'- **live**: undesirable scene detection'."\n" ."\n" .'- **logo**: logo detection', 'type' => 'string', 'example' => 'pron', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '99.99', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The token for the next page.', 'type' => 'string', 'example' => 'ea04afcca7cd4e80b9ece8fbb251****', 'title' => ''], 'CensorResults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CensorResult' => [ 'description' => 'A collection of moderation results, which contains the summary information for various scenarios, such as pornography, terrorism, and political content.', 'type' => 'array', 'items' => [ 'description' => 'The details of the moderation result.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.', 'type' => 'string', 'example' => 'review', 'title' => ''], 'Label' => ['description' => 'The categories of the moderation result. Multiple categories are separated by commas (,). Valid values:'."\n" ."\n" .'- Labels for pornography detection (porn) results:'."\n" ."\n" .' - **porn**: pornographic'."\n" ."\n" .' - **sexy**: sexy'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .'- Labels for terrorism and political content detection (terrorism) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **bloody**: bloody'."\n" ."\n" .' - **explosion**: explosion'."\n" ."\n" .' - **outfit**: special outfit'."\n" ."\n" .' - **logo**: special logo'."\n" ."\n" .' - **weapon**: weapon'."\n" ."\n" .' - **politics**: political content'."\n" ."\n" .' - **violence**: violence'."\n" ."\n" .' - **crowd**: crowd'."\n" ."\n" .' - **parade**: parade'."\n" ."\n" .' - **carcrash**: car crash'."\n" ."\n" .' - **flag**: flag'."\n" ."\n" .' - **location**: landmark'."\n" ."\n" .' - **others**: others'."\n" ."\n" .'- Labels for ad detection (ad) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **ad**: other ads'."\n" ."\n" .' - **politics**: text containing political content'."\n" ."\n" .' - **porn**: text containing pornographic content'."\n" ."\n" .' - **abuse**: text containing abusive content'."\n" ."\n" .' - **terrorism**: text containing terrorist content'."\n" ."\n" .' - **contraband**: text containing contraband content'."\n" ."\n" .' - **spam**: other spam'."\n" ."\n" .' - **npx**: skin-disease-like ads'."\n" ."\n" .' - **qrcode**: QR code'."\n" ."\n" .' - **programCode**: miniapp code'."\n" ."\n" .'- Labels for undesirable scene detection (live) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **meaningless**: no content in the image (for example, a black or white screen)'."\n" ."\n" .' - **PIP**: Picture-in-Picture (PiP)'."\n" ."\n" .' - **smoking**: smoking'."\n" ."\n" .' - **drivelive**: live streaming in a car'."\n" ."\n" .'- Labels for logo detection (logo) results:'."\n" ."\n" .' - **normal**: normal'."\n" ."\n" .' - **TV**: contains a controlled logo'."\n" ."\n" .' - **trademark**: contains a trademark', 'type' => 'string', 'example' => 'meaningless', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario.'."\n" ."\n" .'- **porn**: pornography detection'."\n" ."\n" .'- **terrorism**: terrorism and political content detection'."\n" ."\n" .'- **ad**: ad and text violation detection'."\n" ."\n" .'- **live**: undesirable scene detection'."\n" ."\n" .'- **logo**: logo detection', 'type' => 'string', 'example' => 'terrorism', 'title' => ''], 'Rate' => ['description' => 'The score.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AudioCensorResult' => [ 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The recommended action. Valid values:'."\n" ."\n" .'- **pass**: The content can be passed.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content must be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The category of the detection result. Valid values:'."\n" ."\n" .'- normal: normal text'."\n" ."\n" .'- spam: spam'."\n" ."\n" .'- ad: advertisement'."\n" ."\n" .'- politics: political content'."\n" ."\n" .'- terrorism: terrorist content'."\n" ."\n" .'- abuse: abuse'."\n" ."\n" .'- porn: pornographic content'."\n" ."\n" .'- flood: flooding'."\n" ."\n" .'- contraband: contraband'."\n" ."\n" .'- meaningless: meaningless'."\n" ."\n" .'- harmful: undesirable scenarios (This includes worship of money, fan culture, negative emotions, and negative guidance.)', 'type' => 'string', 'example' => 'normal', 'title' => ''], ], 'description' => 'The audio moderation result.', 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B', 'title' => ''], 'NextPageToken' => ['description' => 'The token for the next page. This is a 32-bit universally unique identifier (UUID). This parameter is returned when the query results span multiple pages. The value of this parameter is updated for each query.', 'type' => 'string', 'example' => '9b1a42bc6e8d46e6a1383b7e7f01****', 'title' => ''], 'NonExistIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The list of job IDs that do not exist. This parameter is not returned if all specified job IDs exist.', 'type' => 'array', 'items' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '78dc866518b843259669df58ed30****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Query the list of content moderation jobs', 'summary' => 'Queries a list of content moderation jobs.', 'description' => 'This operation queries content moderation jobs that were created in the last three months.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'The queries per second (QPS) limit for a single user is 100. If you exceed the limit, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2023-12-07T09:55:24.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaCensorJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'QueryMediaInfoJobList' => [ 'summary' => 'Queries media information analysis jobs.', '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' => 'The ID of the media information analysis job.'."\n" ."\n" .'- You can query up to 10 jobs at a time. Separate multiple job IDs with commas (,).'."\n" ."\n" .'- You can obtain the job ID from the response parameters of the [SubmitMediaInfoJob](~~602827~~) operation.'."\n" ."\n" .'> If you do not specify this parameter, the **InvalidParameter** error code is returned.', 'type' => 'string', 'required' => true, 'example' => '23ca1d184c0e4341e5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NonExistMediaInfoJobIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The media information analysis jobs that do not exist.', 'type' => 'array', 'items' => ['description' => 'A list of IDs of the media information analysis jobs that do not exist. This parameter is not returned if no data is available.', 'type' => 'string', 'example' => '11ce1d184c0e4341e5b665e2a12****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '46A04AA5-B119-41BB-B750-7C5327AC3E7A', 'title' => ''], 'MediaInfoJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaInfoJob' => [ 'description' => 'The list of media information analysis jobs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2014-01-10T12:00:00Z', 'title' => ''], 'State' => ['description' => 'The status of the job.'."\n" ."\n" .'- **Analyzing**: The job is being analyzed.'."\n" ."\n" .'- **Success**: The analysis is successful.'."\n" ."\n" .'- **Fail**: The analysis failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'JobId' => ['description' => 'The ID of the media information analysis job.', 'type' => 'string', 'example' => '23ca1d184c0e4341e5b665e2a12****', 'title' => ''], 'UserData' => ['description' => 'The custom user data.', 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'Code' => ['description' => 'The error code returned when the media information analysis fails.', 'type' => 'string', 'example' => 'InvalidParameter.JsonObjectFormatInvalid', 'title' => ''], 'Message' => ['description' => 'The error message returned when the media information analysis fails.', 'type' => 'string', 'example' => 'The parameter ”*” does not conform to the JSON Object specification', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'example' => '88c6ca184c0e432bbf5b665e2a15****', 'title' => ''], 'Async' => ['description' => 'Indicates whether the job is asynchronous.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Input' => [ 'description' => 'The job input.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The OSS object.', 'type' => 'string', 'example' => 'example.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS region.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket where the input file is stored.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MNSMessageResult' => [ 'description' => 'The result of the MNS message that is sent to notify the user that the job is complete.', 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The message ID. This parameter is returned if the operation is successful. It is not returned if the operation fails.', 'type' => 'string', 'example' => '123', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message. This parameter is returned if the operation fails. It is not returned if the operation is successful.', 'type' => 'string', 'example' => 'The parameter \\"Input\\" does not conform to the JSON Object specification', 'title' => ''], 'ErrorCode' => ['description' => 'The error code. This parameter is returned if the operation fails. It is not returned if the operation is successful.', 'type' => 'string', 'example' => 'InvalidParameter.JsonObjectFormatInvalid', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Properties' => [ 'description' => 'The detailed properties of the media. For more information, see [AliyunProperties data type](~~29251~~).', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'The width of the video in pixels.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'Height' => ['description' => 'The height of the video in pixels.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '17.226000', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '1630.045', 'title' => ''], 'FileFormat' => ['description' => 'The file format.', 'type' => 'string', 'example' => 'QuickTime/MOV', 'title' => ''], 'Streams' => [ 'description' => 'The stream information.', 'type' => 'object', 'properties' => [ 'VideoStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoStream' => [ 'description' => 'The list of video stream information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Sar' => ['description' => 'The sample aspect ratio.', 'type' => 'string', 'example' => '1:1', 'title' => ''], 'Height' => ['description' => 'The height of the video.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'CodecTagString' => ['description' => 'The text of the encoding format tag.', 'type' => 'string', 'example' => '[0][0][0][0]', 'title' => ''], 'NetworkCost' => [ 'description' => 'The network bandwidth consumption.', 'type' => 'object', 'properties' => [ 'PreloadTime' => ['description' => 'The preload time.', 'type' => 'string', 'example' => '8', 'title' => ''], 'AvgBitrate' => ['description' => 'The average bitrate.', 'type' => 'string', 'example' => '300.34', 'title' => ''], 'CostBandwidth' => ['description' => 'The maximum bandwidth consumed.', 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Width' => ['description' => 'The width of the video.', 'type' => 'string', 'example' => '1920', 'title' => ''], 'Index' => ['description' => 'The sequence number of the video stream. It indicates the position of the video stream in the entire media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/1000', 'title' => ''], 'AvgFPS' => ['description' => 'The average frame rate.', 'type' => 'string', 'example' => '23.976025', 'title' => ''], 'PixFmt' => ['description' => 'The pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'CodecLongName' => ['description' => 'The long name of the encoding format.', 'type' => 'string', 'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Rotate' => ['description' => 'The rotation angle of the video.', 'type' => 'string', 'example' => '180', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '30541090', 'title' => ''], 'HasBFrames' => ['description' => 'Indicates whether B-frames exist. A value of 0 means no B-frames. A value of 1 means B-frames exist.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Profile' => ['description' => 'The codec profile.', 'type' => 'string', 'example' => 'High', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.042000', 'title' => ''], 'Dar' => ['description' => 'The display aspect ratio.', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'CodecName' => ['description' => 'The short name of the encoding format. Valid values:'."\n" ."\n" .'- **h264**'."\n" ."\n" .'- **h265**'."\n" ."\n" .'- **gif**'."\n" ."\n" .'- **webp**', 'type' => 'string', 'example' => 'h264', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '25', 'title' => ''], 'CodecTag' => ['description' => 'The encoding format tag.', 'type' => 'string', 'example' => '0x0000', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '1001/48000', 'title' => ''], 'Level' => ['description' => 'The encoding level.', 'type' => 'string', 'example' => '41', 'title' => ''], 'ColorRange' => ['description' => 'The color range.', 'type' => 'string', 'example' => '700', 'title' => ''], 'ColorTransfer' => ['description' => 'The color transfer characteristic.', 'type' => 'string', 'example' => 'R255 G83 B170', 'title' => ''], 'ColorPrimaries' => ['description' => 'The color primaries.', 'type' => 'string', 'example' => '700', 'title' => ''], 'DurationInaccurate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'DolbyVision' => [ 'type' => 'object', 'properties' => [ 'Profile' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Level' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AudioStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AudioStream' => [ 'description' => 'The list of audio stream information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/1000', 'title' => ''], 'Index' => ['description' => 'The sequence number of the audio stream. It indicates the position of the audio stream in the entire media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'SampleFmt' => ['description' => 'The sampling format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'ChannelLayout' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '5.1(side)', 'title' => ''], 'Lang' => ['description' => 'The language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html?spm=a2c4g.11186623.2.66.243851cd2SntfN#Metadata).', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'Samplerate' => ['description' => 'The sample rate.', 'type' => 'string', 'example' => '48000', 'title' => ''], 'CodecLongName' => ['description' => 'The long name of the encoding format.', 'type' => 'string', 'example' => 'DCA (DTS Coherent Acoustics)', 'title' => ''], 'Channels' => ['description' => 'The sound channel output style.', 'type' => 'string', 'example' => '2', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '123', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '1536000', 'title' => ''], 'CodecTagString' => ['description' => 'The text of the encoding format tag.', 'type' => 'string', 'example' => '[0][0][0][0]', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.042000', 'title' => ''], 'CodecName' => ['description' => 'The short name of the encoding format. Valid values:'."\n" ."\n" .'- **acc**'."\n" ."\n" .'- **mp3**'."\n" ."\n" .'- **mp4**'."\n" ."\n" .'- **ogg**'."\n" ."\n" .'- **flac**', 'type' => 'string', 'example' => 'acc', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '123', 'title' => ''], 'CodecTag' => ['description' => 'The encoding format tag.', 'type' => 'string', 'example' => '0x0000', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '1/48000', 'title' => ''], 'DurationInaccurate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubtitleStream' => [ 'description' => 'The list of caption stream information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/1000', 'title' => ''], 'Index' => ['description' => 'The sequence number of the caption stream. It indicates the position of the caption stream in the entire media stream.', 'type' => 'string', 'example' => '3', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'CodecName' => ['description' => 'The short name of the encoding format. Valid values:'."\n" ."\n" .'- **srt**'."\n" ."\n" .'- **ass**', 'type' => 'string', 'example' => 'ass', 'title' => ''], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'CodecLongName' => ['description' => 'The long name of the encoding format.', 'type' => 'string', 'example' => 'ASS (Advanced SSA) subtitle', 'title' => ''], 'Duration' => ['description' => 'The duration in seconds (s).', 'type' => 'string', 'example' => '1370.116000', 'title' => ''], 'CodecTag' => ['description' => 'The encoding format tag.', 'type' => 'string', 'example' => '0x0000', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '0/1', 'title' => ''], 'CodecTagString' => ['description' => 'The text of the encoding format tag.', 'type' => 'string', 'example' => '[0][0][0][0]', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Format' => [ 'description' => 'The format information.', 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.042000', 'title' => ''], 'NumPrograms' => ['description' => 'The total number of program streams.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Size' => ['description' => 'The file size.', 'type' => 'string', 'example' => '3509895', 'title' => ''], 'NumStreams' => ['description' => 'The total number of media streams.', 'type' => 'string', 'example' => '1', 'title' => ''], 'FormatLongName' => ['description' => 'The long name of the container format.', 'type' => 'string', 'example' => 'QuickTime/MOV', 'title' => ''], 'Duration' => ['description' => 'The total duration.', 'type' => 'string', 'example' => '17.226000', 'title' => ''], 'Bitrate' => ['description' => 'The total bitrate.', 'type' => 'string', 'example' => '1630.045', 'title' => ''], 'FormatName' => ['description' => 'The short name of the container format.', 'type' => 'string', 'example' => 'mov', 'title' => ''], 'Tags' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'FileSize' => ['description' => 'The file size.', 'type' => 'string', 'example' => '3509895', 'title' => ''], 'FileMd5' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'QueryMediaInfoJobList', 'description' => '- In asynchronous mode, media information can be queried only after a successful Message Service (MNS) callback is received for the [SubmitMediaInfoJob](~~602827~~) operation. If the media information cannot be queried after a long period, the media information analysis job may have failed.'."\n" ."\n" .'- You can query a maximum of 10 media information analysis jobs at a time.'."\n" ."\n" .'- By default, the returned results are sorted by CreationTime in descending order.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'The queries per second (QPS) limit for this API operation is 100 per user. API calls that exceed this limit are subject to rate limiting, which may affect your business. Plan your API calls accordingly. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => '**Callback message format**'."\n" ."\n" .'When the execution status of a media information analysis job changes, ApsaraVideo Media Processing (MPS) sends a message to the queue that you specify. For information about how to specify a callback queue, see the [UpdatePipeline](~~188374~~) API operation. The message body is a JSON string that contains the following fields:'."\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" .'| Name | Type | Description |'."\n" .'| -------- | ------ | ---------------------------------------------------------------------------------------------- |'."\n" .'| Type | String | The fixed string "MediaInfo", which indicates a media information analysis job. |'."\n" .'| JobId | String | The unique ID of the job. |'."\n" .'| State | String | The current status of the job. It is the same as the State parameter in QueryMediaInfoJobList. |'."\n" .'| UserData | String | The UserData that you pass in SubmitMediaInfoJob. |', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-10-24T07:32:45.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-06-20T05:56:32.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-05-17T02:22:26.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaInfoJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaInfoJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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 \\"DolbyVision\\": {\\n \\"Profile\\": \\"\\",\\n \\"Level\\": \\"\\"\\n }\\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 \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"FileSize\\": \\"3509895\\",\\n \\"FileMd5\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'QueryMediaList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the media files to query. To obtain the media IDs, log on to the MPS console and go to **Media Management** > **Media List**. Separate multiple IDs with a comma (,). You can query a maximum of 10 media files at a time.', 'type' => 'string', 'required' => true, 'example' => '3e1cd21131a94525be55acf65888****,e26cfa29e784402388463f61dbec****', 'title' => ''], ], [ 'name' => 'IncludePlayList', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include the playback information in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'IncludeSnapshotList', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include the snapshot information in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'IncludeMediaInfo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include the media information in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'IncludeSummaryList', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include the summary in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned parameters.', 'properties' => [ 'NonExistMediaIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaId' => [ 'description' => 'The list of non-existent media IDs.', 'type' => 'array', 'items' => ['description' => 'The non-existent media ID. This parameter is not returned if no data exists.', 'type' => 'string', 'example' => '{"MediaId":[e26cfa29e784402388463f61dbec****]}', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'MediaList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Media' => [ 'description' => 'The list of media files.', 'type' => 'array', 'items' => [ 'description' => 'The details of the media file.', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media file was created.', 'type' => 'string', 'example' => '2016-09-14T08:30:33Z', 'title' => ''], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Height' => ['description' => 'The height of the media file.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'CensorState' => ['description' => 'The review state of the video. Valid values:'."\n" ."\n" .'- **Initiated**: The video has been uploaded, but the review is not complete.'."\n" ."\n" .'- **Pass**: The video has been uploaded and approved.', 'type' => 'string', 'example' => 'Initiated', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tag information.', 'type' => 'array', 'items' => ['description' => 'The list of tags.', 'type' => 'string', 'example' => 'tag1,tag2', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PlayList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Play' => [ 'description' => 'The playlist.', 'type' => 'array', 'items' => [ 'description' => 'The details of the playback file.', 'properties' => [ 'Encryption' => ['description' => 'The encryption status. Valid values:'."\n" ."\n" .'- **0**: The file is not encrypted.'."\n" ."\n" .'- **1**: The file is encrypted.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Height' => ['description' => 'The height.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '2659.326', 'title' => ''], 'File' => [ 'description' => 'The playback file.', 'properties' => [ 'State' => ['description' => 'The state of the file. Valid values:'."\n" ."\n" .'- **Normal**: The file is normal.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The OSS bucket of the output file.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'MediaWorkflowId' => ['description' => 'The ID of the workflow that generates the playback file.', 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e91d24d****', 'title' => ''], 'Width' => ['description' => 'The width of the media file.', 'type' => 'string', 'example' => '760', 'title' => ''], 'Size' => ['description' => 'The file size.', 'type' => 'string', 'example' => '2647692', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '7.965000', 'title' => ''], 'ActivityName' => ['description' => 'The name of the media workflow activity.', 'type' => 'string', 'example' => 'example-activity-****', 'title' => ''], 'Format' => ['description' => 'The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], 'MediaWorkflowName' => ['description' => 'The workflow that generates the playback file.', 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '2659.326', 'title' => ''], 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'example' => '3e1cd21131a94525be55acf65888****', 'title' => ''], 'File' => [ 'description' => 'The details of the input file.', 'properties' => [ 'State' => ['description' => 'The state. Valid values:'."\n" ."\n" .'- **Normal**: The file is normal.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The OSS bucket of the input file.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'SummaryList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Summary' => [ 'description' => 'The list of video synopses.', 'type' => 'array', 'items' => [ 'description' => 'The video synopsis data.', 'properties' => [ 'Type' => ['description' => 'The summary type. Valid values:'."\n" ."\n" .'- **Video**: video.'."\n" ."\n" .'- **Gif**: GIF.', 'type' => 'string', 'example' => 'Video', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the workflow that generates the summary.', 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e91d24d****', 'title' => ''], 'ActivityName' => ['description' => 'The name of the media workflow activity.', 'type' => 'string', 'example' => 'example-activity-****', 'title' => ''], 'MediaWorkflowName' => ['description' => 'The name of the workflow that generates the summary.', 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'File' => [ 'description' => 'The information about the input file.', 'properties' => [ 'State' => ['description' => 'The state of the file. Valid values:'."\n" ."\n" .'- **Normal**: The file is normal.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The OSS bucket of the input file.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PublishState' => ['description' => 'The publishing state of the media file. This indicates whether the media file is published. Valid values:'."\n" ."\n" .'- **Initiated**: initial state.'."\n" ."\n" .'- **UnPublish**: The media file is not published. The permission on the OSS playback file is Private.'."\n" ."\n" .'- **Published**: The media file is published. The permission on the OSS playback file is Default.'."\n" ."\n" .'- **Deleted**: The media file is deleted.', 'type' => 'string', 'example' => 'Published', 'title' => ''], 'MediaInfo' => [ 'description' => 'The media information.', 'properties' => [ 'Streams' => [ 'description' => 'The stream information.', 'properties' => [ 'VideoStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoStream' => [ 'description' => 'The list of video streams.', 'type' => 'array', 'items' => [ 'description' => 'The video stream data.', 'properties' => [ 'Sar' => ['description' => 'The sample aspect ratio (SAR).', 'type' => 'string', 'example' => '1:1', 'title' => ''], 'Height' => ['description' => 'The height of the video.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'CodecTagString' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => 'avc1', 'title' => ''], 'NetworkCost' => [ 'description' => 'The network bandwidth consumption.', 'properties' => [ 'PreloadTime' => ['description' => 'The preload time.', 'type' => 'string', 'example' => '0.01', 'title' => ''], 'AvgBitrate' => ['description' => 'The average bitrate.', 'type' => 'string', 'example' => '2659.326', 'title' => ''], 'CostBandwidth' => ['description' => 'The maximum bandwidth consumed.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'Width' => ['description' => 'The width of the video.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Index' => ['description' => 'The sequence number of the video stream. This indicates the position of the video stream in the media stream.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/30000', 'title' => ''], 'AvgFPS' => ['description' => 'The average frame rate.', 'type' => 'string', 'example' => '29.97003', 'title' => ''], 'PixFmt' => ['description' => 'The pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Lang' => ['description' => 'The language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', 'type' => 'string', 'example' => 'und', 'title' => ''], 'CodecLongName' => ['description' => 'The long name of the encoding format.', 'type' => 'string', 'example' => 'QuickTime/MOV', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '12', 'title' => ''], 'Rotate' => ['description' => 'The rotation angle of the video.', 'type' => 'string', 'example' => '90', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '2659.326', 'title' => ''], 'HasBFrames' => ['description' => 'Indicates whether B-frames exist. **1**: yes. **2**: no.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Profile' => ['description' => 'The codec profile.', 'type' => 'string', 'example' => 'High', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'Dar' => ['description' => 'The display aspect ratio (DAR).', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'CodecName' => ['description' => 'The short name of the encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '182.683000', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '29.97003', 'title' => ''], 'CodecTag' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => '0x31637661', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '1001/60000', 'title' => ''], 'Level' => ['description' => 'The encoding level.', 'type' => 'string', 'example' => '40', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AudioStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AudioStream' => [ 'description' => 'The list of audio streams.', 'type' => 'array', 'items' => [ 'description' => 'The audio stream data.', 'properties' => [ 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'Index' => ['description' => 'The sequence number of the audio stream. This indicates the position of the audio stream in the media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'SampleFmt' => ['description' => 'The sampling format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'ChannelLayout' => ['description' => 'The layout of the sound channels.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], 'Lang' => ['description' => 'The language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', 'type' => 'string', 'example' => 'und', 'title' => ''], 'Samplerate' => ['description' => 'The sample rate.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'CodecLongName' => ['description' => 'The long name of the encoding format.', 'type' => 'string', 'example' => 'AAC(Advanced Audio Coding)', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '160.008', 'title' => ''], 'CodecTagString' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => 'mp4a', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'CodecName' => ['description' => 'The short name of the encoding format. Valid values: H264, mov, aac, avc, and mpeg.', 'type' => 'string', 'example' => 'mov', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '182.591995', 'title' => ''], 'CodecTag' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => '0x6134706d', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubtitleStream' => [ 'description' => 'The list of subtitle streams.', 'type' => 'array', 'items' => [ 'description' => 'The subtitle stream data.', 'properties' => [ 'Index' => ['description' => 'The sequence number of the subtitle stream. This indicates the position of the subtitle stream in the media stream.', 'type' => 'string', 'example' => '3', 'title' => ''], 'Lang' => ['description' => 'The language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', 'type' => 'string', 'example' => 'und', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'Format' => [ 'description' => 'The format information.', 'properties' => [ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'NumPrograms' => ['description' => 'The total number of program streams.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Size' => ['description' => 'The file size.', 'type' => 'string', 'example' => '2647692', 'title' => ''], 'NumStreams' => ['description' => 'The total number of media streams.', 'type' => 'string', 'example' => '2', 'title' => ''], 'FormatLongName' => ['description' => 'The long name of the container format.', 'type' => 'string', 'example' => 'QuickTime/MOV', 'title' => ''], 'Duration' => ['description' => 'The total duration.', 'type' => 'string', 'example' => '7.965000', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '2659.326', 'title' => ''], 'FormatName' => ['description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'This is description ****', 'title' => ''], 'Size' => ['description' => 'The file size.', 'type' => 'string', 'example' => '2647692', 'title' => ''], 'Width' => ['description' => 'The width.', 'type' => 'string', 'example' => '1920', 'title' => ''], 'CoverURL' => ['description' => 'The OSS bucket of the thumbnail.', 'type' => 'string', 'example' => 'http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png', 'title' => ''], 'SnapshotList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Snapshot' => [ 'description' => 'The list of snapshots.', 'type' => 'array', 'items' => [ 'description' => 'The snapshot file data.', 'properties' => [ 'Type' => ['description' => 'The snapshot type. Valid values:'."\n" ."\n" .'- **Single**: a single snapshot.'."\n" ."\n" .'- **Sequence**: a sequence of snapshots.', 'type' => 'string', 'example' => 'Sequence', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the workflow that generates the snapshot file.', 'type' => 'string', 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', 'title' => ''], 'ActivityName' => ['description' => 'The name of the workflow activity that generates the snapshot file.', 'type' => 'string', 'example' => 'example-activity1-****', 'title' => ''], 'Count' => ['description' => 'The number of snapshots. This parameter is valid only when **Type** is set to **Sequence**.', 'type' => 'string', 'example' => '5', 'title' => ''], 'MediaWorkflowName' => ['description' => 'The workflow that generates the snapshot file.', 'type' => 'string', 'example' => 'example-workflow-****', 'title' => ''], 'File' => [ 'description' => 'The snapshot file.', 'properties' => [ 'State' => ['description' => 'The state of the file. Valid values:'."\n" ."\n" .'- **Normal**: The file is normal.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The OSS bucket of the snapshot file.', 'type' => 'string', 'example' => 'http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RunIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RunId' => [ 'description' => 'The list of instances.', 'type' => 'array', 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '{"RunId":["47b42486019c4f688bf144c1a6ba****"]}', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '7.965000', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Title' => ['description' => 'The title.', 'type' => 'string', 'example' => 'example-title-****', 'title' => ''], 'Format' => ['description' => 'The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '283DC68C-146F-4489-A2A1-2F88F1472A56', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query media list ', 'summary' => 'You can call this operation to query media files by media ID.', 'description' => 'You can query a maximum of 10 media files at a time.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'The queries per second (QPS) limit for this operation is 100 for each user. If the limit is exceeded, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:01.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'QueryMediaListByURL' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'FileURLs', 'in' => 'query', 'schema' => ['description' => 'The URLs of the media files that you want to query. To obtain the URL of a media file, log on to the MPS console, choose **Media Management** > **Media List**, find the media file, and then click **Manage** in the **Actions** column. On the **Get Transcoding URL** tab, you can obtain the URL of the media file. Separate multiple URLs with commas (,). You can query a maximum of 10 URLs at a time.'."\n" ."\n" .'- The URL must be compliant with RFC 3986. The URL must be encoded in UTF-8, and reserved characters must be URL-encoded. For more information, see [URL encoding](~~423796~~). The URL can be up to 3,200 bytes in length.'."\n" ."\n" .'- Only OSS HTTP URLs are supported. CDN and HTTPS URLs are not supported.', 'type' => 'string', 'required' => true, 'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example.mp4', 'title' => ''], ], [ 'name' => 'IncludePlayList', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include playback information in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'IncludeSnapshotList', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include snapshot information in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'IncludeMediaInfo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include media information in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.'."\n" ."\n" .' > To obtain detailed MediaInfo, set this parameter to true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'IncludeSummaryList', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include a list of video synopses in the response.'."\n" ."\n" .'- Valid values: true and false.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned parameters.', 'properties' => [ 'MediaList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Media' => [ 'description' => 'The list of media files.', 'type' => 'array', 'items' => [ 'description' => 'The details of a media file.', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media file was created.', 'type' => 'string', 'example' => '2021-07-14T13:05:00Z', 'title' => ''], 'CateId' => ['description' => 'The ID of the category.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], 'Height' => ['description' => 'The height of the media file.', 'type' => 'string', 'example' => '360', 'title' => ''], 'CensorState' => ['description' => 'The content review state of the video. Valid values:'."\n" ."\n" .'- **Initiated**: The video is being reviewed.'."\n" ."\n" .'- **Pass**: The video passed the review.', 'type' => 'string', 'example' => 'Initiated', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tag information.', 'type' => 'array', 'items' => ['description' => 'The list of tags.', 'type' => 'string', 'example' => 'tag1,tag2', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PlayList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Play' => [ 'description' => 'The playlist.', 'type' => 'array', 'items' => [ 'description' => 'The details of a playback file.', 'properties' => [ 'Encryption' => ['description' => 'The encryption method. Valid values:'."\n" ."\n" .'- **0**: unencrypted.'."\n" ."\n" .'- **1**: encrypted.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Height' => ['description' => 'The height.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '25.067', 'title' => ''], 'File' => [ 'description' => 'The playback file.', 'properties' => [ 'State' => ['description' => 'The state of the file. Valid values:'."\n" ."\n" .'- **Normal**: The file is in a normal state.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The URL of the playback file in an OSS bucket.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4l-test/in/1.mp4', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'MediaWorkflowId' => ['description' => 'The ID of the workflow that generated the playback file.', 'type' => 'string', 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', 'title' => ''], 'Width' => ['description' => 'The width.', 'type' => 'string', 'example' => '11', 'title' => ''], 'Size' => ['description' => 'The size.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '7.965000', 'title' => ''], 'ActivityName' => ['description' => 'The name of the media workflow activity.', 'type' => 'string', 'example' => 'test name', 'title' => ''], 'Format' => ['description' => 'The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], 'MediaWorkflowName' => ['description' => 'The name of the workflow that generated the playback file.', 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '593.192', 'title' => ''], 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'example' => '52d7e98b05e648199612290bb819****', 'title' => ''], 'File' => [ 'description' => 'The details of the input file.', 'properties' => [ 'State' => ['description' => 'The state of the file. Valid values:'."\n" ."\n" .'- **Normal**: The file is in a normal state.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The URL of the input file in an OSS bucket.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'SummaryList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Summary' => [ 'description' => 'The list of video synopses.', 'type' => 'array', 'items' => [ 'description' => 'The video synopsis data.', 'properties' => [ 'Type' => ['description' => 'The type of the synopsis. Valid values:'."\n" ."\n" .'- **Video**: video.'."\n" ."\n" .'- **Gif**: animated image.', 'type' => 'string', 'example' => 'Gif', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the workflow that generated the synopsis.', 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e91d24d****', 'title' => ''], 'ActivityName' => ['description' => 'The name of the media workflow activity.', 'type' => 'string', 'example' => 'example-activity-****', 'title' => ''], 'MediaWorkflowName' => ['description' => 'The name of the workflow that generated the synopsis.', 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'File' => [ 'description' => 'The source file.', 'properties' => [ 'State' => ['description' => 'The state of the file. Valid values:'."\n" ."\n" .'- **Normal**: The file is in a normal state.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The URL of the input file in an OSS bucket.', 'type' => 'string', 'example' => 'http://example-bucket-****.o', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PublishState' => ['description' => 'The publishing state of the media file. Valid values:'."\n" ."\n" .'- **Initiated**: The media file is in the initial state.'."\n" ."\n" .'- **UnPublish**: The media file is not published. The permission on the OSS playback file is set to Private.'."\n" ."\n" .'- **Published**: The media file is published. The permission on the OSS playback file is set to Default.'."\n" ."\n" .'- **Deleted**: The media file is deleted.', 'type' => 'string', 'example' => 'Published', 'title' => ''], 'MediaInfo' => [ 'description' => 'The media information.', 'properties' => [ 'Streams' => [ 'description' => 'The stream information.', 'properties' => [ 'VideoStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoStream' => [ 'description' => 'The list of video streams.', 'type' => 'array', 'items' => [ 'description' => 'The video stream data.', 'properties' => [ 'Sar' => ['description' => 'The sample aspect ratio (SAR).', 'type' => 'string', 'example' => '1:1', 'title' => ''], 'Height' => ['description' => 'The height of the video.', 'type' => 'string', 'example' => '360', 'title' => ''], 'CodecTagString' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => 'avc1', 'title' => ''], 'NetworkCost' => [ 'description' => 'The network bandwidth consumption.', 'properties' => [ 'PreloadTime' => ['description' => 'The preload time.', 'type' => 'string', 'example' => '0.01', 'title' => ''], 'AvgBitrate' => ['description' => 'The average bitrate.', 'type' => 'string', 'example' => '2659.326', 'title' => ''], 'CostBandwidth' => ['description' => 'The maximum bandwidth consumed.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'Width' => ['description' => 'The width of the video. The value must be a non-negative number.', 'type' => 'string', 'example' => '640', 'title' => ''], 'Index' => ['description' => 'The sequence number of the video stream. This indicates the position of the video stream in the media stream.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/15360', 'title' => ''], 'AvgFPS' => ['description' => 'The average frame rate.', 'type' => 'string', 'example' => '15.0', 'title' => ''], 'PixFmt' => ['description' => 'The pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Lang' => ['description' => 'The language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', 'type' => 'string', 'example' => 'und', 'title' => ''], 'CodecLongName' => ['description' => 'The full name of the encoding format.', 'type' => 'string', 'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '12', 'title' => ''], 'Rotate' => ['description' => 'The rotation angle of the video.', 'type' => 'string', 'example' => '90', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '512.701', 'title' => ''], 'HasBFrames' => ['description' => 'Indicates whether B-frames exist. **1** means yes, and **2** means no.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Profile' => ['description' => 'The codec profile.', 'type' => 'string', 'example' => 'High', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.046029', 'title' => ''], 'Dar' => ['description' => 'The display aspect ratio (DAR).', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'CodecName' => ['description' => 'The short name of the encoding format. Valid values: H264, mov, aac, avc, and mpeg.', 'type' => 'string', 'example' => 'H264', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '79.200000', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '15.0', 'title' => ''], 'CodecTag' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => '0x31637661', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '1/30', 'title' => ''], 'Level' => ['description' => 'The encoding level.', 'type' => 'string', 'example' => '31', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AudioStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AudioStream' => [ 'description' => 'The list of audio streams.', 'type' => 'array', 'items' => [ 'description' => 'The audio stream data.', 'properties' => [ 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'Index' => ['description' => 'The sequence number of the audio stream. This indicates the position of the audio stream in the media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'SampleFmt' => ['description' => 'The sampling format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'ChannelLayout' => ['description' => 'The layout of the sound channels.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], 'Lang' => ['description' => 'The language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', 'type' => 'string', 'example' => 'und', 'title' => ''], 'Samplerate' => ['description' => 'The sample rate.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'CodecLongName' => ['description' => 'The full name of the encoding format.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '76.356', 'title' => ''], 'CodecTagString' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => 'mp4a', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'CodecName' => ['description' => 'The short name of the encoding format. Valid values: H264, mov, aac, avc, and mpeg.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '79.203265', 'title' => ''], 'CodecTag' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => '0x6134706d', 'title' => ''], 'CodecTimeBase' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubtitleStream' => [ 'description' => 'The list of caption streams.', 'type' => 'array', 'items' => [ 'description' => 'The caption stream data.', 'properties' => [ 'Index' => ['description' => 'The sequence number of the caption stream. This indicates the position of the caption stream in the media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Lang' => ['description' => 'The language. For more information, see [FFmpeg language definitions](https://www.ffmpeg.org/ffmpeg-all.html#Metadata).', 'type' => 'string', 'example' => 'und', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'Format' => [ 'description' => 'The format information.', 'properties' => [ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'NumPrograms' => ['description' => 'The total number of program streams.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Size' => ['description' => 'The size.', 'type' => 'string', 'example' => '5872904', 'title' => ''], 'NumStreams' => ['description' => 'The total number of media streams.', 'type' => 'string', 'example' => '2', 'title' => ''], 'FormatLongName' => ['description' => 'The full name of the encoding format.', 'type' => 'string', 'example' => 'QuickTime/MOV', 'title' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '79.204000', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '593.192', 'title' => ''], 'FormatName' => ['description' => 'The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'This is description ****', 'title' => ''], 'Size' => ['description' => 'The file size.', 'type' => 'string', 'example' => '5872904', 'title' => ''], 'Width' => ['description' => 'The width.', 'type' => 'string', 'example' => '640', 'title' => ''], 'CoverURL' => ['description' => 'The URL of the thumbnail in an OSS bucket.', 'type' => 'string', 'example' => 'http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png', 'title' => ''], 'SnapshotList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Snapshot' => [ 'description' => 'The list of snapshots.', 'type' => 'array', 'items' => [ 'description' => 'The details of a snapshot file.', 'properties' => [ 'Type' => ['description' => 'The type of the snapshot. Valid values:'."\n" ."\n" .'- **Single**: a single snapshot.'."\n" ."\n" .'- **Sequence**: a sequence of snapshots.', 'type' => 'string', 'example' => 'Single', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the workflow that generated the snapshot file.', 'type' => 'string', 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', 'title' => ''], 'ActivityName' => ['description' => 'The name of the workflow activity that generated the snapshot file.', 'type' => 'string', 'example' => 'example-activity1-****', 'title' => ''], 'Count' => ['description' => 'The number of snapshots. This parameter is valid only when **Type** is set to **Sequence**.', 'type' => 'string', 'example' => '3', 'title' => ''], 'MediaWorkflowName' => ['description' => 'The name of the workflow that generated the snapshot file.', 'type' => 'string', 'example' => 'example-workflow-****', 'title' => ''], 'File' => [ 'description' => 'The snapshot file.', 'properties' => [ 'State' => ['description' => 'The state of the file. Valid values:'."\n" ."\n" .'- **Normal**: The file is in a normal state.'."\n" ."\n" .'- **Deleted**: The file is deleted.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The URL of the snapshot file in an OSS bucket.', 'type' => 'string', 'example' => 'http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RunIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RunId' => [ 'description' => 'The list of media workflows.', 'type' => 'array', 'items' => ['description' => 'The list of media workflow IDs.', 'type' => 'string', 'example' => '9343bd0e7bb54ae19228529908e5****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'example' => '79.204000', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '15.0', 'title' => ''], 'Title' => ['description' => 'The title.', 'type' => 'string', 'example' => 'kled.mp4', 'title' => ''], 'Format' => ['description' => 'The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NonExistFileURLs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FileURL' => [ 'description' => 'The information about the media files that do not exist.', 'type' => 'array', 'items' => ['description' => 'The URLs of the media files that do not exist. This parameter is not returned if no data is available.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C8A0AEB-4321-485B-B4CB-DA4E9E6C9B42', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query media information by media input URL', 'summary' => 'Queries media files by their Object Storage Service (OSS) file URLs.', 'description' => '- You can query a maximum of 10 media files at a time.'."\n" ."\n" .'- Before you call this operation, you must call the [AddMedia](~~44458~~) operation to add media files. You can then call this operation to query media information.'."\n" ."\n" .'- This operation can query information only about files that have been processed by a workflow. For newly uploaded media files, the information returned by this operation is complete only after the workflow is executed. To retrieve information about videos that have not been processed by a workflow, you must call the [SubmitMediaInfoJob](~~29220~~) operation to submit a media information analysis job.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'The queries per second (QPS) limit for this operation is 100 per user. Throttling is triggered if the limit is exceeded, which may affect your business. Plan your calls accordingly. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaListByURL'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaListByURL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'QueryMediaWorkflowExecutionList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RunIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the media workflow execution instances. To obtain the instance ID, log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Execution Instances** in the left-side navigation pane. Separate multiple IDs with commas (,). You can query a maximum of 10 media workflow execution instances at a time.'."\n", 'type' => 'string', 'required' => true, 'example' => '48e33690ac19445488c706924321****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'NonExistRunIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RunId' => [ 'description' => 'The IDs of the execution instances that do not exist.'."\n", 'type' => 'array', 'items' => ['description' => 'The IDs of the execution instances that do not exist. null is returned if all specified execution instances exist.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'MediaWorkflowExecutionList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaWorkflowExecution' => [ 'description' => 'The details of the media workflows.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '016-04-01T06:53:43Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow.'."\n", 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e91****81d4', 'title' => ''], 'State' => ['description' => 'The status of the media workflow. Valid values:'."\n" ."\n" .'* Running: The media workflow is running.'."\n" .'* Completed: The media workflow is complete.'."\n" ."\n" .'> Completed only indicates that the media workflow is complete. View the status of each method in the workflow, such as the transcode and snapshot methods, to check whether the method is called.'."\n" ."\n" .'* Fail: The media workflow fails.'."\n", 'type' => 'string', 'example' => 'Completed', 'title' => ''], 'ActivityList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Activity' => [ 'description' => 'The methods that are called in the media workflow.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the method.'."\n", 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The time when the method ends.'."\n", 'type' => 'string', 'example' => '2016-04-01T06:53:44Z', 'title' => ''], 'Type' => ['description' => 'The methods that are supported in the media workflow. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see [Methods supported for media workflows](~~68494~~).'."\n", 'type' => 'string', 'example' => 'Start', 'title' => ''], 'StartTime' => ['description' => 'The time when the method is called.'."\n", 'type' => 'string', 'example' => '2016-04-01T06:53:44Z', 'title' => ''], 'State' => ['description' => 'The status of the workflow method. Valid values:'."\n" ."\n" .'* Running: The method is being called.'."\n" .'* Success: The method is called.'."\n" .'* Fail: The method failed to be called.'."\n" .'* Skipped: The method is skipped.'."\n" ."\n" .'> For example, after the analysis is complete, the transcode method is called and high-definition and standard-definition transcoding jobs are created. The system determines whether to run the jobs based on the analysis result. If the resolution of the input video is low, the high-definition transcoding job may be skipped.'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], 'JobId' => ['description' => 'The IDs of the jobs that are generated when the methods are called, such as the job IDs for the analysis, transcode, and snapshot methods.'."\n", 'type' => 'string', 'example' => '2376030d9d0849399cd20e20f4f3****', 'title' => ''], 'Code' => ['description' => 'The error code.'."\n" ."\n" .'* This parameter is returned only if **Fail** is returned for the State parameter.'."\n" .'* This parameter is not returned if the method status is **Success**.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceContentBad', 'title' => ''], 'Message' => ['description' => 'The error message.'."\n" ."\n" .'* This parameter is returned only if **Fail** is returned for the State parameter.'."\n" .'* This parameter is not returned if the method status is **Success**.'."\n", 'type' => 'string', 'example' => 'The resource operated InputFile is bad', 'title' => ''], 'Name' => ['description' => 'The name of the method.'."\n" ."\n" .'> The name of each method in a media workflow is unique.'."\n", 'type' => 'string', 'example' => 'Start', 'title' => ''], 'MNSMessageResult' => [ 'description' => 'The message sent by Message Service (MNS) to notify the user of the job result.'."\n", 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the message that indicates the MNS message is sent. This parameter is not returned if the MNS message fails to be sent.'."\n", 'type' => 'string', 'example' => '4f3bc83233de4e2f81c7dade443e****', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned if the MNS message fails to be sent. This parameter is not returned if the MNS message is sent.'."\n", 'type' => 'string', 'example' => 'MessageConfigEmpty', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the MNS message fails to be sent. This parameter is not returned if the MNS message is sent.'."\n", 'type' => 'string', 'example' => 'The Topic/Queue config is empty, not send message', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'Input' => [ 'description' => 'The input data of the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'UserData' => ['description' => 'The user-defined data.'."\n", 'type' => 'string', 'example' => 'example data ****', 'title' => ''], 'InputFile' => [ 'description' => 'The input file of the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the input file.'."\n", 'type' => 'string', 'example' => 'example-mediaWorkflow-****/example-object-****/example.mp4', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region in which the input file resides.'."\n", 'type' => 'string', 'example' => 'mps-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.'."\n", 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaId' => ['description' => 'The ID of the media asset. A media file contains all the information about a media workflow.'."\n", 'type' => 'string', 'example' => '512046582a924698a41e0f8b0d2b****', 'title' => ''], 'RunId' => ['description' => 'The ID of the execution instance.'."\n", 'type' => 'string', 'example' => '48e33690ac19445488c706924321****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'QueryMediaWorkflowExecutionList', 'summary' => 'Queries media workflow execution instances.', 'description' => '* You can call this operation to query a maximum of 10 media workflow execution instances at a time.'."\n" .'* Before you call this operation, make sure that the workflow pipeline is enabled. Otherwise, the workflow may not run as expected. For example, the following exceptions may occur: the workflow node is invalid and jobs created in the workflow cannot be executed.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaWorkflowExecutionList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaWorkflowExecutionList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'QueryMediaWorkflowList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'MediaWorkflowIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the media workflows that you want to query. To obtain the IDs of the media workflows, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane. You can query up to 10 media workflows at a time. Separate multiple IDs of media workflows with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '93ab850b4f6f44eab54b6e9181d4****,72dfa5e679ab4be9a3ed9974c736****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'NonExistMediaWorkflowIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaWorkflowId' => [ 'description' => 'The workflows that do not exist.'."\n", 'type' => 'array', 'items' => ['description' => 'The IDs of the media workflows that do not exist. This parameter is not returned if all specified media workflows are found.'."\n", 'type' => 'string', 'example' => '72dfa5e679ab4be9a3ed9974c736****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'MediaWorkflowList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaWorkflow' => [ 'description' => 'The media workflows.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detailed information about the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '2016-04-01T05:29:38Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow.'."\n", 'type' => 'string', 'example' => '93ab850b4f6f44eab54b6e9181d4****', 'title' => ''], 'State' => ['description' => 'The state of the media workflow. Valid values:'."\n" ."\n" .'* **Inactive**: The media workflow was deactivated.'."\n" .'* **Active**: The media workflow was activated.'."\n" .'* **Deleted**: The media workflow was deleted.'."\n", 'type' => 'string', 'example' => 'Active', 'title' => ''], 'TriggerMode' => ['description' => 'The trigger mode of the media workflow. Valid values:'."\n" ."\n" .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", 'type' => 'string', 'example' => 'OssAutoTrigger', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'Topology' => ['description' => 'The topology of the media workflow.'."\n", '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"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '16CD0CDD-457E-420D-1234-8385075A618B', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'QueryMediaWorkflowList', 'summary' => 'Queries registered media workflows.', 'description' => 'You can call this operation to query up to 10 media workflows at a time.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaWorkflowList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaWorkflowList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'QueryPipelineList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PipelineIds', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of pipeline IDs to query. Find these IDs in the **MPS console** > **Global Settings** > **Pipelines**. Specify up to 10 IDs, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => 'd1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C538EAA-ACAF-5AD8-B091-A72C63007149', 'title' => ''], 'PipelineList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Pipeline' => [ 'description' => 'The list of pipelines.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'Speed' => ['description' => 'The pipeline type. Default value: **Standard**. Valid values:'."\n" ."\n" .'- **Boost**: accelerated transcoding pipeline.'."\n" ."\n" .'- **Standard**: standard pipeline.'."\n" ."\n" .'- **NarrowBandHDV2**: Narrowband HD 2.0 pipeline.'."\n" ."\n" .'- **AIVideoCover**: intelligent screenshot pipeline.'."\n" ."\n" .'- **AIVideoFPShot**: video DNA pipeline.'."\n" ."\n" .'- **AIVideoCensor**: automated review pipeline.'."\n" ."\n" .'- **AIVideoMCU**: DataQ - Smart Tag Service pipeline.'."\n" ."\n" .'- **AIVideoSummary**: video synopsis pipeline.'."\n" ."\n" .'- **AIVideoPorn**: pornography detection pipeline.'."\n" ."\n" .'- **AIAudioKWS**: audio keyword recognition pipeline.'."\n" ."\n" .'- **AIAudioASR**: speech-to-text pipeline.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'State' => ['description' => 'The pipeline status.'."\n" ."\n" .'- **Active**: The pipeline is enabled.'."\n" ."\n" .'- **Paused**: The pipeline is paused.', 'type' => 'string', 'example' => 'Paused', 'title' => ''], 'SpeedLevel' => ['description' => 'The pipeline level.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'NotifyConfig' => [ 'description' => 'Alibaba Cloud MNS notification configuration.', 'type' => 'object', 'properties' => [ 'MqTopic' => ['description' => 'The message queue that receives messages.', 'type' => 'string', 'example' => 'example1,example2', 'title' => ''], 'QueueName' => ['description' => 'The queue name created in Alibaba Cloud Simple Message Queue (formerly MNS).', 'type' => 'string', 'example' => 'example-queue-****', 'title' => ''], 'MqTag' => ['description' => 'The tag.', 'type' => 'string', 'example' => 'mts-test', 'title' => ''], 'Topic' => ['description' => 'The topic name created in Alibaba Cloud Simple Message Queue (formerly MNS).', 'type' => 'string', 'example' => 'example-topic-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Role' => ['description' => 'The role associated with the current RAM user.', 'type' => 'string', 'example' => 'AliyunMTSDefaultRole', 'title' => ''], 'Name' => ['description' => 'The pipeline name.', 'type' => 'string', 'example' => 'example-pipeline-****', 'title' => ''], 'Id' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], 'QuotaAllocate' => ['description' => 'The pipeline quota allocation.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'ExtendConfig' => [ 'type' => 'object', 'properties' => [ 'IsBoostNew' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'MaxMultiSpeed' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'MultiSpeedDowngradePolicy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NonExistPids' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The list of non-existent pipeline IDs.', 'type' => 'array', 'items' => ['description' => 'The list of non-existent pipeline IDs. This parameter is not returned if no such IDs exist.'."\n" ."\n" .'> If this parameter appears despite correct pipeline IDs, verify the UID in your request matches the pipeline owner\'s UID.', 'type' => 'string', 'example' => '72dfa5e679ab4be9a3ed9974c736****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'QueryPipelineList', 'summary' => 'Query pipelines by pipeline ID.', 'description' => '- You can query up to 10 pipelines in a single request.'."\n" ."\n" .'- If the return value is `"Code": "InvalidIdentity.ServiceDisabled", "Message": "The request identity was not allowed to operate.", "Recommend"`, verify that your MPS permissions are configured correctly (ensure the AliyunMTSDefaultRole role is granted) and confirm that your account has no overdue payments.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The QPS limit for this API is 100 requests per second per user. Exceeding this limit triggers rate limiting and may affect your business. Call this API only as needed. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPipelineList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryPipelineList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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\\": false,\\n \\"MaxMultiSpeed\\": 0,\\n \\"MultiSpeedDowngradePolicy\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"NonExistPids\\": {\\n \\"String\\": [\\n \\"72dfa5e679ab4be9a3ed9974c736****\\"\\n ]\\n }\\n}","type":"json"}]', ], 'QuerySmarttagJob' => [ 'summary' => 'Queries a DataQ - Smart Tag Service job.', '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' => 'The ID of the DataQ - Smart Tag Service job to query. Get this value from the response of [SubmitSmarttagJob](~~163486~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'Additional request parameters as a JSON string. For example: `{"labelResultType":"auto"}`. The `labelResultType` parameter is a string with these values:'."\n" ."\n" .'- **auto**: Machine-generated tags'."\n" ."\n" .'- **hmi**: Human-machine collaborative tags', 'type' => 'string', 'required' => false, 'example' => '{"labelResultType":"auto"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'JobStatus' => ['description' => 'The job status. Valid values:'."\n" ."\n" .'- **Success**: The job succeeded.'."\n" ."\n" .'- **Fail**: The job failed.'."\n" ."\n" .'- **Processing**: The job is running.'."\n" ."\n" .'- **Submitted**: The job was submitted and is waiting to run.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', 'title' => ''], 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Result' => [ 'description' => 'An array of analysis result objects.', 'type' => 'array', 'items' => [ 'description' => 'Detailed information about each analysis result object.', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The specific analysis result, formatted as a JSON string. For the structure of different Type values, see **Result parameter description** below.', 'type' => 'string', 'example' => '{"title":"example-title-****"}', 'title' => ''], 'Type' => ['description' => 'The type of analysis result.'."\n" ."\n" .'- Tag 1.0 result types:'."\n" ."\n" .' - TextLabel: Text labels'."\n" ."\n" .' - VideoLabel: Video labels'."\n" ."\n" .' - ASR: Raw speech recognition results (not returned by default)'."\n" ."\n" .' - OCR: Raw OCR results (not returned by default)'."\n" ."\n" .' - Process: Link to the raw algorithm result JSON file (not returned by default). For the JSON structure, see **Additional notes**.'."\n" ."\n" .'- Tag 2.0 result types:'."\n" ."\n" .' - CPVLabel (human-machine)'."\n" ."\n" .' - Meta: Video title and other metadata (not returned by default)'."\n" ."\n" .'- Tag 2.0-custom result types:'."\n" ."\n" .' - CPVLabel (human-machine)'."\n" ."\n" .' - Meta: Video title and other metadata (not returned by default)', 'type' => 'string', 'example' => 'Meta', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'Information passed through when using MNS callbacks. For the message format, see **Callback message format definition** below.', 'type' => 'string', 'example' => 'example UserData ****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Query Smart Tag Job', 'description' => '- This operation returns the results of an intelligent analysis of people, scenes, and keywords in videos.'."\n" ."\n" .'- The DataQ - Smart Tag Service is available only in the China North 2 (Beijing), China East 2 (Shanghai), and China East 1 (Hangzhou) regions.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'The maximum number of queries per second (QPS) for this operation is 100 per user. If this limit is exceeded, rate limiting is triggered, which may affect your business. For more information, see [QPS limits](~~342832~~).', 'responseParamsDescription' => '**Callback message format**'."\n" ."\n" .'When the state of a DataQ - Smart Tag Service job changes, ApsaraVideo Media Processing (MPS) sends a message to the queue that you specify. You can call the UpdatePipeline operation to specify the callback queue. The message body is a JSON string that contains the following fields:'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| -------- | ------ | ----------------------------------------------------------------------------- |'."\n" .'| Type | String | The fixed string "smarttag", indicating a DataQ - Smart Tag Service job |'."\n" .'| JobId | String | The unique job ID |'."\n" .'| State | String | The current job status. This matches the JobStatus value in QuerySmarttagJob. |'."\n" .'| UserData | String | The UserData value you passed in SubmitSmarttagJob. |'."\n" ."\n" .'**Result parameter description**'."\n" ."\n" .'**VideoLabel** data structure'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| ---------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| persons | JSONArray | Detected people |'."\n" .'| persons.name | String | The detected person\'s name |'."\n" .'| persons.category | String | The person\'s category. Valid values: `celebrity` (celebrity); `politician` (politician); `sensitive` (sensitive person); `unknown` (unknown person); or a custom person library ID (returned if the person is in your custom library) |'."\n" .'| persons.ratio | double | The person\'s appearance ratio. Valid values: 0 to 1 |'."\n" .'| persons.occurrences | JSONArray | Detailed occurrence information |'."\n" .'| persons.occurrences.score | double | Confidence score |'."\n" .'| persons.occurrences.from | double | Start time of the person\'s appearance, in seconds |'."\n" .'| persons.occurrences.to | double | End time of the person\'s appearance, in seconds |'."\n" .'| persons.occurrences.position | JSONObject | Face coordinates |'."\n" .'| persons.occurrences.position.leftTop | int[] | x and y coordinates of the top-left corner |'."\n" .'| persons.occurrences.position.rightBottom | int[] | x and y coordinates of the bottom-right corner |'."\n" .'| persons.occurrences.timestamp | double | Timestamp of the face coordinates, in seconds |'."\n" .'| persons.occurrences.scene | String | Shot type. Valid values: `closeUp` (close-up); `medium-closeUp` (medium close-up); `medium` (medium shot); `medium-long` (long shot) |'."\n" .'| tags | JSONArray | Detected object and scene labels. See the table below for examples. |'."\n" .'| tags.mainTagName | String | Main tag |'."\n" .'| tags.subTagName | String | Subtag |'."\n" .'| tags.ratio | double | Appearance ratio. Valid values: 0 to 1 |'."\n" .'| tags.occurrences | JSONArray | Occurrence details |'."\n" .'| tags.occurrences.score | double | Confidence score |'."\n" .'| tags.occurrences.from | double | Start time, in seconds |'."\n" .'| tags.occurrences.to | double | End time, in seconds |'."\n" .'| classifications | JSONArray | Video classification information |'."\n" .'| classifications.score | double | Confidence score |'."\n" .'| classifications.category1 | String | Level 1 category, such as Life, Animation, or Automobile |'."\n" .'| classifications.category2 | String | Level 2 category, such as Health or Home under Life |'."\n" ."\n" .'Example video tags'."\n" ."\n" .'| mainTagName | subTagName |'."\n" .'| --------------- | ------------------------------------------------------------------------------------------------------------ |'."\n" .'| Program | For example: Where Are We Going, Dad? or Happy Comedians |'."\n" .'| Character | For example: doctor, nurse, or teacher |'."\n" .'| Object | For example: piano, water glass, table, tomato and egg stir-fry, car, or cosmetics |'."\n" .'| Logo | For example: CCTV1, CCTV2, Youku, or Dragon TV |'."\n" .'| Action or event | For example: dancing, kissing, hugging, meeting, singing, making a phone call, horseback riding, or fighting |'."\n" .'| Region | For example: Tiananmen Square in Beijing, Statue of Liberty, Leshan Giant Buddha, China, or United States |'."\n" .'| Scene | For example: bedroom, subway station, terraced fields, beach, or desert |'."\n" ."\n" .'**ImageLabel** data structure'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| ---------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| persons | JSONArray | Detected people |'."\n" .'| persons.name | String | The detected person\'s name |'."\n" .'| persons.category | String | The person\'s category. Valid values: celebrity (celebrity); politician (politician); sensitive (sensitive person) |'."\n" .'| persons.score | double | Confidence score for the person |'."\n" .'| persons.position | JSONObject | Face coordinates |'."\n" .'| persons.position.leftTop | int[] | x and y coordinates of the top-left corner |'."\n" .'| persons.position.rightBottom | int[] | x and y coordinates of the bottom-right corner |'."\n" .'| persons.scene | String | Shot type. Valid values: closeUp (close-up); medium-closeUp (medium close-up); medium (medium shot); medium-long (long shot) |'."\n" .'| tags | JSONArray | Detected object and scene labels. See the table below for examples. |'."\n" .'| tags.mainTagName | String | Main tag |'."\n" .'| tags.subTagName | String | Subtag |'."\n" .'| tags.score | double | Confidence score |'."\n" ."\n" .'Example image tags'."\n" ."\n" .'| mainTagName | subTagName |'."\n" .'| --------------- | ------------------------------------------------------------------------------------------------------------ |'."\n" .'| Character | For example: doctor, nurse, or teacher |'."\n" .'| Region | For example: Tiananmen Square in Beijing, Statue of Liberty, Leshan Giant Buddha, China, or United States |'."\n" .'| Action or event | For example: speaking |'."\n" .'| Logo | For example: CCTV1, CCTV2, Youku, or Dragon TV |'."\n" .'| Action or event | For example: dancing, kissing, hugging, meeting, singing, making a phone call, horseback riding, or fighting |'."\n" .'| Object | For example: piano, water glass, table, tomato and egg stir-fry, car, or cosmetics |'."\n" .'| Scene | For example: bedroom, subway station, terraced fields, beach, or desert |'."\n" ."\n" .'TextLabel data structure (from automatic speech recognition (ASR) and optical character recognition (OCR))'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| ---------- | --------- | --------------------------------------------------------- |'."\n" .'| tags | JSONArray | Text label information. See the table below for examples. |'."\n" .'| tags.name | String | Label category |'."\n" .'| tags.value | String | Label value. Multiple values are separated by commas (,). |'."\n" ."\n" .'Example text tags'."\n" ."\n" .'| name | value |'."\n" .'| ------------ | --------------------------------------------------------------------------------------------------------- |'."\n" .'| Region | For example: Tiananmen Square in Beijing, Statue of Liberty, Leshan Giant Buddha, China, or United States |'."\n" .'| Organization | For example: China Wildlife Conservation Association or China Media Group |'."\n" .'| Logo | For example: Nike or Li-Ning |'."\n" .'| Keyword | For example: backbone force |'."\n" ."\n" .'**CPVLabel** data structure'."\n" ."\n" .'- cates: Categories (level 1, level 2, and level 3)'."\n" ."\n" .'- entities: Category properties (with knowledge graph information)'."\n" ."\n" .'- hotwords: Hot words (your watchlist)'."\n" ."\n" .'- freeTags: Free tags (keywords)'."\n" ."\n" .'| Name | Type | Example value | Description |'."\n" .'| --------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| type | String | hmi | Result type. Valid values: hmi (human-machine collaborative result) or autp (machine-generated result) |'."\n" .'| cates | JSONArray | \\- | Category results |'."\n" .'| cates.labelLevel1 | String | Travel | Level 1 label |'."\n" .'| cates.labelLevel2 | String | Scenic spots | Level 2 label |'."\n" .'| cates.label | String | "" | Label name. The algorithm may return an empty string. |'."\n" .'| cates.appearanceProbability | double | 0.96 | Appearance ratio |'."\n" .'| cates.detailInfo | JSONArray | \\- | \\- |'."\n" .'| cates.detailInfo.score | double | 0.9 | Confidence score |'."\n" .'| cates.detailInfo.startTime | double | 0.021 | Start time |'."\n" .'| cates.detailInfo.endTime | double | 29.021 | End time |'."\n" .'| entities | JSONArray | \\- | \\- |'."\n" .'| entities.labelLevel1 | String | Region | Level 1 label |'."\n" .'| entities.labelLevel2 | String | Landmark | Level 2 label |'."\n" .'| entities.label | String | Huangguoshu Waterfall | Label name |'."\n" .'| entities.appearanceProbability | double | 0.067 | Appearance ratio |'."\n" .'| entities.knowledgeInfo | String | {"name": "Huangguoshu Waterfall", "nameEn": "Huangguoshu Waterfall", "description": "One of Asia\'s four great waterfalls"} | Knowledge graph information. All fields are listed in the tables at the end: IP Graph, Music Graph, Person Graph, Landmark Graph, and Object Graph. |'."\n" .'| entities.detailInfo | JSONArray | \\- | \\- |'."\n" .'| entities.detailInfo.score | double | 0.33292606472969055 | Confidence score |'."\n" .'| entities.detailInfo.startTime | double | 6.021 | Start time |'."\n" .'| entities.detailInfo.endTime | double | 8.021 | End time |'."\n" .'| entities.detailInfo.trackData | JSONArray | \\- | Structured entity label information |'."\n" .'| entities.detailInfo.trackData.score | double | 0.32 | Confidence score |'."\n" .'| entities.detailInfo.trackData.bbox | integer[] | 23, 43, 45, 67 | Bounding box |'."\n" .'| entities.detailInfo.trackData.timestamp | double | 7.9 | Timestamp |'."\n" .'| hotwords | JSONArray | \\- | \\- |'."\n" .'| hotwords.labelLevel1 | String | Keyword | Level 1 label |'."\n" .'| hotwords.labelLevel1 | String | Keyword | Level 2 label |'."\n" .'| hotwords.labelLevel2 | String | "" | Level 2 label |'."\n" .'| hotwords.label | String | China Meteorological Administration | Hot word content |'."\n" .'| hotwords.appearanceProbability | double | 0.96 | Appearance ratio |'."\n" .'| hotwords.detailInfo | JSONArray | | |'."\n" .'| hotwords.detailInfo.score | double | 1.0 | Confidence score |'."\n" .'| hotwords.detailInfo.startTime | double | 0.021 | Start time |'."\n" .'| hotwords.detailInfo.endTime | double | 29.021 | End time |'."\n" .'| freeTags | JSONArray | | |'."\n" .'| freeTags.labelLevel1 | String | Keyword | Level 1 label |'."\n" .'| freeTags.labelLevel2 | String | "" | Level 2 label |'."\n" .'| freeTags.label | String | Central Meteorological Observatory | Hot word content |'."\n" .'| freeTags.appearanceProbability | double | 0.96 | Appearance ratio |'."\n" .'| freeTags.detailInfo | JSONArray | | |'."\n" .'| freeTags.detailInfo.score | double | 0.9 | Confidence score |'."\n" .'| freeTags.detailInfo.startTime | double | 0.021 | Start time |'."\n" .'| freeTags.detailInfo.endTime | double | 29.021 | End time |'."\n" ."\n" .'**Automatic speech recognition (ASR) results**'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| --------------- | --------- | --------------------------- |'."\n" .'| details | JSONArray | Detailed task results |'."\n" .'| details.from | double | Start timestamp, in seconds |'."\n" .'| details.to | double | End timestamp, in seconds |'."\n" .'| details.content | String | Recognized text content |'."\n" ."\n" .'**Optical character recognition (OCR) results**'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| --------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| details | JSONArray | Detailed task results |'."\n" .'| details.timestamp | double | Timestamp, in seconds |'."\n" .'| details.info | JSONArray | Specific information recognized at that timestamp |'."\n" .'| details.info.score | double | Confidence score |'."\n" .'| details.info.position | JSONObject | Text coordinates |'."\n" .'| details.info.position.leftTop | int[] | x and y coordinates of the top-left corner |'."\n" .'| details.info.position.rightBottom | int[] | x and y coordinates of the bottom-right corner |'."\n" .'| details.info.content | String | Recognized text content |'."\n" .'| details.info.textType | String | Text type. Valid values: 0 (normal caption), 1 (scrolling caption), or 2 (fixed-length identifying caption, duration longer than 3 seconds) |'."\n" ."\n" .'**Meta tagging results**'."\n" ."\n" .'> If you do not use human-machine tagging and set needMetaData to true in a [SubmitSmarttagJob](~~163486~~) request, QuerySmarttagJob returns the original title.'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| ----- | ------ | ----------- |'."\n" .'| title | String | Title |'."\n" ."\n" .'**Caption extraction results**'."\n" ."\n" .'| Name | Type | Description |'."\n" .'| -------------------- | --------- | ---------------------------------------------------------------------------------------- |'."\n" .'| details | JSONArray | Detailed task results |'."\n" .'| details.allResultUrl | String | URL for all captions. This URL remains valid for six months after the job completes. |'."\n" .'| details.chResultUrl | String | URL for Chinese captions. This URL remains valid for six months after the job completes. |'."\n" .'| details.engResultUrl | String | URL for English captions. This URL remains valid for six months after the job completes. |'."\n" ."\n" .'> The content of the file at the caption result URL is formatted as follows: `Sequence number + Time range + Caption content (each caption on one line)`.', 'extraInfo' => '### Parsing Output Information'."\n" ."\n" .'| Output Parameter | Description |'."\n" .'| --- | --- |'."\n" .'| name | Result module name: "tag" indicates tag results, with all tags output in a unified format; "asr" indicates speech recognition results; "ocr" indicates text recognition results. |'."\n" .'| result | List of product-level results, currently containing only content analysis products |'."\n" .'| content | Struct of product-level results |'."\n" .'| data | List of specific algorithm results |'."\n" ."\n" .'The following sections describe fields based on the value of `name`:'."\n" ."\n" .'name = \'tag\' // Fused tag results'."\n" ."\n" .'| Output Parameter | Description |'."\n" .'| --- | --- |'."\n" .'| labelLevel1 | Level 1 category, such as video categorization, program, face, identity, character role, Region, scenario, action event, organization, keyword, etc. |'."\n" .'| labelLevel2 | Level 2 category. For faces, level 2 categories include: political figure, sensitive person, celebrity, unknown face, and Custom. Multiple types are separated by commas (\',\'). |'."\n" .'| label | Fine-grained tag |'."\n" .'| knowledgeInfo | Knowledge graph information (as a dictionary) |'."\n" .'| appearanceProbability | Appearance probability of the tag, representing the time proportion of the tag in the video |'."\n" .'| isWhite | Indicates whether the tag hits the User-defined whitelist |'."\n" .'| detailInfo | This struct stores detailed information about the tag, including time intervals, score, area, Source, etc. |'."\n" .'| score | Confidence level of the tag. For some tags, confidence level may not exist; in such cases, it is uniformly set to -1. For example, the score of an extracted unknown face is -1. |'."\n" .'| bboxes | Position information of the tag area (deprecated and not recommended for use). Values are, in order: X coordinate and Y coordinate of the top-left vertex, width, and height of the area. This field will be gradually phased out, with information migrated to `trackData`. |'."\n" .'| trackData | Algorithm results recorded at regular intervals over the time segment, including fields such as bbox, score, attributes, landmark, and timestamp |'."\n" .'| score | Score under `trackData`, representing the algorithm confidence level at the current moment. For facial recognition algorithms, this is the face detection score. |'."\n" .'| bbox | Bbox under `trackData`, indicating tag area position information in the format [x1, y1, x2, y2], representing the top-left and bottom-right vertices. |'."\n" .'| landmark | Landmark under `trackData`, indicating key pixel information of the tag area |'."\n" .'| attributes | Attributes under `trackData`, containing fields `property`, `value`, and `score`, which respectively represent the attribute class, Attribute Value, and attribute score at the current frame, such as facial expression information |'."\n" .'| timestamp | Timestamp under `trackData`, marking the current moment |'."\n" .'| source | Tag Source: \'vision\' for visual Source, \'audio\' for audio Source, \'text\' for text Source |'."\n" .'| subSource | Algorithm model-level Source; Users do not need to concern themselves with this field |'."\n" .'| metaData | Contains non-unified information about the tag. Different tag types may vary. You can determine whether a tag contains a specific field by checking if the field is empty. Specific subfields are as follows: |'."\n" .'| metaData.sampleUrl | Representative image of the tag. For facial recognition, the predicted person matches this image, which also serves as our standard for defining the tag |'."\n" .'| metaData.feature | Feature of the representative image of the tag, such as the optimal face feature in facial recognition, corresponding to the image feature of `sampleUrl` |'."\n" .'| metaData.group | Group of the tag, such as the face library information in facial recognition |'."\n" .'| metaData.itemUrl | Standard image describing the tag |'."\n" .'| metaData.finegrainName | Fine-grained tag describing the segment |'."\n" .'| mediaData.entityInfo | Customer-defined entity information (for self-registered algorithms) |'."\n" ."\n" .'name = \'sbd\' // Segment detection results'."\n" ."\n" .'| Output Parameter | Description |'."\n" .'| --- | --- |'."\n" .'| index | Segment ID |'."\n" .'| timestamp | Segment End Time |'."\n" .'| score | Segment confidence level |'."\n" ."\n" .'name = \'asr\' // Speech recognition results'."\n" ."\n" .'| Output Parameter | Description |'."\n" .'| --- | --- |'."\n" .'| startTime | Start Time of the time segment |'."\n" .'| endTime | End Time of the time segment |'."\n" .'| text | ASR text |'."\n" ."\n" .'name = \'ocr\' // OCR text recognition results'."\n" ."\n" .'| Output Parameter | Description |'."\n" .'| --- | --- |'."\n" .'| startTime | Start Time of the time segment |'."\n" .'| endTime | End Time of the time segment |'."\n" .'| detailInfo | Specific OCR recognition results, a List representing OCR results from different areas |'."\n" .'| score | OCR recognition confidence level |'."\n" .'| char_probs | Confidence levels predicted for each individual character by OCR |'."\n" .'| text | OCR text |'."\n" .'| bbox | Tag area position information, in the format [x1, y1, x2, y2], representing the top-left and bottom-right vertices. |'."\n" .'| timestamp | UNIX timestamp of the frame in the video |'."\n" ."\n" .'name = \'video_ocr\' // VideoOCR text recognition results'."\n" ."\n" .'| Output Parameter | Description |'."\n" .'| --- | --- |'."\n" .'| startTime | Start Time of the time segment |'."\n" .'| endTime | End Time of the time segment |'."\n" .'| detailInfo | Specific VideoOCR recognition results, a List representing VideoOCR results from different clip areas |'."\n" .'| score | VideoOCR recognition confidence level |'."\n" .'| text | VideoOCR text |'."\n" .'| bbox | Tag area position information, in the format [x1, y1, x2, y2], representing the top-left and bottom-right vertices. |'."\n" .'| text_type | Text type (0 – Normal caption, 1 – scroll caption, 2 – fixed-length identifying caption lasting more than 3 seconds) |'."\n" ."\n" .'```JSON', 'changeSet' => [ ['createdAt' => '2024-10-16T12:29:20.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-06T12:14:09.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmarttagJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QuerySmarttagJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QuerySmarttagTemplateList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the template. You can obtain the template ID from the response of the [AddSmarttagTemplate](~~187759~~) operation. If you set this parameter to a specific value, the information about the corresponding template is returned. If you do not specify this parameter, the operation returns the information about all the templates that are created by the current RAM user.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '05de22f255284c7a8d2aab535dde****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26', 'title' => ''], 'Templates' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Template' => [ 'description' => 'The templates.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The detailed information about the template.'."\n", 'type' => 'object', 'properties' => [ 'AnalyseTypes' => ['description' => 'The analysis types that are used in the template. One or more values are returned. Valid values:'."\n" ."\n" .'* **ocr**: text recognition'."\n" .'* **asr**: speech recognition'."\n" .'* **classification**: video classification'."\n" .'* **shows**: program recognition'."\n" .'* **face**: facial recognition'."\n" .'* **role**: figure recognition'."\n" .'* **object**: object recognition'."\n" .'* **tvstation**: logo recognition'."\n" .'* **action**: action recognition'."\n" .'* **emotion**: facial expression recognition'."\n" .'* **landmark**: landmark recognition'."\n" .'* **scene**: scene recognition'."\n" .'* **movieip**: movie intellectual property recognition'."\n" .'* **subtitle**: subtitle extraction'."\n", 'type' => 'string', 'example' => 'ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene', 'title' => ''], 'Industry' => ['description' => 'The industry to which the template applies. Default value: **common**. Valid values:'."\n" ."\n" .'* **microVideo**: short video industry'."\n" .'* **common**: general industries'."\n", 'type' => 'string', 'example' => 'common', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the template is the default template. Valid values:'."\n" ."\n" .'* **true**: The template is the default template.'."\n" .'* **false**: The template is not the default template.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'TemplateName' => ['description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'example-****', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the template.'."\n", 'type' => 'string', 'example' => '05de22f255284c7a8d2aab535dde****', 'title' => ''], 'FaceCategoryIds' => ['description' => 'The IDs of the system facial image libraries that are used in the template. One or more values are returned. Valid values:'."\n" ."\n" .'* celebrity: the facial image library of celebrities'."\n" .'* politician: the facial image library of politicians'."\n" .'* sensitive: the facial image library of sensitive figures'."\n", 'type' => 'string', 'example' => 'politician,sensitive,celebrity', 'title' => ''], 'FaceCustomParamsConfig' => ['description' => 'The configurations of face-related algorithms. The value of this parameter is a JSON string and consists of the thresholds set for face detection and facial recognition. Valid values:'."\n" ."\n" .'* **faceDetThreshold**: The default threshold for face detection is 0.999. The threshold takes effect only for the faces that are strange to the system.'."\n" .'* **faceRegThreshold**: The default threshold for facial recognition is 0.9.'."\n", 'type' => 'string', 'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }', 'title' => ''], 'ObjectGroupIds' => ['description' => 'The IDs of the object libraries that are used in the template.'."\n", 'type' => 'string', 'example' => 'general,item,weapon,animal', 'title' => ''], 'LandmarkGroupIds' => ['description' => 'The IDs of the landmark libraries that are used in the template.'."\n", 'type' => 'string', 'example' => 'common', 'title' => ''], 'Scene' => ['description' => 'The scenario in which the template is used. Valid values:'."\n" ."\n" .'* **search**: search scenarios'."\n" .'* **recommend**: recommendation scenarios'."\n", 'type' => 'string', 'example' => 'search', 'title' => ''], 'LabelType' => ['description' => 'The type of the tagging. Default value: **auto**. Valid values:'."\n" ."\n" .'* **auto**: machine tagging'."\n" .'* **hmi**: tagging by human and machine'."\n", 'type' => 'string', 'example' => 'hmi', 'title' => ''], 'LabelVersion' => ['description' => 'The version of the smart tagging feature. Default value: 1.0. Valid values:'."\n" ."\n" .'* 1.0: Smart tagging V1.0'."\n" .'* 2.0: Smart tagging V2.0 (CPV tagging)'."\n" .'* 2.0-custom: Smart tagging V2.0-custom (CPV tagging by using custom models)'."\n", 'type' => 'string', 'example' => '1.0', 'title' => ''], 'KnowledgeConfig' => ['description' => 'The fields to be identified as knowledge graph information when tags are returned in Smart tagging V2.0 and Smart tagging V2.0-custom modes. For more information, see [Knowledge graph fields in smart tagging jobs](~~356383~~). If this parameter is not specified or the specified value is NULL or invalid because it is not a JSON string, the following fields are returned:'."\n" ."\n" .'* movie-related fields:'."\n" ."\n" .' * name: the name of the intellectual property that is featured in the movie'."\n" .' * alias: the alias of the intellectual property that is featured in the movie'."\n" .' * chnl: the category of the movie'."\n" .' * genre: the genre of the movie'."\n" .' * country: the country or region in which the movie was produced'."\n" .' * language: the language of the movie'."\n" .' * releaseYear: the year when the movie was released'."\n" ."\n" .'* music-related fields:'."\n" ."\n" .' * songName: the name of the song'."\n" .' * artistName: the name of the singer'."\n" .' * artistArea: the region to which the singer belongs, such as China, Japan, Korea, Europe, and America, or others.'."\n" .' * albumName: the name of the album'."\n" ."\n" .'* person-related fields:'."\n" ."\n" .' * name: the name of the person'."\n" .' * gender: the gender of the person'."\n" .' * citizenship: the nationality of the person'."\n" .' * occupation: the occupation of the person'."\n" .' * classification: the type into which the person is classified'."\n" .' * nationality: the ethnic group of the person'."\n" .' * birthPlace: the place where the person was born'."\n" .' * birthDate: the date when the person was born'."\n" ."\n" .'* landmark-related fields:'."\n" ."\n" .' * name: the display name of the landmark'."\n" .' * nameEn: the English name of the landmark'."\n" .' * Description: the description of the parameter'."\n" .' * address: the address of the landmark'."\n" ."\n" .'* item-related fields:'."\n" ."\n" .' * brandName: the brand of the item'."\n" .' * finegrainName: the fine-grained description of the item'."\n", 'type' => 'string', 'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }', 'title' => ''], 'KeywordConfig' => ['description' => 'The configuration of keyword tags. The type field specifies the category of a keyword tag. You can specify one or more values and separate the values with commas (,). Valid values:'."\n" ."\n" .'* name'."\n" .'* location'."\n" .'* organization'."\n" .'* other'."\n" ."\n" .'> Keyword tags of all the categories are returned in one of the following scenarios: The KeywordConfig parameter is not specified or the Keyword field is invalid because it is not a JSON string, or the KeywordConfig parameter does not contain the type field or the type field is invalid.'."\n", 'type' => 'string', 'example' => '{ "type": "name,location,organization,other" }', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], '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' => 'QuerySmarttagTemplateList', 'summary' => 'Queries the analysis template of a smart tagging job.', 'description' => 'If you call this operation to query the information about a smart tagging template, you must specify the template ID. Otherwise, the operation returns the information about all the templates that are created by the current RAM user.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### SDK sample code'."\n" ."\n" .'* [Java SDK](~~188025~~)'."\n" .'* [Python SDK](~~188026~~)'."\n" .'* [Php SDK](~~188027~~)'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QuerySmarttagTemplateList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmarttagTemplateList'], ], ], ], 'QuerySnapshotJobList' => [ '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' => 'The list of snapshot job IDs.'."\n" ."\n" .'- You can query up to **10** jobs at a time. Separate multiple IDs with commas (,).'."\n" ."\n" .'- You can obtain the job IDs from the [MPS console](https://mps.console.aliyun.com/overview) by choosing **Task Management** > **Snapshots**. You can also obtain them from the response parameters of the [SubmitSnapshotJob](~~602857~~) operation.', 'type' => 'string', 'required' => false, 'example' => '72dfa5e679ab4be9a3ed9974c736****', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The token for the next page. It is a 32-bit universally unique identifier (UUID).'."\n" ."\n" .'- If the query result is truncated, the NextPageToken parameter is returned. The value of this parameter is updated for each query. Use this token in the next query to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'cc6cbef8e8d5481ca536f5d2a466****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return on each page of a paged query.'."\n" ."\n" .'- Valid values: **\\[1, 300]**.'."\n" ."\n" .'- Default value: **30**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '30', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The state of the snapshot jobs to query.'."\n" ."\n" .'- **Submitted**: The job is submitted.'."\n" ."\n" .'- **Snapshoting**: The job is in progress.'."\n" ."\n" .'- **Success**: The job is successful.'."\n" ."\n" .'- **Fail**: The job failed.', 'type' => 'string', 'required' => false, 'default' => 'All', 'example' => 'Snapshoting', 'title' => ''], ], [ 'name' => 'StartOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The beginning of the job creation time range.'."\n" ."\n" .'- The date format must follow the ISO 8601 standard and use Coordinated Universal Time (UTC).'."\n" ."\n" .'- The format is YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2014-01-10T12:00:00Z', 'title' => ''], ], [ 'name' => 'EndOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The end of the job creation time range.'."\n" ."\n" .'- The date format must follow the ISO 8601 standard and use Coordinated Universal Time (UTC).'."\n" ."\n" .'- The format is YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2014-01-12T12:00:00Z', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue. For more information, see [Terms](~~29197~~).'."\n" ."\n" .'- You can view and create MPS queues in the [MPS console](https://mps.console.aliyun.com/overview) by choosing **Global Settings** > **Pipelines**.'."\n" ."\n" .'- If you want to receive asynchronous notification messages, attach an MNS queue or topic to the MPS queue. For more information, see [Receive message notifications](https://help.aliyun.com/document_detail/42618.html)[Receive message notifications](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications).', 'type' => 'string', 'required' => false, 'example' => 'b11c171cced04565b1f38f1ecc39****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'SnapshotJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SnapshotJob' => [ 'description' => 'The list of snapshot jobs.', 'type' => 'array', 'items' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time the job was created.', 'type' => 'string', 'example' => '2021-06-30T12:34:29Z', 'title' => ''], 'SnapshotConfig' => [ 'description' => 'The snapshot configuration.', 'type' => 'object', 'properties' => [ 'Time' => ['description' => 'The start time for the snapshot. Unit: milliseconds.', 'type' => 'string', 'example' => '4', 'title' => ''], 'TileOut' => [ 'description' => 'The mosaic configuration.', 'type' => 'object', 'properties' => [ 'Padding' => ['description' => 'The spacing between images.'."\n" ."\n" .'- Default: **0**.'."\n" ."\n" .'- Unit: px.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Color' => ['description' => 'The background color.'."\n" ."\n" .'- Default: **black**.'."\n" ."\n" .'- Valid values: **color keyword**, **random**.'."\n" ."\n" .'> Color keywords support three formats. For example, black can be specified as Black, black, or #000000.', 'type' => 'string', 'example' => 'black', 'title' => ''], 'CellSelStep' => ['description' => 'The step size for selecting a single image.', 'type' => 'string', 'example' => '3', 'title' => ''], 'CellHeight' => ['description' => 'The height of a single image. The default is the height of the snapshot output.', 'type' => 'string', 'example' => '8', 'title' => ''], 'CellWidth' => ['description' => 'The width of a single image. The default is the width of the snapshot output.', 'type' => 'string', 'example' => '8', 'title' => ''], 'Margin' => ['description' => 'The width of the outer border.'."\n" ."\n" .'- Default: **0**.'."\n" ."\n" .'- Unit: px.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Columns' => ['description' => 'The number of columns in the mosaic. Default: **10**.', 'type' => 'string', 'example' => '10', 'title' => ''], 'IsKeepCellPic' => ['description' => 'Indicates whether to keep the individual images. Default: **true**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Lines' => ['description' => 'The number of rows in the mosaic. Default: **10**.', 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Interval' => ['description' => 'The snapshot interval.'."\n" ."\n" .'- If specified, it indicates a sequence of snapshots, and the value must be greater than 0.'."\n" ."\n" .'- Unit: seconds.'."\n" ."\n" .'- Default value: **10**.', 'type' => 'string', 'example' => '10', 'title' => ''], 'FrameType' => ['description' => 'The snapshot type.'."\n" ."\n" .'- **normal**: Normal frame.'."\n" ."\n" .'- **intra**: I-frame.'."\n" ."\n" .'- Default value: **intra**.', 'type' => 'string', 'example' => 'intra', 'title' => ''], 'Width' => ['description' => 'The width of the output snapshot image.', 'type' => 'string', 'example' => '8', 'title' => ''], 'Height' => ['description' => 'The height of the output snapshot image.', 'type' => 'string', 'example' => '8', 'title' => ''], 'OutputFile' => [ 'description' => 'The OSS configuration for the snapshot output.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.', 'type' => 'string', 'example' => 'acs:ram::1:role/testrole', 'title' => ''], 'Object' => ['description' => 'The output file (OSS Object) for the snapshot.', 'type' => 'string', 'example' => 'example.png', 'title' => ''], 'Location' => ['description' => 'The data center where the output OSS bucket is located (OSS Location).', 'type' => 'string', 'example' => 'example-location', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket where the output file is stored.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Num' => ['description' => 'The number of snapshots. If specified, it indicates a sequence of snapshots.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TileOutputFile' => [ 'description' => 'The OSS configuration for the large image output of the mosaic job.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.', 'type' => 'string', 'example' => 'acs:ram::1:role/testrole', 'title' => ''], 'Object' => ['description' => 'The output file (OSS Object).', 'type' => 'string', 'example' => 'example.png', 'title' => ''], 'Location' => ['description' => 'The data center where the output OSS bucket is located (OSS Location).', 'type' => 'string', 'example' => 'example-location', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket where the output file is stored.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TimeArray' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TimePointList' => [ 'type' => 'array', 'items' => ['description' => 'The array of specified time points. Unit: milliseconds. This is a floating-point number with two decimal places. The time points can be repeated and submitted in any order. MPS sorts them. A maximum of 100 time points are supported. If you specify this parameter, do not specify Num, Time, or Interval. Otherwise, an InvalidParameter.Ambiguity error is returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '[10050, 50000, 110000, 1000500, 1100500]', 'title' => ''], 'description' => 'The array of specified time points.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The state of the snapshot job.'."\n" ."\n" .'- **Submitted**: The job is submitted.'."\n" ."\n" .'- **Snapshoting**: The job is in progress.'."\n" ."\n" .'- **Success**: The job is successful.'."\n" ."\n" .'- **Fail**: The job failed.', 'type' => 'string', 'example' => 'Snapshoting', 'title' => ''], 'Message' => ['description' => 'The error message returned when the analysis fails. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'The resource operated InputFile is bad', 'title' => ''], 'MNSMessageResult' => [ 'description' => 'The result of the MNS notification sent to the user when the job is complete.', 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the message. This parameter is not returned if the job fails.', 'type' => 'string', 'example' => '799454621135656C7F815F198A76****', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'The resource operated InputFile is bad', 'title' => ''], 'ErrorCode' => ['description' => 'The error code. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Input' => [ 'description' => 'The job input.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.', 'type' => 'string', 'example' => 'acs:ram::1:role/testrole', 'title' => ''], 'Object' => ['description' => 'The input file (OSS Object).', 'type' => 'string', 'example' => 'example.flv', 'title' => ''], 'Location' => ['description' => 'The data center where the input OSS bucket is located (OSS Location).', 'type' => 'string', 'example' => 'example-location', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket where the input file is stored.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Count' => ['description' => 'The number of captured images.', 'type' => 'string', 'example' => '1', 'title' => ''], 'TileCount' => ['description' => 'The number of images in the mosaic.', 'type' => 'string', 'example' => '7', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'Code' => ['description' => 'The error code returned when the analysis fails. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'b11c171cced04565b1f38f1ecc39****', 'title' => ''], 'Id' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'example' => 'cc6cbef8e8d5481ca536f5d2a466****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '34BCAB31-2833-43A7-9FBD-B34302AB23EQ', 'title' => ''], 'NonExistSnapshotJobIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The list of non-existent snapshot job IDs.', 'type' => 'array', 'items' => ['description' => 'The details of a non-existent snapshot job ID. This parameter is not returned if no data exists.', 'type' => 'string', 'example' => 'c6d973c33d1c4b21bc39907d3b29****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The token for the next page. It is a 32-bit UUID. This parameter is returned when the query result is truncated. The value of this parameter is updated for each query.', 'type' => 'string', 'example' => 'b11c171cced04565b1f38f1ecc39****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Query snapshot job results', 'summary' => 'Queries snapshot jobs.', 'description' => '- You can query snapshot jobs by specifying one or more snapshot job IDs (SnapshotJobIds). You can also perform a paged query and filter jobs by status, creation time, or MPS queue without specifying job IDs.'."\n" ."\n" .'- This operation queries a maximum of 10 snapshot jobs per call.'."\n" ."\n" .'- The return values of this operation are sorted by CreationTime in descending order by default.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'This operation is limited to 100 queries per second (QPS) per user. If you exceed this limit, API calls are throttled, which may affect your business. To prevent throttling, you can call this operation at a reasonable rate. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-04-24T06:31:18.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-04-10T03:38:58.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-05T03:18:26.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySnapshotJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'mts:QuerySnapshotJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'QueryTemplateList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'TemplateIds', 'in' => 'query', 'schema' => ['description' => 'The response parameters.'."\n", 'type' => 'string', 'required' => true, 'example' => '16f01ad6175e4230ac42bb5182cd****,88c6ca184c0e424d5w5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'NonExistTids' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The IDs of the templates that do not exist. This parameter is not returned if all specified transcoding templates are found.'."\n", 'type' => 'array', 'items' => ['description' => 'The details of transcoding templates.'."\n", 'type' => 'string', 'example' => '88c6ca184c0e424d5w5b665e2a12****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TemplateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Template' => [ 'description' => 'The transcoding templates.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Bufsize' => ['description' => 'The buffer size.'."\n" ."\n" .'* Unit: KB.'."\n" .'* Default value: **6000**.'."\n", 'type' => 'string', 'example' => '6000', 'title' => ''], 'LongShortMode' => ['description' => 'Indicates whether the auto-rotate screen feature is enabled.'."\n" ."\n" .'* If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode. Valid values:'."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Degrain' => ['description' => 'The level of video quality control.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'BitrateBnd' => [ 'description' => 'The average bitrate range of the video.'."\n", 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], 'Min' => ['description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Pad' => ['description' => 'The black bars that are added to the video. Format: width:height:left:top. Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Codec' => ['description' => 'The codec. Default value: **H.264**.'."\n", 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The height of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: **the height of the input video**.'."\n", 'type' => 'string', 'example' => '800', 'title' => ''], 'Qscale' => ['description' => 'The strength of the independent denoising algorithm.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Crop' => ['description' => 'The method of video cropping. Valid values:'."\n" ."\n" .'* **border**: automatically detects and removes black bars.'."\n" .'* **Value in the width:height:left:top format**: crops the video based on custom settings. Format: width:height:left:top. Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => 'border', 'title' => ''], 'Bitrate' => ['description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Maxrate' => ['description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'MaxFps' => ['description' => 'The maximum frame rate.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], 'Profile' => ['description' => 'The encoding profile. Valid values:'."\n" ."\n" .'* **baseline**: applicable to mobile devices.'."\n" .'* **main**: applicable to standard-definition devices.'."\n" .'* **high**: applicable to high-definition devices.'."\n" .'* Default value: **high**.'."\n", 'type' => 'string', 'example' => 'high', 'title' => ''], 'Crf' => ['description' => 'The constant rate factor.'."\n" ."\n" .'* Default value when the encoding format is H.264: **23**. Default value when the encoding format is H.265: **26**.'."\n" .'* If this parameter is set, the value of Bitrate becomes invalid.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Remove' => ['description' => 'Indicates whether the video stream is deleted. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Gop' => ['description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Width' => ['description' => 'The width of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: **the width of the input video**.'."\n", 'type' => 'string', 'example' => '256', 'title' => ''], 'Fps' => ['description' => 'The frame rate.'."\n" ."\n" .'* The value is 60 if the frame rate of the input file exceeds 60.'."\n" .'* Default value: **the frame rate of the input file**.'."\n", 'type' => 'string', 'example' => '25', 'title' => ''], 'Preset' => ['description' => 'The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: **medium**.'."\n", 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'The scan mode. Valid values:'."\n" ."\n" .'* **interlaced**'."\n" .'* **progressive**'."\n", 'type' => 'string', 'example' => 'interlaced', 'title' => ''], 'ResoPriority' => ['description' => 'The policy of resolution adjustment. Valid values: cropFirst, widthFirst, and heightFirst.'."\n", 'type' => 'string', 'example' => 'heightFirst', 'title' => ''], 'Hdr2sdr' => ['description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'NarrowBand' => [ 'description' => 'The Narrowband HD settings.'."\n", 'type' => 'object', 'properties' => [ 'Version' => ['description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", 'type' => 'string', 'example' => '1.0', 'title' => ''], 'Abrmax' => ['description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '3000', 'title' => ''], 'MaxAbrRatio' => ['description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'The general transcoding configurations.'."\n", 'type' => 'object', 'properties' => [ 'IsCheckAudioBitrate' => ['description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" ."\n" .'* **true**'."\n" ."\n" .'* **false**'."\n" ."\n" .'* Default value:'."\n" ."\n" .' * If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" .' * If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'TransMode' => ['description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" ."\n" .'* **onepass**'."\n" .'* **twopass**'."\n" .'* **CBR**'."\n", 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Indicates whether video bitrate check errors are allowed. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:'."\n" ."\n" .'* **true**: If the video bitrate check fails, the input file is not transcoded.'."\n" .'* **false**: The video bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'AdjDarMethod' => ['description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" ."\n" .'* rescale'."\n" .'* crop'."\n" .'* none'."\n", 'type' => 'string', 'example' => 'none', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Indicates whether audio bitrate check errors are allowed. This parameter has a greater priority than IsCheckAudioBitrate. Valid values:'."\n" ."\n" .'* **true**: If the audio bitrate check fails, the input file is not transcoded.'."\n" .'* **false**: The audio bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The status of the template. Valid values:'."\n" ."\n" .'* **Normal**'."\n" .'* **Deleted**'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'MuxConfig' => [ 'description' => 'The transmuxing configurations.'."\n", 'type' => 'object', 'properties' => [ 'Webp' => [ 'description' => 'The transmuxing configurations for WebP.'."\n", 'type' => 'object', 'properties' => [ 'Loop' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gif' => [ 'description' => 'The transmuxing configurations for GIF.'."\n", 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'The duration for which the final frame is paused.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'DitherMode' => ['description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", 'type' => 'string', 'example' => 'sierra', 'title' => ''], 'Loop' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'IsCustomPalette' => ['description' => 'Indicates whether a custom palette is used.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'The segment configurations.'."\n", 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The length of the segment. Unit: seconds.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'MPS-example', 'title' => ''], 'Audio' => [ 'description' => 'The audio codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The codec profile of the audio. Valid values when the value of Codec is aac:'."\n" ."\n" .'* **aac_low**'."\n" .'* **aac_he**'."\n" .'* **aac_he_v2**'."\n" .'* **aac_ld**'."\n" .'* **aac_eld**'."\n", 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Remove' => ['description' => 'Indicates whether the audio stream is deleted. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Codec' => ['description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" ."\n" .'* **aac**'."\n" .'* **mp3**'."\n" .'* **vorbis**'."\n" .'* **flac**'."\n", 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Samplerate' => ['description' => 'The sampling rate.'."\n" ."\n" .'* Unit: Hz'."\n" .'* Default value: **44100**.'."\n", 'type' => 'string', 'example' => '44100', 'title' => ''], 'Qscale' => ['description' => 'The strength of the independent denoising algorithm.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels. Default value: **2**.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Valid values: **\\[8,1000]**.'."\n" .'* Unit: Kbit/s.'."\n" .'* Default value: **128**.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'Volume' => [ 'description' => 'The volume control configurations.'."\n", 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'The method that is used to adjust the volume. Valid values:'."\n" ."\n" .'* **auto**'."\n" .'* **dynamic**'."\n" .'* **linear**'."\n" .'* Default value: dynamic.'."\n", 'type' => 'string', 'example' => 'auto', 'title' => ''], 'TruePeak' => ['description' => 'The peak volume.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is dynamic.'."\n" .'* Unit: dB.'."\n" .'* Valid values: \\[-9,0].'."\n" .'* Default value: -1.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], 'IntegratedLoudnessTarget' => ['description' => 'The output volume.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is dynamic.'."\n" .'* Unit: dB.'."\n" .'* Valid values: \\[-70,-5].'."\n" .'* Default value: -6.'."\n", 'type' => 'string', 'example' => '-6', 'title' => ''], 'LoudnessRangeTarget' => ['description' => 'The range of the volume relative to the output volume.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is dynamic.'."\n" .'* Unit: dB.'."\n" .'* Valid values: \\[1,20].'."\n" .'* Default value: 8.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Level' => ['description' => 'The increased volume relative to the volume of the input audio.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is linear.'."\n" .'* Unit: dB.'."\n" .'* Valid values: less than or equal to 20.'."\n" .'* Default value: -20.'."\n", 'type' => 'string', 'example' => '-20', 'title' => ''], 'PeakLevel' => ['title' => '', 'description' => 'The volume adjustment coefficient.'."\n" ."\n" .'This parameter takes effect only if the value of Method is adaptive.'."\n" ."\n" .'Valid values: \\[0,1].'."\n" ."\n" .'Default value: 0.9.'."\n", 'type' => 'string', 'example' => '0.9'], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'The transcoding template ID.'."\n", 'type' => 'string', 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], 'Container' => [ 'description' => 'The container format configurations.'."\n", 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The format of the container. Valid values: flv, mp4, ts, m3u8, gif, mp3, ogg, and flac.'."\n", 'type' => 'string', 'example' => 'flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CreationTime' => ['description' => 'The time when the template was created.'."\n", 'type' => 'string', 'example' => '2021-03-04T06:44:43Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BC860F04-778A-472F-AB39-E1BF329C1EA8', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], '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' => 'QueryTemplateList', 'summary' => 'You can call this operation to query up to 10 transcoding templates at a time.', 'description' => 'The IDs of the transcoding templates that you want to query. You can query up to 10 transcoding templates at a time. Separate multiple IDs of custom transcoding templates with commas (,).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-03-13T07:14:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-04T02:22:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-13T05:42:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTemplateList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryTemplateList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryTraceAbJob' => [ 'summary' => 'Invoke this API to query video tracing watermark AB stream jobs. ', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222523', 'abilityTreeNodes' => ['FEATUREmtsGVUB1B'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Job ID. You can obtain it from the response parameters of the submitted video tracing watermark AB stream job. ', 'type' => 'string', 'required' => false, 'example' => '31fa3c9ca8134fb4b0b0f7878301****', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'Media ID. ', 'type' => 'string', 'required' => false, 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', 'title' => ''], ], ], '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' => 'Return message ', 'type' => 'string', 'example' => 'ok'], 'Data' => [ 'description' => 'Returned data. ', 'type' => 'array', 'items' => [ 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'Callback' => ['title' => '', 'description' => 'Callback URL ', 'type' => 'string', 'example' => 'http://callbacktest.com/callback'], 'GmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322'], 'GmtModified' => ['title' => '', 'description' => 'Updated At ', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357325'], 'Input' => ['title' => '', 'description' => 'Watermarked video input ', 'type' => 'string', 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"test.mp4"}'], 'JobId' => ['title' => '', 'description' => 'Job ID ', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****'], 'Level' => ['title' => '', 'description' => 'Watermark strength ', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'MediaId' => ['title' => '', 'description' => 'Media ID ', 'type' => 'string', 'example' => '437bd2b516ffda105d07b12a9a82****'], 'Output' => ['title' => '', 'description' => 'Watermarked video output ', 'type' => 'string', 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}'], 'Status' => ['title' => '', 'description' => 'Status ', 'type' => 'string', 'example' => 'success'], 'UserData' => ['title' => '', 'description' => 'User Data', 'type' => 'string', 'example' => '123'], 'UserId' => ['title' => '', 'description' => 'User ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13466****'], 'Result' => ['title' => '', 'description' => 'Task Result ', 'type' => 'string', 'example' => '{"Code":"success","Message":"ok"}'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'StatusCode' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], ], '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' => 'Query video tracing watermark AB stream job ', 'description' => 'Currently, digital watermarking-related APIs are only supported in the China (Shanghai) and China (Beijing) regions. ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceAbJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryTraceAbJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryTraceExtractJob' => [ 'summary' => 'Invoke this API to query the tracing watermark fetch job information.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222527', 'abilityTreeNodes' => ['FEATUREmtsGVUB1B'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Job ID. You can obtain it from the response parameters of the API call that submitted the tracing watermark fetch job.', 'type' => 'string', 'required' => true, 'example' => '31fa3c9ca8134fb4b0b0f7878301****', 'title' => ''], ], ], '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' => 'Return message', 'type' => 'string', 'example' => 'ok'], 'Data' => [ 'title' => '', 'description' => 'Returned data', 'type' => 'object', 'properties' => [ 'Trace' => ['title' => '', 'description' => 'Tracing watermark information', 'type' => 'string', 'example' => 'example water mark '."\n"], ], 'example' => '', ], 'StatusCode' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], ], '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' => 'Query tracing watermark fetch job', 'description' => 'Currently, digital watermarking-related APIs are only supported in the China (Shanghai) and China (Beijing) regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceExtractJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryTraceExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryTraceM3u8Job' => [ 'summary' => 'Invoke this API to query the video tracing watermark m3u8 job. ', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222524', 'abilityTreeNodes' => ['FEATUREmtsGVUB1B'], ], 'parameters' => [ [ 'name' => 'CreateTimeStart', 'in' => 'query', 'schema' => ['description' => 'Start of creation time, in UNIX timestamp format. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1527441300'."\n", 'title' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', 'schema' => ['description' => 'End of creation time, in UNIX timestamp format. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1527441303', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Job ID. You can obtain it from the response parameters after submitting a video tracing watermark m3u8 job. ', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page index for pagination. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Quantity per page. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], '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' => 'Return message ', 'type' => 'string', 'example' => 'ok'], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322'], 'GmtModified' => ['title' => '', 'description' => 'Updated At ', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357327'], 'MediaId' => ['description' => 'Media ID ', 'type' => 'string', 'example' => '437bd2b516ffda105d07b12a9a82****', 'title' => ''], 'JobId' => ['title' => '', 'description' => 'Job ID ', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****'."\n"], 'Trace' => ['title' => '', 'description' => 'Watermark information ', 'type' => 'string', 'example' => 'T-Head Semiconductor (Shanghai)'], 'Output' => ['title' => '', 'description' => 'Watermarked video output ', 'type' => 'string', 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}'], 'Status' => ['title' => '', 'description' => 'Status ', 'type' => 'string', 'example' => 'success'], 'UserData' => ['title' => '', 'description' => 'User Data ', 'type' => 'string', 'example' => '123'], 'UserId' => ['title' => '', 'description' => 'User ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13466****'], ], 'description' => 'Returned data ', 'title' => '', 'example' => '', ], 'description' => 'Returned data ', 'title' => '', 'example' => '', ], 'StatusCode' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], ], '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\\": \\"T-Head Semiconductor (Shanghai)\\",\\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' => 'Query video tracing watermark m3u8 job ', 'description' => '- Currently, digital watermarking-related APIs are only supported in the China (Shanghai) and China (Beijing) regions. '."\n" ."\n" .'- The signed authentication for the absolute path of the m3u8 file generated by the video tracing watermark m3u8 job is valid for 24 hours (starting from the time processing completes). Please query it as soon as possible. After the signed authentication expires, the watermark information for that job will no longer be accessible. If you need the information after expiration, you must resubmit the video tracing watermark m3u8 job. '."\n" ."\n" .'- The maximum time range for querying historical data (job information) is 6 months. ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceM3u8Job'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryTraceM3u8Job', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'QueryWaterMarkTemplateList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'WaterMarkTemplateIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the watermark templates that you want to query. To obtain the IDs of the watermark templates, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Watermark Templates** in the left-side navigation pane. You can query up to 10 watermark templates at a time. Separate multiple IDs of watermark templates with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '3780bd69b2b74540bc7b1096f564****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '17079AF5-6276-51A9-B755-D26594C93F3C', 'title' => ''], 'NonExistWids' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The IDs of the templates that do not exist.'."\n", 'type' => 'array', 'items' => ['description' => 'The IDs of the watermark templates that do not exist. This parameter is not returned if all specified watermark templates are found.'."\n", 'type' => 'string', 'example' => '72dfa5e679ab4be9a3ed9974c736****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'WaterMarkTemplateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'WaterMarkTemplate' => [ 'description' => 'The details of the watermark templates.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the watermark. Valid values:'."\n" ."\n" .'* Image: an image watermark.'."\n" .'* Text: a text watermark.'."\n" ."\n" .'> Only watermarks of the **Image** type are supported.'."\n", 'type' => 'string', 'example' => 'Image', 'title' => ''], 'RatioRefer' => [ 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" ."\n" .'* **Width**: the width edge.'."\n" .'* **Height**: the height edge.'."\n" .'* **Long**: the long edge.'."\n" .'* **Short**: the short edge.'."\n", 'type' => 'object', 'properties' => [ 'Dx' => ['description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.51', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.36', 'title' => ''], 'Height' => ['description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.33', 'title' => ''], 'Dy' => ['description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ReferPos' => ['description' => 'The position of the watermark. Valid values:'."\n" ."\n" .'* **TopRight**: the upper-right corner.'."\n" .'* **TopLeft**: the upper-left corner.'."\n" .'* **BottomRight**: the lower-right corner.'."\n" .'* **BottomLeft**: the lower-left corner.'."\n", 'type' => 'string', 'example' => 'TopRight', 'title' => ''], 'State' => ['description' => 'The status of the watermark template. Valid values: Valid values:'."\n" ."\n" .'* **Normal**: The watermark template is normal.'."\n" .'* **Deleted**: The watermark template is deleted.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Dx' => ['description' => 'The horizontal offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Height' => ['description' => 'The height of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Timeline' => [ 'description' => 'The timeline of the watermark.'."\n", 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The beginning of the time range during which the watermark is displayed.'."\n" ."\n" .'* Unit: seconds.'."\n" .'* Default value: **0**.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the watermark template.'."\n", 'type' => 'string', 'example' => 'example-watermark', 'title' => ''], 'Dy' => ['description' => 'The vertical offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], 'Id' => ['description' => 'The ID of the watermark template.'."\n", 'type' => 'string', 'example' => '3780bd69b2b74540bc7b1096f564****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [], 'title' => 'QueryWaterMarkTemplateList', 'summary' => 'Queries watermark templates.', 'description' => 'You can call this operation to query up to 10 watermark templates at a time.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryWaterMarkTemplateList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryWaterMarkTemplateList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'RegisterCustomFace' => [ 'summary' => 'Register a custom face.', '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' => 'The unique ID for a custom figure library. The caller generates this ID and must ensure it is unique. Save this ID to use when you call other APIs.'."\n" .'>This ID cannot be the same as a system figure library ID. If the IDs match, the system figure library is used by default. The ID can be up to 120 characters long, is case-insensitive, and supports characters from any language.>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CategoryId001-****', 'title' => ''], ], [ 'name' => 'PersonId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom person. This ID uniquely identifies a custom person. You generate this ID and ensure its uniqueness. Store it securely for use with other API calls.'."\n" ."\n" .'> Supports up to 120 characters, supports Chinese and English characters, is case-insensitive, and returns FaceId as a String.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PersonId001-****', 'title' => ''], ], [ 'name' => 'ImageUrl', 'in' => 'query', 'schema' => ['description' => 'The public URL of the image containing the face to register. The image must contain exactly one frontal face.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'http://example-****.jpeg', 'title' => ''], ], [ 'name' => 'PersonName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'FaceId' => ['description' => 'The ID of the registered face.', 'type' => 'string', 'example' => 'c6cc71cb44a9491093818faf9d60****', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '91AEA76D-25B5-50DF-9126-AA6BB10FDAF4', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FaceId\\": \\"c6cc71cb44a9491093818faf9d60****\\",\\n \\"RequestId\\": \\"91AEA76D-25B5-50DF-9126-AA6BB10FDAF4\\"\\n}","type":"json"}]', 'title' => 'RegisterCustomFace', 'description' => '- You can register one custom face per API call.'."\n" ."\n" .'- You can register up to 10 images for a single custom face.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The per-user QPS limit for this operation is 100 calls per second. Exceeding this limit triggers rate limiting, which may affect your business. Call this API appropriately. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### SDK sample code'."\n" ."\n" .'* [Java SDK](~~188025~~)'."\n" .'* [Python SDK](~~188026~~)'."\n" .'* [Php SDK](~~188027~~)'."\n", 'changeSet' => [ ['createdAt' => '2024-10-16T12:29:20.000Z', 'description' => 'Error codes changed, Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterCustomFace'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:RegisterCustomFace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'RegisterCustomView' => [ 'summary' => 'Register a custom entity image.', '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' => 'The custom type. Valid values:'."\n" ."\n" .'- landmark: custom landmark.'."\n" ."\n" .'- object: custom object.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'CustomGroupId', 'in' => 'query', 'schema' => ['description' => 'The custom group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'CustomEntityId', 'in' => 'query', 'schema' => ['description' => 'The custom entity ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''], ], [ 'name' => 'ImageUrl', 'in' => 'query', 'schema' => ['description' => 'The image URL.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'http://127.66.**.**/image.jpeg', 'title' => ''], ], [ 'name' => 'LabelPrompt', 'in' => 'query', 'schema' => ['description' => 'The custom label text prompt.', 'type' => 'string', 'example' => 'A girl live streaming on phone', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'CustomViewId' => ['description' => 'The view image ID under the custom entity.', 'type' => 'string', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID, which is unique.', 'type' => 'string', 'example' => '580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CustomViewId\\": \\"1\\",\\n \\"RequestId\\": \\"580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5\\"\\n}","type":"json"}]', 'title' => 'Register a custom entity image', 'description' => 'This API currently supports the following regions: China (Beijing), China (Shanghai), and China (Hangzhou). Other regions are not supported at this time.'."\n" ."\n" .'## Queries per second (QPS) limit'."\n" .'The queries per second (QPS) limit for this API is 50 requests per second per user. If you exceed this limit, your API calls will be subject to rate limiting, which may impact your business. Invoke this API appropriately. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2025-03-17T08:47:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-06T14:44:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterCustomView'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:RegisterCustomView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SearchMediaWorkflow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.'."\n" ."\n" .'* A maximum of **100** entries can be returned on each page.'."\n" .'* Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'StateList', 'in' => 'query', 'schema' => ['description' => 'The status of the media workflows that you want to query. You can specify multiple states. Separate multiple states with commas (,). Default value: **Inactive,Active,Deleted**. Valid values:'."\n" ."\n" .'* **Inactive**: Deactivated media workflows are queried.'."\n" .'* **Active**: Activated media workflows are queried.'."\n" .'* **Deleted**: Deleted media workflows are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Inactive,Active,Deleted', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'MediaWorkflowList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaWorkflow' => [ 'description' => 'The details of the media workflows.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '2016-04-01T05:38:41Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow.'."\n", 'type' => 'string', 'example' => '88c6ca184c0e4578645b665e2a12****', 'title' => ''], 'State' => ['description' => 'The status of the media workflow. Valid values:'."\n" ."\n" .'* **Inactive**: The media workflow is deactivated.'."\n" .'* **Active**: The media workflow is activated.'."\n" .'* **Deleted**: The media workflow is deleted.'."\n", 'type' => 'string', 'example' => 'Active', 'title' => ''], 'TriggerMode' => ['description' => 'The trigger mode of the media workflow. Valid values:'."\n" ."\n" .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", 'type' => 'string', 'example' => 'OssAutoTrigger', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'Topology' => ['description' => 'The topology of the media workflow.'."\n", '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"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PageSize' => ['description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '16CD0CDD-457E-420D-9755-8385075A1234', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'SearchMediaWorkflow', 'summary' => 'Queries media workflows in the specified state.', 'description' => 'You can call this operation to query media workflows in the specified state. If you do not specify the state, all media workflows are queried by default.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaWorkflow'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'SearchPipeline' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page for a paged query.'."\n" ."\n" .'- Maximum value: **100**.'."\n" ."\n" .'- Default value: **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The current page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The status of the MPS queues to search for. If you leave this parameter empty, all MPS queues are searched by default.'."\n" ."\n" .'- **All**: All MPS queues.'."\n" ."\n" .'- **Active**: The MPS queue is active.'."\n" ."\n" .'- **Paused**: The MPS queue is paused.'."\n" ."\n" .'- Default value: **All**.', 'type' => 'string', 'required' => false, 'default' => 'All', 'example' => 'Paused', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5', 'title' => ''], 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PipelineList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Pipeline' => [ 'description' => 'The list of pipelines.', 'type' => 'array', 'items' => [ 'description' => 'The details of the MPS queue.', 'type' => 'object', 'properties' => [ 'Speed' => ['description' => 'The type of the MPS queue. Default value: **Standard**. Valid values:'."\n" ."\n" .'- **Boost**: a high-speed transcoding MPS queue.'."\n" ."\n" .'- **Standard**: a standard MPS queue.'."\n" ."\n" .'- **NarrowBandHDV2**: a Narrowband HD 2.0 MPS queue.'."\n" ."\n" .'- **AIVideoCover**: a smart snapshot MPS queue.'."\n" ."\n" .'- **AIVideoFPShot**: a video DNA MPS queue.'."\n" ."\n" .'- **AIVideoCensor**: an automated review MPS queue.'."\n" ."\n" .'- **AIVideoMCU**: a smart tagging MPS queue.'."\n" ."\n" .'- **AIVideoSummary**: a video synopsis MPS queue.'."\n" ."\n" .'- **AIVideoPorn**: a pornography detection MPS queue.'."\n" ."\n" .'- **AIAudioKWS**: an audio keyword recognition MPS queue.'."\n" ."\n" .'- **AIAudioASR**: a speech-to-text MPS queue.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'State' => ['description' => 'The status of the MPS queue. Valid values:'."\n" ."\n" .'- **Active**: The MPS queue is active.'."\n" ."\n" .'- **Paused**: The MPS queue is paused.', 'type' => 'string', 'example' => 'Paused', 'title' => ''], 'SpeedLevel' => ['description' => 'The speed level of the MPS queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'NotifyConfig' => [ 'description' => 'The MNS notification settings.', 'type' => 'object', 'properties' => [ 'MqTopic' => ['description' => 'The topic of the message queue.', 'type' => 'string', 'example' => 'example1,example2', 'title' => ''], 'QueueName' => ['description' => 'The queue created in Alibaba Cloud Simple Message Queue (formerly MNS).', 'type' => 'string', 'example' => 'example-queue-****', 'title' => ''], 'MqTag' => ['description' => 'The tag.', 'type' => 'string', 'example' => 'mts-test', 'title' => ''], 'Topic' => ['description' => 'The topic created in Alibaba Cloud Simple Message Queue (formerly MNS).', 'type' => 'string', 'example' => 'example-topic-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Role' => ['description' => 'The role associated with the current RAM user.', 'type' => 'string', 'example' => 'AliyunMTSDefaultRole', 'title' => ''], 'Name' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'example' => 'example-pipeline-****', 'title' => ''], 'Id' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], 'QuotaAllocate' => ['description' => 'The quota allocated to the MPS queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'CreationTime' => ['description' => 'The time when the MPS queue was created.', 'type' => 'string', 'title' => '', 'example' => ' 2021-03-04T06:44:43Z'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Search pipelines', 'summary' => 'Search for pipelines by status.', 'description' => 'This operation searches for MPS queues by status. If you do not specify a status, the operation searches all MPS queues by default.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'The queries per second (QPS) limit for this operation is 100 for each user. If you exceed this limit, your API calls are throttled, which may affect your business. Plan your calls accordingly. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-21T08:15:35.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-13T05:42:26.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-08T02:32:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchPipeline'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchPipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'SearchTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The size of each page set during the result paging query.'."\n" ."\n" .'- Upper limit: 100.'."\n" .'- Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The status of the custom transcoding templates that you want to query.'."\n" ."\n" .'* **All**: All custom transcoding templates are queried.'."\n" .'* **Normal**: Normal custom transcoding templates are queried.'."\n" .'* **Deleted**: Deleted custom transcoding templates are queried.'."\n" .'* Default value: **All**.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'default' => 'All', 'title' => ''], ], [ 'name' => 'NamePrefix', 'in' => 'query', 'schema' => ['description' => 'The name prefix based on which you want to search for templates.'."\n", 'type' => 'string', 'required' => false, 'example' => 'S00000001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of search results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TemplateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Template' => [ 'description' => 'The transcoding templates.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Bufsize' => ['description' => 'The buffer size.'."\n" ."\n" .'* Unit: KB.'."\n" .'* Default value: **6000**.'."\n", 'type' => 'string', 'example' => '6000', 'title' => ''], 'LongShortMode' => ['description' => 'Indicates whether the auto-rotate screen feature is enabled.'."\n" ."\n" .'* If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode. Valid values:'."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Degrain' => ['description' => 'The level of video quality control.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'BitrateBnd' => [ 'description' => 'The average bitrate range of the video.'."\n", 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'Min' => ['description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Pad' => ['description' => 'The black bars that are added to the video.'."\n" ."\n" .'* Format: width:height:left:top.'."\n" .'* Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Codec' => ['description' => 'The codec.'."\n" ."\n" .'* Valid values: H.264 and H.265.'."\n" .'* Default value: **H.264**.'."\n", 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The height of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: **the height of the input video**.'."\n", 'type' => 'string', 'example' => '800', 'title' => ''], 'Qscale' => ['description' => 'The strength of the independent denoising algorithm.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Crop' => ['description' => 'The method of video cropping. Valid values:'."\n" ."\n" .'* **border**: automatically detects and removes black bars.'."\n" .'* **Value in the width:height:left:top format**: crops the video image based on the custom settings. Format: width:height:left:top. Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => 'border', 'title' => ''], 'Bitrate' => ['description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Maxrate' => ['description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'NarrowBand' => [ 'description' => 'The Narrowband HD settings.'."\n", 'type' => 'object', 'properties' => [ 'Abrmax' => ['description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '3000', 'title' => ''], 'MaxAbrRatio' => ['description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.0', 'title' => ''], 'Version' => ['description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", 'type' => 'string', 'example' => '1.0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MaxFps' => ['description' => 'The maximum frame rate.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], 'Profile' => ['description' => 'The codec profile. Valid values:'."\n" ."\n" .'* **baseline**: applicable to mobile devices.'."\n" .'* **main**: applicable to standard-definition devices.'."\n" .'* **high**: applicable to high-definition devices.'."\n" .'* Default value: **high**.'."\n", 'type' => 'string', 'example' => 'high', 'title' => ''], 'Crf' => ['description' => 'The constant rate factor.'."\n" ."\n" .'* Default value when the value of Codec is H.264: **23**, default value when the value of Codec is H.265: **26**.'."\n" .'* If this parameter is set, the value of Bitrate becomes invalid.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Remove' => ['description' => 'Indicates whether the video stream is deleted. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Gop' => ['description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Width' => ['description' => 'The width of the video.'."\n" ."\n" .'* Valid values: **\\[128,4096]**.'."\n" .'* Unit: pixel.'."\n" .'* Default value: **the width of the input video**.'."\n", 'type' => 'string', 'example' => '256', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the video.'."\n" ."\n" .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" .'* Default value: **the frame rate of the input video**.'."\n", 'type' => 'string', 'example' => '25', 'title' => ''], 'Preset' => ['description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" ."\n" .'* **veryfast**'."\n" .'* **fast**'."\n" .'* **medium**'."\n" .'* **slow**'."\n" .'* **slower**'."\n", 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'The scan mode. Valid values:'."\n" ."\n" .'* **interlaced**'."\n" .'* **progressive**'."\n", 'type' => 'string', 'example' => 'interlaced', 'title' => ''], 'ResoPriority' => ['description' => 'The policy of resolution adjustment.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Hdr2sdr' => ['description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'The general transcoding configurations.'."\n", 'type' => 'object', 'properties' => [ 'IsCheckAudioBitrate' => ['description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:'."\n" ."\n" .'* **true**'."\n" ."\n" .'* **false**'."\n" ."\n" .'* Default value:'."\n" ."\n" .' * If this parameter is empty and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" .' * If this parameter is empty and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'TransMode' => ['description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" ."\n" .'* **onepass**'."\n" .'* **twopass**'."\n" .'* **CBR**'."\n", 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Indicates whether video bitrate check errors are allowed. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:'."\n" ."\n" .'* **true**: If the video bitrate check fails, the input file is not transcoded.'."\n" .'* **false**: The video bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'AdjDarMethod' => ['description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" ."\n" .'* rescale'."\n" .'* crop'."\n" .'* none'."\n", 'type' => 'string', 'example' => 'none', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Indicates whether audio bitrate check errors are allowed. This parameter has a greater priority than IsCheckAudioBitrate. Valid values:'."\n" ."\n" .'* **true**: If the audio bitrate check fails, the input file is not transcoded.'."\n" .'* **false**: The audio bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The status of the template. Valid values:'."\n" ."\n" .'* **Normal**'."\n" .'* **Deleted**'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'MuxConfig' => [ 'description' => 'The transmuxing configurations.'."\n", 'type' => 'object', 'properties' => [ 'Gif' => [ 'description' => 'The transmuxing configurations for GIF.'."\n", 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'The duration for which the final frame is paused. Unit: centisecond.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'DitherMode' => ['description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", 'type' => 'string', 'example' => 'sierra', 'title' => ''], 'Loop' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'IsCustomPalette' => ['description' => 'Indicates whether a custom palette is used.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'The segment configurations.'."\n", 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The length of the segment. Unit: seconds.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'MPS-example', 'title' => ''], 'Audio' => [ 'description' => 'The audio codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The codec profile of the audio. Valid values when the value of Codec is aac:'."\n" ."\n" .'* **aac_low**'."\n" .'* **aac_he**'."\n" .'* **aac_he_v2**'."\n" .'* **aac_ld**'."\n" .'* **aac_eld**'."\n", 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Remove' => ['description' => 'Indicates whether the audio stream is deleted. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Codec' => ['description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" ."\n" .'* **aac**'."\n" .'* **mp3**'."\n" .'* **vorbis**'."\n" .'* **flac**'."\n", 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Samplerate' => ['description' => 'The sampling rate.'."\n" ."\n" .'* Unit: Hz'."\n" .'* Default value: **44100**.'."\n", 'type' => 'string', 'example' => '44100', 'title' => ''], 'Qscale' => ['description' => 'The strength of the independent denoising algorithm. Valid values: **\\[1,9]**.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels. Default value: **2**.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Unit: Kbit/s.'."\n" .'* Default value: **128**.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'The transcoding template ID.'."\n", 'type' => 'string', 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], 'Container' => [ 'description' => 'The container format configurations.'."\n", 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The format of the container. Valid values:'."\n" ."\n" .'* **flv**'."\n" .'* **mp4**'."\n" .'* **ts**'."\n" .'* **m3u8**'."\n" .'* **gif**'."\n" .'* **mp3**'."\n" .'* **ogg**'."\n" .'* **flac**'."\n", 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CreationTime' => ['description' => 'The time when the template was created.'."\n", 'type' => 'string', 'example' => '2021-03-04T06:44:43Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PageSize' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BC860F04-778A-472F-AB39-E1BF329C****', 'title' => ''], 'PageNumber' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'SearchTemplate', 'summary' => 'You can call this operation to query custom transcoding templates in the specified state.', 'description' => 'You can call this operation up to 100 times per second. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-03-14T06:38:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-04T02:22:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-21T08:15:35.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-13T05:42:29.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'SearchWaterMarkTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.'."\n" ."\n" .'* A maximum of **100** entries can be returned on each page.'."\n" .'* Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The state of the watermark templates that you want to query. Valid values:'."\n" ."\n" .'* **All (default)**'."\n" .'* **Normal**'."\n" .'* **Deleted**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', 'default' => 'Normal', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The details of the watermark templates.'."\n", 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The type of the watermark. Valid values:'."\n" ."\n" .'* Image: an image watermark.'."\n" .'* Text: a text watermark.'."\n" ."\n" .'> Only watermarks of the **Image** types are supported.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" ."\n" .'* **Width**: the width edge.'."\n" .'* **Height**: the height edge.'."\n" .'* **Long**: the long edge.'."\n" .'* **Short**: the short edge.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'FC029D04-8F47-57FF-A759-23383C15617D', 'title' => ''], 'PageNumber' => ['description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'WaterMarkTemplateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'WaterMarkTemplate' => [ 'description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The position of the watermark. Valid values:'."\n" ."\n" .'* TopRight: the upper-right corner.'."\n" .'* TopLeft: the upper-left corner.'."\n" .'* BottomRight: the lower-right corner.'."\n" .'* BottomLeft: the lower-left corner.'."\n", 'type' => 'string', 'example' => 'Image', 'title' => ''], 'RatioRefer' => [ 'description' => 'The status of the watermark template. Valid values: Valid values:'."\n" ."\n" .'* **Normal**: The watermark template is normal.'."\n" .'* **Deleted**: The watermark template is deleted.'."\n", 'type' => 'object', 'properties' => [ 'Dx' => ['description' => 'The horizontal offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '0.51', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '0.36', 'title' => ''], 'Height' => ['description' => 'The height of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '0.33', 'title' => ''], 'Dy' => ['description' => 'The timeline of the watermark.'."\n", 'type' => 'string', 'example' => '0.2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ReferPos' => ['description' => 'The beginning of the time range during which the watermark is displayed.'."\n" ."\n" .'* Unit: seconds.'."\n" .'* Default value: **0**.'."\n", 'type' => 'string', 'example' => 'TopRight', 'title' => ''], 'State' => ['description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Dx' => ['description' => 'The name of the watermark template.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], 'Width' => ['description' => 'The vertical offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Height' => ['description' => 'The ID of the watermark template.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Timeline' => [ 'description' => 'The timeline of the watermark.'."\n", 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset.'."\n" ."\n" .'The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => 'ToEND', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => 'example-watermark', 'title' => ''], 'Dy' => ['description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" ."\n" .'* **Width**: the width edge.'."\n" .'* **Height**: the height edge.'."\n" .'* **Long**: the long edge.'."\n" .'* **Short**: the short edge.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], 'Id' => ['description' => 'The vertical offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '88c6ca184c0e4578645b665e2a12****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], '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' => 'SearchWaterMarkTemplate', 'summary' => 'Searches for watermark templates.', 'description' => 'The total number of returned entries.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchWaterMarkTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitAnalysisJob' => [ 'summary' => 'Submits a preset template analysis job.', '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' => 'The input information about the preset template analysis job to be submitted. The value must be a JSON object. You must log on to the Object Storage Service (OSS) console to grant the read permissions on the specified OSS bucket to MPS. For more information, see the "Input" section of the [Parameter details](~~29253~~) topic.'."\n" ."\n" .'> The OSS bucket must reside in the same region as your MPS service.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.flv"}', 'title' => ''], ], [ 'name' => 'AnalysisConfig', 'in' => 'query', 'schema' => ['description' => 'The job configurations. Set this parameter as required. For more information, see the "AnalysisConfig" section of the [Parameter details](~~29253~~) topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"QualityControl":{"RateQuality":25,"MethodStreaming":"network"}}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The custom data. The custom data can contain letters, digits, and hyphens (-), and can be up to 1,024 bytes in length. The custom data cannot start with a special character.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testid-001', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue to which the job is submitted. To view the ID of the MPS queue, log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane. If you want to enable asynchronous notifications, make sure that the MPS queue is bound to a Message Service (MNS) topic.'."\n", 'type' => 'string', 'required' => true, 'example' => 'bb558c1cc25b45309aab5be44d19****', 'title' => ''], ], [ 'name' => 'Priority', 'in' => 'query', 'schema' => ['description' => 'The priority of the job in the MPS queue to which the job is submitted.'."\n" ."\n" .'* Valid values: **1 to 10**. A value of 10 indicates the highest priority.'."\n" .'* Default value: **6**.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B52658D4-07AB-43CD-82B0-210958A65E23', 'title' => ''], 'AnalysisJob' => [ 'description' => 'The information about the preset template analysis job that was submitted.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the job was created.'."\n", 'type' => 'string', 'example' => '2014-01-10T12:00:00Z', 'title' => ''], 'Percent' => ['description' => 'The transcoding progress.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'State' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'* **Submitted**: The job is submitted.'."\n" .'* **Analyzing**: The job is being run.'."\n" .'* **Success**: The job is successful.'."\n" .'* **Fail**: The job fails.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'AnalysisConfig' => [ 'description' => 'The job configurations.'."\n", 'type' => 'object', 'properties' => [ 'QualityControl' => [ 'description' => 'The quality control on the job output.'."\n", 'type' => 'object', 'properties' => [ 'MethodStreaming' => ['description' => 'The playback mode. Valid values:'."\n" ."\n" .'* **network**: online playback'."\n" .'* **local**: playback on local devices'."\n" .'* Default value: **network**.'."\n", 'type' => 'string', 'example' => 'network', 'title' => ''], 'RateQuality' => ['description' => 'The quality level of the output file.'."\n", 'type' => 'string', 'example' => '50', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PropertiesControl' => [ 'description' => 'The control on the attributes of the job output.'."\n", 'type' => 'object', 'properties' => [ 'Deinterlace' => ['description' => 'Indicates whether deinterlacing was forced to run. Valid values:'."\n" ."\n" .'* **Auto**: Deinterlacing was automatically run.'."\n" .'* **Force**: Deinterlacing was forced to run.'."\n" .'* **None**: Deinterlacing was forced not to run.'."\n", 'type' => 'string', 'example' => 'Force', 'title' => ''], 'Crop' => [ 'description' => 'The cropping configurations of video images.'."\n", 'type' => 'object', 'properties' => [ 'Top' => ['description' => 'The top margin that was cropped out.'."\n" ."\n" .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Width' => ['description' => 'The width of the video after the margins were cropped out.'."\n" ."\n" .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Height' => ['description' => 'The height of the video after the margins were cropped out.'."\n" ."\n" .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Left' => ['description' => 'The left margin that was cropped out.'."\n" ."\n" .'> This parameter is invalid if the **Mode** parameter is set to Auto or None.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'Mode' => ['description' => 'The cropping mode. Valid values:'."\n" ."\n" .'* **Auto**: Cropping was automatically run. This is the default value.'."\n" .'* **Force**: Cropping was forced to run.'."\n" .'* **None**: Cropping was forced not to run.'."\n", 'type' => 'string', 'example' => 'Auto', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The error message returned if the job failed.'."\n", 'type' => 'string', 'example' => 'The resource operated \\"PipelineId\\" cannot be found', 'title' => ''], 'Priority' => ['description' => 'The priority of the job in the MPS queue to which the job was submitted.'."\n" ."\n" .'* Valid values: **1 to 10**. A value of 10 indicates the highest priority.'."\n" .'* Default value: **10**.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'MNSMessageResult' => [ 'description' => 'The message sent by MNS to notify users of the job result.'."\n", 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the message returned if the job was successful. This parameter is not returned if the job failed.'."\n", 'type' => 'string', 'example' => '3ca84a39a9024f19853b21be9cf9****', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'The resource operated \\"PipelineId\\" cannot be found', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TemplateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Template' => [ 'description' => 'The matched preset templates.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the preset template.'."\n", 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Bufsize' => ['description' => 'The size of the buffer.'."\n" ."\n" .'* Unit: KB.'."\n" .'* Default value: **6000**.'."\n", 'type' => 'string', 'example' => '5000', 'title' => ''], 'Degrain' => ['description' => 'The strength of the independent noise reduction algorithm.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'BitrateBnd' => [ 'description' => 'The average bitrate range of the video.'."\n", 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''], 'Min' => ['description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'The pixel format for video color encoding. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", 'type' => 'string', 'example' => 'yuvj420p', 'title' => ''], 'Codec' => ['description' => 'The video codec. Default value: **H.264**.'."\n", 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The height of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: the height of the input video.'."\n", 'type' => 'string', 'example' => '1880', 'title' => ''], 'Qscale' => ['description' => 'The level of quality control on the video.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Bitrate' => ['description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Maxrate' => ['description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Profile' => ['description' => 'The codec profile. Valid values:'."\n" ."\n" .'* **baseline**: applicable to mobile devices.'."\n" .'* **main**: applicable to standard-definition devices.'."\n" .'* **high**: applicable to high-definition devices.'."\n" .'* Default value: **high**.'."\n", 'type' => 'string', 'example' => 'baseline', 'title' => ''], 'Crf' => ['description' => 'The constant rate factor.'."\n" ."\n" .'* Default value if the Codec parameter is set to H.264: **23**. Default value if the Codec parameter is set to H.265: **26**.'."\n" .'* If this parameter is returned, the setting of the Bitrate parameter is invalid.'."\n", 'type' => 'string', 'example' => '27', 'title' => ''], 'Gop' => ['description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Width' => ['description' => 'The width of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: the width of the input video.'."\n", 'type' => 'string', 'example' => '1990', 'title' => ''], 'Fps' => ['description' => 'The frame rate.'."\n" ."\n" .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" .'* Default value: the frame rate of the input video.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], 'Preset' => ['description' => 'The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: **medium**.'."\n", 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'The scan mode. Valid values:'."\n" ."\n" .'* **interlaced**'."\n" .'* **progressive**'."\n", 'type' => 'string', 'example' => 'progressive', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'The general transcoding configurations.'."\n", 'type' => 'object', 'properties' => [ 'TransMode' => ['description' => 'The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: **onepass**.'."\n", 'type' => 'string', 'example' => 'onepass', 'title' => ''], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The status of the template.'."\n" ."\n" .'* **Normal**: The template is normal.'."\n" .'* **Deleted**: The template is deleted.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'MuxConfig' => [ 'description' => 'The transmuxing configurations.'."\n", 'type' => 'object', 'properties' => [ 'Gif' => [ 'description' => 'The transmuxing configurations for the GIF format.'."\n", 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'The interval between two consecutive loops for the GIF format. Unit: 0.01s. For example, a value of 500 indicates 5 seconds.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Loop' => ['description' => 'The number of loops for the GIF or WebP format. Default value: 0.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'The segment configurations.'."\n", 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The length of the segment. Unit: seconds.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'FLV-UD', 'title' => ''], 'Audio' => [ 'description' => 'The audio codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The codec profile of the audio. Valid values if the **Codec** parameter is set to **aac**: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Codec' => ['description' => 'The audio codec format. Default value: **acc**.'."\n", 'type' => 'string', 'example' => 'mp3', 'title' => ''], 'Samplerate' => ['description' => 'The sampling rate.'."\n" ."\n" .'* Unit: Hz.'."\n" .'* Default value: **44100**.'."\n", 'type' => 'string', 'example' => '32000', 'title' => ''], 'Qscale' => ['description' => 'The level of quality control on the audio.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels. Default value: **2**.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Unit: Kbit/s.'."\n" .'* Default value: **128**.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'The ID of the transcoding template.'."\n", 'type' => 'string', 'example' => 'S00000000-00****', 'title' => ''], 'Container' => [ 'description' => 'The container format configurations.'."\n", 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The container format.'."\n", 'type' => 'string', 'example' => 'flv', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'The custom data.'."\n", 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job failed. This parameter is not returned if the job was successful.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], 'InputFile' => [ 'description' => 'The information about the job input.'."\n", 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the input file.'."\n", 'type' => 'string', 'example' => 'example.flv', 'title' => ''], 'Location' => ['description' => 'The ID of the OSS region.'."\n", 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket.'."\n", 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the analysis job was submitted.'."\n", 'type' => 'string', 'example' => 'bb558c1cc25b45309aab5be44d19****', 'title' => ''], 'Id' => ['description' => 'The ID of the template analysis job.'."\n", 'type' => 'string', 'example' => '57f6aa3f84824309bcba67231b40****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'SubmitAnalysisJob', 'description' => '* After you call the SubmitAnalysisJob operation to submit a preset template analysis job, ApsaraVideo Media Processing (MPS) intelligently analyzes the input file of the job and recommends a suitable preset template. You can call the [QueryAnalysisJobList](~~29224~~) operation to query the analysis result or enable asynchronous notifications to receive the analysis result.'."\n" .'* The analysis result is retained only for two weeks after it is generated. The analysis result is deleted after two weeks. If you use the recommended preset template in a transcoding job after two weeks, the job fails, and the `AnalysisResultNotFound` error code is returned.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAnalysisJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitAnalysisJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'SubmitCopyrightExtractJob' => [ 'summary' => 'Submits a copyright watermark extraction job.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222529', 'abilityTreeNodes' => ['FEATUREmtsRH229Z'], ], 'parameters' => [ [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The OSS URL of the input file.', 'type' => 'string', 'required' => false, 'example' => '{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}', 'title' => ''], ], [ 'name' => 'CallBack', 'in' => 'query', 'schema' => ['description' => 'The callback URL for the job result. Only HTTP URLs are supported.', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback'."\n", 'title' => ''], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => ['description' => 'A publicly accessible URL for the video. If this parameter is specified, this URL is used as the job input and takes precedence over the Input parameter.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/video/test.mp4'."\n", 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The custom data. The maximum length is 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '123'."\n", 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'The parameters for the watermarking job, specified as a JSON string. It supports the following parameter:'."\n" ."\n" .'- `algoType`: The algorithm to use. Default value: v1.'."\n" ."\n" .' - `v1`: For long-form videos.'."\n" ."\n" .' - `v2`: For short-form videos.', 'type' => 'string', 'required' => false, 'example' => '{"algoType":"v1"}'."\n" ."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '05F8B913-E9F3-4A6F-9922-48CADA0FFAAD'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'Data' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'ebbfe90c63b54ed4b61acb2f6c44****', 'title' => ''], ], 'example' => '', ], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'Submit a Copyright Watermark Extraction Job ', 'description' => '- Currently, digital watermarking operations are supported only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" .'- This is an [asynchronous operation](~~3027615~~). After you submit a request, the system returns a job ID and queues the job for background processing. You can obtain the final result through a callback notification, or call the [QueryCopyrightExtractJob](~~2834790~~) operation to query the job status.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightExtractJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitCopyrightExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitCopyrightJob' => [ 'summary' => 'Use SubmitCopyrightJob to submit a video copyright watermark job.', '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' => 'The location of the input media object in OSS, specified as a JSON object. Currently, only video files are supported. For more information, see [Input](~~29253~~).'."\n" ."\n" .'> - The OSS bucket must be in the same region as MPS.'."\n" ."\n" .'- `Bucket`: The name of the input OSS bucket.'."\n" ."\n" .'- `Location`: The region of the OSS bucket. This must be the same as the MPS region.'."\n" ."\n" .'- `Object`: The object in the OSS bucket to be processed.', 'type' => 'string', 'required' => false, 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"}', 'title' => ''], ], [ 'name' => 'Output', 'in' => 'query', 'schema' => ['description' => 'The location of the output object in OSS, specified as a JSON object.'."\n" ."\n" .'> - The OSS bucket must be in the same region as MPS.', 'type' => 'string', 'required' => true, 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"}', 'title' => ''], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => ['description' => 'The watermark message to embed.', 'type' => 'string', 'example' => 'T-Head Semiconductor', 'required' => true, 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time for embedding the watermark, in seconds. If this parameter is not specified, the default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'TotalTime', 'in' => 'query', 'schema' => ['description' => 'The total duration for embedding the watermark, in seconds. If unspecified, the watermark is applied to the entire video.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => ['description' => 'The watermark embedding channel. Valid values: 0 (U channel), 1 (UV channels), and 2 (YUV channels).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'A description of the watermark information.', 'type' => 'string', 'example' => 'Address: Shangke Road, Pudong New Area, Shanghai', 'required' => false, 'title' => ''], ], [ 'name' => 'CallBack', 'in' => 'query', 'schema' => ['description' => 'The callback URL for job results. Only HTTP URLs are supported.', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', 'title' => ''], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => ['description' => 'A publicly accessible URL of the video. If specified, this URL is used as the job input and overrides the `Input` parameter.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/video/test.mp4', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'User-defined data. The maximum length is 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'Additional parameters for the watermarking job, specified as a JSON string. The following parameter is supported:'."\n" ."\n" .'- `algoType`: The algorithm type. Default value: `v1`.'."\n" ."\n" .' - `v1`: The copyright watermark algorithm for long-form video. It supports only videos that are 3 minutes or longer.'."\n" ."\n" .' - `v2`: The copyright watermark algorithm for short-form video.', 'type' => 'string', 'required' => false, 'example' => '{"algoType":"v2"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3'], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'Data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****', 'title' => ''], ], 'example' => '', ], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'Submit Video Copyright Watermarking Job ', 'description' => '- By default, copyright watermark jobs support only videos that are 3 minutes or longer. Submitting a video shorter than this duration may cause the API call to fail or produce no output. To add a copyright watermark to a short-form video (under 3 minutes), configure the `Params` parameter. For details, see the parameter description.'."\n" ."\n" .'- Each API call processes one video.'."\n" ."\n" .'- Currently, APIs related to digital watermark are available only in the China (Shanghai) and China (Beijing) regions. For more usage limitations, see [digital watermark](~~2527021#893034503fwvw~~).'."\n" ."\n" .'- This is an [asynchronous API](~~3027615~~). After a job is submitted, the service returns a job ID and queues the job for background processing. The final result is delivered through a callback. You can also query the job status with the [QueryCopyrightJob](~~2834792~~) API.', 'changeSet' => [ ['createdAt' => '2025-05-14T03:22:00.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-07-23T02:15:26.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitCopyrightJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitFpDBDeleteJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) pipeline for the job. MPS uses this ID to send message notifications. You can obtain the pipeline ID in the **MPS console** by navigating to **Global Settings** > **Pipelines**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'fb712a6890464059b1b2ea7c8647****', 'title' => ''], ], [ 'name' => 'FpDBId', 'in' => 'query', 'schema' => ['description' => 'The API call to [create a DNA library](~~170149~~) returns this ID in its response.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data. The value can be a string of up to 128 bytes.', 'type' => 'string', 'required' => false, 'example' => 'example data', 'title' => ''], ], [ 'name' => 'DelType', 'in' => 'query', 'schema' => ['description' => 'The type of operation. Valid values:'."\n" ."\n" .'- **Purge**: Purges the DNA library. This operation removes all content from the library but does not delete the library itself.'."\n" ."\n" .'- **Delete**: Deletes the DNA library. This operation permanently removes the library. Note: This is the only supported operation for fingerprint libraries with a `modelId` from 11 to 14.'."\n" ."\n" .'- Default value: **Purge**.', 'type' => 'string', 'required' => false, 'example' => 'Purge', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4247B23C-26DE-529F-8D9F-FD6811AE979B', 'title' => ''], 'JobId' => ['description' => 'The ID of the submitted job. We recommend that you save this ID for subsequent API calls.', 'type' => 'string', 'example' => 'd98459323c024947a104f6a50cbf****', 'title' => ''], ], 'description' => 'The response parameters.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4247B23C-26DE-529F-8D9F-FD6811AE979B\\",\\n \\"JobId\\": \\"d98459323c024947a104f6a50cbf****\\"\\n}","type":"json"}]', 'title' => 'SubmitFpDBDeleteJob', 'summary' => 'Submits a job to delete or purge a DNA library.', 'description' => 'This operation purges or deletes a DNA library by its ID. You can choose one of two operations: `Purge` or `Delete`. The `Purge` operation removes all content from the DNA library but preserves the library. The `Delete` operation permanently removes the library. If you do not specify an operation type, `Purge` is used by default. Note that fingerprint libraries with a `modelId` from 11 to 14 support only the `Delete` operation.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The rate limit for this operation is 100 queries per second (QPS) per user. If you exceed this limit, your API calls will be throttled, which may affect your business. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitFpDBDeleteJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitFpDBDeleteJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitFpFileDeleteJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is submitted. The MPS queue is bound with a notification method. To view the MPS queue ID, log on to the **MPS console** and choose **Global Settings** > **MPS queue and Callback** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ed450ea0bfbd41e29f80a401fb4d****', 'title' => ''], ], [ 'name' => 'FpDBId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media fingerprint library. You can obtain the library ID from the response parameters of the [CreateFpShotDB](~~170149~~) operation.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '88c6ca184c0e432bbf5b665e2a15****', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The custom data. The value can contain letters and digits and can be up to 128 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example data', 'title' => ''], ], [ 'name' => 'FileIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the media files that you want to delete. Separate multiple file IDs with commas (,). You can delete up to 200 media files at a time. You can obtain media file IDs from the response parameters of the [ListFpShotFiles](~~209266~~) operation.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '41e6536e4f2250e2e9bf26cdea19****', 'title' => ''], ], [ 'name' => 'PrimaryKeys', 'in' => 'query', 'schema' => ['description' => 'The primary keys of the files to be deleted. Separate multiple primary keys with commas (,). You can delete up to 200 primary keys at a time. You can obtain the primary keys of media files from the response parameters of the [ListFpShotFiles](~~209266~~) operation.'."\n" ."\n" .'> This parameter is available only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n", 'type' => 'string', 'required' => false, 'example' => '24e0fba7188fae707e146esa54****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D127C68E-F1A1-4CE5-A874-8FF724881A12', 'title' => ''], 'JobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter.DBNotExist', 'errorMessage' => 'The DNA database does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The operation has failed due to some unknown error, exception or failure.', 'description' => ''], ], ], 'title' => 'SubmitFpFileDeleteJob', 'summary' => 'Submits a job of deleting media files from a media fingerprint library.', 'description' => '## [](#)Limits'."\n" ."\n" .'* You can call this operation to delete up to 200 media files from a media fingerprint library at a time.'."\n" .'* This operation is available in the following regions: China (Beijing), China (Hangzhou), China (Shanghai), and Singapore.'."\n" ."\n" .'## [](#qps-)QPS limits'."\n" ."\n" .'You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limits](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-11T12:21:11.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitFpFileDeleteJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitFpFileDeleteJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'SubmitFpShotJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The input file for the job. You can specify the file by using an OSS URL, an HTTP URL, or an ApsaraVideo VOD media asset.'."\n" ."\n" .'- OSS URL: A JSON string that contains the OSS triplet. Example: `{"Bucket":"test-bucket","Location":"oss-cn-shanghai","Object":"test.mp4"}`'."\n" ."\n" .'- HTTP URL: A publicly accessible URL. Example: `http://example-test-****.mp4`.'."\n" ."\n" .'- ApsaraVideo VOD media asset: a JSON string that contains the ID of the media asset. Example: `{"MediaId":"99238***321"}`'."\n" ."\n" .'> The region of the OSS bucket and the storage region of the media asset must be the same as the region where you use the ApsaraVideo Media Processing service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the pipeline used for message notifications. You can find the pipeline ID under **Global Settings** > **Pipelines** in the **ApsaraVideo Media Processing console**.', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], [ 'name' => 'FpShotConfig', 'in' => 'query', 'schema' => ['description' => 'The video DNA job configurations. The value must be a JSON object. For more information, see [FpShotConfig](~~93568~~).', 'type' => 'string', 'required' => true, 'example' => '{'."\n" .' "PrimaryKey": "12345****",'."\n" .' "SaveType": "save",'."\n" .' "FpDBId": "417f2ada5999daf****"'."\n" .'}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data. The value can be up to 128 bytes in length and cannot start with a special character.', 'type' => 'string', 'required' => false, 'example' => 'testid-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'JobId' => ['description' => 'The video DNA job ID. We recommend that you save this ID for subsequent calls to related operations.', 'type' => 'string', 'example' => '2a0697e35a7342859f733a9190c4****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"2a0697e35a7342859f733a9190c4****\\"\\n}","type":"json"}]', 'title' => 'SubmitFpShotJob', 'summary' => 'This operation searches a DNA library for matching or similar fingerprints.', 'description' => '- Use this operation to submit jobs for video, audio, image, and text DNA analysis.'."\n" ."\n" .'- This is an [asynchronous API](~~3027615~~). After you submit a job, the operation returns a job ID. The service then queues the job for background processing. When the job is complete, ApsaraVideo Media Processing sends a [callback notification](~~3027615~~) with the results. You can also call the [QueryFpShotJob](~~602896~~) operation to check the job status.'."\n" ."\n" .'- The DNA analysis features are available in the China (Beijing), China (Shanghai), China (Hangzhou), Asia Pacific SE 1 (Singapore), and Saudi Arabia (Riyadh) regions. The service in the Saudi Arabia (Riyadh) region is operated by a partner. These features are not available in other regions. The text DNA analysis feature is supported only in the China (Shanghai) region.'."\n" ."\n" .'- The following input file formats are supported:'."\n" ."\n" .' - Image formats: JPEG, PNG, and BMP.'."\n" ."\n" .' - Video formats: MP4, AVI, MKV, MPG, TS, MOV, FLV, and MXF.'."\n" ."\n" .' - Video codecs: MPEG-2, MPEG-4, H.264, HEVC, and WMV.'."\n" ."\n" .'- For text DNA analysis, the DNA library supports only long text strings that are added with `TextType` set to `Text`. The search input must be an Automatic Speech Recognition (ASR) result with `TextType` set to `ASR`. The ASR result must be a JSON array of objects that contain `start`, `end`, and `text` fields.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'This operation is limited to 100 queries per second (QPS) per user. Calls that exceed this limit are subject to throttling, which may affect your business. Plan your calls accordingly. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => '**Asynchronous notification parameters**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| :-------------- | :-------------------- | :------------------------------------------------------------------------------------------- |'."\n" .'| Type | String | The type of the message. |'."\n" .'| FpShotJobNotify | AliyunFpShotJobNotify | A video DNA job. For more information, see [the AliyunFpShotJobNotify data type](~~29251~~). |'."\n" .'| UserData | String | The user-defined data. |', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-26T10:10:27.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitFpShotJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitFpShotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitIProductionJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'FunctionName', 'in' => 'query', 'schema' => ['description' => 'The name of the function. For information about the regions that support each function, see [Service regions](~~43248~~). Valid values:'."\n" ."\n" .'- **VideoH2V**: Converts a landscape video to a portrait video.'."\n" ."\n" .'- **VideoDelogo**: Removes watermarks or logos from videos.'."\n" ."\n" .'- **Cover**: Generates an [intelligent cover]().'."\n" ."\n" .'- **VideoClip**: Generates a [video summary]().'."\n" ."\n" .'- **ImageH2V**: Converts a landscape image to a portrait image.'."\n" ."\n" .'- **ImageDelogo**: Removes watermarks or logos from images.'."\n" ."\n" .'- **CaptionExtraction**: Performs [caption extraction](). The algorithm extracts captions from the input video and returns the caption file.'."\n" ."\n" .'- **VideoDetext**: Removes hard-coded subtitles from videos.'."\n" ."\n" .'- **VideoGreenScreenMatting**: Performs [green screen matting](). The algorithm composites the input green screen video with a background image and returns the resulting video.'."\n" ."\n" .'- **MusicSegmentDetect**: Performs [chorus detection](). The algorithm detects chorus segments in the input audio or video file and returns their start and end times. If no chorus is detected, the result is empty.'."\n" ."\n" .'- **AudioMixing**: Performs audio mixing.'."\n" ."\n" .'- **AudioBeatDetection**: Performs [beat detection](). The algorithm takes the URL of an audio or video file as input and outputs a list of beat timestamps (BeatList) and a list of downbeat timestamps (DownBeatList).'."\n" ."\n" .'- **ImageCartoonize**: Applies 3D or stylized effects to faces. To use the face stylization feature, contact us on DingTalk at yuanzhigao1209.'."\n" ."\n" .'- **AudioQualityAssessment**: Assesses audio quality.'."\n" ."\n" .'- **FaceBeauty**: Applies beauty filters to faces in videos.'."\n" ."\n" .'- **SpeechDenoise**: Performs [intelligent noise reduction]().'."\n" ."\n" .' > For audio quality assessment, the input audio must be a 16-bit quantized WAV file. Both mono and stereo channels are supported. Supported [sampling rates]() range from 8,000 Hz to 48,000 Hz.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ImageCartoonize', 'title' => ''], ], [ 'name' => 'ModelId', 'in' => 'query', 'schema' => ['description' => 'The ID of the algorithm [model](). If you do not specify this parameter, the system uses the default model for the function.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'JobParams', 'in' => 'query', 'schema' => ['description' => 'The job parameters for the algorithm, specified as a JSON object. The content of this parameter varies depending on the algorithm. For more information, see [Supplemental parameters for intelligent production jobs](~~352026~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"Model":"gif"}', 'title' => ''], ], [ 'name' => 'ScheduleParams', 'in' => 'query', 'schema' => ['description' => 'Optional job scheduling parameters.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'NotifyUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL. Only MNS message queues are supported. You can find the [message queue]() path in the **MNS console** by navigating to **Queues** > **Details**.', 'type' => 'string', 'required' => false, 'example' => 'mns://125340688170****.mns.cn-beijing.aliyuncs.com/queues/example-pipeline', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'Optional custom data that the service passes back in the callback notification.', 'type' => 'string', 'required' => false, 'example' => '{\\"key\\":\\"value\\"}', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the job [pipeline](). You can obtain the pipeline ID from the **MPS console** by navigating to **Global Settings** > **Pipelines**. This ID determines the job callback queue and provides [tenant isolation](). If you do not specify this parameter, the default pipeline is used. The default pipeline has a [concurrency]() of 10 and is not bound to a [message queue]() for notifications.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The input file in an [OSS bucket](). Only OSS paths are supported. The file must be in an OSS bucket in the same region as the MPS service. You can obtain the path from the **MPS console** by navigating to **Media Management** > **Media List**, or from the OSS console by selecting the corresponding bucket.'."\n" ."\n" .'> The `Input` parameter is required for some algorithms. Specify this parameter based on your business requirements.', 'type' => 'string', 'required' => false, 'example' => 'oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4', 'title' => ''], ], [ 'name' => 'Output', 'in' => 'query', 'schema' => ['description' => 'The output file in an [OSS bucket](). Only OSS paths are supported. The destination OSS bucket must be in the same region as the MPS service. You can obtain the path from the **MPS console** by navigating to **Media Management** > **Media List**, or from the OSS console by selecting the corresponding bucket.'."\n" ."\n" .'> The format is `oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt`. In this format, `{source}`, `{timestamp}`, and `{sequenceId}` are [placeholders](). The system replaces them with the input filename, a Unix [timestamp](), and a sequence number, respectively. The placeholders are not required. However, for algorithms that produce multiple outputs, such as [intelligent cover](), you must include a sequence number placeholder like `{sequenceId}` to ensure that each output file has a unique path. You can define the file extension.', 'type' => 'string', 'required' => false, 'example' => 'oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The [request ID]().', 'type' => 'string', 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26', 'title' => ''], 'JobId' => ['description' => 'The [job ID](). Save this ID for subsequent queries.', 'type' => 'string', 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], 'Result' => ['description' => 'The job result. The structure of the result varies depending on the algorithm. For more information, see [Supplemental parameters for intelligent production jobs](~~352026~~).', 'type' => 'string', 'example' => '{ "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" }', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Submit Intelligent Production Job ', 'summary' => 'Submits an intelligent production job.', 'description' => 'This operation submits jobs for asynchronous execution. The system adds each job to a [pipeline](~~3027615~~) for scheduling, queuing, and processing. You can retrieve job results by calling the [QueryIProductionJob](~~170217~~) operation or through asynchronous [message notifications](~~3027615~~).'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The [QPS limit](~~342832~~) for this operation is 100 queries per second (QPS) for each user. If you exceed this limit, API calls are subject to [rate limiting](~~342832~~). For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2022-06-17T06:10:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-23T04:14:46.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitIProductionJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitIProductionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitImageCopyright' => [ 'summary' => 'Use this operation to submit a job that generates a transparent image watermark.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '209015', 'abilityTreeNodes' => ['FEATUREmtsRH229Z'], ], 'parameters' => [ [ 'name' => 'Output', 'in' => 'query', 'schema' => ['description' => 'The OSS location for the output transparent image watermark.'."\n" ."\n" .'> The OSS bucket must be in the same region where MPS is activated.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '{"Bucket":"abc-test","Location":"oss-cn-shanghai","Object":"out.jpeg"}', 'title' => ''], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => ['description' => 'The content of the watermark.', 'type' => 'string', 'example' => 'T-Head Semiconductor', 'required' => true, 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'The watermark parameters, provided as a JSON string. This string contains the following fields:'."\n" ."\n" .'- `width`: The width of the output image.'."\n" ."\n" .'- `height`: The height of the output image.'."\n" ."\n" .'- `afa`: The transparency level of the watermark. Valid values: 0 to 255.'."\n" ."\n" .'- `type`: The watermark algorithm. Valid values: `0` (for game rendering) and `1` (for general application rendering).'."\n" ."\n" .'- `version`: The watermark version. Currently, only the value `0` is supported.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '{"width":2999, "height":2999, "afa": 3, "type":1, "version":0}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'Data' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****', 'title' => ''], ], 'example' => '', ], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'Submit Transparent Image Watermark', 'description' => '- This operation generates a transparent image with a hidden watermark. You can overlay this image on your page content to protect it from unauthorized screenshots. The `Params`, `Output`, and `Message` parameters are required.'."\n" ."\n" .'- This operation is available only in the China (Shanghai) region.'."\n" ."\n" .'- This is an [asynchronous API](~~3027615~~). After you submit a job, the API returns a job ID and queues the job for background processing. The service sends a callback notification with the final result.', 'changeSet' => [ ['createdAt' => '2024-07-23T02:15:26.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitImageCopyright'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitImageCopyright', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitJobs' => [ 'summary' => 'This operation submits a transcoding job. You can use this operation if the transcoding tasks or workflows created in the console do not meet your requirements. You can configure the required transcoding parameters based on your business logic.', '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' => 'Job input. For details, see [Input details](~~29253~~).'."\n" ."\n" .'> - In ApsaraVideo Media Processing APIs, the Object value must be URL-encoded using UTF-8 encoding.'."\n" ."\n" .'- The OSS region must match the region where MPS is deployed.', 'type' => 'string', 'example' => '{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"example.flv","Referer": "The anti-hotlinking parameter configured on the OSS console"}', 'required' => true, 'title' => ''], ], [ 'name' => 'Outputs', 'in' => 'query', 'schema' => ['description' => 'Job output configurations. For details, see [Output details](~~29253~~).'."\n" ."\n" .'- Outputs is a JSON array of Output objects. The maximum size is 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"}]', 'title' => ''], ], [ 'name' => 'OutputBucket', 'in' => 'query', 'schema' => ['description' => 'The OSS bucket where output files are stored.'."\n" ."\n" .'- Follows the OSS bucket definition. For more information, see [Terms](~~31827~~).', 'type' => 'string', 'required' => true, 'example' => 'exampleBucket', 'title' => ''], ], [ 'name' => 'OutputLocation', 'in' => 'query', 'schema' => ['description' => 'The OSS region (OSS Region) where the output bucket resides.'."\n" ."\n" .'- The OSS bucket must be in the same region as the ApsaraVideo Media Processing service.'."\n" ."\n" .'- Follows the OSS bucket definition. For more information, see [Terms](~~31827~~).', 'type' => 'string', 'required' => false, 'default' => 'oss-cn-hangzhou', 'example' => 'oss-cn-hangzhou', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The pipeline ID. For more information, see [Terms](~~31827~~).'."\n" ."\n" .'- You can find it in the [MPS console](https://mps.console.aliyun.com/overview) > **Settings** > **Pipelines and callbacks**.'."\n" ."\n" .'- To receive asynchronous notifications, bind an MNS message topic to the pipeline. For details, see [Receive message notifications](https://help.aliyun.com/document_detail/42618.html)[Receive message notifications](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications).', 'type' => 'string', 'required' => true, 'example' => 'dd3dae411e704030b921e52698e5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'JobResultList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'JobResult' => [ 'description' => 'List of submitted transcoding jobs.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Error code if the job creation fails. This parameter is not returned if the job is created successfully.', 'type' => 'string', 'example' => 'InvalidParameter.NullValue', 'title' => ''], 'Job' => [ 'description' => 'Detailed job information. No job ID is generated if the job submission fails.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Error code if transcoding fails. This parameter is not returned if transcoding succeeds.', 'type' => 'string', 'example' => 'InternalError', 'title' => ''], 'CreationTime' => ['description' => 'Time when the job was added.', 'type' => 'string', 'example' => '2014-01-10T12:00:00Z', 'title' => ''], 'FinishTime' => ['description' => 'Time when the job finished.', 'type' => 'string', 'example' => '2014-01-10T12:20:00Z', 'title' => ''], 'Input' => [ 'description' => 'Job input.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'OSS bucket for the job input.', 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], 'Location' => ['description' => 'OSS location for the job input.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Object' => ['description' => 'OSS object for the job input.', 'type' => 'string', 'example' => 'example.flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'JobId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', 'title' => ''], 'MNSMessageResult' => [ 'description' => 'MNS notification result for job completion.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code if the notification fails. This parameter is not returned if the notification succeeds.', 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message if the notification fails. This parameter is not returned if the notification succeeds.', 'type' => 'string', 'example' => 'The resource operated "%s" cannot be found.', 'title' => ''], 'MessageId' => ['description' => 'Error message ID if the notification fails. This parameter is not returned if the notification succeeds.', 'type' => 'string', 'example' => '123', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Message if transcoding fails. This parameter is not returned if transcoding succeeds.', 'type' => 'string', 'example' => 'The operation has failed due to some unknown error, exception or failure.', 'title' => ''], 'Output' => [ 'description' => 'Job output.', 'type' => 'object', 'properties' => [ 'AmixList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Amix' => [ 'description' => 'Audio mixing list.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'AmixURL' => ['description' => 'Media file to be mixed as background audio.'."\n" ."\n" .'- Valid values: An OSS URL or the string `"input"`.'."\n" ."\n" .'- Input scenario: Mix two audio tracks from the same video.', 'type' => 'string', 'example' => 'https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3', 'title' => ''], 'Duration' => ['description' => 'Duration. Format: numeric or time format.', 'type' => 'string', 'example' => '20', 'title' => ''], 'Map' => ['description' => 'Select the target audio track from AmixURL. Valid values: 0:a:{audio\\_index}, such as 0:a:0.', 'type' => 'string', 'example' => '0:a:0', 'title' => ''], 'MixDurMode' => ['description' => 'Media duration selection. Valid values: **first**, **long**.'."\n" ."\n" .'- **first**: Use the input media duration as the output media duration.'."\n" ."\n" .'- **long**: Use the longer duration between the two media files as the output media duration.'."\n" ."\n" .'- Default value: **long**.', 'type' => 'string', 'example' => 'long', 'title' => ''], 'Start' => ['description' => 'Start time. Format: numeric or time format, such as "1:25:36.240" or "32000.23".', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Audio' => [ 'description' => 'Audio configuration.'."\n" ."\n" .'> If you specify audio configuration in the request parameters, it overrides the corresponding parameters in the specified transcoding template.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'Audio bitrate of the output file.'."\n" ."\n" .'- Unit: Kbps.'."\n" ."\n" .'- Default value: **128**.', 'type' => 'string', 'example' => '128', 'title' => ''], 'Channels' => ['description' => 'Number of sound channels.'."\n" ."\n" .'- When Codec is set to mp3, valid values are **1** and **2**.'."\n" ."\n" .'- When Codec is set to aac, valid values are **1**, **2**, **4**, **5**, **6**, and **8**.'."\n" ."\n" .'- Default value: **2**.', 'type' => 'string', 'example' => '6', 'title' => ''], 'Codec' => ['description' => 'Audio codec format.'."\n" ."\n" .'- Valid values: **aac**, **mp3**, **vorbis**, **flac**.'."\n" ."\n" .'- Default value: **aac**.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Profile' => ['description' => 'Audio codec profile.'."\n" ."\n" .'> When **Codec** is **aac**, valid values include **aac\\_low**, **aac\\_he**, **aac\\_he\\_v2**, **aac\\_ld**, and **aac\\_eld**.', 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Qscale' => ['description' => 'Audio quality control factor.', 'type' => 'string', 'example' => '15', 'title' => ''], 'Samplerate' => ['description' => 'Sample rate.'."\n" ."\n" .'- Valid values: **22050**, **32000**, **44100**, **48000**, **96000**.'."\n" ."\n" .'- Unit: Hz.'."\n" ."\n" .'- Default value: **44100**.'."\n" ."\n" .'> If the container format is flv and the audio codec is mp3, sample rates 32000, 48000, and 96000 are not supported. If the audio codec is mp3, sample rate 96000 is not supported.', 'type' => 'string', 'example' => '32000', 'title' => ''], 'Volume' => [ 'description' => 'Volume control.', 'type' => 'object', 'properties' => [ 'Level' => ['description' => 'Volume adjustment level.'."\n" ."\n" .'- Unit: dB.'."\n" ."\n" .'- Default: **-20 dB**.', 'type' => 'string', 'example' => '-20', 'title' => ''], 'Method' => ['description' => 'Volume adjustment method. Valid values:'."\n" ."\n" .'- **auto**: Automatic adjustment.'."\n" ."\n" .'- **dynamic**: Dynamic adjustment.'."\n" ."\n" .'- **linear**: Linear adjustment.', 'type' => 'string', 'example' => 'auto', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AudioStreamMap' => ['description' => 'Audio stream index.'."\n" ."\n" .'- Format: 0:a:{index}, for example, 0:a:0.'."\n" ."\n" .'- The index is the position in the audio stream list, starting from 0.'."\n" ."\n" .'- If not set, the default audio stream is selected.', 'type' => 'string', 'example' => '0:a:0', 'title' => ''], 'Clip' => [ 'description' => 'Clipping segment.', 'type' => 'object', 'properties' => [ 'TimeSpan' => [ 'description' => 'Clipping time span.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'Duration.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" .'- Valid range: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.', 'type' => 'string', 'example' => '01:00:59.999', 'title' => ''], 'Seek' => ['description' => 'Start time.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" .'- Valid range: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.', 'type' => 'string', 'example' => '01:59:59.999', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Container' => [ 'description' => 'Container.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'Container format.'."\n" ."\n" .'- Default value: **mp4**.'."\n" ."\n" .'- For video transcoding, valid values are flv, mp4, HLS (m3u8+ts), and MPEG-DASH (MPD+fMP4).'."\n" ."\n" .'- For audio transcoding, valid values are mp3, mp4, ogg, flac, and m4a.'."\n" ."\n" .'- For images, valid values are gif and WEBP.'."\n" ."\n" .'- If the container format is gif, VideoCodec must be set to GIF.'."\n" ."\n" .'- If the container format is webp, VideoCodec must be set to WEBP.'."\n" ."\n" .'- If the container format is flv, VideoCodec cannot be set to H265.', 'type' => 'string', 'example' => 'flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'DeWatermark' => ['description' => 'Blur processing, as a JSON object. For more information, see **Blur processing details** in [Parameter details](~~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}]}', 'title' => ''], 'DigiWaterMark' => [ 'description' => 'Digital watermark.', 'type' => 'object', 'properties' => [ 'Alpha' => ['description' => 'Transparency of text or image.'."\n" ."\n" .'- Valid range: **(0,1]**.'."\n" ."\n" .'- Default value: **1.0**.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'InputFile' => [ 'description' => 'Input file.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'OSS bucket for the input file.', 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], 'Location' => ['description' => 'OSS location for the input file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Object' => ['description' => 'OSS object for the input file.', 'type' => 'string', 'example' => 'example-intput.flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Type' => ['description' => 'Watermark type. If set, this value overrides the corresponding parameter in the watermark template. Valid values:'."\n" ."\n" .'- **Image**: Default. Image watermark.'."\n" ."\n" .'- **Text**: Text watermark.', 'type' => 'string', 'example' => 'Image', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Encryption' => [ 'description' => 'Data encryption. Supported only for m3u8 output.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'Encryption ID.', 'type' => 'string', 'example' => '31fa3c9ca8134f9cec2b4b0b0f78****', 'title' => ''], 'Key' => ['description' => 'Encryption key for the video.', 'type' => 'string', 'example' => 'encryptionkey128', 'title' => ''], 'KeyType' => ['description' => 'The encryption key cannot be sent in plaintext to MPS. It must be encrypted using Base64 or KMS. For example, if the key is "encryptionkey128", use Base64("encryptionkey128") or KMS(Base64("encryptionkey128")).', 'type' => 'string', 'example' => 'Base64', 'title' => ''], 'KeyUri' => ['description' => 'URL to access the key, encoded using BASE64.', 'type' => 'string', 'example' => 'https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/', 'title' => ''], 'SkipCnt' => ['description' => 'Number of initial segments to skip encryption (to enable fast playback).', 'type' => 'string', 'example' => '3', 'title' => ''], 'Type' => ['description' => 'Encryption type. Valid value: **hls-aes-128**.', 'type' => 'string', 'example' => 'hls-aes-128', 'title' => ''], ], 'title' => '', 'example' => '', ], 'M3U8NonStandardSupport' => [ 'description' => 'M3U8 non-standard support, as a JSON object. For more information, see **M3U8 non-standard parameter support details** in [Parameter details](~~29253~~).', 'type' => 'object', 'properties' => [ 'TS' => [ 'description' => 'JSON object for TS file non-standard support. For more information, see **TS parameter support details** in [Parameter details](~~29253~~).', 'type' => 'object', 'properties' => [ 'Md5Support' => ['description' => 'Whether to output the MD5 value of TS files in the M3U8 file. Valid values:'."\n" ."\n" .'- **true**: Yes.'."\n" ."\n" .'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SizeSupport' => ['description' => 'Whether to output the size of TS files in the M3U8 file. Valid values:'."\n" ."\n" .'- **true**: Yes.'."\n" ."\n" .'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MergeConfigUrl' => ['description' => 'You can specify either **MergeList** or **MergeConfigUrl**, but not both.'."\n" ."\n" .'- The configuration file specified by MergeConfigUrl supports up to 50 merge segments.'."\n" ."\n" .'- MergeConfigUrl is the URL of the merge configuration file.'."\n" ."\n" .'- The configuration file must be stored in OSS and have permissions granted to MPS for access. See merge parameter details for the internal file content.'."\n" ."\n" .'- Example mergeConfigfile content: `{"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"}]}', 'title' => ''], 'MergeList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Merge' => [ 'description' => 'Video merging configuration.', 'type' => 'array', 'items' => [ 'description' => 'Detailed video merging configuration.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'Duration.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" .'- Examples: 01:59:59.999 or 32000.23.', 'type' => 'string', 'example' => '00000.20', 'title' => ''], 'MergeURL' => ['description' => 'URL of the merge segment.'."\n" ."\n" .'- Example: `http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv`.'."\n" ."\n" .'- The Object value must be URL-encoded using UTF-8 encoding.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv', 'title' => ''], 'RoleArn' => ['description' => 'Role ARN used for agent authorization.', 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], 'Start' => ['description' => 'Start time point.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" .'- Examples: 01:59:59.999 or 32000.23.', 'type' => 'string', 'example' => '00000.50', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'MuxConfig' => [ 'description' => 'Muxing configuration. If you set this parameter in the request, it overrides the corresponding parameter in the specified transcoding template.', 'type' => 'object', 'properties' => [ 'Gif' => [ 'description' => 'GIF muxing configuration.', 'type' => 'object', 'properties' => [ 'DitherMode' => ['description' => 'Dither mode for the color palette. Valid values: **sierra**, **bayer**.', 'type' => 'string', 'example' => 'bayer', 'title' => ''], 'FinalDelay' => ['description' => 'Pause time for the final frame, in centiseconds.', 'type' => 'string', 'example' => '0', 'title' => ''], 'IsCustomPalette' => ['description' => 'Custom color palette feature. Valid values:'."\n" ."\n" .'- **true**: Custom.'."\n" ."\n" .'- **false**: Not custom.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Loop' => ['description' => 'Number of loops.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'Segmentation configuration, as a JSON object.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'Segment duration. Integer, in seconds.'."\n" ."\n" .'- Valid range: **\\[1,10]**.'."\n" ."\n" .'- Default value: **10** seconds.', 'type' => 'string', 'example' => '20', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Webp' => [ 'description' => 'WEBP muxing configuration.', 'type' => 'object', 'properties' => [ 'Loop' => ['description' => 'Number of loops.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'OpeningList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Opening' => [ 'description' => 'Opening list, as a JSON object.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Valid values: **0\\~4096**, **-1**, **full**.'."\n" ."\n" .'- Default value: **-1**.'."\n" ."\n" .'- **-1** means the source height.'."\n" ."\n" .'- **full** means fill the entire screen.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'Start' => ['description' => 'Start time relative to the main video. Delay before displaying the opening video.'."\n" ."\n" .'- Unit: seconds.'."\n" ."\n" .'- Default value: **0**.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Width' => ['description' => 'Width.'."\n" ."\n" .'- Valid values: **0\\~4096**, **-1**, **full**.'."\n" ."\n" .'- Default value: **-1**.'."\n" ."\n" .'- **-1** means the source width.'."\n" ."\n" .'- **full** means fill the entire screen.', 'type' => 'string', 'example' => '1920', 'title' => ''], 'openUrl' => ['description' => 'OSS URL of the opening video.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'OutSubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'OutSubtitle' => [ 'description' => 'Output subtitle list.', 'type' => 'array', 'items' => [ 'description' => 'Output subtitle details.', 'type' => 'object', 'properties' => [ 'Map' => ['description' => 'Video track. Format: `0:{stream}:{stream_index}`, i.e., `0:v:{video_index}`. Stream values: v = video. Index is the position in the video track list, starting from 0.', 'type' => 'string', 'example' => '0:v:0', 'title' => ''], 'Message' => ['description' => 'Error message if job creation fails. This parameter is not returned if job creation succeeds.', 'type' => 'string', 'example' => 'The specified parameter “%s” cannot be null.', 'title' => ''], 'OutSubtitleFile' => [ 'description' => 'Output file details.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'OSS bucket for the input file.', 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], 'Location' => ['description' => 'OSS location for the output file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Object' => ['description' => 'OSS object for the output file.', 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], 'RoleArn' => ['description' => 'Role ARN used for agent authorization.', 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Whether the operation was successful. Valid values:'."\n" ."\n" .'- **true**: Success.'."\n" ."\n" .'- **false**: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'OutputFile' => [ 'description' => 'Output file.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'OSS bucket for the input file.', 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], 'Location' => ['description' => 'OSS location for the output file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Object' => ['description' => 'OSS object for the output file.', 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], 'RoleArn' => ['description' => 'Role ARN used for agent authorization.', 'type' => 'string', 'example' => 'acs:ram:::role/', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Priority' => ['description' => 'Priority of the job within its corresponding pipeline.'."\n" ."\n" .'- Highest priority: **10**.'."\n" ."\n" .'- Default value: **6**.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Properties' => [ 'description' => 'Media properties.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Duration' => ['description' => 'Duration.', 'type' => 'string', 'example' => '55', 'title' => ''], 'FileFormat' => ['description' => 'File format.', 'type' => 'string', 'example' => 'QuickTime / MOV', 'title' => ''], 'FileSize' => ['description' => 'File size.', 'type' => 'string', 'example' => '3509895', 'title' => ''], 'Format' => [ 'description' => 'Format information.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'Total bitrate.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Duration' => ['description' => 'Total duration.', 'type' => 'string', 'example' => '55', 'title' => ''], 'FormatLongName' => ['description' => 'Long name of the container or encapsulation format.', 'type' => 'string', 'example' => 'QuickTime / MOV', 'title' => ''], 'FormatName' => ['description' => 'Short name of the container or encapsulation format. Valid values: mov, mp4, m4a, 3gp, 3g2, mj2.', 'type' => 'string', 'example' => 'mov', 'title' => ''], 'NumPrograms' => ['description' => 'Total number of program streams.', 'type' => 'string', 'example' => '0', 'title' => ''], 'NumStreams' => ['description' => 'Total number of media streams.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Size' => ['description' => 'File size.', 'type' => 'string', 'example' => '3509895', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Fps' => ['description' => 'Frame rate, numeric.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Height' => ['description' => 'Video height.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Streams' => [ 'description' => 'Stream information.', 'type' => 'object', 'properties' => [ 'AudioStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AudioStream' => [ 'description' => 'Audio stream list.', 'type' => 'array', 'items' => [ 'description' => 'Audio stream details.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '128.806', 'title' => ''], 'ChannelLayout' => ['description' => 'Sound channel output style.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], 'Channels' => ['description' => 'Number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'CodecLongName' => ['description' => 'Long name of the encoding format.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'CodecName' => ['description' => 'Short name of the encoding format.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'CodecTag' => ['description' => 'Encoding format tag.', 'type' => 'string', 'example' => '0x6134706d', 'title' => ''], 'CodecTagString' => ['description' => 'Encoding format tag text.', 'type' => 'string', 'example' => 'mp4a', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'Duration' => ['description' => 'Duration.', 'type' => 'string', 'example' => '17.159546', 'title' => ''], 'Index' => ['description' => 'Audio stream index. Identifies the position of the audio stream within the entire media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Lang' => ['description' => 'Language. For more information, see [FFmpeg language definition](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'NumFrames' => ['description' => 'Total number of frames.', 'type' => 'string', 'example' => '25', 'title' => ''], 'SampleFmt' => ['description' => 'Sampling format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'Samplerate' => ['description' => 'Sample rate.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'Timebase' => ['description' => 'Time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubtitleStream' => [ 'description' => 'Subtitle stream list.', 'type' => 'array', 'items' => [ 'description' => 'Subtitle stream details.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Subtitle stream index. Identifies the position of the subtitle stream within the entire media stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Lang' => ['description' => 'Language. For more information, see [FFmpeg language definition](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).', 'type' => 'string', 'example' => 'eng', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'VideoStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoStream' => [ 'description' => 'Video stream list.', 'type' => 'array', 'items' => [ 'description' => 'Video stream details.', 'type' => 'object', 'properties' => [ 'AvgFPS' => ['description' => 'Average frame rate.', 'type' => 'string', 'example' => '23.976025', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '1496.46', 'title' => ''], 'CodecLongName' => ['description' => 'Long name of the encoding format.', 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'title' => ''], 'CodecName' => ['description' => 'Short name of the encoding format.', 'type' => 'string', 'example' => 'h264', 'title' => ''], 'CodecTag' => ['description' => 'Encoding format tag.', 'type' => 'string', 'example' => '0x31637661', 'title' => ''], 'CodecTagString' => ['description' => 'Encoding format tag text.', 'type' => 'string', 'example' => 'avc1', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec time base.', 'type' => 'string', 'example' => '1001/48000', 'title' => ''], 'Dar' => ['description' => 'Display aspect ratio.', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'Duration' => ['description' => 'Duration.', 'type' => 'string', 'example' => '17.225542', 'title' => ''], 'Fps' => ['description' => 'Frame rate.', 'type' => 'string', 'example' => '23.976025', 'title' => ''], 'HasBFrames' => ['description' => 'Whether B-frames exist.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Height' => ['description' => 'Video resolution height.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Index' => ['description' => 'Video stream index. Identifies the position of the video stream within the entire media stream.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Lang' => ['description' => 'Language. For more information, see [FFmpeg language definition](https://www.ffmpeg.org/ffmpeg-all.html#Metadata) and [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'Level' => ['description' => 'Encoding profile.', 'type' => 'string', 'example' => '51', 'title' => ''], 'NetworkCost' => [ 'description' => 'Network bandwidth consumption.', 'type' => 'object', 'properties' => [ 'AvgBitrate' => ['description' => 'Average bitrate.', 'type' => 'string', 'example' => '100', 'title' => ''], 'CostBandwidth' => ['description' => 'Maximum bandwidth consumed.', 'type' => 'string', 'example' => '10', 'title' => ''], 'PreloadTime' => ['description' => 'Preload time.', 'type' => 'string', 'example' => '8', 'title' => ''], ], 'title' => '', 'example' => '', ], 'NumFrames' => ['description' => 'Total number of frames.', 'type' => 'string', 'example' => '25', 'title' => ''], 'PixFmt' => ['description' => 'Pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Profile' => ['description' => 'Codec profile.', 'type' => 'string', 'example' => 'high', 'title' => ''], 'Sar' => ['description' => 'Sample aspect ratio.', 'type' => 'string', 'example' => '1:1', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'Timebase' => ['description' => 'Time base.', 'type' => 'string', 'example' => '1/24000', 'title' => ''], 'Width' => ['description' => 'Video resolution width, numeric.', 'type' => 'string', 'example' => '1280', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Width' => ['description' => 'Video width.', 'type' => 'string', 'example' => '1280', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Rotate' => ['description' => 'Clockwise rotation angle of the video.', 'type' => 'string', 'example' => '180', 'title' => ''], 'SubtitleConfig' => [ 'description' => 'Subtitle configuration information.', 'type' => 'object', 'properties' => [ 'ExtSubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ExtSubtitle' => [ 'description' => 'List of external subtitles. A JSON array with a maximum of **4** items.', 'type' => 'array', 'items' => [ 'description' => 'External subtitle details.', 'type' => 'object', 'properties' => [ 'CharEnc' => ['description' => 'Character encoding for external subtitles.'."\n" ."\n" .'- Range: **UTF-8**, **GBK**, **BIG5**, **auto**.'."\n" ."\n" .'- Default: **auto**.'."\n" ."\n" .'> When the external subtitle character encoding is set to **auto**, detection errors may occur. We recommend specifying a specific character encoding.', 'type' => 'string', 'example' => 'UTF-8', 'title' => ''], 'FontName' => ['description' => 'Font name for converting external subtitles to hard subtitles. Default: **SimSun**. For more font information, see [Font list](~~59950~~).', 'type' => 'string', 'example' => '"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"', 'title' => ''], 'Input' => [ 'description' => 'JSON object for the external input subtitle file. Currently supports **srt** and **ass** formats.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'OSS bucket for the input file.', 'type' => 'string', 'example' => 'example-bucket-****', 'title' => ''], 'Location' => ['description' => 'OSS location for the input file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Object' => ['description' => 'OSS object for the input file.', 'type' => 'string', 'example' => 'example-output.flv', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Subtitle' => [ 'description' => 'Subtitle list.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'Map' => ['description' => 'Audio track. Format: `0:{stream}:{stream_index}`, i.e., `0:a:{audio_index}`. The stream value is a for audio stream. The index is the position in the audio stream list, starting from 0.', 'type' => 'string', 'example' => '0:a:0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'SuperReso' => [ 'description' => 'Resolution follows source.', 'type' => 'object', 'properties' => [ 'IsHalfSample' => ['description' => 'Whether to get sample rate related parameters. Valid values:'."\n" ."\n" .'- **true**: Yes.'."\n" ."\n" .'- **false**: No.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TailSlateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TailSlate' => [ 'description' => 'End slate list, as a JSON object.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'BgColor' => ['description' => 'If the width and height of the end slate video are smaller than the main video, set the background color for the blank areas. Default is **White**. For more values, see [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', 'title' => ''], 'BlendDuration' => ['description' => 'Transition duration between the main video and the end slate. The effect is a fade-in/fade-out: the last frame of the main video is displayed while the end slate video plays. The last frame of the main video gradually fades out, and the end slate video gradually fades in. Unit: seconds. Default: **0**.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Valid values: **0\\~4096**, **-1**, **full**.'."\n" ."\n" .'- **-1** means the source height, **full** means fill the entire screen.'."\n" ."\n" .'- Default: \\*\\*-1\\*\\*.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'IsMergeAudio' => ['description' => 'Whether to merge the audio content of the end slate video. Valid values:'."\n" ."\n" .'- **true**: Merge.'."\n" ."\n" .'- **false**: Do not merge.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Start' => ['description' => 'Start time.', 'type' => 'string', 'example' => '1', 'title' => ''], 'TailUrl' => ['description' => 'OSS URL of the end slate video.', 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv', 'title' => ''], 'Width' => ['description' => 'Width.'."\n" ."\n" .'- Valid values: **0\\~4096**, **-1**, **full**.'."\n" ."\n" .'- **-1** means the source width, **full** means fill the entire screen.'."\n" ."\n" .'- Default: \\*\\*-1\\*\\*.', 'type' => 'string', 'example' => '1920', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TemplateId' => ['description' => 'Transcoding template ID.', 'type' => 'string', 'example' => 'S00000000-000010', 'title' => ''], 'TransConfig' => [ 'description' => 'General transcoding configuration.'."\n" ."\n" .'> If you set this value in the request, it overrides the corresponding parameter in the specified transcoding template.', 'type' => 'object', 'properties' => [ 'AdjDarMethod' => ['description' => 'Resolution rewriting method. Default: **none**. Valid values:'."\n" ."\n" .'- rescale: Rescale.'."\n" ."\n" .'- crop: Crop.'."\n" ."\n" .'- pad: Pad.'."\n" ."\n" .'- none: Do not rewrite.', 'type' => 'string', 'example' => 'crop', 'title' => ''], 'IsCheckAudioBitrate' => ['description' => 'Whether to check the audio bitrate. If the output audio bitrate is greater than the source audio bitrate, the output audio bitrate is considered equal to the source audio bitrate, meaning the set audio bitrate parameter will not take effect. This value has a lower priority than IsCheckAudioBitrateFail.'."\n" ."\n" .'- **true** means check.'."\n" ."\n" .'- **false** means do not check.'."\n" ."\n" .'- Default value:'."\n" ."\n" .' - If the parameter is empty and the codec is different from the source: false.'."\n" ."\n" .' - If the parameter is empty and the codec is the same as the source: true.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Whether to check the audio bitrate. This value has a higher priority than **IsCheckAudioBitrate**. If the output audio bitrate is greater than the source audio bitrate, transcoding is not performed, and the job fails directly.'."\n" ."\n" .'- **false**: Check.'."\n" ."\n" .'- **true**: Do not check.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckReso' => ['description' => 'Whether to check the resolution. If the output resolution is greater than the input resolution (based on width or height), the output resolution is considered equal to the input resolution.'."\n" ."\n" .'- **true** means check.'."\n" ."\n" .'- **false** means do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Whether to check the resolution. This value has a higher priority than IsCheckReso. If the output resolution is greater than the input resolution (based on width or height), transcoding is not performed, and the job fails directly.'."\n" ."\n" .'- **true**: Check.'."\n" ."\n" .'- **false**: Do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Whether to check the video bitrate. If the output video bitrate is greater than the input video bitrate, the output video bitrate is considered equal to the input video bitrate.'."\n" ."\n" .'- **true** means check.'."\n" ."\n" .'- **false** means do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Whether to check the bitrate. If the output video bitrate is greater than the source video bitrate, transcoding is not performed, and the job fails directly. This value has a higher priority than **IsCheckVideoBitrate**.'."\n" ."\n" .'- **true** means check.'."\n" ."\n" .'- **false** means do not check.'."\n" ."\n" .'- Default value: **false**.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'TransMode' => ['description' => 'Transcoding mode. Valid values:'."\n" ."\n" .'- **onepass**: Based on the One-Pass algorithm, with good accuracy.'."\n" ."\n" .'- **twopass**: Based on the Two-Pass algorithm, with lower accuracy.'."\n" ."\n" .'- **CBR**: Constant bit rate.', 'type' => 'string', 'example' => 'onepass', 'title' => ''], ], 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'User-defined data.', 'type' => 'string', 'example' => 'example data', 'title' => ''], 'Video' => [ 'description' => 'Video configuration.'."\n" ."\n" .'> If specified, this replaces the **AliyunVideoCodec** settings of the template specified by **TemplateId**.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'Bitrate of the output video file. Unit: Kbps.', 'type' => 'string', 'example' => '10', 'title' => ''], 'BitrateBnd' => [ 'description' => 'Average video bitrate range.', 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'Maximum total bitrate. Unit: Kbps.', 'type' => 'string', 'example' => '20', 'title' => ''], 'Min' => ['description' => 'Minimum total bitrate. Unit: Kbps.', 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Bufsize' => ['description' => 'Buffer size.'."\n" ."\n" .'- Unit: Kb.'."\n" ."\n" .'- Default value: **6000**.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Codec' => ['description' => 'Codec format.'."\n" ."\n" .'- Supports **H.264**, **H.265**, **GIF**, **WEBP**.'."\n" ."\n" .'- Default value: **H.264**.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Crf' => ['description' => 'Rate-quality control factor.'."\n" ."\n" .'- If **Crf** is set, the **Bitrate** setting is ignored.'."\n" ."\n" .'- Default value: **23** for H.264 codec, **26** for H.265 codec.', 'type' => 'string', 'example' => '22', 'title' => ''], 'Crop' => ['description' => 'Video frame cropping. Supports 2 methods:'."\n" ."\n" .'- Auto-detect and crop black bars: set to **border**.'."\n" ."\n" .'- Custom crop: parameter format is width:height:left:top.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Degrain' => ['description' => 'Independent denoising algorithm strength.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Fps' => ['description' => 'Frame rate.'."\n" ."\n" .'- Unit: fps.'."\n" ."\n" .'- Valid range: 0-60. If the input file frame rate exceeds 60, it is set to 60.'."\n" ."\n" .'- Default value: The frame rate of the input file.', 'type' => 'string', 'example' => '60', 'title' => ''], 'Gop' => ['description' => 'Maximum time interval or maximum number of frames between keyframes. Unit: seconds (s).'."\n" ."\n" .'- Default value: 10s.'."\n" ."\n" .'- No unit for maximum number of frames.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'- Default value: Original video height.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'MaxFps' => ['description' => 'Maximum frame rate.', 'type' => 'string', 'example' => '15', 'title' => ''], 'Maxrate' => ['description' => 'Peak video bitrate. Unit: Kbps.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Pad' => ['description' => 'Video padding with black bars.'."\n" ."\n" .'- Parameter format: width:height:left:top.'."\n" ."\n" .'- Unit: px.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'PixFmt' => ['description' => 'Video color format.'."\n" ."\n" .'- Default value: **yuv420p** or original color format.'."\n" ."\n" .'- Valid values: **yuv420p**, **yuvj420p**, and other standard color formats.'."\n" ."\n" .' > Non-standard color formats (such as yuvj420p(pc, bt470bg/bt470bg/smpte170m)) require compatibility configuration, otherwise transcoding will fail.', 'type' => 'string', 'example' => 'yuvj420p', 'title' => ''], 'Preset' => ['description' => 'Video algorithm preset. Default: **medium**. Valid values:'."\n" ."\n" .'- **veryfast**: Super fast.'."\n" ."\n" .'- **fast**: Fast.'."\n" ."\n" .'- **medium**: Medium.'."\n" ."\n" .'- **slow**: Slow.'."\n" ."\n" .'- **slower**: Slower.', 'type' => 'string', 'example' => 'veryfast', 'title' => ''], 'Profile' => ['description' => 'Encoding profile. Currently only supported for H.264. Default: **high**. Valid values:'."\n" ."\n" .'> If you have multiple definitions, we recommend setting the lowest definition to baseline to ensure playback on low-end devices. Set other definitions to main or high.'."\n" ."\n" .'- **baseline**: For mobile devices.'."\n" ."\n" .'- **main**: For standard resolution devices.'."\n" ."\n" .'- **high**: For high resolution devices.', 'type' => 'string', 'example' => 'baseline', 'title' => ''], 'Qscale' => ['description' => 'Video quality control value.', 'type' => 'string', 'example' => '15', 'title' => ''], 'ResoPriority' => ['description' => 'Resource priority.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ScanMode' => ['description' => 'Scan mode. Valid values:'."\n" ."\n" .'- **Not set**: Use the original mode of the input file.'."\n" ."\n" .'- **auto**: Automatic deinterlacing.'."\n" ."\n" .'- **progressive**: Progressive scan.'."\n" ."\n" .'- **interlaced**: Interlaced scan.'."\n" ."\n" .'- **Default value**: Empty, meaning not set.'."\n" ."\n" .'**Best practice**: Although interlaced scanning saves more data than progressive scanning, its image quality is poor. Therefore, mainstream video production now uses progressive scanning.'."\n" ."\n" .'- If you set **progressive** or **interlaced** scan, but it does not match the original video mode, transcoding will fail.'."\n" ."\n" .'- We recommend setting it to the **original video mode** or **automatic deinterlacing** to improve compatibility.', 'type' => 'string', 'example' => 'interlaced', 'title' => ''], 'Width' => ['description' => 'Width.'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'- Default value: **Original video width**.', 'type' => 'string', 'example' => '1080', 'title' => ''], ], 'title' => '', 'example' => '', ], 'VideoStreamMap' => ['description' => 'Video stream index.'."\n" ."\n" .'- Format: 0:a:{index}, for example, 0:a:0.'."\n" ."\n" .'- The index is the position in the audio stream list, starting from 0.'."\n" ."\n" .'- If not set, the default video stream is selected.', 'type' => 'string', 'example' => '0:a:0', 'title' => ''], 'WaterMarkConfigUrl' => ['description' => 'Watermark configuration file URL.', 'type' => 'string', 'example' => 'http://example.com/configure', 'title' => ''], 'WaterMarkList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'WaterMark' => [ 'description' => 'Watermark list.'."\n" ."\n" .'> If the watermark output is truncated or fails, check if your text watermark contains special characters. If it does, escape the special characters before passing them, or [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?product=mts)[submit a ticket](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.dticket.68797bbcm8H408#/ticket/add/?productId=1232) to Alibaba Cloud support for compatibility handling.', 'type' => 'array', 'items' => [ 'description' => 'Watermark details.', 'type' => 'object', 'properties' => [ 'Dx' => ['description' => 'The horizontal offset of the watermark image relative to the output video. If set in the request, this value overrides the corresponding parameter in the watermark template. The default value is 0. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the offset in pixels.'."\n" ."\n" .' - Range: **\\[8,4096]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio of the horizontal offset to the output video width.'."\n" ."\n" .' - Range: (0,1).'."\n" ."\n" .' - Supports up to four decimal places, for example, 0.9999. Any extra digits are discarded.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Dy' => ['description' => 'The vertical offset of the watermark image relative to the output video. If set in the request, this value overrides the corresponding parameter in the watermark template. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the vertical offset in pixels.'."\n" ."\n" .' - Range: **\\[8,4096]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio of the vertical offset to the output video height.'."\n" ."\n" .' - Range: **(0,1)**.'."\n" ."\n" .' - Supports up to four decimal places, for example, 0.9999. Any extra digits are discarded.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Height' => ['description' => 'Height of the watermark image. If set in the request, this value overrides the corresponding parameter in the watermark template. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the height in pixels.'."\n" ."\n" .' - Range: **\\[8,4096]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio of the watermark height to the output video height.'."\n" ."\n" .' - Range: **(0,1)**.'."\n" ."\n" .' - Supports up to four decimal places, for example, 0.9999. Any extra digits are discarded.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'InputFile' => [ 'description' => 'The watermark input file. Currently supports PNG images and MOV files as input.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'OSS bucket for the input file.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], 'Location' => ['description' => 'OSS location for the input file.', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], 'Object' => ['description' => 'OSS object for the input file.', 'type' => 'string', 'example' => 'example-logo-****.png', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ReferPos' => ['description' => 'The position of the watermark. If set in the request, this value overrides the corresponding parameter in the watermark template. Valid values:'."\n" ."\n" .'- **TopRight**: Top right.'."\n" ."\n" .'- **TopLeft**: Top left.'."\n" ."\n" .'- **BottomRight**: Bottom right.'."\n" ."\n" .'- **BottomLeft**: Bottom left.', 'type' => 'string', 'example' => 'TopRight', 'title' => ''], 'Type' => ['description' => 'Watermark type. If set in the request, this value overrides the corresponding parameter in the watermark template. For more information, see [Parameter details](~~29253~~). Valid values:'."\n" ."\n" .'- **Image**: Image watermark.'."\n" ."\n" .'- **Text**: Text watermark.', 'type' => 'string', 'example' => 'Image', 'title' => ''], 'WaterMarkTemplateId' => ['description' => 'Watermark template ID.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Width' => ['description' => 'Width of the watermark image. If set in the request, this value overrides the corresponding parameter in the watermark template. The value can be in two forms:'."\n" ."\n" .'- Integer: Represents the width in pixels.'."\n" ."\n" .' - Range: **\\[8,4096]**.'."\n" ."\n" .' - Unit: px.'."\n" ."\n" .'- Decimal: Represents the ratio of the watermark width to the output video width.'."\n" ."\n" .' - Range: **(0,1)**.'."\n" ."\n" .' - Supports up to four decimal places, for example, 0.9999. Any extra digits are discarded.', 'type' => 'string', 'example' => '1080', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Percent' => ['description' => 'Transcoding progress.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'PipelineId' => ['description' => 'Pipeline ID.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a126797', 'title' => ''], 'State' => ['description' => 'Job status.'."\n" ."\n" .'- **Submitted**: The job has been submitted.'."\n" ."\n" .'- **TranscodeFail**: Transcoding failed.', 'type' => 'string', 'example' => 'Submitted', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Error message if job creation fails. This parameter is not returned if the job is created successfully.', 'type' => 'string', 'example' => 'The specified parameter "%s" cannot be null.', 'title' => ''], 'Success' => ['description' => 'Whether the operation was successful. Valid values:'."\n" ."\n" .'- **true**: Success.'."\n" ."\n" .'- **false**: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A45S71F6-D73936451234', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'SubmitJobs', 'description' => '- Transcoding jobs are [asynchronous jobs](~~3027615~~). They are not guaranteed to be executed immediately. After you submit a transcoding job, it is added to an MPS queue and waits for scheduling. Therefore, the API response does not indicate that the transcoding is complete. To check the result, you can call the [QueryTranscodeJobList](~~602836~~) operation to poll for the status, or configure MNS message notifications for the queue. For more information, see [Receive message notifications](https://help.aliyun.com/document_detail/42618.html)[Receive message notifications](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications).'."\n" ."\n" .'- The maximum size of a single input file is 100 GB. Larger files may cause the job to fail.'."\n" ."\n" .'- To transcode an input file using a **preset intelligent template**, first call the SubmitAnalysisJob operation ([SubmitAnalysisJob](~~29223~~)) to submit a template analysis job. After the analysis job is successful, call the QueryAnalysisJobList operation ([QueryAnalysisJobList](~~29224~~)) to retrieve the list of available preset templates for the input file. When you submit the transcoding job, set the TemplateId parameter to one of the available preset template IDs. If the specified template is not in the list of available preset templates, the transcoding job fails.'."\n" ."\n" .'- To transcode an input file using a **preset static template**, you do not need to submit a template analysis job.'."\n" ."\n" .'- To use multiple Alibaba Cloud accounts with MPS, you can create RAM users for your Alibaba Cloud account. For more information, see [Create a RAM user and grant permissions](~~42841~~). If you submit and query a transcoding job using different Alibaba Cloud accounts, no data is returned in the query results.'."\n" ."\n" .''."\n" ."\n" .'- If your account has overdue payments, your service is suspended within 24 hours after the due date. For more information, see [Overdue payments](~~29203~~).'."\n" ."\n" .''."\n" ."\n\n" .'- For answers to frequently asked questions about transcoding, see the [ApsaraVideo Media Processing FAQ](~~38986~~).'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The QPS limit for this operation is 100 requests per second per user. Exceeding this limit triggers rate limiting, which may affect your business. Call this operation accordingly. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitJobs'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], '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' => 'The OSS URL of the media file to censor. Video and audio files are supported. You can obtain the URL from the **MPS console** under **Media Management** > **Media List**. To censor an image file, use the `CoverImage` parameter. Specify this parameter as a JSON object. For details, see the [Input details](~~29253~~).'."\n" ."\n" .'- Bucket: The name of the input file\'s OSS bucket.'."\n" ."\n" .'- Location: The OSS region. This must match the region of your MPS service.'."\n" ."\n" .'- Object: The OSS object to scan.'."\n" ."\n" .' > The object name cannot start with a forward slash (/). Otherwise, the API call fails.', 'type' => 'string', 'required' => false, 'example' => '{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.flv"}', 'title' => ''], ], [ 'name' => 'CoverImages', 'in' => 'query', 'schema' => ['description' => 'The OSS URLs of the cover images. You can obtain the URLs from the **MPS console** under **Media Management** > **Media List**. You can specify up to five cover images. Specify the URLs as a JSON array.'."\n" ."\n" .'- Bucket: The name of the input file\'s OSS bucket.'."\n" ."\n" .'- Location: The OSS region. This must match the region of your MPS service.'."\n" ."\n" .'- Object: The OSS object to scan.'."\n" ."\n" .' > The object name cannot start with a forward slash (/). Otherwise, the API call fails.', 'type' => 'string', 'required' => false, 'example' => '[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg"}]', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the video. The maximum length is 64 bytes.', 'type' => 'string', 'required' => false, 'example' => 'Hello World', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the video. The maximum length is 128 bytes.', 'type' => 'string', 'required' => false, 'example' => 'example description', 'title' => ''], ], [ 'name' => 'Barrages', 'in' => 'query', 'schema' => ['description' => 'The barrage comments, provided as a string.', 'type' => 'string', 'required' => false, 'example' => 'hello world', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the pipeline that is used for message notifications. You can obtain the ID from the **MPS console** under **Global Settings** > **Pipelines**. If you do not specify this parameter, the default pipeline is used. The default pipeline has a concurrency of 10. To increase the concurrency, submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/mts/recommend/1186)[ticket](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.ditem-sub.35da7bbcitpQnr#/ticket/createIndex).'."\n" ."\n" .'> Currently, pipelines can only be created on the backend. To query and update pipelines, see [Update a pipeline](~~188374~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'b22c173cced04565b1f38f1ecc39****', 'title' => ''], ], [ 'name' => 'VideoCensorConfig', 'in' => 'query', 'schema' => ['description' => 'The video censorship configuration and the OSS URL for output snapshots. You can obtain the URL from the **MPS console** under **Media Management** > **Media List**.'."\n" ."\n" .'This parameter is a JSON object.'."\n" ."\n" .'- OutputFile:'."\n" ."\n" .' - Bucket: The name of the output OSS bucket.'."\n" ."\n" .' - Location: The OSS region. This must be the same as the region where the MPS service resides.'."\n" ."\n" .' - Object: The OSS object for the output. The {Count} placeholder is replaced with the sequence number of the snapshot.'."\n" ."\n" .' The detailed censorship results are saved in a file named {jobId}.output in the same directory as the OutputFile. For information about the fields in the output file, see [Fields in the media censorship result file](~~609186~~).'."\n" ."\n" .'- StoreVideoTimeline: Specifies whether to generate a `{jobId}.video_timeline` file and store it in OSS. Set the value to `true` to generate the file. If you set the value to `false` or omit the parameter, the system does not generate the file. For details about the file format, see [Query a media job (videoTimeline example)](~~91779~~).'."\n" ."\n" .'- SaveType: The output mode. `abnormal` saves only snapshots of problematic content. `all` saves all snapshots.'."\n" ."\n" .'- Biztype: The censorship template. The default value is `common`. To use a custom censorship template, you must submit a ticket. After your custom template is configured, set this parameter to your user ID (UID).'."\n" ."\n" .'- Scene: The detection scenes. You can select one or more scenes. If you do not specify this parameter, the system defaults to the `porn` and `terrorism` scenes. Valid scenes:'."\n" ."\n" .' - `porn`: pornographic content'."\n" ."\n" .' - `terrorism`: terrorist content'."\n" ."\n" .' - `ad`: text-image policy violations'."\n" ."\n" .' - `live`: undesirable scenes'."\n" ."\n" .' - `logo`: logos'."\n" ."\n" .' - `audio`: audio anti-spam'."\n" ."\n" .'> For input files that have an audio track, the `audio` scene performs audio censorship. Do not specify the `audio` scene for input files that do not have an audio track.', '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"}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'Custom user data. The maximum length is 128 bytes.', 'type' => 'string', 'required' => false, 'example' => 'UserDatatestid-001-****', 'title' => ''], ], [ 'name' => 'ExternalUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the video.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/video-****/test-****.mp4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'JobId' => ['description' => 'The ID of the media censor job. Save this ID for subsequent API calls.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","type":"json"}]', 'title' => 'SubmitMediaCensorJob', 'summary' => 'Submits a media censor job.', 'description' => '- This is an [asynchronous API](~~3027615~~). After you submit a job, the system returns a job ID and queues it for asynchronous processing. The final results are delivered through a callback notification. You can also call the [Query a media censor job](~~91779~~) operation to check the job status.'."\n" ."\n" .'- Media censorship is available in the China (Beijing), China (Shanghai), and Asia Pacific SE 1 (Singapore) regions. This feature is not supported in other regions.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The queries per second (QPS) limit for this API is 100 per user. API calls that exceed this limit are rate-limited, which can affect your business. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => '**Asynchronous notification message parameters**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| :------------------- | :------------------------- | :------------------------------------------------ |'."\n" .'| Type | String | The type of the message. Value: MediaCensor. |'."\n" .'| MediaCensorJobNotify | AliyunMediaCensorJobNotify | The notification object for the media censor job. |'."\n" .'| UserData | String | The custom user data. |', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-23T06:13:24.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaCensorJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitMediaCensorJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitMediaInfoJob' => [ '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' => 'Job input. For more information, see [Input details](~~29253#section-f3p-d24-y2b~~).'."\n" ."\n" .'> - In MPS APIs, the Object value must be URL encoded using UTF-8.'."\n" ."\n" .'- The region of the OSS bucket must match the region where MPS is deployed.', 'type' => 'string', 'required' => true, 'example' => '{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Fexample.flv"}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'User-defined data. You can use letters, digits, and hyphens (-). It cannot start with a special character. Maximum length: 1024 bytes.', 'type' => 'string', 'required' => false, 'example' => 'testid-001', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'Pipeline ID. For more information, see [Terms](~~29197~~).'."\n" ."\n" .'- You can find or create pipelines in the [MPS console](https://mps.console.aliyun.com/overview)>**Settings**>**Pipelines**.'."\n" ."\n" .'- To receive asynchronous notifications, attach an MNS topic to the pipeline. For more information, see [Receive message notifications](https://help.aliyun.com/document_detail/42618.html) and [Receive message notifications](https://www.alibabacloud.com/help/en/mps/receive-message-notifications/?spm=a2c63.p38356.0.0.b48576d2jxNSca).', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e432bbf5b665e2a15****', 'title' => ''], ], [ 'name' => 'Async', 'in' => 'query', 'schema' => ['description' => 'Specify whether to run the job asynchronously. Valid values:'."\n" ."\n" .'- **true**: Run the job asynchronously. We recommend this option.'."\n" ."\n" .'- **false**: Run the job synchronously.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'MediaInfoJob' => [ 'description' => 'Detailed information about the media information analysis job.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'Time when the job was submitted.', 'type' => 'string', 'example' => '2014-01-10T12:00:00Z', 'title' => ''], 'State' => ['description' => 'Job status.'."\n" ."\n" .'- **Success**: The job succeeded.'."\n" ."\n" .'- **Fail**: The job failed.'."\n" ."\n" .'- **Analyzing**: The job is running.', 'type' => 'string', 'example' => 'Analyzing', 'title' => ''], 'JobId' => ['description' => 'ID of the media information analysis job.', 'type' => 'string', 'example' => '23ca1d184c0e4341e5b665e2a12****', 'title' => ''], 'UserData' => ['description' => 'User-defined data.', 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'Code' => ['description' => 'Error code if the job fails.', 'type' => 'string', 'example' => 'InvalidParameter.JsonObjectFormatInvalid', 'title' => ''], 'Message' => ['description' => 'Error message if the job fails.', 'type' => 'string', 'example' => 'The parameter ”*” does not conform to the JSON Object specification', 'title' => ''], 'PipelineId' => ['description' => 'Pipeline ID.', 'type' => 'string', 'example' => '88c6ca184c0e432bbf5b665e2a15****', 'title' => ''], 'Async' => ['description' => 'Whether the job runs asynchronously.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Input' => [ 'description' => 'Job input information.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'OSS object of the input file.', 'type' => 'string', 'example' => 'example.flv', 'title' => ''], 'Location' => ['description' => 'Region of the OSS bucket.', 'type' => 'string', 'example' => 'example-location', 'title' => ''], 'Bucket' => ['description' => 'OSS bucket of the input file.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MNSMessageResult' => [ 'description' => 'MNS notification result for job completion.', 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'Message ID if the job succeeds. This parameter is not returned if the job fails.', 'type' => 'string', 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message if the job fails. This parameter is not returned if the job succeeds.', 'type' => 'string', 'example' => 'InvalidParameter.JsonObjectFormatInvalid', 'title' => ''], 'ErrorCode' => ['description' => 'Error code if the job fails. This parameter is not returned if the job succeeds.', 'type' => 'string', 'example' => 'The parameter \\"Input\\" does not conform to the JSON Object specification', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Properties' => [ 'description' => 'Media file properties.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'Video width, in pixels (px).', 'type' => 'string', 'example' => '1920', 'title' => ''], 'Height' => ['description' => 'Video height, in pixels (px).', 'type' => 'string', 'example' => '1080', 'title' => ''], 'Duration' => ['description' => 'Total duration, in seconds (s).', 'type' => 'string', 'example' => '17.226000', 'title' => ''], 'Fps' => ['description' => 'Frame rate.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate, in Kbps.', 'type' => 'string', 'example' => '1630.045', 'title' => ''], 'FileFormat' => ['description' => 'File format.', 'type' => 'string', 'example' => 'QuickTime/MOV', 'title' => ''], 'Streams' => [ 'description' => 'Stream information.', 'type' => 'object', 'properties' => [ 'VideoStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VideoStream' => [ 'description' => 'Video stream list. Maximum: 4 items.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'Sar' => ['description' => 'Sample aspect ratio.', 'type' => 'string', 'example' => '1:1', 'title' => ''], 'Height' => ['description' => 'Video height, in pixels (px).', 'type' => 'string', 'example' => '1080', 'title' => ''], 'CodecTagString' => ['description' => 'Codec tag string.', 'type' => 'string', 'example' => 'avc1', 'title' => ''], 'NetworkCost' => [ 'description' => 'Network bandwidth consumption.', 'type' => 'object', 'properties' => [ 'PreloadTime' => ['description' => 'Preload time.', 'type' => 'string', 'example' => '8', 'title' => ''], 'AvgBitrate' => ['description' => 'Average bitrate, in Kbps.', 'type' => 'string', 'example' => '300.34', 'title' => ''], 'CostBandwidth' => ['description' => 'Maximum bandwidth consumption.', 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Width' => ['description' => 'Video width, in pixels (px).', 'type' => 'string', 'example' => '1920', 'title' => ''], 'Index' => ['description' => 'Video stream index. Identifies the position of the video stream in the media file. Some players let you specify which video stream to start playback from. Others start from index 1 by default.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Timebase' => ['description' => 'Time base.', 'type' => 'string', 'example' => '1/24000', 'title' => ''], 'AvgFPS' => ['description' => 'Average frame rate.', 'type' => 'string', 'example' => '23.976025', 'title' => ''], 'PixFmt' => ['description' => 'Pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Lang' => ['description' => 'Language.', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'CodecLongName' => ['description' => 'Codec long name.', 'type' => 'string', 'example' => 'H.264/AVC/MPEG-4 AVC/MPEG-4 part 10', 'title' => ''], 'NumFrames' => ['description' => 'Total number of frames.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Rotate' => ['description' => 'Video rotation angle, in degrees.', 'type' => 'string', 'example' => '90', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate, in Kbps.', 'type' => 'string', 'example' => '1496.46', 'title' => ''], 'HasBFrames' => ['description' => 'Whether B-frames exist. 0 means no. 1 means yes.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Profile' => ['description' => 'Codec profile.', 'type' => 'string', 'example' => 'High', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.042000', 'title' => ''], 'Dar' => ['description' => 'Display aspect ratio. Dar = video width / video height. Use this value to determine whether the video is landscape or portrait.', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'CodecName' => ['description' => 'Codec short name. Valid values:'."\n" ."\n" .'- **h264**'."\n" ."\n" .'- **h265**'."\n" ."\n" .'- **gif**'."\n" ."\n" .'- **webp**', 'type' => 'string', 'example' => 'h264', 'title' => ''], 'Duration' => ['description' => 'Duration, in seconds (s).', 'type' => 'string', 'example' => '17.225542', 'title' => ''], 'Fps' => ['description' => 'Frame rate.', 'type' => 'string', 'example' => '25', 'title' => ''], 'CodecTag' => ['description' => 'Codec tag.', 'type' => 'string', 'example' => '0x31637661', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec time base.', 'type' => 'string', 'example' => '1001/48000', 'title' => ''], 'Level' => ['description' => 'Codec level.', 'type' => 'string', 'example' => '41', 'title' => ''], 'ColorRange' => ['description' => 'Color range.', 'type' => 'string', 'example' => '700', 'title' => ''], 'ColorTransfer' => ['description' => 'Color transfer.', 'type' => 'string', 'example' => 'R255 G83 B170', 'title' => ''], 'ColorPrimaries' => ['description' => 'Color primaries.', 'type' => 'string', 'example' => '700', 'title' => ''], 'DurationInaccurate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'DolbyVision' => [ 'type' => 'object', 'properties' => [ 'Profile' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Level' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AudioStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AudioStream' => [ 'description' => 'Audio stream list. Maximum: 4 items.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'Timebase' => ['description' => 'Time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'Index' => ['description' => 'Audio stream index. Identifies the position of the audio stream in the media file.', 'type' => 'string', 'example' => '1', 'title' => ''], 'SampleFmt' => ['description' => 'Sample format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'ChannelLayout' => ['description' => 'Channel layout.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], 'Lang' => ['description' => 'Language.', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'Samplerate' => ['description' => 'Sample rate, in Hz.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'CodecLongName' => ['description' => 'Codec long name.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'Channels' => ['description' => 'Number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'NumFrames' => ['description' => 'Total number of frames.', 'type' => 'string', 'example' => '123', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate, in Kbps.', 'type' => 'string', 'example' => '128.806', 'title' => ''], 'CodecTagString' => ['description' => 'Codec tag string.', 'type' => 'string', 'example' => 'mp4a', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'CodecName' => ['description' => 'Codec short name. Default value: aac. Valid values:'."\n" ."\n" .'- **aac**'."\n" ."\n" .'- **mp3**'."\n" ."\n" .'- **mp4**'."\n" ."\n" .'- **ogg**'."\n" ."\n" .'- **flac**', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Duration' => ['description' => 'Duration, in seconds (s).', 'type' => 'string', 'example' => '17.159546', 'title' => ''], 'CodecTag' => ['description' => 'Codec tag.', 'type' => 'string', 'example' => '0x6134706d', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'DurationInaccurate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubtitleStreamList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubtitleStream' => [ 'description' => 'Subtitle stream list. Maximum: 4 items.', 'type' => 'array', 'items' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'Timebase' => ['description' => 'Time base.', 'type' => 'string', 'example' => '1/1000', 'title' => ''], 'Index' => ['description' => 'Subtitle stream index. Identifies the position of the subtitle stream in the media file.', 'type' => 'string', 'example' => '3', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'CodecName' => ['description' => 'Codec short name. Valid values:'."\n" ."\n" .'- **srt**'."\n" ."\n" .'- **ass**', 'type' => 'string', 'example' => 'ass', 'title' => ''], 'Lang' => ['description' => 'Language.', 'type' => 'string', 'example' => 'eng', 'title' => ''], 'CodecLongName' => ['description' => 'Codec long name.', 'type' => 'string', 'example' => 'ASS (Advanced SSA) subtitle', 'title' => ''], 'Duration' => ['description' => 'Duration, in seconds (s).', 'type' => 'string', 'example' => '1370.116000', 'title' => ''], 'CodecTag' => ['description' => 'Codec tag.', 'type' => 'string', 'example' => '0x0000', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec time base.', 'type' => 'string', 'example' => '0/1', 'title' => ''], 'CodecTagString' => ['description' => 'Codec tag string.', 'type' => 'string', 'example' => '[0][0][0][0]', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Format' => [ 'description' => 'Format information.', 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '0.000000', 'title' => ''], 'NumPrograms' => ['description' => 'Total number of program streams.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Size' => ['description' => 'File size, in bytes.', 'type' => 'string', 'example' => '3509895', 'title' => ''], 'NumStreams' => ['description' => 'Total number of media streams.', 'type' => 'string', 'example' => '2', 'title' => ''], 'FormatLongName' => ['description' => 'Container or wrapper format long name.', 'type' => 'string', 'example' => 'QuickTime/MOV', 'title' => ''], 'Duration' => ['description' => 'Total duration, in seconds (s).', 'type' => 'string', 'example' => '17.226000', 'title' => ''], 'Bitrate' => ['description' => 'Total bitrate, in Kbps.', 'type' => 'string', 'example' => '1630.045', 'title' => ''], 'FormatName' => ['description' => 'Container or wrapper format short name. For more information, see [Parameter details](~~29253~~).', 'type' => 'string', 'example' => 'mov', 'title' => ''], 'Tags' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'FileSize' => ['description' => 'File size, in bytes.', 'type' => 'string', 'example' => '3509895', 'title' => ''], 'MD5' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '62D9BE16-B7D5-550C-A482-7A0F60E09877', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'SubmitMediaInfoJob', 'summary' => 'Submits a media information analysis job. After you call this operation, ApsaraVideo Media Processing (MPS) analyzes the media information of the input file and returns the results.', 'description' => '- Ensure that the file is uploaded to OSS before you submit a media information analysis job. Otherwise, the job fails. You can use **OSS callback messages** to confirm the upload status.'."\n" ."\n" .'- Media information analysis jobs support synchronous and asynchronous modes.'."\n" ."\n" .'- The asynchronous mode does not guarantee timeliness. After you submit a job, it enters the MPS queue and waits for scheduling. The job may not be created at the time the API returns a response. To retrieve the result, you can poll the [QueryMediaInfoJob](~~602828~~) operation or configure MNS message notifications for the MPS queue. For more information, see [Receive message notifications](https://help.aliyun.com/document_detail/42618.html) and [Receive message notifications](https://www.alibabacloud.com/help/en/mps/receive-message-notifications/?spm=a2c63.p38356.0.0.b48576d2jxNSca).'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The maximum queries per second (QPS) for a single user is 50. If you exceed this limit, API calls are rate-limited. This may affect your business. Plan your API calls accordingly. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-10-24T07:32:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-06-20T05:56:32.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-05-18T07:53:16.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaInfoJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitMediaInfoJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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 \\"DolbyVision\\": {\\n \\"Profile\\": \\"\\",\\n \\"Level\\": \\"\\"\\n }\\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 \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"FileSize\\": \\"3509895\\",\\n \\"MD5\\": \\"\\"\\n }\\n },\\n \\"RequestId\\": \\"62D9BE16-B7D5-550C-A482-7A0F60E09877\\"\\n}","type":"json"}]', ], 'SubmitSmarttagJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the pipeline. This ID distinguishes between services and binds notifications. You can obtain the pipeline ID from the **MPS console** by choosing **Global Settings** > **Pipelines**. You can leave this parameter empty to use the default pipeline. The default pipeline supports a concurrency of 10. To increase the concurrency, [submit a ticket](https://ia.aliyun.com/home?channel=ticket\\&mark=console-home).'."\n" ."\n" .'> Pipelines can be created only on the backend. To query or update a pipeline, see [Update a pipeline](~~188374~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the video. The title can contain Chinese characters, letters, digits, and hyphens (-). It must not start with a special character or exceed 256 bytes in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example-title-****', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'A description of the video content. The description can contain Chinese characters, letters, digits, and hyphens (-). It must not start with a special character or exceed 1 KB in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'example content ****', 'title' => ''], ], [ 'name' => 'ContentType', 'in' => 'query', 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'application/zip', 'title' => ''], ], [ 'name' => 'ContentAddr', 'in' => 'query', 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'http://exampleBucket.oss-cn-shanghai.aliyuncs.com/mps-test/ai-tag.mp4', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'Additional request parameters specified as a JSON string. Example: `{"needAsrData":true, "needOcrData":false}`. The following fields are supported:'."\n" ."\n" .'- `needAsrData`: Specifies whether to include the raw Automatic Speech Recognition (ASR) result in the analysis output. Default value: `false`. Optional value: `true`.'."\n" ."\n" .'- `needOcrData`: Specifies whether to include the raw Optical Character Recognition (OCR) result in the analysis output. Default value: `false`. Optional value: `true`.'."\n" ."\n" .'- `needMetaData`: Specifies whether to include metadata in the analysis output. Default value: `false`. Optional value: `true`.'."\n" ."\n" .'- `nlpParams`: Specifies the input parameters for the Natural Language Processing (NLP) operator. The default value is an empty object, which means the NLP operator is not used. For more information, see the supplementary information about request parameters.', 'type' => 'string', 'required' => false, 'example' => '{"needAsrData":true, "needOcrData":false, "nlpParams":{"sourceLanguage":"cn"}}', 'title' => ''], ], [ 'name' => 'NotifyUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL. Only HTTP and HTTPS URLs are supported.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/endpoint/aliyun/ai?id=76401125000***', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'Custom data that is passed through in the callback. The data must not exceed 1 KB in length.', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The address of the video or image file to be analyzed. Supports JPG, JPEG, and PNG image formats, verified by file extension. The smart tag API supports Object Storage Service (OSS) URLs, HTTP URLs, and Video on Demand (VoD) media asset URLs as input.'."\n" ."\n" .'> Make sure that the filename is correct and the bucket is in the same region where the API is called. Otherwise, the file may not be found or the API call may fail.'."\n" ."\n" .'- OSS URL: `oss://[bucket name]/[file path]`, for example, `oss://[example-bucket-****]/[object_path-****]`.'."\n" ."\n" .'- HTTP URL: A publicly downloadable address, for example, `http://example-test-****.mp4`.'."\n" ."\n" .'- VoD media asset URL: `vod://[VoD media asset ID]`, for example, `vod://MediaId`.'."\n" ."\n" .'Examples:'."\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" .'> The OSS bucket must be in the same region where the API is called. MPS does not charge for traffic when pulling videos or images from your bucket.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'oss://mybucket-****/example-****.mp4', 'title' => ''], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the template specifying the analysis algorithm. For more information about template operations, see [Add a template](~~602910~~), [Query templates](~~187770~~), [Update templates](~~187776~~), and [Delete templates](~~187775~~).'."\n" ."\n" .'You can also use the public template:'."\n" ."\n" .'- `public-nlp` for NLP analysis', 'type' => 'string', 'required' => false, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'Priority', 'in' => 'query', 'schema' => ['description' => 'The job priority in its pipeline. A lower value indicates a higher priority. Valid values: 0 to 9. Default value: 5.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', 'title' => ''], 'JobId' => ['description' => 'The smart tag job ID. Save this ID for subsequent API calls.', 'type' => 'string', 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"JobId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","type":"json"}]', 'title' => 'Submit a DataQ - Smart Tag Service Job ', 'summary' => 'Submits a smart tag job.', 'description' => '- Before submitting a smart tag job, you must configure the analysis type in a template. For more information, see [Add a template](~~187759~~).'."\n" ."\n" .'- The smart tag feature is available only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.'."\n" ."\n" .'- This is an [asynchronous API](~~3027615~~). After you submit a job, the system returns a job ID and queues the job for background processing. The final result is returned through a callback. You can also call the [Query a smart tag job](~~602909~~) operation to check the job status.'."\n" ."\n" .'- The default concurrency of a smart tag pipeline is 2. If you require a higher concurrency, [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?product=mts)[submit a ticket](https://workorder-intl.console.aliyun.com/?spm=5176.12246746.top-nav.dticket.68797bbcm8H408#/ticket/add/?productId=1232) to contact Alibaba Cloud customer service for evaluation and configuration.'."\n" ."\n" .'- The system retains smart tag jobs and their results for 180 days, after which they are automatically deleted.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The QPS limit for this operation is 100 calls per second per user. Exceeding this limit triggers throttling, which can affect your business. Plan your calls accordingly. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => '### nlpParams'."\n" ."\n" .'| Feature | Parameter | Type | Required | Description | Example |'."\n" .'| ------------------- | ------------------------ | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |'."\n" .'| | nlpParams | object | Yes | Contains all NLP-related parameters. Required if the analysis type in the template includes NLP; otherwise, the job fails. | {"sourceLanguage":"cn"} |'."\n" .'| Transcription | sourceLanguage | string | Yes | The source language model for transcription. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), and `fspk` (free-form Chinese and English). | "cn" |'."\n" .'| | diarizationEnabled | boolean | No | Specifies whether to enable speaker diarization. Default value: false. | true |'."\n" .'| | speakerCount | integer | No | The parameter for speaker diarization. If this parameter is not set, speaker roles are not differentiated. Set to `0` to identify an indefinite number of speakers, or `2` to identify two speakers. | 2 |'."\n" .'| Summarization | summarizationEnabled | boolean | No | Specifies whether to enable the summarization feature. If you enable this feature, the system can generate results such as a full-text summary and speaker summaries. | true |'."\n" .'| | summarizationTypes | string | No | If summarization is enabled, you must specify the desired summary types: `Paragraph` (full-text summary), `Conversational` (speaker summary), and `QuestionsAnswering` (Q&A summary). | "Paragraph,Conversational,QuestionsAnswering" |'."\n" .'| Translation | translationEnabled | boolean | No | Specifies whether to enable the translation feature. | true |'."\n" .'| | targetLanguages | string | No | The target languages for translation. This parameter is required if translation is enabled. Valid values: `cn` (Chinese), `en` (English), and `ja` (Japanese). | "en" |'."\n" .'| Chapter recognition | autoChaptersEnabled | boolean | No | Specifies whether to enable chapter recognition. The results include chapter titles and chapter summaries. | true |'."\n" .'| Meeting assistance | meetingAssistanceEnabled | boolean | No | Specifies whether to enable meeting assistance. The results include categories, keywords, key sentences, and action items. If you set `meetingAssistanceEnabled` to true without specifying `meetingAssistanceTypes`, the system processes and returns all types by default. | true |'."\n" .'| | meetingAssistanceTypes | string | No | If the meeting assistance feature is enabled, you must specify the desired assistance types. Supported types: `Actions` (action items) and `KeyInformation` (key information). Key information includes keywords and key content (key sentences). | "Actions,KeyInformation" |', 'responseParamsDescription' => ' ', 'extraInfo' => '### SDK Sample'."\n" ."\n" .'- [Java SDK](~~188025~~)'."\n" .'- [Python SDK](~~188026~~)'."\n" .'- [PHP SDK](~~188027~~)', 'changeSet' => [ ['createdAt' => '2023-07-05T06:16:28.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmarttagJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitSmarttagJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitSnapshotJob' => [ 'summary' => 'Submit a screenshot job. Media Processing Service (MPS) will then take screenshots and generate a sprite image from the input file.', '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' => 'The job input. For more information, see [Input](~~29253#section-f3p-d24-y2b~~).'."\n" ."\n" .'> - In ApsaraVideo for Media Processing (MPS) APIs, you must [URL-encode](~~423796~~) the value of `Object` in UTF-8.'."\n" ."\n" .'- The OSS region must be the same as the MPS region.', 'type' => 'string', 'required' => true, 'example' => '{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"}', 'title' => ''], ], [ 'name' => 'SnapshotConfig', 'in' => 'query', 'schema' => ['description' => 'The snapshot configurations. For more information, see [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"}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The custom data. The value can contain letters, digits, and hyphens (-), but cannot start with a special character. The value can be up to 1,024 bytes in length.', 'type' => 'string', 'required' => false, 'example' => 'testid-001', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue. For more information, see [Basic concepts](~~29197~~).'."\n" ."\n" .'- You can view or create MPS queues in the [MPS console](https://mps.console.aliyun.com/overview) by choosing **Global Settings** > **Pipelines**.'."\n" ."\n" .'- To receive asynchronous notifications, you must bind a Message Service (MNS) queue to the MPS queue. For more information, see [Receive message notifications](https://help.aliyun.com/document_detail/42618.html)[Receive message notifications](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications).', 'type' => 'string', 'required' => false, 'example' => 'dd3dae411e704030b921e52698e5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '19B6D8C5-A5DD-467A-B435-29D393C71E2D', 'title' => ''], 'SnapshotJob' => [ 'description' => 'The snapshot job.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time the job was created.', 'type' => 'string', 'example' => '2021-05-19T03:11:48Z', 'title' => ''], 'SnapshotConfig' => [ 'description' => 'The snapshot configuration.', 'type' => 'object', 'properties' => [ 'Time' => ['description' => 'The snapshot start time. Unit: milliseconds.', 'type' => 'string', 'example' => '5', 'title' => ''], 'TileOut' => [ 'description' => 'The tiling configuration.', 'type' => 'object', 'properties' => [ 'Padding' => ['description' => 'The padding between images.'."\n" ."\n" .'- Default value: **0**.'."\n" ."\n" .'- Unit: pixels.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Color' => ['description' => 'The background color.'."\n" ."\n" .'- Default value: **black**.'."\n" ."\n" .'- Valid values: **color keyword** or **random**.'."\n" ."\n" .'> Color keywords can be specified in three formats. For example, to specify black, you can use `Black`, `black`, or `#000000`.', 'type' => 'string', 'example' => 'black', 'title' => ''], 'CellSelStep' => ['description' => 'The step for selecting individual images to include in the tiled output.', 'type' => 'string', 'example' => '3', 'title' => ''], 'CellHeight' => ['description' => 'The height of an individual image in the tiled output. Defaults to the height of the output snapshot.', 'type' => 'string', 'example' => '100', 'title' => ''], 'CellWidth' => ['description' => 'The width of an individual image in the tiled output. Defaults to the width of the output snapshot.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Margin' => ['description' => 'The width of the outer margin for the tiled image.'."\n" ."\n" .'- Default value: **0**.'."\n" ."\n" .'- Unit: pixels.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Columns' => ['description' => 'The number of columns in the tiled image. Default value: **10**.', 'type' => 'string', 'example' => '10', 'title' => ''], 'IsKeepCellPic' => ['description' => 'Specifies whether to keep the individual snapshots. Valid values:'."\n" ."\n" .'- **true**: Keeps the individual snapshots.'."\n" ."\n" .'- **false**: Deletes the individual snapshots.'."\n" ."\n" .'- Default value: **true**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Lines' => ['description' => 'The number of rows in the tiled image. Default value: **10**.', 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Interval' => ['description' => 'The interval for capturing a sequence of snapshots.'."\n" ."\n" .'- The value must be greater than 0.'."\n" ."\n" .'- Unit: seconds.'."\n" ."\n" .'- Default value: **10**.', 'type' => 'string', 'example' => '20', 'title' => ''], 'FrameType' => ['description' => 'The type of frames to capture. Default value: **normal**. Valid values:'."\n" ."\n" .'- **normal**: normal frames.'."\n" ."\n" .'- **intra**: I-frames (keyframes).'."\n" ."\n" .'> If this parameter is set to `intra`, only keyframes are captured. If a specified time point is not a keyframe, the system uses the nearest keyframe. Capturing keyframes is typically faster than capturing normal frames.', 'type' => 'string', 'example' => 'intra', 'title' => ''], 'Width' => ['description' => 'The width of the output snapshot.', 'type' => 'string', 'example' => '8', 'title' => ''], 'Height' => ['description' => 'The height of the output snapshot.', 'type' => 'string', 'example' => '8', 'title' => ''], 'OutputFile' => [ 'description' => 'The OSS configuration for the output snapshot.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the role. Format: `acs:ram::$accountID:role/$roleName`.', 'type' => 'string', 'example' => 'acs:ram::1:role/testrole', 'title' => ''], 'Object' => ['description' => 'The name of the output OSS object.', 'type' => 'string', 'example' => 'test.png', 'title' => ''], 'Location' => ['description' => 'The data center of the output OSS bucket.', 'type' => 'string', 'example' => 'example-location', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket for the output file.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Num' => ['description' => 'The number of snapshots to capture in a sequence.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TileOutputFile' => [ 'description' => 'The OSS configuration for the output tiled image.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the role. Format: `acs:ram::$accountID:role/$roleName`.', 'type' => 'string', 'example' => 'acs:ram::1:role/testrole', 'title' => ''], 'Object' => ['description' => 'The name of the output OSS object.', 'type' => 'string', 'example' => 'example.png', 'title' => ''], 'Location' => ['description' => 'The data center of the output OSS bucket.', 'type' => 'string', 'example' => 'example-location', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket for the output file.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TimeArray' => [ 'itemNode' => true, 'description' => '', 'type' => 'object', 'properties' => [ 'TimePointList' => [ 'description' => 'An array of time points.', 'type' => 'array', 'items' => ['description' => 'An array of up to 100 time points, in milliseconds, at which to capture snapshots. Values can be floating-point numbers with up to two decimal places. You can submit time points in any order and include duplicates; MPS automatically sorts them. If you specify this parameter, do not use the `Num`, `Time`, or `Interval` parameters. Otherwise, the API returns an `InvalidParameter.Ambiguity` error.', 'type' => 'integer', 'format' => 'int64', 'example' => '[10050, 50000, 110000, 1000500, 1100500]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The state of the snapshot job. Valid values:'."\n" ."\n" .'- **Submitted**: The job has been submitted.'."\n" ."\n" .'- **Snapshotting**: The snapshot job is in progress.'."\n" ."\n" .'- **Success**: The job was successful.'."\n" ."\n" .'- **Fail**: The job failed.', 'type' => 'string', 'example' => 'Snapshoting', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is returned only if the job fails.', 'type' => 'string', 'example' => 'The resource operated InputFile is bad', 'title' => ''], 'MNSMessageResult' => [ 'description' => 'The result of the MNS notification sent to the user upon job completion.', 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the MNS message. This parameter is returned only on successful notification.', 'type' => 'string', 'example' => '799454621135656C7F815F198A76****', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message, returned only if the MNS notification fails.', 'type' => 'string', 'example' => 'The resource operated InputFile is bad', 'title' => ''], 'ErrorCode' => ['description' => 'The error code, returned only if the MNS notification fails.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Input' => [ 'description' => 'The job input.', 'type' => 'object', 'properties' => [ 'RoleArn' => ['description' => 'The ARN of the role. Format: `acs:ram::$accountID:role/$roleName`.', 'type' => 'string', 'example' => 'acs:ram::1:role/testrole', 'title' => ''], 'Object' => ['description' => 'The name of the input OSS object.', 'type' => 'string', 'example' => 'example.flv', 'title' => ''], 'Location' => ['description' => 'The data center of the input OSS bucket.', 'type' => 'string', 'example' => 'example-location\'', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket that contains the input file.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Count' => ['description' => 'The total number of captured snapshots.', 'type' => 'string', 'example' => '1', 'title' => ''], 'TileCount' => ['description' => 'The number of tiled images.', 'type' => 'string', 'example' => '5', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => 'testid-001', 'title' => ''], 'Code' => ['description' => 'The error code. This parameter is returned only when the job status is **Fail**.', 'type' => 'string', 'example' => 'ResourceContentBad', 'title' => ''], 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'dd3dae411e704030b921e52698e5****', 'title' => ''], 'Id' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'example' => 'f4e3b9ba9f3840c39d6e288056f0****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Submit a snapshot job ', 'description' => '- The maximum size for a single input file is 100 GB. Exceeding this limit may cause the job to fail.'."\n" ."\n" .'- Before you submit a snapshot job, ensure the file has been successfully uploaded to OSS. Otherwise, the job may fail. You can configure OSS callbacks to confirm the file upload status.'."\n" ."\n" .'- Snapshot jobs support both synchronous and asynchronous modes.'."\n" ."\n" .' - Synchronous mode supports only a single snapshot and generates the image when the API call returns.'."\n" ."\n" .' - [Asynchronous mode](~~3027615~~) does not guarantee immediate processing. After you submit a snapshot job, it enters a pipeline, where it is queued and scheduled for execution. Therefore, the snapshot is not guaranteed to be generated when the API call returns. After the job is complete, you can poll for the results by calling the [Query snapshot job results](~~602858~~) API or receive message notifications by binding MNS to the pipeline. For more information, see [Receive message notifications](https://help.aliyun.com/document_detail/42618.html)[Receive message notifications](https://www.alibabacloud.com/help/zh/apsaravideo-for-media-processing/latest/receive-message-notifications).'."\n" ."\n" .' - Specifying either the **Interval** or **Num** parameter triggers asynchronous mode.'."\n" ."\n" .'- Currently, only images in JPG format are supported.'."\n" ."\n" .'- For more information about common snapshot issues, see [Snapshot FAQ](~~60805~~).'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The QPS limit for this API is 50 requests per second per user. API calls that exceed this limit are subject to throttling, which may impact your business. Please call this API at a reasonable rate. For more information, see [QPS limit](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-04-24T06:31:18.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-04-10T03:40:41.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-05T03:18:26.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSnapshotJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitSnapshotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitTraceAbJob' => [ 'summary' => 'The SubmitTraceAbJob operation submits a video tracing watermark A/B stream job.', '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' => 'The Object Storage Service (OSS) location of the input video. The region of the OSS bucket must be the same as the region where you use Media Processing Service (MPS).'."\n" ."\n" .'>', 'type' => 'string', 'required' => false, 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"test.mp4"}', 'title' => ''], ], [ 'name' => 'Output', 'in' => 'query', 'schema' => ['description' => 'The Object Storage Service (OSS) location for the job output. You must specify the output directory by using the `Dir` parameter.', 'type' => 'string', 'required' => true, 'example' => '{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Dir":"out/"}', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time for embedding the watermark, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'TotalTime', 'in' => 'query', 'schema' => ['description' => 'The total duration for embedding the watermark, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '360', 'title' => ''], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => ['description' => 'The watermark level. This parameter specifies the color channels for embedding the watermark. Valid values: 0 (U channel), 1 (UV channels), and 2 (YUV channels).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'CallBack', 'in' => 'query', 'schema' => ['description' => 'The URL for receiving callback notifications. Currently, only HTTP URLs are supported.', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', 'title' => ''], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => ['description' => 'A publicly accessible URL of the video. This URL overrides the `Input` parameter.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/video/test.mp4', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The custom user data. The maximum length is 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'CipherBase64ed', 'in' => 'query', 'schema' => ['description' => 'The Base64-encoded encryption key.', 'type' => 'string', 'required' => false, 'example' => 'Qh6OdgIMcliQSI1fReOw****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '030E2671-806A-52AF-A93C-DA8E308603A6'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'Data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****', 'title' => ''], 'MediaId' => ['description' => 'The media file ID.', 'type' => 'string', 'example' => '437bd2b516ffda105d07b12a9a82****', 'title' => ''], ], 'example' => '', ], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'Submit Video Tracing Watermark AB Stream Job', 'description' => '- You can submit a video tracing watermark A/B stream job only for videos that are 3 minutes or longer. Processing shorter videos may cause the operation to fail or produce no output.'."\n" ."\n" .'- Digital watermark-related operations are currently available only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" .'- This is an [asynchronous operation](~~3027615~~). After submission, the system returns a job ID and processes the job in the background. A callback notification delivers the final result. You can also call the [QueryTraceAbJob](~~2834788~~) operation to query the job status.', 'changeSet' => [ ['createdAt' => '2025-05-14T03:22:00.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-07-23T02:15:26.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceAbJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitTraceAbJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitTraceExtractJob' => [ 'summary' => 'Submits a trace watermark extraction job.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222528', 'abilityTreeNodes' => ['FEATUREmtsGVUB1B'], ], 'parameters' => [ [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The OSS address of the input file for trace watermark extraction.', 'type' => 'string', 'required' => false, 'example' => '{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}'."\n", 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'User-defined data. Maximum length: 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '123'."\n", 'title' => ''], ], [ 'name' => 'CallBack', 'in' => 'query', 'schema' => ['description' => 'The callback URL for job results. Only HTTP URLs are supported.', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback'."\n", 'title' => ''], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => ['description' => 'A publicly accessible URL of the video file. If specified, this URL is used as the job input and takes precedence over the Input parameter.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/video/test.mp4'."\n", 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'Parameters for the extraction job, specified as a JSON string. The following parameter is supported:'."\n" ."\n" .'- m3u8Type: The algorithm type. Default: v1.'."\n" ."\n" .' - v1: Extracts an M3U8 file with an absolute path.'."\n" ."\n" .' - v2: Extracts an M3U8 file with a relative path.', 'type' => 'string', 'required' => false, 'example' => '{"m3u8Type":"v1"}'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of the response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A1326BD4-30B1-4CB6-Q123-3330B877B0D4'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'Data' => [ 'title' => '', 'description' => 'The data returned in the response.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****', 'title' => ''], ], 'example' => '', ], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'Submit a Tracing Watermark Extraction Job ', 'description' => '- Digital watermark APIs are available only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" .'- This is an [asynchronous API](~~3027615~~). After you submit a job, a job ID is returned. The job is then queued for background processing. The final result is sent via a callback. You can also check the job status by calling the [Query Trace Extraction Job](~~2834787~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceExtractJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitTraceExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitTraceM3u8Job' => [ 'summary' => 'Submits a job to generate an M3U8 file with a video tracing watermark.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222530', 'abilityTreeNodes' => ['FEATUREmtsGVUB1B'], ], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The media ID of the processed AB stream. You can obtain this ID from the response of the operation that submits the AB stream processing job.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '437bd2b516ffda105d07b12a9a82****', 'title' => ''], ], [ 'name' => 'Output', 'in' => 'query', 'schema' => ['description' => 'The OSS location of the output M3U8 file.'."\n" ."\n" .'> The OSS bucket must be in the same region as your MPS service.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '{"Bucket":"exampleBucket","Location":"oss-cn-shanghai","Object":"out.m3u8"}', 'title' => ''], ], [ 'name' => 'Trace', 'in' => 'query', 'schema' => ['description' => 'The trace watermark information.', 'type' => 'string', 'example' => 'Today is Monday.', 'docRequired' => true, 'required' => true, 'title' => ''], ], [ 'name' => 'KeyUri', 'in' => 'query', 'schema' => ['description' => 'The key server URI.', 'type' => 'string', 'required' => false, 'example' => 'https://cipher.abc.com'."\n", 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'The parameters for the watermark job, specified as a JSON string. The following parameters are supported:'."\n" ."\n" .'- `m3u8Type`: The algorithm type. The default value is `v1`.'."\n" ."\n" .' - `v1`: Generates an M3U8 file with absolute paths that can be played directly. The signature authentication is valid for 24 hours. After expiration, you must submit a new job to get a new M3U8 file.'."\n" ."\n" .' - `v2`: Generates an M3U8 file with relative paths. This file must be in the same directory as the TS files.', 'type' => 'string', 'required' => false, 'example' => '{"m3u8Type":"v1"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DEB915C5-D001-5C17-AF65-FF8A65DFE432'], 'Data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****', 'title' => ''], ], 'example' => '', ], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'Submit Video Tracing Watermark M3U8 Job ', 'description' => '- Before you call this operation, you must submit a job to process the video\'s AB stream to obtain its media ID, which is a required input for this operation.'."\n" ."\n" .'- The digital watermark feature is available only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" .'- This is an [asynchronous API](~~3027615~~). After you submit a job, the system returns a job ID and queues it for background processing. You will receive the job result through a callback notification. You can also call the [Query video trace watermark m3u8 job](~~2834784~~) operation to query the job\'s status.'."\n" ."\n" .'- The signature authentication for the M3U8 file generated by the job is valid for 24 hours after the job completes. After the signature authentication expires, you can no longer retrieve the watermark information for the job. To retrieve the information again, you must submit a new job.', 'changeSet' => [ ['createdAt' => '2024-07-23T02:15:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceM3u8Job'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitTraceM3u8Job', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'TagCustomPerson' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'Person library ID. This ID uniquely identifies a custom person library. It is generated by the caller, who must ensure its uniqueness.'."\n" ."\n" .'Note: This ID must not be the same as any system person library ID. If it matches a system ID, the system person library will be used by default. The ID can contain up to 120 characters, supports both Chinese and English characters, and is case-insensitive. You can query this using the [List all persons and face information in a person library](~~187787~~) API.', 'type' => 'string', 'required' => false, 'example' => 'CategoryId001-****', 'title' => ''], ], [ 'name' => 'CategoryName', 'in' => 'query', 'schema' => ['description' => 'Person library name. Supports up to 512 characters, including both Chinese and English characters.', 'type' => 'string', 'required' => false, 'example' => 'CategoryNametest-****', 'title' => ''], ], [ 'name' => 'CategoryDescription', 'in' => 'query', 'schema' => ['description' => 'Person library description. Supports up to 512 characters, including both Chinese and English characters.', 'type' => 'string', 'required' => false, 'example' => 'CategoryDescription001-****', 'title' => ''], ], [ 'name' => 'PersonId', 'in' => 'query', 'schema' => ['description' => 'Person ID. This ID uniquely identifies a custom person. It is generated by the caller, who must ensure its uniqueness.'."\n" ."\n" .'The ID can contain up to 120 characters, supports both Chinese and English characters, and is case-insensitive. You can query this using the [List all persons and face information in a person library](~~187787~~) API. The returned FaceId is of type String.', 'type' => 'string', 'required' => false, 'example' => 'PersonId001-****', 'title' => ''], ], [ 'name' => 'PersonName', 'in' => 'query', 'schema' => ['description' => 'Person name. Supports up to 512 characters, including both Chinese and English characters.', 'type' => 'string', 'required' => false, 'example' => 'PersonNametest-****', 'title' => ''], ], [ 'name' => 'PersonDescription', 'in' => 'query', 'schema' => ['description' => 'Person description. Supports up to 512 characters, including both Chinese and English characters.', 'type' => 'string', 'required' => false, 'example' => 'PersonDescriptiontest-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'FD8B5B8C-0C3D-5776-B3B1-EE6AD11F905A', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD8B5B8C-0C3D-5776-B3B1-EE6AD11F905A\\"\\n}","type":"json"}]', 'title' => 'Add labels to a custom person library or a person', 'summary' => 'Add labels to a custom person library or a person.', 'description' => 'You can add labels to a custom person library or a person in two ways:'."\n" ."\n" .'- Specify CategoryId, and set CategoryName and CategoryDescription.'."\n" .'- Specify PersonId, and set PersonName and PersonDescription.'."\n" ."\n" .'You can set both at the same time or set only one at a time.'."\n" ."\n" .'## Queries per second (QPS) limit'."\n" .'The queries per second (QPS) limit for this API is 100 requests per second per user. If you exceed this limit, your API calls will be subject to rate limiting, which may impact your business. Call the API appropriately. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### Software development kit (SDK) samples'."\n" ."\n" .'- [Java SDK](~~188025~~)'."\n" .'- [Python SDK](~~188026~~)'."\n" .'- [PHP SDK](~~188027~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagCustomPerson'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:TagCustomPerson', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UnbindInputBucket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Bucket', 'in' => 'query', 'schema' => ['description' => 'The name of the input media bucket to be unbound. To obtain the media bucket name, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Media Buckets** in the left-side navigation pane. Alternatively, you can log on to the **Object Storage Service (OSS) console** and click **Historical Paths**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'example-bucket-****', 'title' => ''], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the role used for delegated authorization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:ram::174809843091****:role/exampleRole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","type":"json"}]', 'title' => 'UnbindInputBucket', 'summary' => 'Unbinds an input media bucket from the media library.', 'description' => '# Usage notes'."\n" ."\n" .'You can call this operation to unbind an input media bucket from the media library based on the name of the output media bucket.'."\n" ."\n" .'# QPS limits'."\n" ."\n" .'You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindInputBucket'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:UnbindInputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UnbindOutputBucket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Bucket', 'in' => 'query', 'schema' => ['description' => 'The name of the output media bucket to detach. You can find it in the **MPS console** > **Workflow Management** > **Media Buckets**, or in the **OSS console** > **My Access Paths**.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'UnbindOutputBucket', 'summary' => 'Detaches an output media bucket.', 'description' => 'This API operation detaches the specified output media bucket by its bucket name.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'The queries per second (QPS) limit for this API operation is 100 per user. Exceeding this limit triggers rate limiting, which may affect your business. Call this operation only as needed. For more information, see [QPS limits](~~342832~~).', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindOutputBucket'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:UnbindOutputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AEA0480-32F4-1656-92B3-F4D4CDE6BBB3\\"\\n}","type":"json"}]', ], 'UnregisterCustomFace' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the figure library. The ID is used to uniquely identify a figure library. You can specify the ID of a custom figure library. Make sure that the ID is unique. If you set this parameter to the ID of a system figure library, the system figure library is used. The ID can be up to 120 characters in length and is not case-sensitive. You can call the [ListCustomPersons](~~187787~~) operation to query the figure library ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CategoryId001-****', 'title' => ''], ], [ 'name' => 'PersonId', 'in' => 'query', 'schema' => ['description' => 'The ID of the figure. The ID is used to uniquely identify a custom figure. Make sure that the ID is unique. The ID can be up to 120 characters in length and is not case-sensitive. You can call the [ListCustomPersons](~~187787~~) operation to query the figure ID. If you set this parameter to ALL, all the faces in the specified figure library are deleted, and the custom figure library is deleted.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PersonId001-****', 'title' => ''], ], [ 'name' => 'FaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the face. The ID is used to uniquely identify a face. Make sure that the ID is unique. The ID can be up to 120 characters in length and is not case-sensitive. You can call the [ListCustomPersons](~~187787~~) operation to query the face ID. If you set this parameter to ALL, all the faces associated with the specified figure are deleted.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '15****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A3347BF-7BCE-40A6-B33E-43C2B8A9A278', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], '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' => 'UnregisterCustomFace', 'summary' => 'Deletes a custom face, all the custom faces that are registered in a custom figure library, or a custom figure library.', 'description' => 'You can call this operation to delete a specific custom face, all the custom faces that are registered in a custom figure library, or a custom figure library.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### Sample SDKs'."\n" ."\n" .'* [SDK for Java](~~188025~~)'."\n" .'* [SDK for Python](~~188026~~)'."\n" .'* [SDK for PHP](~~188027~~)'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'mts:UnregisterCustomFace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterCustomFace'], ], ], ], 'UpdateMedia' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media file whose basic information you want to update. To obtain the ID of the media file, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Media Management** > **Media List** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => '3e1cd21131a94525be55acf65888****', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the media file. Multiple character types, such as letters and digits, are supported.'."\n" ."\n" .'* If you do not specify this parameter, the value is NULL.'."\n" .'* The value is encoded in UTF-8 and can be up to 128 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the media file. Multiple character types, such as letters and digits, are supported.'."\n" ."\n" .'* If you do not specify this parameter, the value is NULL.'."\n" .'* The value is encoded in UTF-8 and can be up to 1,024 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example description', 'title' => ''], ], [ 'name' => 'CoverURL', 'in' => 'query', 'schema' => ['description' => 'The URL of the thumbnail. This parameter is used to specify the storage location of the thumbnail. To obtain the URL, you can log on to the **MPS console** and choose **Workflows** > **Media Buckets** in the left-side navigation pane. Alternatively, you can log on to the **OSS console** and click **Buckets** in the left-side navigation pane.'."\n" ."\n" .'* The value can be up to 3,200 bytes in length.'."\n" .'* The URL complies with RFC 2396 and is encoded in UTF-8, with reserved characters being percent-encoded. For more information, see [URL encoding](~~423796~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/test****.jpg', 'title' => ''], ], [ 'name' => 'CateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the category to which the media file belongs. The value must be an integer.'."\n" ."\n" .'* If you do not specify this parameter, the value is NULL.'."\n" .'* The value cannot be negative.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'The tags that you want to add to the media file.'."\n" ."\n" .'* You can specify up to 16 tags for a media file. Separate multiple tags with commas (,).'."\n" .'* Each tag can be up to 32 bytes in length.'."\n" .'* The value is encoded in UTF-8.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1,tag2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6A88246F-C91F-42BD-BABE-DB0DF993F960', 'title' => ''], 'Media' => [ 'description' => 'The information about the media file.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media file was created.'."\n", 'type' => 'string', 'example' => '2016-09-14T08:30:33Z', 'title' => ''], 'CateId' => ['description' => 'The ID of the category to which the media file belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Height' => ['description' => 'The height of the media file.'."\n", 'type' => 'string', 'example' => '1080', 'title' => ''], 'CensorState' => ['description' => 'The review state of the media file. Valid values:'."\n" ."\n" .'* **Initiated**: The media file is uploaded but not reviewed.'."\n" .'* **Pass**: The media file is uploaded and passes the review.'."\n", 'type' => 'string', 'example' => 'Initiated', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The information about the tags.'."\n", 'type' => 'array', 'items' => ['description' => 'The tags that you want to add to the media file.'."\n", 'type' => 'string', 'example' => 'tag1,tag2', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Bitrate' => ['description' => 'The bitrate of the media file.'."\n", 'type' => 'string', 'example' => '2659.326', 'title' => ''], 'MediaId' => ['description' => 'The ID of the media file.'."\n", 'type' => 'string', 'example' => '3e1cd21131a94525be55acf65888****', 'title' => ''], 'File' => [ 'description' => 'The information about the input file.'."\n", 'type' => 'object', 'properties' => [ 'State' => ['description' => 'The state of the input file. Valid values:'."\n" ."\n" .'* **Normal**: The input file is normal.'."\n" .'* **Deleted**: The input file is deleted.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'URL' => ['description' => 'The name of the OSS bucket in which the input media file is stored.'."\n", 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PublishState' => ['description' => 'The publishing state of the media file. Valid values:'."\n" ."\n" .'* **Initiated**: The media file is in the initial state.'."\n" .'* **UnPublish**: The media file has not been published, and the playback permission on the OSS object is Private.'."\n" .'* **Published**: The media file has been published, and the playback permission on the OSS object is Default.'."\n" .'* **Deleted**: The media file is deleted.'."\n", 'type' => 'string', 'example' => 'Published', 'title' => ''], 'Description' => ['description' => 'The description of the media file.'."\n", 'type' => 'string', 'example' => 'example description', 'title' => ''], 'Width' => ['description' => 'The width of the media file.'."\n", 'type' => 'string', 'example' => '1920', 'title' => ''], 'Size' => ['description' => 'The size of the media file.'."\n", 'type' => 'string', 'example' => '2647692', 'title' => ''], 'CoverURL' => ['description' => 'The URL of the thumbnail.'."\n", 'type' => 'string', 'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg', 'title' => ''], 'RunIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RunId' => [ 'description' => 'The IDs of the media workflow execution instances.'."\n", 'type' => 'array', 'items' => ['description' => 'The IDs of the media workflow execution instances.'."\n", 'type' => 'string', 'example' => '{"RunId":["47b42486019c4f688bf144c1a6ba****"]}', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Duration' => ['description' => 'The duration of the media file.'."\n", 'type' => 'string', 'example' => '7.965000', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the media file.'."\n", 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Title' => ['description' => 'The title of the media file.'."\n", 'type' => 'string', 'example' => 'hello', 'title' => ''], 'Format' => ['description' => 'The format of the media file. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.'."\n", 'type' => 'string', 'example' => 'mov', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'UpdateMedia', 'summary' => 'Updates the basic information about a media file.', 'description' => 'The basic information that you can update by calling this operation includes the title, description, and category of a media file. This operation applies to a full update. You must set all the parameters unless you want to replace the value of a specific parameter with a NULL value.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMedia'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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 \\n mov\\n \\n","errorExample":""}]', ], 'UpdateMediaCategory' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media file whose category you want to update.'."\n" ."\n" .'> To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management > Media List**. Find the required video and click **Manage** in the Actions column. The ID of the video is displayed on the Basics tab.'."\n", 'type' => 'string', 'required' => true, 'example' => '3e1cd21131a94525be55acf65888****', 'title' => ''], ], [ 'name' => 'CateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the category. The value cannot be negative.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E3931857-E3D3-4D6E-9C7B-D2C09441BD01', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'UpdateMediaCategory', 'summary' => 'Updates the category to which a media file belongs.', 'description' => 'You can call this operation to update only the category of a media file. For more information about how to update all the information about a media file, see [UpdateMedia](~~44464~~).'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:33.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaCategory'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaCategory', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E3931857-E3D3-4D6E-9C7B-D2C09441BD01\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E3931857-E3D3-4D6E-9C7B-D2C09441BD01\\n","errorExample":""}]', ], 'UpdateMediaCover' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media file whose thumbnail you want to update. To obtain the ID of a media file, you can call the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage**. The ID of the video is displayed on the Basics tab.'."\n", 'type' => 'string', 'required' => true, 'example' => '6cc3aa66d1cb4bb2adf14e726c0a****', 'title' => ''], ], [ 'name' => 'CoverURL', 'in' => 'query', 'schema' => ['description' => 'The URL of the thumbnail that you want to specify for the media file. The URL complies with RFC 2396 and is encoded in UTF-8. The URL can be up to 3,200 bytes in length.'."\n" ."\n" .'> To obtain the thumbnail URL, you can find the image in the Object Storage Service (OSS) bucket and click the image to view details. In the View Details panel, copy the part before the question mark (?) from the URL field. You can enter only an HTTP URL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0DC39B9E-13D4-40BA-AE76-CFF9BD64239D', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'UpdateMediaCover', 'summary' => 'Updates the thumbnail of a media file.', 'description' => 'You can call this operation to update only the thumbnail of a media file. For more information about how to update all the information about a media file, see [UpdateMedia](~~44464~~).'."\n" ."\n" .'## Limits on QPS'."\n" ."\n" .'You can call this operation up to 100 times per second. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see [QPS limits](https://www.alibabacloud.com/help/en/apsaravideo-for-media-processing/latest/qps-limit).', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaCover'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaCover', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0DC39B9E-13D4-40BA-AE76-CFF9BD64239D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0DC39B9E-13D4-40BA-AE76-CFF9BD64239D\\n","errorExample":""}]', ], 'UpdateMediaPublishState' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media file whose publishing status you want to update. You can obtain the ID of a media file from the response of the [AddMedia](~~44458~~) operation. Alternatively, perform the following operations in the ApsaraVideo Media Processing (MPS) console: In the left-side navigation pane, choose **Media Management** > **Media List**. Find the required video and click **Manage**. The ID of the video is displayed on the Basics tab.', 'type' => 'string', 'required' => true, 'example' => '3e6149d5a8c944c09b1a8d2dc3e4****', 'title' => ''], ], [ 'name' => 'Publish', 'in' => 'query', 'schema' => ['description' => 'The publishing status. Default value: **Initialed**. Valid values:'."\n" ."\n" .'* **true**: published.'."\n" .'* **false**: unpublished.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '91B6CAB9-034C-4E4E-A40B-E7F5C81E688C', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], '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' => 'UpdateMediaPublishState', 'summary' => 'Updates the publishing status of a media file.', 'description' => 'The published state indicates that the access control list (ACL) of media playback resources and snapshot files is set to inherit the ACL of the bucket to which they belong. The unpublished state indicates that the ACL of media playback resources and snapshot files is set to private.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => '**Default publishing state of a media file and status change rules**'."\n" ."\n" .'Default publishing state:'."\n" ."\n" .'The default publishing state of a media file is **Initialed**. The following two types of media files are in the Initialed state:'."\n" ."\n" .'* New media file: When a media file is generated for the first time (a media workflow is triggered for the first time), and the media execution of the workflow is in progress, the media file is in the Initialed state. After the execution of the media workflow is complete, the status of the media file changes to published or unpublished based on the configurations of the media workflow.'."\n" .'* Deleted media file: After a media file is deleted, the publishing status is meaningless, and the media file is in the Initialed state. If you restore the deleted media file to the media library, a workflow is executed on the file as a new media file.'."\n" ."\n" .'Status change rules'."\n" ."\n" .'**Note**The publishing status changes among the Initialed, published, and unpublished states. The status change rules for the API are different from those for workflow execution.'."\n" ."\n" .'|Caller|Status|Changed status|Allowed|'."\n" .'|:---|:---|:---|:---|'."\n" .'|API|Initialed|Published|No|'."\n" .'|API|Initialed|Unpublished|No|'."\n" .'|API|Published|Unpublished|Yes|'."\n" .'|API|Unpublished|Published|Yes|'."\n" .'|Workflow execution|Initialed|Published|Yes|'."\n" .'|Workflow execution|Initialed|Unpublished|Yes|'."\n" .'|Workflow execution|Published|Unpublished|No|'."\n" .'|Workflow execution|Unpublished|Published|No|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaPublishState'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaPublishState', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateMediaWorkflow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '25042', 'abilityTreeNodes' => ['FEATUREmts0IG2Y5'], ], 'parameters' => [ [ 'name' => 'MediaWorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media workflow that you want to update. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => '6307eb0d3f85477882d205aa040f****', 'title' => ''], ], [ 'name' => 'Topology', 'in' => 'query', 'schema' => ['description' => 'The new topology of the media workflow. The value is a JSON object that contains the activity list and activity dependencies.'."\n" ."\n" .'> The Object Storage Service (OSS) bucket must reside in the same region as your MPS service.'."\n", '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" .'}', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The media workflow Name.'."\n" ."\n" .'- Cannot Be Empty.'."\n" .'- The workflow Name must be unique within the same Account.'."\n" .'- Must not exceed 64 characters.'."\n" .'- UTF-8 encoding.', 'type' => 'string', 'required' => false, 'example' => 'mediaworkflow-example'."\n", 'title' => ''], ], [ 'name' => 'TriggerMode', 'in' => 'query', 'schema' => ['description' => 'The trigger mode. Valid values:'."\n" .'- OssAutoTrigger: Automatically triggered.'."\n" .'- NotInAuto: Not automatically triggered.', 'type' => 'string', 'required' => false, 'example' => 'OssAutoTrigger', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7D752035-97DA-54E5-88E2-E8405EEA****', 'title' => ''], 'MediaWorkflow' => [ 'description' => 'The detailed information about the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '2016-04-01T05:29:38Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow that is updated.'."\n", 'type' => 'string', 'example' => '6307eb0d3f85477882d205aa040f****', 'title' => ''], 'State' => ['description' => 'The state of the media workflow. Valid values:'."\n" ."\n" .'* **Inactive**: The media workflow is disabled.'."\n" .'* **Active**: The media workflow is enabled.'."\n", 'type' => 'string', 'example' => 'Active', 'title' => ''], 'TriggerMode' => ['description' => 'The trigger mode of the media workflow. Valid values:'."\n" ."\n" .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", 'type' => 'string', 'example' => 'OssAutoTrigger', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'examp-mediaworkflow-****', 'title' => ''], 'Topology' => ['description' => 'The topology of the media workflow.'."\n", '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" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Update the topology of a media workflow', 'summary' => 'Update a media workflow.', 'description' => '- This API is used to update the topology of a media workflow. To update the trigger mode of a media workflow, see [Update the trigger mode of a media workflow](~~70372~~).'."\n" .'- After a workflow is deleted or disabled, it becomes unavailable. In this case, uploading files to the specified OSS bucket path of the workflow will not automatically trigger the workflow execution.'."\n" ."\n" .''."\n" .'>Deleting or disabling a workflow does not affect jobs that have already been submitted. If you delete or disable a workflow after submitting jobs, those jobs already in the processing queue cannot be canceled and will execute normally, incurring the corresponding fees.'."\n" .'>'."\n" ."\n" .'## Queries per second (QPS) limit'."\n" .'The QPS limit for this API is 100 queries per second (QPS) per user. If this limit is exceeded, API calls will be subject to rate limiting, which may impact your business. Call this API appropriately. For more information, see [QPS limits](~~342832~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-01T08:08:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaWorkflow'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'UpdateMediaWorkflowTriggerMode' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'MediaWorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media workflow that you want to update. To obtain the ID of the media workflow, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Workflows** > **Workflow Settings** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => 'e00732b977da427d9177a4dee646****', 'title' => ''], ], [ 'name' => 'TriggerMode', 'in' => 'query', 'schema' => ['description' => 'The trigger mode of the media workflow. Valid values:'."\n" ."\n" .'* **OssAutoTrigger**: automatically triggers the media workflow.'."\n" .'* **NotInAuto**: does not automatically trigger the media workflow.'."\n", 'type' => 'string', 'required' => true, 'example' => 'NotInAuto', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '16CD0CDD-457E-420D-9755-8385075A1234', 'title' => ''], 'MediaWorkflow' => [ 'description' => 'The information about the media workflow.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media workflow was created.'."\n", 'type' => 'string', 'example' => '2016-04-01T05:29:37Z', 'title' => ''], 'MediaWorkflowId' => ['description' => 'The ID of the media workflow.'."\n", 'type' => 'string', 'example' => 'e00732b977da427d9177a4dee646****', 'title' => ''], 'State' => ['description' => 'The status of the media workflow. Valid values:'."\n" ."\n" .'* **Inactive**: The media workflow is disabled.'."\n" .'* **Active**: The media workflow is enabled.'."\n", 'type' => 'string', 'example' => 'Inactive', 'title' => ''], 'TriggerMode' => ['description' => 'The trigger mode of the media workflow. Valid values:'."\n" ."\n" .'* **OssAutoTrigger**: The media workflow is automatically triggered.'."\n" .'* **NotInAuto**: The media workflow is not automatically triggered.'."\n", 'type' => 'string', 'example' => 'NotInAuto', 'title' => ''], 'Name' => ['description' => 'The name of the media workflow.'."\n", 'type' => 'string', 'example' => 'example-mediaworkflow-****', 'title' => ''], 'Topology' => ['description' => 'The topology of the media workflow.'."\n", '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"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'UpdateMediaWorkflowTriggerMode', 'summary' => 'Updates the trigger mode of a media workflow.', 'description' => 'You can call this operation only to modify the trigger mode of a media workflow. To modify other information about the workflow, call the [UpdateMediaWorkflow](~~44438~~) operation.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaWorkflowTriggerMode'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaWorkflowTriggerMode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], 'UpdatePipeline' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue that you want to update. To view the MPS queue ID, log on to the **MPS console** and choose **Global Settings** > **Pipelines** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The new name of the MPS queue. The value can contain letters, digits, and special characters such as hyphens (-) and can be up to 128 bytes in size. The value cannot start with a special character.'."\n", 'type' => 'string', 'required' => true, 'example' => 'example-pipeline-****', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The new state of the MPS queue.'."\n" ."\n" .'* **Active**: The MPS queue is active. Jobs in the MPS queue can be scheduled and run by MPS.'."\n" .'* **Paused**: The MPS queue is paused. Jobs in the MPS queue cannot be scheduled or run by MPS, and all jobs remain in the Submitted state. Jobs that are running will not be affected.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Paused', 'title' => ''], ], [ 'name' => 'NotifyConfig', 'in' => 'query', 'schema' => ['description' => 'The Message Service (MNS) configuration, such as the information about the MNS queue or topic. For more information, see the "NotifyConfig" section of the [Parameter details](~~29253~~) topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Topic":"example-topic-****"}', 'title' => ''], ], [ 'name' => 'Role', 'in' => 'query', 'schema' => ['description' => 'The role that is assigned to the current RAM user. To obtain the role, you can log on to the **Resource Access Management (RAM) console** and choose **Identities** > **Roles** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AliyunMTSDefaultRole', 'title' => ''], ], [ 'name' => 'ExtendConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'Extension configuration', 'example' => '{\\"IsBoostNew\\":true,\\"MultiSpeedDowngradePolicy\\":\\"NormalSpeed\\",\\"MaxMultiSpeed\\":20}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1FE0F96B-544D-4244-9D83-DFCFB0E5A231', 'title' => ''], 'Pipeline' => [ 'description' => 'The details of the MPS queue.'."\n", 'type' => 'object', 'properties' => [ 'Speed' => ['description' => 'The type of the MPS queue. Default value: **Standard**. Valid values:'."\n" ."\n" .'* **Boost**: MPS queue with transcoding speed boosted'."\n" .'* **Standard**: standard MPS queue'."\n" .'* **NarrowBandHDV2**: MPS queue that supports Narrowband HD 2.0'."\n" .'* **AIVideoCover**: MPS queue for intelligent snapshot capture'."\n" .'* **AIVideoFPShot**: MPS queue for media fingerprinting'."\n" .'* **AIVideoCensor**: MPS queue for automated review'."\n" .'* **AIVideoMCU**: MPS queue for smart tagging'."\n" .'* **AIVideoSummary**: MPS queue for video synopsis'."\n" .'* **AIVideoPorn**: MPS queue for pornography detection in videos'."\n" .'* **AIAudioKWS**: MPS queue for keyword recognition in audio'."\n" .'* **AIAudioASR**: MPS queue for speech-to-text conversion'."\n", 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'State' => ['description' => 'The state of the MPS queue. Valid values:'."\n" ."\n" .'* **Active**: The MPS queue is active.'."\n" .'* **Paused**: The MPS queue is paused.'."\n", 'type' => 'string', 'example' => 'Paused', 'title' => ''], 'NotifyConfig' => [ 'description' => 'The MNS configuration.'."\n", 'type' => 'object', 'properties' => [ 'MqTopic' => ['description' => 'The queue of messages that are received.'."\n", 'type' => 'string', 'example' => 'example1,example2', 'title' => ''], 'QueueName' => ['description' => 'The queue that is created in MNS.'."\n", 'type' => 'string', 'example' => 'example-queue-****', 'title' => ''], 'MqTag' => ['description' => 'The tags of the messages.'."\n", 'type' => 'string', 'example' => 'mts-test', 'title' => ''], 'Topic' => ['description' => 'The topic that is created in MNS.'."\n", 'type' => 'string', 'example' => 'example-topic-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The new name of the MPS queue.'."\n", 'type' => 'string', 'example' => 'example-pipeline-****', 'title' => ''], 'Role' => ['description' => 'The role that is assigned to the current RAM user.'."\n", 'type' => 'string', 'example' => 'AliyunMTSExampleRole', 'title' => ''], 'Id' => ['description' => 'The ID of the MPS queue.'."\n", 'type' => 'string', 'example' => 'd1ce4d3efcb549419193f50f1fcd****', 'title' => ''], 'QuotaAllocate' => ['description' => 'The quota that is allocated to the MPS queue.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Update pipeline: name, status, and notification settings', 'summary' => 'Update an MPS queue.'."\n", 'description' => '- This API allows you to modify the name, status, and notification settings of a specified MPS queue. '."\n" .'- If an MPS queue is paused, any pipeline or individual job (such as automated review or media fingerprint) that uses this paused queue will fail and cannot proceed.'."\n" ."\n" .''."\n" .'>Pausing an MPS queue does not affect jobs already submitted. If an MPS queue is shut down after a job is submitted, any job already queued for processing cannot be canceled and will execute normally, incurring the corresponding fee.'."\n" .'>'."\n" ."\n" .'## Queries per second (QPS) limit '."\n" .'The QPS limit for this API is 100 requests per second per user. If this limit is exceeded, API calls will be rate-limited, which may impact your business operations. Please invoke the API appropriately. For more information, see [QPS limits](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-06-13T02:31:51.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-05T03:18:26.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdatePipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateSmarttagTemplate' => [ 'summary' => 'Updates the analysis template for a smart tag job.', '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' => 'The ID of the template. Obtain this ID from the response of the [Add a template](~~187759~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05de22f255284c7a8d2aab535dde****', 'title' => ''], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['description' => 'The name of the custom template. The name can contain English and Chinese characters and be up to 120 characters long.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'template-example-****', 'title' => ''], ], [ 'name' => 'Industry', 'in' => 'query', 'schema' => ['description' => 'The industry of the file to be analyzed. The default value is **common** (general). Select a suitable industry to match the file with the appropriate algorithm combination. Valid values:'."\n" ."\n" .'- **microVideo**: The short-form video industry.'."\n" ."\n" .'- **common**: The general industry.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'common', 'title' => ''], ], [ 'name' => 'Scene', 'in' => 'query', 'schema' => ['description' => 'The scenario. Select a suitable scenario to match the file with the appropriate algorithm combination. The default value is **search**. Valid values:'."\n" ."\n" .'- **search**: The search scenario.'."\n" ."\n" .'- **recommend**: The recommendation scenario.'."\n" ."\n" .'- The default value is **search**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'search', 'title' => ''], ], [ 'name' => 'AnalyseTypes', 'in' => 'query', 'schema' => ['description' => 'The analysis types. You can select multiple types. Separate them with commas (,). The following types are available:'."\n" ."\n" .'- **ocr**: Recognizes labels from text in images.'."\n" ."\n" .'- **asr**: Recognizes labels from speech in audio.'."\n" ."\n" .'- **classification**: Video classification.'."\n" ."\n" .'- **shows**: Recognizes programs in videos.'."\n" ."\n" .'- **face**: Recognizes faces in videos.'."\n" ."\n" .'- **role**: Recognizes character roles in videos.'."\n" ."\n" .'- **object**: Recognizes objects in videos.'."\n" ."\n" .'- **tvstation**: Recognizes TV station logos in videos.'."\n" ."\n" .'- **action**: Recognizes action events in videos.'."\n" ."\n" .'- **emotion**: Recognizes expressions in videos.'."\n" ."\n" .'- **landmark**: Recognizes landmarks in videos.'."\n" ."\n" .'- **scene**: Recognizes scenes in videos.'."\n" ."\n" .'- **movielp**: Recognizes movie and TV intellectual properties (IPs) in videos.'."\n" ."\n" .'- **subtitle**: Caption extraction.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ocr,asr', 'title' => ''], ], [ 'name' => 'FaceCategoryIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the face libraries for recognition. You can specify multiple IDs, separated by commas (,). You can enter the IDs of system face libraries and custom face libraries. The default value is **celebrity**, **politician**, and **sensitive**. The system face library IDs are as follows:'."\n" ."\n" .'- **celebrity**: Celebrities.'."\n" ."\n" .'- **politician**: Political figures.'."\n" ."\n" .'- **sensitive**: Sensitive figures.'."\n" ."\n" .'- Default value: **celebrity**, **politician**, and **sensitive**.'."\n" ."\n" .'> For more information about the IDs of custom face libraries, see [Custom face library operations](~~187777~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'celebrity', 'title' => ''], ], [ 'name' => 'FaceCustomParamsConfig', 'in' => 'query', 'schema' => ['description' => 'The parameters for the facial recognition algorithm, in a JSON string. The face detection threshold and facial recognition threshold are supported.'."\n" ."\n" .'- **faceDetThreshold**: The face detection threshold. The default value is 0.999. This parameter is valid only for the analysis of unrecognized faces.'."\n" ."\n" .'- **faceRegThreshold**: The facial recognition threshold. The default value is 0.9.', 'type' => 'string', 'required' => false, 'example' => '{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }', 'title' => ''], ], [ 'name' => 'ObjectGroupIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the object libraries for recognition. You can specify multiple IDs, separated by commas (,). You can enter the IDs of system object libraries and custom object libraries. The system object library IDs are as follows:'."\n" ."\n" .'- **general**: General.'."\n" ."\n" .'- **item**: Commodity.'."\n" ."\n" .'- **weapon**: Weapon.'."\n" ."\n" .'- **animal**: Animal.'."\n" ."\n" .'- For more information about the IDs of custom object libraries, see the [Register a custom entity](~~451180~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'general,item,weapon,animal', 'title' => ''], ], [ 'name' => 'LandmarkGroupIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the landmark libraries for recognition. You can specify multiple IDs, separated by commas (,). You can enter the IDs of system landmark libraries and custom landmark libraries. The system landmark library IDs are as follows:'."\n" ."\n" .'- **common**: General.'."\n" ."\n" .'- For more information about the IDs of custom landmark libraries, see the [Register a custom entity photo](~~451182~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'common', 'title' => ''], ], [ 'name' => 'IsDefault', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the template is the default template. Valid values:'."\n" ."\n" .'- **true**: The template is the default template.'."\n" ."\n" .'- **false**: The template is not the default template.'."\n" ."\n" .'The default value is **false**. Each user can have only one default template.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'LabelType', 'in' => 'query', 'schema' => ['description' => 'The labeling type. The default value is **auto**. The following types are supported:'."\n" ."\n" .'- **auto**: Machine-generated labels.'."\n" ."\n" .'- **hmi**: Human-machine collaboration.', 'type' => 'string', 'required' => false, 'example' => 'hmi', 'title' => ''], ], [ 'name' => 'LabelVersion', 'in' => 'query', 'schema' => ['description' => 'Specifies the smart tag version. The default value is "1.0".'."\n" ."\n" .'- 1.0: Smart Tag 1.0.'."\n" ."\n" .'- 2.0: Smart Tag 2.0 (CPV tags).'."\n" ."\n" .'- 2.0-custom: Smart Tag 2.0-custom (custom CPV tag model).', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], [ 'name' => 'KnowledgeConfig', 'in' => 'query', 'schema' => ['description' => 'In Smart Tag 2.0 and 2.0-custom modes, this parameter sets the scope of knowledge graph fields that are returned in the tagging results. For more information about knowledge graph information, see [Knowledge graph fields in smart tag operations](~~356383~~). If you do not specify this parameter, or if the value of knowledgeConfig is empty or not a valid JSON string, the following fields are returned by default:'."\n" ."\n" .'- movie:'."\n" ."\n" .' - name: The IP name'."\n" ."\n" .' - alias: The IP alias'."\n" ."\n" .' - chnl: The category'."\n" ."\n" .' - genre: The genre'."\n" ."\n" .' - country: The country or region of production'."\n" ."\n" .' - language: The language'."\n" ."\n" .' - releaseYear: The release year'."\n" ."\n" .'- music:'."\n" ."\n" .' - songName: The song name'."\n" ."\n" .' - artistName: The artist name'."\n" ."\n" .' - artistArea: The region of the artist, such as Chinese-speaking, Japan, Korea, Europe and the United States, or Other.'."\n" ."\n" .' - albumName: The album name'."\n" ."\n" .'- person:'."\n" ."\n" .' - name: The name'."\n" ."\n" .' - gender: The gender'."\n" ."\n" .' - citizenship: The citizenship'."\n" ."\n" .' - occupation: The occupation'."\n" ."\n" .' - classification: The type'."\n" ."\n" .' - nationality: The nationality'."\n" ."\n" .' - birthPlace: The place of birth'."\n" ."\n" .' - birthDate: The date of birth'."\n" ."\n" .'- landmark'."\n" ."\n" .' - name: The name'."\n" ."\n" .' - nameEn: The English name'."\n" ."\n" .' - description: The description'."\n" ."\n" .' - address: The address'."\n" ."\n" .'- item'."\n" ."\n" .' - brandName: The brand'."\n" ."\n" .' - finegrainName: The fine-grained description', 'type' => 'string', 'required' => false, 'example' => '{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }', 'title' => ''], ], [ 'name' => 'KeywordConfig', 'in' => 'query', 'schema' => ['description' => 'The keyword tag configuration. \\`type\\` specifies the part-of-speech categories. You can select multiple categories, separated by commas (,). The following categories are available:'."\n" ."\n" .'- name: Person name'."\n" ."\n" .'- location: Location name'."\n" ."\n" .'- organization: Organization name'."\n" ."\n" .'- other: Other'."\n" ."\n" .'> If you do not specify this parameter, or if its value is invalid, all keyword categories are returned by default. A value is invalid if it is not a valid JSON string, is missing the type field, or has an invalid type value.', 'type' => 'string', 'required' => false, 'example' => '{ "type": "name,location,organization,other" }', 'title' => ''], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5210DBB0-E327-4D45-ADBC-0B83C8796E26', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5210DBB0-E327-4D45-ADBC-0B83C8796E26\\"\\n}","type":"json"}]', 'title' => 'Update Template', 'description' => 'This operation updates a template that specifies the analysis algorithms for a smart tag job. You can combine different parameters as needed.'."\n" ."\n" .'## QPS limits'."\n" ."\n" .'The queries per second (QPS) limit for this operation is 100 calls per second for each user. If you exceed the limit, API calls are subject to rate limiting, which can affect your business. Call this operation at a reasonable rate. For more information, see [QPS limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '### SDK Sample'."\n" ."\n" .'- [Java SDK](~~188025~~)'."\n" .'- [Python SDK](~~188026~~)'."\n" .'- [PHP SDK](~~188027~~)', 'changeSet' => [ ['createdAt' => '2025-05-12T11:50:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-06T14:35:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-12-17T01:58:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-28T13:32:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-26T10:17:50.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSmarttagTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateSmarttagTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The name of the template. The name can be up to 128 bytes in length.'."\n", 'type' => 'string', 'required' => true, 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The container format. The value is a JSON object. Default format: **MP4**.'."\n" ."\n" .'* Video formats: FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4)'."\n" .'* Audio formats: MP3, MP4, OGG, FLAC, and M4A'."\n" .'* Images formats: GIF and WebP'."\n" ."\n" .'For more information, see the [Container](~~29253~~) parameter of the "Parameter details" topic.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MPS-example', 'title' => ''], ], [ 'name' => 'Container', 'in' => 'query', 'schema' => ['description' => 'The configurations of the video stream. The value is a JSON object. For more information, see the [Video](~~29253~~) parameter of the "Parameter details" topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Format":"mp4"}', 'title' => ''], ], [ 'name' => 'Video', 'in' => 'query', 'schema' => ['description' => 'The configurations of the audio stream. The value is a JSON object. For more information, see the [Audio](~~29253~~) parameter of the "Parameter details" topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10"}', 'title' => ''], ], [ 'name' => 'Audio', 'in' => 'query', 'schema' => ['description' => 'The transmuxing configurations. The value is a JSON object. For more information, see the [MuxConfig](~~29253~~) parameter of the "Parameter details" topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Codec":"aac","Samplerate":"44100","Bitrate":"500","Channels":"2"}', 'title' => ''], ], [ 'name' => 'MuxConfig', 'in' => 'query', 'schema' => ['description' => 'The general transcoding configurations. The value is a JSON object. For more information, see the [TransConfig](~~29253~~) parameter of the "Parameter details" topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"Segment":{"Duration":"10"}}', 'title' => ''], ], [ 'name' => 'TransConfig', 'in' => 'query', 'schema' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"TransMode":"onepass"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The type of the transcoding template.'."\n", 'type' => 'string', 'example' => '5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21', 'title' => ''], 'Template' => [ 'description' => 'The type of the transcoding template.'."\n", 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => 'The video codec configurations.'."\n", 'type' => 'object', 'properties' => [ 'LongShortMode' => ['description' => 'The size of the buffer.'."\n" ."\n" .'* Unit: KB.'."\n" .'* Default value: **6000**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Bufsize' => ['description' => 'The level of quality control on the video.'."\n", 'type' => 'string', 'example' => '6000', 'title' => ''], 'Degrain' => ['description' => 'The average bitrate range of the video.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'BitrateBnd' => [ 'description' => 'The upper limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'object', 'properties' => [ 'Max' => ['description' => 'The lower limit of the total bitrate. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'Min' => ['description' => 'The pixel format. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PixFmt' => ['description' => 'The black borders added to the video.'."\n" ."\n" .'* Format: width:height:left:top.'."\n" .'* Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Pad' => ['description' => 'The video codec. Default value: **H.264**.'."\n", 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Codec' => ['description' => 'The height of the output video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: the height of the input video.'."\n", 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The level of the independent denoising algorithm.'."\n", 'type' => 'string', 'example' => '800', 'title' => ''], 'Qscale' => ['description' => 'The method used to crop the video.'."\n" ."\n" .'* **border**: automatically detects and removes borders.'."\n" .'* Value in the width:height:left:top format: crops the video based on custom settings.**** Example: 1280:800:0:140.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Crop' => ['description' => 'The average bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => 'border', 'title' => ''], 'Bitrate' => ['description' => 'The maximum bitrate of the video. Unit: Kbit/s.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Maxrate' => ['description' => 'The maximum frame rate.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'MaxFps' => ['description' => 'The encoding profile. Valid values:'."\n" ."\n" .'* **baseline**: applicable to mobile devices.'."\n" .'* **main**: applicable to standard-definition devices.'."\n" .'* **high**: applicable to high-definition devices.'."\n" .'* Default value: **high**.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], 'Profile' => ['description' => 'The bitrate quality control factor.'."\n" ."\n" .'* Default value if the Codec parameter is set to H.264: **23**. Default value if the Codec parameter is set to H.265: **26**.'."\n" .'* If this parameter is returned, the setting of the Bitrate parameter is invalid.'."\n", 'type' => 'string', 'example' => 'high', 'title' => ''], 'Crf' => ['description' => 'Indicates whether the video stream is deleted. Valid values:'."\n" ."\n" .'* **true**: The video stream is deleted.'."\n" .'* **false**: The video stream is retained.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'Remove' => ['description' => 'The maximum number of frames between two keyframes. Default value: **250**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Gop' => ['description' => 'The width of the video.'."\n" ."\n" .'* Unit: pixel.'."\n" .'* Default value: **the width of the input video**.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Width' => ['description' => 'The frame rate.'."\n" ."\n" .'* A value of 60 is returned if the frame rate of the input video exceeds 60.'."\n" .'* Default value: the frame rate of the input video.'."\n", 'type' => 'string', 'example' => '256', 'title' => ''], 'Fps' => ['description' => 'The preset video algorithm. Default value: **medium**. Valid values:'."\n" ."\n" .'* **veryfast**'."\n" .'* **fast**'."\n" .'* **medium**'."\n" .'* **slow**'."\n" .'* **slower**'."\n", 'type' => 'string', 'example' => '25', 'title' => ''], 'Preset' => ['description' => 'The scan mode. Valid values:'."\n" ."\n" .'* **interlaced**: An interlaced scan is performed.'."\n" .'* **progressive**: A progressive scan is performed.'."\n", 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'The policy of resolution adjustment.'."\n", 'type' => 'string', 'example' => 'interlaced', 'title' => ''], 'ResoPriority' => ['description' => 'The general transcoding configurations.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Hdr2sdr' => ['description' => 'Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'NarrowBand' => [ 'description' => 'The Narrowband HD settings.'."\n", 'type' => 'object', 'properties' => [ 'Version' => ['description' => 'The Narrowband HD version. Only 1.0 may be returned.'."\n", 'type' => 'string', 'example' => '1.0', 'title' => ''], 'Abrmax' => ['description' => 'The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '3000', 'title' => ''], 'MaxAbrRatio' => ['description' => 'The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1.0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'TransConfig' => [ 'description' => 'Indicates whether the audio bitrate is checked. If the bitrate of the output audio is greater than the bitrate of the input audio, the bitrate of the input audio is retained after transcoding. In this case, the specified audio bitrate does not take effect. This parameter has a lower priority than the IsCheckAudioBitrateFail parameter. Valid values:'."\n" ."\n" .'* **true**: The audio bitrate is checked.'."\n" ."\n" .'* **false**: The audio bitrate is not checked.'."\n" ."\n" .'* Default value:'."\n" ."\n" .' * If the parameter is left empty and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" .' * If the parameter is left empty and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", 'type' => 'object', 'properties' => [ 'IsCheckAudioBitrate' => ['description' => 'The transcoding mode. Default value: **onepass**. Valid values:'."\n" ."\n" .'* **onepass**'."\n" .'* **twopass**'."\n" .'* **CBR**'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'TransMode' => ['description' => 'Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained after transcoding. Valid values:'."\n" ."\n" .'* **true**: The resolution is checked.'."\n" .'* **false**: The resolution is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Indicates whether the video bitrate is checked. This parameter has a higher priority than the IsCheckVideoBitrate parameter. Valid values:'."\n" ."\n" .'* **true**: The video bitrate is checked'."\n" .'* **false**: The video bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'The method of resolution adjustment. Default value: **none**. Valid values:'."\n" ."\n" .'* rescale: The input video is rescaled.'."\n" .'* crop: The input video is cropped.'."\n" .'* none: No change is made.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'AdjDarMethod' => ['description' => 'Indicates whether the video bitrate is checked. If this parameter is set to true and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding. Valid values:'."\n" ."\n" .'* **true**: The video bitrate is checked.'."\n" .'* **false**: The video bitrate is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'none', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Indicates whether the resolution is checked. If this parameter is set to true and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned. Valid values:'."\n" ."\n" .'* **true**: The resolution is checked.'."\n" .'* **false**: The resolution is not checked.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Indicates whether the audio bitrate is checked. This parameter has a higher priority than the IsCheckAudioBitrate parameter. Valid values:'."\n" ."\n" .'* **true**: The audio bitrate is checked.'."\n" .'* **false**: The audio bitrate is not checked.'."\n" .'* Default value: **false**.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'The status of the template. Valid values:'."\n" ."\n" .'* **Normal**: The template is normal.'."\n" .'* **Deleted**: The template is deleted.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'State' => ['description' => 'The transmuxing configurations.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'MuxConfig' => [ 'description' => 'The transmuxing configurations for WebP.'."\n", 'type' => 'object', 'properties' => [ 'Webp' => [ 'description' => 'The loop count.'."\n", 'type' => 'object', 'properties' => [ 'Loop' => ['description' => 'The transmuxing configurations for GIF.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gif' => [ 'description' => 'The duration for which the final frame is paused. Unit: milliseconds.'."\n", 'type' => 'object', 'properties' => [ 'FinalDelay' => ['description' => 'The color dithering algorithm of the palette. Valid values: sierra and bayer.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'DitherMode' => ['description' => 'The loop count.'."\n", 'type' => 'string', 'example' => 'bayer', 'title' => ''], 'Loop' => ['description' => 'Indicates whether the custom palette is used.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'IsCustomPalette' => ['description' => 'The segment configurations.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Segment' => [ 'description' => 'The length of the segment. Unit: seconds.'."\n", 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The audio codec configurations.'."\n", 'type' => 'string', 'example' => 'MPS-example', 'title' => ''], 'Audio' => [ 'description' => 'The audio codec settings.'."\n", 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'Indicates whether the audio stream is deleted.'."\n" ."\n" .'* **true**: The audio stream is deleted.'."\n" .'* **false**: The audio stream is retained.'."\n" .'* Default value: **false**.'."\n", 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Remove' => ['description' => 'The audio codec format. Default value: **aac**. Valid values:'."\n" ."\n" .'* **aac**'."\n" .'* **mp3**'."\n" .'* **vorbis**'."\n" .'* **flac**'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Codec' => ['description' => 'The sampling rate.'."\n" ."\n" .'* Unit: Hz.'."\n" .'* Default value: **44100**.'."\n", 'type' => 'string', 'example' => 'aac', 'title' => ''], 'Samplerate' => ['description' => 'The level of the independent denoising algorithm.'."\n", 'type' => 'string', 'example' => '44100', 'title' => ''], 'Qscale' => ['description' => 'The number of sound channels. Default value: **2**.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Channels' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Valid values: 8 to 1000.****'."\n" .'* Unit: Kbit/s.'."\n" .'* Default value: **128**.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'Bitrate' => ['description' => 'The ID of the transcoding template.'."\n", 'type' => 'string', 'example' => '500', 'title' => ''], 'Volume' => [ 'description' => 'The volume control configurations.'."\n", 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'The volume adjustment method. Valid values:'."\n" ."\n" .'* **auto**'."\n" .'* **dynamic**'."\n" .'* **linear**'."\n", 'type' => 'string', 'example' => 'auto', 'title' => ''], 'TruePeak' => ['description' => 'The peak volume.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is dynamic.'."\n" .'* Unit: decibel.'."\n" .'* Valid values: \\[-9,0].'."\n" .'* Default value: -1.'."\n", 'type' => 'string', 'example' => '-1', 'title' => ''], 'IntegratedLoudnessTarget' => ['description' => 'The expected volume.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is dynamic.'."\n" .'* Unit: decibel.'."\n" .'* Valid values: \\[-70,-5].'."\n" .'* Default value: -6.'."\n", 'type' => 'string', 'example' => '-6', 'title' => ''], 'Level' => ['description' => 'The increased volume relative to the volume of the input audio.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is linear.'."\n" .'* Unit: decibel.'."\n" .'* Valid values: less than or equal to 20.'."\n" .'* Default value: -20.'."\n", 'type' => 'string', 'example' => '-20', 'title' => ''], 'LoudnessRangeTarget' => ['description' => 'The range of the volume relative to the expected volume.'."\n" ."\n" .'* This parameter takes effect only if the value of Method is dynamic.'."\n" .'* Unit: decibel.'."\n" .'* Valid values: \\[1,20].'."\n" .'* Default value: 8.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'PeakLevel' => ['title' => '', 'description' => 'The volume adjustment coefficient.'."\n" ."\n" .'This parameter takes effect only if the value of Method is adaptive.'."\n" ."\n" .'Valid values: \\[0,1].'."\n" ."\n" .'Default value: 0.9.'."\n", 'type' => 'string', 'example' => '0.9'], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'The container configurations.'."\n", 'type' => 'string', 'example' => '16f01ad6175e4230ac42bb5182cd****', 'title' => ''], 'Container' => [ 'description' => 'The container format.'."\n", 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The container format.'."\n", 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Update custom transcoding template', 'summary' => 'Update custom transcoding template settings.', 'description' => 'If any job with the status "Submitted" specifies the use of this custom template, the corresponding transcoding template information cannot be updated.'."\n" ."\n" .'## QPS Limit'."\n" .'The queries per second (QPS) limit for this API is 100 requests per second per user. If the limit is exceeded, API calls will be subject to rate limiting, which may impact your business. Please invoke the API appropriately. For more information, see [QPS Limits](~~342832~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-03-13T07:14:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-10T06:44:43.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-04T02:22:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-13T05:42:26.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'UpdateWaterMarkTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'WaterMarkTemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the watermark template that you want to update. To obtain the ID of the watermark template, you can log on to the **ApsaraVideo Media Processing (MPS) console** and choose **Global Settings** > **Watermark Templates** in the left-side navigation pane.'."\n", 'type' => 'string', 'required' => true, 'example' => '3780bd69b2b74540bc7b1096f564****', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The new name of the watermark template. The value can contain letters and digits and can be up to 128 bytes in size.'."\n", 'type' => 'string', 'required' => true, 'example' => 'example-watermark-****', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The updated configuration of the watermark template. The value is a JSON object. For more information, see [Parameter details](~~29253~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '{"Width":"10","Height":"30","Dx":"10","Dy":"5","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'WaterMarkTemplate' => [ 'description' => 'The details of the watermark template.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the watermark. Valid values:'."\n" ."\n" .'* Image: an image watermark.'."\n" .'* Text: a text watermark.'."\n" ."\n" .'> Only watermarks of the Image type are supported.'."\n", 'type' => 'string', 'example' => 'Image', 'title' => ''], 'RatioRefer' => [ 'description' => 'The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:'."\n" ."\n" .'* **Width**: the width edge.'."\n" .'* **Height**: the height edge.'."\n" .'* **Long**: the long edge.'."\n" .'* **Short**: the short edge.'."\n", 'type' => 'object', 'properties' => [ 'Dx' => ['description' => 'The horizontal offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.51', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the width of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.36', 'title' => ''], 'Height' => ['description' => 'The height of the watermark image in the output video. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the height of the watermark image. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.33', 'title' => ''], 'Dy' => ['description' => 'The vertical offset of the watermark relative to the output video image. Default value: **0**. The default value indicates no offset. The value can be an integer or a decimal.'."\n" ."\n" .'* **Integer**: the vertical offset. This indicates the absolute position. Unit: pixel.'."\n" .'* **Decimal**: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.'."\n", 'type' => 'string', 'example' => '0.28', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ReferPos' => ['description' => 'The position of the watermark. Valid values:'."\n" ."\n" .'* **TopRight**: the upper-right corner.'."\n" .'* **TopLeft**: the upper-left corner.'."\n" .'* **BottomRight**: the lower-right corner.'."\n" .'* **BottomLeft**: the lower-left corner.'."\n", 'type' => 'string', 'example' => 'TopRight', 'title' => ''], 'State' => ['description' => 'The status of the watermark template. Default value: **Normal**.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Dx' => ['description' => 'The horizontal offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Width' => ['description' => 'The width of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Height' => ['description' => 'The height of the watermark image. Unit: pixel.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''], 'Timeline' => [ 'description' => 'The timeline of the watermark.'."\n", 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The beginning of the time range during which the watermark is displayed.'."\n" ."\n" .'* Unit: seconds.'."\n" .'* Default value: **0**.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The display duration of the watermark. Default value: **ToEND**. The default value indicates that the watermark is displayed until the video ends.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the watermark template.'."\n", 'type' => 'string', 'example' => 'example-watermark-****', 'title' => ''], 'Dy' => ['description' => 'The vertical offset. Unit: pixel.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'Id' => ['description' => 'The ID of the watermark template. We recommend that you keep this ID for subsequent operation calls.'."\n", 'type' => 'string', 'example' => '3780bd69b2b74540bc7b1096f564****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E558894E-40D9-57C6-B5CC-0F5CDF23614E', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'UpdateWaterMarkTemplate', 'summary' => 'Updates the name and configurations of the specified watermark template.', 'description' => '* You can call this operation to update the information about a watermark template based on the ID of the watermark template. For example, you can update the name and configurations of a watermark template.'."\n" .'* A watermark template cannot be updated if it is being used by a job that has been submitted.'."\n" ."\n" .'### QPS limit'."\n" ."\n" .'You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see [QPS limit](~~342832~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-18T12:04:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWaterMarkTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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":""}]', ], ], 'endpoints' => [ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.cn-shenzhen.aliyuncs.com', 'endpoint' => 'mts.cn-shenzhen.aliyuncs.com', 'vpc' => 'mts-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.cn-beijing.aliyuncs.com', 'endpoint' => 'mts.cn-beijing.aliyuncs.com', 'vpc' => 'mts-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.ap-northeast-1.aliyuncs.com', 'endpoint' => 'mts.ap-northeast-1.aliyuncs.com', 'vpc' => 'mts-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.cn-qingdao.aliyuncs.com', 'endpoint' => 'mts.cn-qingdao.aliyuncs.com', 'vpc' => 'mts-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.cn-shanghai.aliyuncs.com', 'endpoint' => 'mts.cn-shanghai.aliyuncs.com', 'vpc' => 'mts-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.cn-hongkong.aliyuncs.com', 'endpoint' => 'mts.cn-hongkong.aliyuncs.com', 'vpc' => 'mts-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.ap-southeast-1.aliyuncs.com', 'endpoint' => 'mts.ap-southeast-1.aliyuncs.com', 'vpc' => 'mts-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.ap-southeast-5.aliyuncs.com', 'endpoint' => 'mts.ap-southeast-5.aliyuncs.com', 'vpc' => 'mts-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'mts.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'mts-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'mts.cn-hangzhou.aliyuncs.com', 'endpoint' => 'mts.cn-hangzhou.aliyuncs.com', 'vpc' => 'mts-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'mts.us-west-1.aliyuncs.com', 'endpoint' => 'mts.us-west-1.aliyuncs.com', 'vpc' => 'mts-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'mts.eu-central-1.aliyuncs.com', 'endpoint' => 'mts.eu-central-1.aliyuncs.com', 'vpc' => 'mts-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'mts.eu-west-1.aliyuncs.com', 'endpoint' => 'mts.eu-west-1.aliyuncs.com', 'vpc' => 'mts-vpc.eu-west-1.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'AccessDenied', 'message' => 'The OwnerId that your Access Key Idassociated to is forbidden for this operation.', 'http_code' => 400, 'description' => ''], ['code' => 'Bucket.AlreadyBind', 'message' => 'Bucket already binded to media store for this type', 'http_code' => 400, 'description' => ''], ['code' => 'Bucket.NotBind', 'message' => 'Bucket is not binded to media store', 'http_code' => 400, 'description' => ''], ['code' => 'Bucket.NotExist ', 'message' => 'OSS Bucket \\%s\\ not exit', 'http_code' => null, 'description' => ''], ['code' => 'DataEncryption.CiphertextNotExist', 'message' => 'The ciphertext does not exist', 'http_code' => 400, 'description' => 'A ciphertext error occurred. Check whether the ciphertext is correct.'], ['code' => 'DataEncryption.ContainerFormatNotSupported', 'message' => 'The container format only support: m3u8', 'http_code' => 400, 'description' => ''], ['code' => 'DB.ConcurrentUpdate', 'message' => 'concurrent update db', 'http_code' => 400, 'description' => ''], ['code' => 'EntityNotExist.Role', 'message' => 'The role does not exist.', 'http_code' => 400, 'description' => ''], ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 401, 'description' => ''], ['code' => 'InternalError', 'message' => 'The operation has failed due to some unknown error, exception or failure', 'http_code' => 500, 'description' => ''], ['code' => 'InternalError', 'message' => 'errorMsg:%s', 'http_code' => 500, 'description' => ''], ['code' => 'InvalidArgument', 'message' => 'The length of message should not be larger than MaximumMessageSize.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidIdentity.ServiceDisabled', 'message' => 'The request identity was not allowed operated.', 'http_code' => 400, 'description' => 'The service has not been activated or has been frozen. Check the status of the service.'], ['code' => 'InvalidParameter', 'message' => 'The specified parameter \\”%s\\” is not valid.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.BucketNameInvalid', 'message' => 'The bucket name \\”%s\\” is invalid. A bucket name must: 1) be comprised of lower-case characters, numbers, underscore(_) or dash(-); 2) start with lower case or numbers; 3) be between 3-255 characters long.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.EmptyValue', 'message' => 'The specified parameter \\”%s\\” cannot be empty', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.Format', 'message' => 'The format of parameter \\”%s\\” is invalid', 'http_code' => 400, 'description' => 'The specified parameter is in an invalid format.'], ['code' => 'InvalidParameter.InvalidBase64Format', 'message' => 'The specified parameter “%s” should be encoded by base64_urlsafe', 'http_code' => null, 'description' => 'This parameter is invalid because it does not conform to the Base64 format.'], ['code' => 'InvalidParameter.InvalidLength', 'message' => 'The maximum length of the parameter is exceeded.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.InvalidState', 'message' => 'The specified parameter \\”%s\\” is not valid', 'http_code' => null, 'description' => 'The status is invalid.'], ['code' => 'InvalidParameter.JobNotFound', 'message' => 'The job is not found.', 'http_code' => 400, 'description' => 'The specified job does not exist.'], ['code' => 'InvalidParameter.JsonArrayFormatInvalid', 'message' => 'The parameter \\”%s\\” does not conform to the JSON Array specification', 'http_code' => null, 'description' => 'The parameter is not a valid JSON array.'], ['code' => 'InvalidParameter.JsonFormatInvalid', 'message' => 'The parameter \\”%s\\” does not conform to the JSON specification', 'http_code' => 400, 'description' => 'The parameter is not a valid JSON string.'], ['code' => 'InvalidParameter.JsonObjectFormatInvalid', 'message' => 'The parameter \\”%s\\” does not conform to the JSON Object specification', 'http_code' => 400, 'description' => 'The parameter is not a valid JSON string.'], ['code' => 'InvalidParameter.ListSizeExceed', 'message' => 'The specified parameter “%s” size exceed', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.LocationInvalid', 'message' => 'The location \\”%s\\” is invalid. A location name shoud be one of five:oss-cn-hangzhou,oss-cn-qingdao,oss-cn-beijing,oss-cn-hongkong,oss-cn-shenzhen.And now MTS only support oss-cn-hangzhou.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.MergeFileNoVideoOrAudio', 'message' => 'The merge File must contain video and audio stream at the sametime', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.NoAudioStream', 'message' => 'The resource has no audio stream', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.NotSupported', 'message' => 'The specified parameter \\”%s\\” is not supported.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.NullValue', 'message' => 'The specified parameter \\”%s\\” cannot be null', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.NumberFormatInvalid', 'message' => 'The number format of parameter \\”%s\\” is invalid', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.ObjectKeyInvalid', 'message' => 'The object key \\”%s\\” is invalid. An object name should be between 1 - 1023 bytes long when encoded as UTF-8 and cannot contain LF or CR or unsupported chars in XML1.0.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.OutOfRange', 'message' => 'The specified parameter \\”%s\\” is out of range', 'http_code' => null, 'description' => 'The parameter value is beyond the valid range.'], ['code' => 'InvalidParameter.OutOfRange', 'message' => 'The specified parameter %s is out of range.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.ResourceContentBad', 'message' => 'The resource operated \\”%s\\” is bad.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.ResourceDeleted', 'message' => 'The resource operated \\”%s\\” has been deleted', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.ResourceNotFound', 'message' => 'The resource operated \\”%s\\” cannot be found', 'http_code' => null, 'description' => 'The resource that you want to manage does not exist.'], ['code' => 'InvalidParameter.ResourceNotSupported', 'message' => 'The resource operated \\”%s\\” is not supported.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.ServiceNotSupportRegion', 'message' => 'The parameter region “%s” has not support the open video service', 'http_code' => null, 'description' => 'The feature is not available in this region.'], ['code' => 'InvalidParameter.SizeExceed', 'message' => 'The specified parameter \\%s\\ is too long', 'http_code' => 400, 'description' => 'The length of the parameter exceeds the limit.'], ['code' => 'InvalidParameter.TemplateNotFound', 'message' => 'The Template operated \\”%s\\” cannot be found', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter.TemplateNotSupported', 'message' => 'The template operated \\”%s\\” is not supported.', 'http_code' => null, 'description' => 'The template that you are using is not supported. For example, the preset template specified when you submit a job is not in the list of preset templates recommended when intelligent analysis is successful.'], ['code' => 'InvalidParameter.UUIDFormatInvalid', 'message' => 'The parameter \\”%s\\” is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long', 'http_code' => null, 'description' => 'Invalid ID. The ID does not conform to the UUID specification.'], ['code' => 'InvalidParameter.WaterMarkFileFormatNotSupported', 'message' => 'The resource operated “%s” is not supported, watermark only supports png file', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidQueueName', 'message' => 'The queue name you provided is invalid. QueueName should start with alpha and contain only alpha, digit or - .', 'http_code' => 400, 'description' => ''], ['code' => 'Media.PublishState', 'message' => 'The Media state can not be changed from Initiated to Unpublish/Published by this api', 'http_code' => 400, 'description' => ''], ['code' => 'MediaWorkflow.Inactive', 'message' => 'The MediaWrokflow is Inactive', 'http_code' => 400, 'description' => ''], ['code' => 'MediaWorkflow.InputNotSupported', 'message' => 'The MediaWrokflow does not support the input,location | input,object | input,bucket does not match', 'http_code' => 400, 'description' => ''], ['code' => 'MediaWorkflow.NotExist', 'message' => 'The MediaWrokflow does not exist', 'http_code' => 400, 'description' => ''], ['code' => 'MediaWorkflow.NotFound', 'message' => 'The MediaWrokflow not found', 'http_code' => 400, 'description' => ''], ['code' => 'MediaWorkflow.PreviousActivityNotSupported', 'message' => 'The MediaWrokflow activity previous activity is not supported', 'http_code' => 400, 'description' => ''], ['code' => 'NotFoundThisTriggerMode', 'message' => 'The trigger mode is not found', 'http_code' => 400, 'description' => ''], ['code' => 'NotSupportedJob.AnalysisJobNotSupported', 'message' => 'Analysis Job cannot be supported by boost pipeline.', 'http_code' => 400, 'description' => ''], ['code' => 'NotSupportedJob.ContainerFormatNotSupported', 'message' => 'In user defined template \\”%s”,container format \\”%s” is not m3u8, cannot be supported by boost pipeline.', 'http_code' => 400, 'description' => ''], ['code' => 'NotSupportedJob.DurationIsLessThanHalfAnHour', 'message' => 'Duration is \\”%s\\” less than half an hour,cannot be supported by boost pipeline.', 'http_code' => 400, 'description' => ''], ['code' => 'NotSupportedJob.SystemTemplateJobNotSupported', 'message' => 'The Template \\”%s\\” is a system template,cannot be supported by boost pipeline.', 'http_code' => 400, 'description' => ''], ['code' => 'OSS.AccessDenied', 'message' => 'Permission denied,can not call setObjectACL', 'http_code' => 400, 'description' => 'OSS denies access. Make sure that you have access permissions.'], ['code' => 'ParameterNotBoolean', 'message' => 'ParameterNotBoolean”, “The Parameter “%s” is not boolean value', 'http_code' => 400, 'description' => ''], ['code' => 'Parameters.NotSupported', 'message' => 'The Parameters “%s” is not supported the same time,choose one of them', 'http_code' => 400, 'description' => ''], ['code' => 'PermissionDenied.JobInComplete', 'message' => 'The Job operated \\”%s\\” is complete, cannot cancel', 'http_code' => 400, 'description' => ''], ['code' => 'PermissionDenied.JobInFailure', 'message' => 'The Job operated \\”%s\\” is failure, cannot cancel', 'http_code' => 400, 'description' => ''], ['code' => 'PermissionDenied.JobInRunning', 'message' => 'The Job operated is running, cannot cancel', 'http_code' => 400, 'description' => ''], ['code' => 'PermissionDenied.ResourceAccess', 'message' => 'MTS not authorized to operate on the specified resource \\”%s\\”', 'http_code' => 400, 'description' => ''], ['code' => 'PermissionDenied.ResourceQuotaExceed', 'message' => 'The resource \\”%s\\” quota has been used up', 'http_code' => 400, 'description' => 'The resource quota has been used up.'], ['code' => 'QuerySubmitSoQuickly', 'message' => 'Query submit so quickly, please wait for 3 mins', 'http_code' => 400, 'description' => ''], ['code' => 'QueueNotExist', 'message' => 'The queue name you provided is not exist.', 'http_code' => 400, 'description' => ''], ['code' => 'TopicNameInvalid', 'message' => 'The topic name you provided is invalid. TopicName should start with alpha or digit and contain only alpha, digit or -.', 'http_code' => 400, 'description' => ''], ['code' => 'TopicNotExist', 'message' => 'The Topic you provided does not exist.', 'http_code' => 400, 'description' => ''], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryMediaInfoJobList'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitMediaInfoJob'], ], 'createdAt' => '2025-10-24T07:33:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitMediaCensorJob'], ], 'createdAt' => '2024-07-23T06:13:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitCopyrightJob'], ['description' => 'Request parameters changed', 'api' => 'SubmitImageCopyright'], ['description' => 'Request parameters changed', 'api' => 'SubmitTraceAbJob'], ['description' => 'Request parameters changed', 'api' => 'SubmitTraceM3u8Job'], ], 'createdAt' => '2024-07-23T02:15:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'QuerySnapshotJobList'], ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'SubmitSnapshotJob'], ], 'createdAt' => '2024-04-24T06:40:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QuerySnapshotJobList'], ['description' => 'Response parameters changed', 'api' => 'SubmitSnapshotJob'], ], 'createdAt' => '2024-04-10T03:44:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'SearchTemplate'], ], 'createdAt' => '2024-03-14T06:39:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AddTemplate'], ['description' => 'Response parameters changed', 'api' => 'QueryTemplateList'], ['description' => 'Response parameters changed', 'api' => 'UpdateTemplate'], ], 'createdAt' => '2024-03-13T07:15:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DeletePipeline'], ['description' => 'Error codes changed', 'api' => 'DeleteTemplate'], ], 'createdAt' => '2024-01-30T11:51:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'UpdateTemplate'], ], 'createdAt' => '2024-01-10T06:45:24.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AddTemplate'], ['description' => 'Response parameters changed', 'api' => 'QueryTemplateList'], ['description' => 'Response parameters changed', 'api' => 'SearchTemplate'], ['description' => 'Response parameters changed', 'api' => 'UpdateTemplate'], ], 'createdAt' => '2024-01-04T02:22:56.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryMediaCensorJobDetail'], ['description' => 'Response parameters changed', 'api' => 'QueryMediaCensorJobList'], ], 'createdAt' => '2023-12-07T09:56:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AddPipeline'], ], 'createdAt' => '2023-09-21T09:57:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddPipeline'], ['description' => 'Response parameters changed', 'api' => 'QueryJobList'], ['description' => 'Response parameters changed', 'api' => 'SearchPipeline'], ['description' => 'Response parameters changed', 'api' => 'SearchTemplate'], ], 'createdAt' => '2023-09-21T08:16:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryJobList'], ], 'createdAt' => '2023-08-03T07:44:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryTemplateList'], ['description' => 'Response parameters changed', 'api' => 'SearchPipeline'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchTemplate'], ['description' => 'Response parameters changed', 'api' => 'UpdateTemplate'], ], 'createdAt' => '2023-07-13T05:44:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'SubmitSmarttagJob'], ], 'createdAt' => '2023-07-05T06:18:01.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryJobList'], ], 'createdAt' => '2023-06-13T02:41:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'QueryJobList'], ['description' => 'Response parameters changed', 'api' => 'UpdatePipeline'], ], 'createdAt' => '2023-06-13T02:32:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'SearchPipeline'], ], 'createdAt' => '2023-06-08T02:47:47.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ListFpShotFiles'], ], 'createdAt' => '2022-09-08T09:24:45.000Z', 'description' => '更新ListFpShotFiles接口', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddSmarttagTemplate'], ['description' => 'OpenAPI offline', 'api' => 'CreateCustomEntity'], ['description' => 'OpenAPI offline', 'api' => 'CreateCustomGroup'], ['description' => 'OpenAPI offline', 'api' => 'DeleteCustomEntity'], ['description' => 'OpenAPI offline', 'api' => 'DeleteCustomGroup'], ['description' => 'OpenAPI offline', 'api' => 'DeleteCustomView'], ['description' => 'OpenAPI offline', 'api' => 'ListCustomEntities'], ['description' => 'OpenAPI offline', 'api' => 'ListCustomGroups'], ['description' => 'OpenAPI offline', 'api' => 'ListCustomViews'], ['description' => 'Response parameters changed', 'api' => 'QuerySmarttagTemplateList'], ], 'createdAt' => '2022-09-06T14:44:16.000Z', 'description' => '自注册接口发布', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListFpShotFiles'], ], 'createdAt' => '2022-08-30T11:00:23.000Z', 'description' => '更新ListFpShotFiles', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ImAudit'], ], 'createdAt' => '2022-08-30T02:27:06.000Z', 'description' => '补全图文审核IMAudit返回结果参数', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitFpFileDeleteJob'], ], 'createdAt' => '2022-08-11T12:22:32.000Z', 'description' => 'SubmitFpFileDeleteJob新增PrimaryKeys参数', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitIProductionJob'], ], 'createdAt' => '2022-06-17T06:11:39.000Z', 'description' => 'SubmitIproductionJob接口PipelineId字段文档改成非必填', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BindInputBucket'], ['description' => 'Request parameters changed', 'api' => 'BindOutputBucket'], ['description' => 'Request parameters changed', 'api' => 'UnbindInputBucket'], ], 'createdAt' => '2022-05-27T01:49:33.000Z', 'description' => '不对外参数设置为私有', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SubmitSyncFpShotJob'], ], 'createdAt' => '2022-03-01T16:04:55.000Z', 'description' => '新增同步图搜视频搜接口', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BindInputBucket'], ['description' => 'Request parameters changed', 'api' => 'BindOutputBucket'], ['description' => 'Request parameters changed', 'api' => 'UnbindInputBucket'], ], 'createdAt' => '2022-03-01T16:04:25.000Z', 'description' => '接口参数维护', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ImportFpShotJob'], ], 'createdAt' => '2022-03-01T16:04:15.000Z', 'description' => '修改ImportFpShotJob参数是否必填 ListFpShotImportJob改为公开', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryFpShotJobList'], ], 'createdAt' => '2022-02-18T03:00:15.000Z', 'description' => '调整QueryFpShotJobList部分参数可见性', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CheckResource'], ], 'createdAt' => '2022-01-11T12:09:40.000Z', 'description' => '内部使用接口直接设置为私有', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BindInputBucket'], ['description' => 'Response parameters changed', 'api' => 'ListAllMediaBucket'], ], 'createdAt' => '2022-01-11T06:18:44.000Z', 'description' => '绑定InputBucket支持接受防盗链信息', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddSmarttagTemplate'], ['description' => 'Response parameters changed', 'api' => 'QuerySmarttagTemplateList'], ['description' => 'Request parameters changed', 'api' => 'UpdateSmarttagTemplate'], ], 'createdAt' => '2021-12-17T01:59:24.000Z', 'description' => '模板添加自定义人脸参数配置支持，faceCustomParamsConfig', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryJobList'], ], 'createdAt' => '2021-12-15T03:36:33.000Z', 'description' => 'QueryJobList 增加返回值', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ListJob'], ['description' => 'Error codes changed', 'api' => 'ListMediaWorkflowExecutions'], ['description' => 'Error codes changed', 'api' => 'QueryMediaList'], ['description' => 'Error codes changed', 'api' => 'QueryMediaListByURL'], ['description' => 'Error codes changed', 'api' => 'QueryMediaWorkflowExecutionList'], ['description' => 'Error codes changed', 'api' => 'QueryMediaWorkflowList'], ['description' => 'Error codes changed', 'api' => 'SearchMediaWorkflow'], ['description' => 'Error codes changed', 'api' => 'SubmitJobs'], ['description' => 'Error codes changed', 'api' => 'UpdateMedia'], ], 'createdAt' => '2021-12-15T03:35:52.000Z', 'description' => '修改 action 参数为必选项', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ImAudit'], ['description' => 'Error codes changed', 'api' => 'QueryMediaCensorJobDetail'], ], 'createdAt' => '2021-12-07T15:36:59.000Z', 'description' => '发布完毕', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'QuerySmarttagJob'], ], 'createdAt' => '2021-12-07T15:36:00.000Z', 'description' => 'done', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'QueryFpShotJobList'], ], 'createdAt' => '2021-12-01T09:28:33.000Z', 'description' => '修改QueryFpShotJobList参数JobIds非必填', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddSmarttagTemplate'], ['description' => 'Error codes changed', 'api' => 'DeleteSmarttagTemplate'], ['description' => 'Response parameters changed', 'api' => 'QuerySmarttagTemplateList'], ['description' => 'Request parameters changed', 'api' => 'UpdateSmarttagTemplate'], ], 'createdAt' => '2021-12-01T09:28:03.000Z', 'description' => '发布', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'AddSmarttagTemplate'], ['description' => 'Response parameters changed, Error codes changed', 'api' => 'QuerySmarttagTemplateList'], ], 'createdAt' => '2021-11-26T10:25:24.000Z', 'description' => 'dev', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'QueryFpCompareJobList'], ['description' => 'Error codes changed', 'api' => 'QueryFpImportResult'], ], 'createdAt' => '2021-11-26T10:12:36.000Z', 'description' => '修改接口参数配置', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'QueryFpShotJobList'], ], 'createdAt' => '2021-11-26T06:34:49.000Z', 'description' => '增加query参数支持', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'QueryIProductionJob'], ['description' => 'Error codes changed', 'api' => 'SubmitIProductionJob'], ], 'createdAt' => '2021-11-23T04:16:19.000Z', 'description' => '智能生产接口参数调整', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ActivateMediaWorkflow'], ['description' => 'Error codes changed', 'api' => 'AddMedia'], ['description' => 'Error codes changed', 'api' => 'AddMediaTag'], ['description' => 'Error codes changed', 'api' => 'AddMediaWorkflow'], ['description' => 'Error codes changed', 'api' => 'AddTemplate'], ['description' => 'Error codes changed', 'api' => 'AddWaterMarkTemplate'], ['description' => 'Error codes changed', 'api' => 'BindInputBucket'], ['description' => 'Error codes changed', 'api' => 'BindOutputBucket'], ['description' => 'Error codes changed', 'api' => 'CancelJob'], ['description' => 'Error codes changed', 'api' => 'DeactivateMediaWorkflow'], ], 'createdAt' => '2021-11-18T12:14:06.000Z', 'description' => 'Action是否必填属性更新为是', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'QuerySnapshotJobList'], ['description' => 'Error codes changed', 'api' => 'SubmitSnapshotJob'], ['description' => 'Error codes changed', 'api' => 'UpdatePipeline'], ], 'createdAt' => '2021-11-05T03:19:32.000Z', 'description' => 'Action是否必选设置为“是”', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'ImAudit'], ], 'createdAt' => '2021-11-04T03:07:32.000Z', 'description' => 'ImAudit接口修改', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ListFpShotImportJob'], ], 'createdAt' => '2021-09-28T06:58:36.000Z', 'description' => '增加文本指纹导库查询接口', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitURLUploadJob'], ], 'createdAt' => '2021-09-06T08:11:55.000Z', 'description' => '产出文件支持存储到外部 S3', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SubmitOssFileCopyJob'], ], 'createdAt' => '2021-09-06T08:11:26.000Z', 'description' => '可以提交Oss文件拷贝作业', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInferenceServer'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListInferenceJob'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryInferenceJob'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryInferenceServer'], ['description' => 'Request parameters changed', 'api' => 'SubmitInferenceJob'], ], 'createdAt' => '2021-06-10T02:42:32.000Z', 'description' => 'PAI部署视频云查询接口修改', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SubmitMediaInfoJob'], ], 'createdAt' => '2021-05-18T07:56:31.000Z', 'description' => 'submitMediaInfo接口，支持返回colorRange、colorTransfer、colorPrimaries', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'QueryMediaInfoJobList'], ], 'createdAt' => '2021-05-17T02:34:51.000Z', 'description' => '接口QueryMediaInfoJob接口新增色彩描述相关字段，分别是 colorRange、colorTransfer、colorPrimaries', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateInferenceServer'], ['description' => 'OpenAPI offline', 'api' => 'ListInferenceJob'], ['description' => 'OpenAPI offline', 'api' => 'QueryInferenceJob'], ['description' => 'OpenAPI offline', 'api' => 'QueryInferenceServer'], ['description' => 'OpenAPI offline', 'api' => 'SubmitInferenceJob'], ], 'createdAt' => '2021-05-11T06:16:30.000Z', 'description' => '新增PAI服务部署功能', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySnapshotJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitFpDBDeleteJob'], ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaCensorJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightExtractJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaPublishState'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMediaTag'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitFpFileDeleteJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindInputBucket'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaWorkflowExecutionList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAnalysisJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomGroups'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFpShotDB'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceAbJob'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllMediaBucket'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSmarttagTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchPipeline'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindOutputBucket'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaCategory'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterCustomView'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaWorkflow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFpShotJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaWorkflowExecutions'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomView'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaTag'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSmarttagTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaterMarkTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFpShotImportJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTemplateList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaListByURL'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMedia'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeactivateMediaWorkflow'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitImageCopyright'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMedia'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomEntities'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindOutputBucket'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPipeline'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFpDBDeleteJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterCustomFace'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaInfoJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaWorkflow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobDetail'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagCustomPerson'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImAudit'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryWaterMarkTemplateList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaWorkflow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmarttagTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaInfoJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomEntity'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomGroup'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceM3u8Job'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaWorkflowList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitIProductionJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmarttagJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightExtractJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitJobs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmarttagJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaCover'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryIProductionJob'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceM3u8Job'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomViews'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWaterMarkTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFpFileDeleteJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaWorkflowTriggerMode'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateMediaWorkflow'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSnapshotJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFpShotFiles'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomPersons'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMedia'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportFpShotJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceExtractJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindInputBucket'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFpShotDB'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPipelineList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomEntity'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterCustomFace'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceAbJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAnalysisJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmarttagTemplateList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitFpShotJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceExtractJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchWaterMarkTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMediaWorkflow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddWaterMarkTemplate'], ], ], 'ram' => [ 'productCode' => 'MPS', 'productName' => 'ApsaraVideo Media Processing', 'ramCodes' => ['mts'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'QueryJobList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelJob', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:CancelJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddTemplate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QuerySnapshotJobList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'mts:QuerySnapshotJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitTraceExtractJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitTraceExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryMediaList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMediaWorkflow', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAllMediaBucket', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListAllMediaBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCustomView', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteCustomView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeletePipeline', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeletePipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'BindInputBucket', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:BindInputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteWaterMarkTemplate', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SearchMediaWorkflow', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitSnapshotJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitSnapshotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UnregisterCustomFace', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:UnregisterCustomFace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateCustomEntity', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:CreateCustomEntity', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryIProductionJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryIProductionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SearchPipeline', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchPipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCustomGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteCustomGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteSmarttagTemplate', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteSmarttagTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UnbindOutputBucket', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:UnbindOutputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'TagCustomPerson', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:TagCustomPerson', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryAnalysisJobList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryAnalysisJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitFpShotJob', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitFpShotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ImAudit', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:ImAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCustomEntities', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomEntities', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMedia', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ActivateMediaWorkflow', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:ActivateMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFpShotImportJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListFpShotImportJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddWaterMarkTemplate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitMediaCensorJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitMediaCensorJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCustomViews', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomViews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ImportFpShotJob', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:ImportFpShotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QuerySmarttagJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QuerySmarttagJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryMediaWorkflowList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaWorkflowList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCustomGroups', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMediaWorkflow', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitSmarttagJob', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitSmarttagJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitTraceAbJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitTraceAbJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMediaTag', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteMediaTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryTraceM3u8Job', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryTraceM3u8Job', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteTemplate', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitIProductionJob', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitIProductionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RegisterCustomView', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:RegisterCustomView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddMediaWorkflow', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateCustomGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:CreateCustomGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SearchWaterMarkTemplate', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdatePipeline', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdatePipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryWaterMarkTemplateList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryWaterMarkTemplateList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryTraceExtractJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryTraceExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitFpDBDeleteJob', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitFpDBDeleteJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitJobs', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddPipeline', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddPipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryPipelineList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryPipelineList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryFpShotJobList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryFpShotJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryFpFileDeleteJobList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryFpFileDeleteJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QuerySmarttagTemplateList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QuerySmarttagTemplateList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitTraceM3u8Job', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitTraceM3u8Job', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryMediaInfoJobList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaInfoJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitAnalysisJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitAnalysisJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMediaCategory', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaCategory', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateWaterMarkTemplate', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateWaterMarkTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateTemplate', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SearchTemplate', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:SearchTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitCopyrightJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitCopyrightJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeactivateMediaWorkflow', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:DeactivateMediaWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RegisterCustomFace', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:RegisterCustomFace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UnbindInputBucket', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:UnbindInputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddSmarttagTemplate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddSmarttagTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMediaWorkflowTriggerMode', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaWorkflowTriggerMode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitFpFileDeleteJob', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:SubmitFpFileDeleteJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddMedia', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMediaPublishState', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaPublishState', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFpShotFiles', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListFpShotFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateFpShotDB', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:CreateFpShotDB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryMediaWorkflowExecutionList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaWorkflowExecutionList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'BindOutputBucket', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'mts:BindOutputBucket', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFpShotDB', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListFpShotDB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListMediaWorkflowExecutions', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListMediaWorkflowExecutions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitMediaInfoJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:SubmitMediaInfoJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCustomPersons', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:ListCustomPersons', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitCopyrightExtractJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitCopyrightExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddMediaTag', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'mts:AddMediaTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryMediaListByURL', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaListByURL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryMediaCensorJobList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaCensorJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMedia', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitImageCopyright', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:SubmitImageCopyright', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMediaCover', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateMediaCover', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateSmarttagTemplate', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'mts:UpdateSmarttagTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryCopyrightJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryCopyrightJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryTemplateList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryTemplateList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCustomEntity', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'mts:DeleteCustomEntity', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryFpDBDeleteJobList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryFpDBDeleteJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryMediaCensorJobDetail', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'mts:QueryMediaCensorJobDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryCopyrightExtractJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryCopyrightExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryTraceAbJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'mts:QueryTraceAbJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'MPS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];