'1.0', 'info' => ['style' => 'RPC', 'product' => 'ICE', 'version' => '2020-11-09'], 'directories' => [ [ 'children' => ['CreateUploadMedia', 'CreateUploadStream', 'RefreshUploadMedia', 'RegisterMediaStream', 'GetUrlUploadInfos', 'UploadMediaByURL', 'UploadStreamByURL'], 'type' => 'directory', 'title' => 'Media upload', ], [ 'children' => [ [ 'children' => [ [ 'children' => ['CloseStreamToSearchLib', 'GetStreamTagList', 'CreateStreamToSearchLib', 'AddStreamTagToSearchLib'], 'type' => 'directory', 'title' => 'Streaming media asset operations', ], [ 'children' => ['CreateSearchLib', 'QuerySearchLib', 'ListSearchLib', 'AlterSearchLib', 'DropSearchLib'], 'type' => 'directory', 'title' => 'Search library management', ], [ 'children' => ['CreateSearchIndex', 'AlterSearchIndex', 'QuerySearchIndex', 'DropSearchIndex'], 'type' => 'directory', 'title' => 'Search index configuration management', ], [ 'children' => ['QueryMediaIndexJob', 'SearchIndexJobRerun'], 'type' => 'directory', 'title' => 'Search index task management', ], [ 'children' => ['InsertMediaToSearchLib', 'UpdateMediaToSearchLib', 'DeleteMediaFromSearchLib'], 'type' => 'directory', 'title' => 'Media asset operations', ], [ 'children' => [ [ 'children' => ['SearchMedia', 'GetVideoList'], 'type' => 'directory', 'title' => 'Basic search', ], [ 'children' => ['SearchMediaByFace', 'SearchMediaClipByFace'], 'type' => 'directory', 'title' => 'Face search', ], [ 'children' => ['SearchMediaByAILabel'], 'type' => 'directory', 'title' => 'Smart tag search', ], [ 'children' => ['SearchMediaByMultimodal', 'SearchMediaByHybrid'], 'type' => 'directory', 'title' => 'Large model search', ], ], 'type' => 'directory', 'title' => 'Search features', ], ], 'type' => 'directory', 'title' => 'Media asset search', ], [ 'children' => ['RegisterMediaInfo', 'GetMediaInfo', 'UpdateMediaInfo', 'DeleteMediaInfos', 'BatchGetMediaInfos', 'ListMediaBasicInfos', 'ListPublicMediaBasicInfos', 'ListAllPublicMediaTags', 'SubmitMediaAiAnalysisJob'], 'type' => 'directory', 'title' => 'Media asset library', ], [ 'children' => ['GetCategories', 'UpdateCategory'], 'type' => 'directory', 'title' => 'Category management', ], [ 'children' => ['AddMediaMarks', 'GetMediaMarks', 'UpdateMediaMarks', 'DeleteMediaMarks', 'ListMediaMarks'], 'type' => 'directory', 'title' => 'Tag management', ], [ 'children' => ['CreateIpcOrder', 'GetIpcDeviceInfo', 'QueryIpcQuota'], 'type' => 'directory', 'title' => 'IPC management', ], 'GetPlayInfo', 'DeletePlayInfo', ], 'type' => 'directory', 'title' => 'Media asset management', ], [ 'children' => ['CreateAudit', 'SubmitMediaCensorJob', 'QueryMediaCensorJobDetail', 'QueryMediaCensorJobList'], 'type' => 'directory', 'title' => 'Media asset review', ], [ 'children' => [ [ 'children' => ['GetSystemTemplate', 'SetDefaultCustomTemplate', 'UpdateCustomTemplate', 'ListSystemTemplates', 'ListCustomTemplates'], 'type' => 'directory', 'title' => 'Template management', ], ], 'type' => 'directory', 'title' => 'Configuration management', ], [ 'children' => [ [ 'children' => ['SubmitMediaConvertJob', 'GetMediaConvertJob', 'ListMediaConvertJobs', 'SubmitTranscodeJob', 'GetTranscodeJob', 'ListTranscodeJobs', 'SubmitPackageJob', 'GetPackageJob', 'ListPackageJobs', 'GenerateKMSDataKey', 'DecryptKMSDataKey'], 'type' => 'directory', 'title' => 'Transcoding operations', ], [ 'children' => ['SubmitSnapshotJob', 'SubmitDynamicImageJob', 'GetSnapshotUrls', 'GetSnapshotJob', 'GetDynamicImageJob', 'ListSnapshotJobs', 'ListDynamicImageJobs'], 'type' => 'directory', 'title' => 'Snapshot operations', ], [ 'children' => ['SubmitSyncMediaInfoJob', 'SubmitMediaInfoJob', 'GetMediaInfoJob', 'ListMediaInfoJobs'], 'type' => 'directory', 'title' => 'Media information operations', ], ], 'type' => 'directory', 'title' => 'Media processing', ], [ 'children' => [ [ 'children' => ['CreateLiveTranscodeTemplate', 'GetLiveTranscodeTemplate', 'UpdateLiveTranscodeTemplate', 'DeleteLiveTranscodeTemplate', 'ListLiveTranscodeTemplates', 'SubmitLiveTranscodeJob', 'SendLiveTranscodeJobCommand', 'GetLiveTranscodeJob', 'UpdateLiveTranscodeJob', 'DeleteLiveTranscodeJob', 'ListLiveTranscodeJobs'], 'type' => 'directory', 'title' => 'Real-time media transcoding', ], [ 'children' => ['CreateLiveRecordTemplate', 'GetLiveRecordTemplate', 'UpdateLiveRecordTemplate', 'DeleteLiveRecordTemplate', 'ListLiveRecordTemplates', 'SubmitLiveRecordJob', 'GetLiveRecordJob', 'DeleteLiveRecordFiles', 'ListLiveRecordJobs', 'ListLiveRecordFiles'], 'type' => 'directory', 'title' => 'Real-time media recording', ], [ 'children' => ['CreateLiveSnapshotTemplate', 'GetLiveSnapshotTemplate', 'UpdateLiveSnapshotTemplate', 'DeleteLiveSnapshotTemplate', 'ListLiveSnapshotTemplates', 'SubmitLiveSnapshotJob', 'SendLiveSnapshotJobCommand', 'GetLiveSnapshotJob', 'DeleteLiveSnapshotFiles', 'ListLiveSnapshotJobs', 'ListLiveSnapshotFiles'], 'type' => 'directory', 'title' => 'Real-time media snapshot', ], ], 'type' => 'directory', 'title' => 'Real-time processing', ], [ 'children' => [ [ 'children' => ['CreateEditingProject', 'GetEditingProject', 'UpdateEditingProject', 'DeleteEditingProjects', 'ListEditingProjects', 'AddEditingProjectMaterials', 'GetEditingProjectMaterials', 'DeleteEditingProjectMaterials', 'GetLiveEditingIndexFile', 'SubmitProjectExportJob', 'GetProjectExportJob'], 'type' => 'directory', 'title' => 'Cloud editing project management', ], [ 'children' => ['SubmitMediaProducingJob', 'GetMediaProducingJob', 'SubmitLiveEditingJob', 'GetLiveEditingJob', 'SubmitBatchMediaProducingJob', 'GetBatchMediaProducingJob', 'SubmitSportsHighlightsJob', 'SubmitScreenMediaHighlightsJob', 'ListMediaProducingJobs', 'ListBatchMediaProducingJobs'], 'type' => 'directory', 'title' => 'Editing and production', ], [ 'children' => ['GetTemplateMaterials', 'GetTemplateParams'], 'type' => 'directory', 'title' => 'Template factory', ], [ 'children' => [ [ 'children' => ['DeleteHotwordLibrary', 'GetHotwordLibrary', 'ListHotwordLibraries', 'UpdateHotwordLibrary', 'CreateHotwordLibrary'], 'type' => 'directory', 'title' => 'Hot word management', ], [ 'children' => ['CreateAvatarTrainingJob', 'UpdateAvatarTrainingJob', 'SubmitAvatarTrainingJob', 'GetAvatarTrainingJob', 'DeleteAvatarTrainingJob', 'ListAvatarTrainingJobs', 'GetAvatar', 'ListAvatars'], 'type' => 'directory', 'title' => 'Digital human training', ], [ 'children' => ['CreateCustomizedVoiceJob', 'GetDemonstrationForCustomizedVoiceJob', 'DetectAudioForCustomizedVoiceJob', 'SubmitCustomizedVoiceJob', 'SubmitStandardCustomizedVoiceJob', 'GetCustomizedVoiceJob', 'DeleteCustomizedVoiceJob', 'ListCustomizedVoiceJobs', 'GetCustomizedVoice', 'UpdateCustomizedVoice', 'ListCustomizedVoices'], 'type' => 'directory', 'title' => 'Voice cloning', ], 'SubmitASRJob', 'SubmitAvatarVideoJob', 'SubmitAudioProduceJob', 'SubmitTextGenerateJob', 'SubmitVideoTranslationJob', 'SubmitHighlightExtractionJob', 'SubmitSegmentationJob', 'GetSmartHandleJob', 'DeleteSmartJob', 'ListSmartJobs', 'ListSmartSysAvatarModels', 'ListSmartVoiceGroups', ], 'type' => 'directory', 'title' => 'Intelligent tasks', ], ], 'type' => 'directory', 'title' => 'Production', ], [ 'children' => [ [ 'children' => ['StartAIAgentInstance', 'StopAIAgentInstance', 'UpdateAIAgentInstance', 'DescribeAIAgentInstance', 'ListAIAgentInstance', 'GetAIAgentConcurrency', 'SendAIAgentSpeech', 'TakeoverAIAgentCall', 'SendAIAgentDataChannelMessage', 'SendAIAgentText'], 'type' => 'directory', 'title' => 'Agent management', ], [ 'children' => ['GenerateMessageChatToken', 'GenerateAIAgentCall', 'ListAIAgentDialogues', 'DeleteAIAgentDialogue', 'SendMessageChatText'], 'type' => 'directory', 'title' => 'AICallKit integration operations', ], [ 'children' => ['StartAIAgentOutboundCall', 'ListAIAgentPhoneNumber', 'ForwardAIAgentCall'], 'type' => 'directory', 'title' => 'Carrier line operations', ], [ 'children' => ['SetAIAgentVoiceprint', 'ClearAIAgentVoiceprint', 'ListAIAgentVoiceprints'], 'type' => 'directory', 'title' => 'Voiceprint management', ], [ 'children' => ['SubmitAIAgentVideoAuditTask'], 'type' => 'directory', 'title' => 'Offline tasks', ], [ 'children' => ['GetAiRtcAuthCodeList', 'ActiveAiRtcLicense'], 'type' => 'directory', 'title' => 'RTOS License', ], ], 'type' => 'directory', 'title' => 'Real-time conversational AI', ], [ 'children' => [ [ 'children' => [ [ 'children' => ['SubmitVideoCognitionJob', 'QueryVideoCognitionJob'], 'type' => 'directory', 'title' => 'Task operations', ], [ 'children' => ['CreateRecognitionEntity', 'CreateRecognitionLib', 'CreateRecognitionSample', 'ListRecognitionSamples', 'DeleteRecognitionSample', 'ListRecognitionEntities', 'ListRecognitionLibs', 'DeleteRecognitionLib', 'DeleteRecognitionEntity'], 'type' => 'directory', 'title' => 'Custom recognition entity operations', ], ], 'type' => 'directory', 'title' => 'Intelligent content understanding', ], [ 'children' => ['SubmitIProductionJob', 'QueryIProductionJob'], 'type' => 'directory', 'title' => 'Intelligent production', ], [ 'children' => ['CreateDNADB', 'DeleteDNADB', 'ListDNADB', 'SubmitDNAJob', 'CancelDNAJob', 'DeleteDNAFiles', 'ListDNAFiles', 'QueryDNAJobList'], 'type' => 'directory', 'title' => 'Media DNA', ], [ 'children' => ['SubmitCopyrightJob', 'QueryCopyrightJobList', 'SubmitCopyrightExtractJob', 'QueryCopyrightExtractJob', 'SubmitTraceAbJob', 'QueryTraceAbJobList', 'SubmitTraceM3u8Job', 'QueryTraceM3u8JobList', 'SubmitTraceExtractJob', 'QueryTraceExtractJob'], 'type' => 'directory', 'title' => 'Digital watermarking', ], ], 'type' => 'directory', 'title' => 'Media AI', ], [ 'children' => ['DescribeMeterImsMediaConvertUHDUsage', 'DescribeMeterImsMediaConvertUsage', 'DescribeMeterImsEditUsage', 'DescribeMeterImsSummary', 'DescribeMeterImsMpsAiUsage'], 'type' => 'directory', 'title' => 'Usage statistics', ], [ 'children' => ['SetEventCallback', 'GetEventCallback'], 'type' => 'directory', 'title' => 'Global configuration', ], [ 'children' => ['StartWorkflow', 'GetWorkflowTask', 'ListWorkflowTasks', 'StartAIWorkflow', 'StopAIWorkflowTask', 'GetAIWorkflowTask'], 'type' => 'directory', 'title' => 'Workflow', ], [ 'children' => [ [ 'children' => ['CreateMediaLiveInputSecurityGroup', 'UpdateMediaLiveInputSecurityGroup', 'GetMediaLiveInputSecurityGroup', 'ListMediaLiveInputSecurityGroups', 'DeleteMediaLiveInputSecurityGroup', 'CreateMediaLiveInput', 'UpdateMediaLiveInput', 'GetMediaLiveInput', 'ListMediaLiveInputs', 'DeleteMediaLiveInput', 'CreateMediaLiveChannel', 'UpdateMediaLiveChannel', 'GetMediaLiveChannel', 'ListMediaLiveChannels', 'DeleteMediaLiveChannel', 'StartMediaLiveChannel', 'StopMediaLiveChannel'], 'type' => 'directory', 'title' => 'Live streaming', ], [ 'children' => ['GetMediaConnectAvailableRegion', 'ForbidMediaConnectFlowOutput', 'ResumeMediaConnectFlowOutput', 'GetMediaConnectFlowAllOutputName', 'CloseMediaConnectFlowFailover', 'OpenMediaConnectFlowFailover', 'UpdateMediaConnectFlowOutput', 'GetMediaConnectFlowOutput', 'DeleteMediaConnectFlowOutput', 'AddMediaConnectFlowOutput', 'DeleteMediaConnectFlowInput', 'UpdateMediaConnectFlowInput', 'GetMediaConnectFlowInput', 'AddMediaConnectFlowInput', 'DeleteMediaConnectFlow', 'UpdateMediaConnectFlowStatus', 'GetMediaConnectFlow', 'CreateMediaConnectFlow'], 'type' => 'directory', 'title' => 'Media transport', ], [ 'children' => [ 'AddAdInsertion', 'UpdateAdInsertion', 'GetAdInsertion', 'ListAdInsertions', 'DeleteAdInsertion', 'GetSourceLocation', 'UpdateSourceLocation', 'DeleteSourceLocation', 'ListSourceLocations', 'CreateSourceLocation', 'UpdateProgram', 'GetProgram', 'UpdateSource', 'StartChannel', 'DeleteProgram', 'StopChannel', 'ListChannels', 'ListPrograms', 'CreateChannel', 'ListSchedules', 'ListSources', 'GetChannel', 'CreateProgram', 'ListChannelAlerts', 'UpdateChannel', ], 'type' => 'directory', 'title' => 'Media advertising', ], [ 'children' => [ [ 'children' => ['CreateVodPackagingGroup', 'GetVodPackagingGroup', 'ListVodPackagingGroups', 'DeleteVodPackagingGroup', 'CreateVodPackagingConfiguration', 'GetVodPackagingConfiguration', 'ListVodPackagingConfigurations', 'DeleteVodPackagingConfiguration', 'CreateVodPackagingAsset', 'BatchCreateVodPackagingAsset', 'GetVodPackagingAsset', 'ListVodPackagingAssets', 'DeleteVodPackagingAsset'], 'type' => 'directory', 'title' => 'VOD packaging', ], [ 'children' => ['CreateLivePackageChannelGroup', 'UpdateLivePackageChannelGroup', 'GetLivePackageChannelGroup', 'ListLivePackageChannelGroups', 'DeleteLivePackageChannelGroup', 'CreateLivePackageChannel', 'UpdateLivePackageChannel', 'UpdateLivePackageChannelCredentials', 'GetLivePackageChannel', 'ListLivePackageChannels', 'DeleteLivePackageChannel', 'CreateLivePackageOriginEndpoint', 'UpdateLivePackageOriginEndpoint', 'GetLivePackageOriginEndpoint', 'ListLivePackageOriginEndpoints', 'DeleteLivePackageOriginEndpoint'], 'type' => 'directory', 'title' => 'Live packaging', ], ], 'type' => 'directory', 'title' => 'Media packaging', ], ], 'type' => 'directory', 'title' => 'Media services', ], [ 'children' => ['RegisterYikeAssetMediaInfo', 'ListYikeProductions', 'GetYikeAssetMediaInfo', 'ListYikeAssetFolders', 'BatchGetYikeAssetMediaInfos', 'DeleteYikeAssetMediaInfos', 'ResumeYikeStoryboardJob', 'CreateYikeProduction', 'CreateYikeWorkspace', 'CreateYikeUser', 'GetYikeUser', 'SetYikeUserRole', 'AddYikeUserCredit', 'GetYikeUserCredit', 'SubYikeUserCredit', 'PrecheckYikeAIAppJob'], 'type' => 'directory', 'title' => 'Wanjing yike', ], [ 'children' => [ 'SubmitSmarttagJob', 'QuerySmarttagJob', [ 'children' => ['SetContentAnalyzeConfig', 'GetContentAnalyzeConfig', 'SetDefaultStorageLocation', 'GetDefaultStorageLocation'], 'type' => 'directory', 'title' => 'Global configuration--deprecated', ], 'DescribePlayList', [ 'children' => ['AddFavoritePublicMedia', 'CancelFavoritePublicMedia', 'GetPublicMediaInfo', 'SearchPublicMediaInfo'], 'type' => 'directory', 'title' => 'Material center', ], 'GetStorageList', 'SearchEditingProject', 'StopRtcRobotInstance', 'StartRtcRobotInstance', 'UpdateRtcRobotInstance', 'DescribeRtcRobotInstance', 'SetNotifyConfig', 'DescribeNotifyConfig', 'CancelIProductionJob', 'SubmitSceneMediaSelectionJob', 'SubmitSceneBatchEditingJob', 'SubmitSceneTimelineOrganizationJob', 'CreateCustomTemplate', 'CreateSource', 'DeleteChannel', 'DeleteCustomTemplate', 'DeleteSource', 'GetAiRtcLicenseInfoList', 'GetCustomTemplate', 'GetSource', 'ListAlerts', 'SubmitDynamicChartJob', 'CreatePipeline', 'DeletePipeline', 'GetPipeline', 'ListPipelines', 'UpdatePipeline', 'AddTemplate', 'BatchGetYikeAIAppJob', 'CreateYikeAssetUpload', 'DeleteTemplate', 'GetTemplate', 'GetYikeAIAppJob', 'GetYikeStoryboardJob', 'ListTemplates', 'SubmitYikeAIAppJob', 'SubmitYikeStoryboardJob', 'UpdateTemplate', 'AddCategory', 'DeleteCategory', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'AIAgentCallInfo' => [ 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'The status of the call.', 'type' => 'string', 'example' => '4'], 'CallStartTime' => ['title' => '', 'description' => 'The time the call started, in ISO 8601 format.', 'type' => 'string', 'example' => '2026-04-01T16:53:53.184797+00:00'], 'CallEndTime' => ['title' => '', 'description' => 'The time the call ended, in ISO 8601 format.', 'type' => 'string', 'example' => '2026-04-01T16:53:58.875932+00:00'], 'CallDuration' => ['title' => '', 'description' => 'The duration of the call, in seconds.', 'type' => 'integer', 'example' => '5', 'format' => 'int32'], 'HangupRole' => ['title' => '', 'description' => 'Indicates which party ended the call.'."\n" .'0: The agent ended the call.'."\n" .'1: The user ended the call.'."\n" .'2: The system ended the call for a transfer.', 'type' => 'integer', 'example' => '0', 'format' => 'int32'], 'CallerNumber' => ['description' => 'The number of the calling party.', 'type' => 'string', 'title' => '', 'example' => '183*****333'], 'CalleeNumber' => ['description' => 'The number of the called party.', 'type' => 'string', 'title' => '', 'example' => '136******794'], ], 'description' => 'Details of the PSTN call.', 'title' => '', 'example' => '', ], 'AIAgentConfig' => [ 'description' => 'The parameters for the AI agent template.', 'type' => 'object', 'properties' => [ 'Greeting' => ['description' => 'The welcome message the AI agent plays when joining the session. Changes apply to subsequent sessions. If omitted, no welcome message is played.', 'type' => 'string', 'example' => '你好', 'title' => ''], 'WakeUpQuery' => ['description' => 'A user-provided command that the AI agent responds to immediately after the call starts.', 'type' => 'string', 'example' => '今天天气怎么样？'."\n", 'title' => ''], 'MaxIdleTime' => ['description' => 'The maximum idle duration in seconds before the AI agent disconnects. If the agent receives no user interaction within this period, it ends the task. Default: 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'UserOnlineTimeout' => ['description' => 'The duration in seconds the AI agent waits for a user to join. If the user does not join within this time, the agent terminates the task. Default: 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], 'UserOfflineTimeout' => ['description' => 'The duration in seconds the AI agent waits before terminating the task after a user leaves the session. Default: 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'EnablePushToTalk' => ['description' => 'Specifies whether to enable push-to-talk mode. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'GracefulShutdown' => ['description' => 'Specifies whether to enable graceful shutdown. Default: `false`.'."\n" ."\n" .'If enabled, the AI agent completes its current utterance before disconnecting when the task is stopped. The agent will not speak for more than 10 seconds.', 'type' => 'boolean', 'example' => 'false'."\n", 'title' => ''], 'Volume' => ['description' => 'The speaking volume of the AI agent.'."\n" ."\n" .'- If not set, the adaptive volume mode recommended by Alibaba Cloud is used by default.'."\n" ."\n" .'- If set, the value must be in the range of 0 to 400. The final output volume is calculated as: `(Workflow volume) * (volume / 100)`. For example:'."\n" ."\n" .'1. If `volume` is 0, the output volume is 0.'."\n" ."\n" .'2. If `volume` is 100, the output volume is the same as the original volume.'."\n" ."\n" .'3. If `volume` is 200, the output volume is twice the original volume.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'WorkflowOverrideParams' => ['description' => 'A JSON string containing parameters to override the default workflow configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'AvatarUrl' => ['description' => 'The URL of the avatar to display during voice calls. If omitted, no avatar is displayed.', 'type' => 'string', 'example' => 'http://example.com/a.jpg'."\n", 'title' => ''], 'AvatarUrlType' => ['description' => 'The type of the avatar URL. By default, this parameter is not set.', 'type' => 'string', 'example' => 'USER', 'title' => ''], 'EnableIntelligentSegment' => ['description' => 'Specifies whether to enable intelligent segmentation. When enabled, short user utterances are merged into a single sentence. Default: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AsrConfig' => [ 'description' => 'Configuration for automatic speech recognition (ASR).', 'type' => 'object', 'properties' => [ 'AsrLanguageId' => ['description' => 'The language for ASR. Valid values:'."\n" ."\n" .'- `zh_mandarin`: Chinese (Mandarin)'."\n" ."\n" .'- `en`: English'."\n" ."\n" .'- `zh_en`: Chinese-English mixed'."\n" ."\n" .'- `es`: Spanish'."\n" ."\n" .'- `jp`: Japanese', 'type' => 'string', 'example' => 'zh_mandarin', 'title' => ''], 'AsrMaxSilence' => ['description' => 'The maximum duration of silence in milliseconds before the ASR engine finalizes an utterance. A pause longer than this value signals a sentence break. Range: 200–1200. Default: 400.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'AsrHotWords' => [ 'description' => 'A list of hotwords to improve ASR accuracy. You can specify a maximum of 128 hotwords.', 'type' => 'array', 'items' => ['description' => 'A hotword string. Length: 1 to 10 characters.', 'type' => 'string', 'example' => '检查', 'title' => ''], 'title' => '', 'example' => '', ], 'VadLevel' => ['description' => 'The Voice Activity Detection (VAD) threshold for interruptions. Range: 0–11. Default: 11.'."\n" ."\n" .'- `0`: Disables VAD.'."\n" ."\n" .'- `1`–`10`: Sets the interruption sensitivity. A higher value makes the agent harder to interrupt.'."\n" ."\n" .'- `11`: An enhanced mode with lower audio distortion and stronger noise resistance.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'CustomParams' => ['description' => 'Passthrough parameters for proprietary ASR integrations.', 'type' => 'string', 'example' => 'mode=fast&sample=16000&format=wav', 'title' => ''], 'VadDuration' => ['description' => 'The minimum duration in milliseconds of continuous user speech required to trigger an interruption. This controls interruption sensitivity. A value of 0 disables this feature. Range: 200–2000. A common range is 200–500 ms, which typically corresponds to 1 to 4 Chinese characters. If omitted, this feature is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TtsConfig' => [ 'description' => 'Configuration for text-to-speech (TTS).', 'type' => 'object', 'properties' => [ 'VoiceId' => ['description' => 'The ID of the preset TTS voice. Changes apply to the next utterance. If omitted, the voice from the AI agent template is used. The ID can be a maximum of 64 characters. For available voices, see [Intelligent Voice Samples](~~449563~~).', 'type' => 'string', 'example' => 'longcheng_v2'."\n" ."\n", 'title' => ''], 'VoiceIdList' => [ 'description' => 'A list of available voices.', 'type' => 'array', 'items' => ['description' => 'A voice.', 'type' => 'string', 'example' => 'zhixiaoxia', 'title' => ''], 'title' => '', 'example' => '', ], 'PronunciationRules' => [ 'description' => 'A list of TTS pronunciation rules, executed in order. You can specify a maximum of 20 rules.', 'type' => 'array', 'items' => [ 'description' => 'A TTS pronunciation rule.', 'type' => 'object', 'properties' => [ 'Word' => ['description' => 'The word to be replaced. It must be 1 to 9 Chinese characters long and cannot contain spaces.', 'type' => 'string', 'example' => '一一零', 'title' => ''], 'Pronunciation' => ['description' => 'The replacement pronunciation. It must be 1 to 9 Chinese characters long and cannot contain spaces.', 'type' => 'string', 'example' => '幺幺零', 'title' => ''], 'Type' => ['description' => 'The type of pronunciation rule.'."\n" .'Valid value:'."\n" ."\n" .'- `replacement`: Replaces the specified `Word` with the `Pronunciation`.', 'type' => 'string', 'example' => 'replacement', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ModelId' => ['description' => 'This parameter applies only to the Minimax provider. Valid values:'."\n" .'`speech-01-turbo`, `speech-02-turbo`', 'type' => 'string', 'example' => 'speech-01-turbo', 'title' => ''], 'LanguageId' => ['description' => 'This parameter is for the minimax provider only. It enhances recognition for specific low-resource languages and dialects. If the language is unknown, set this to `auto` for automatic detection. By default, this parameter is not set. Supported values include:'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'Supported languages'."\n" ."\n" .'

'."\n" ."\n" .'- Chinese'."\n" ."\n" .'- Chinese,Yue: Cantonese'."\n" ."\n" .'- English'."\n" ."\n" .'- Arabic'."\n" ."\n" .'- Russian'."\n" ."\n" .'- Spanish'."\n" ."\n" .'- French'."\n" ."\n" .'- Portuguese'."\n" ."\n" .'- German'."\n" ."\n" .'- Turkish'."\n" ."\n" .'- Dutch'."\n" ."\n" .'- Ukrainian'."\n" ."\n" .'- Vietnamese'."\n" ."\n" .'- Indonesian'."\n" ."\n" .'- Japanese'."\n" ."\n" .'- Italian'."\n" ."\n" .'- Korean'."\n" ."\n" .'- Thai'."\n" ."\n" .'- Polish'."\n" ."\n" .'- Romanian'."\n" ."\n" .'- Greek'."\n" ."\n" .'- Czech'."\n" ."\n" .'- Finnish'."\n" ."\n" .'- Hindi'."\n" ."\n" .'- auto'."\n" ."\n" .'

', 'type' => 'string', 'example' => 'Chinese', 'title' => ''], 'Emotion' => ['description' => 'This parameter applies only to the Minimax provider. Supported emotions include:'."\n" ."\n" .'- `happy`'."\n" ."\n" .'- `sad`'."\n" ."\n" .'- `angry`'."\n" ."\n" .'- `fearful`'."\n" ."\n" .'- `disgusted`'."\n" ."\n" .'- `surprised`'."\n" ."\n" .'- `calm`', 'type' => 'string', 'example' => 'happy', 'title' => ''], 'SpeechRate' => ['description' => 'The speech rate, where a value of 1.0 is normal speed. The supported range can vary by provider. For CosyVoice, the range is 0.5 to 2.0 (default: 1.0). For Minimax, the range is 0.5 to 2.0 (default: 1.0).', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'LlmConfig' => [ 'description' => 'Configuration for the large language model (LLM).', 'type' => 'object', 'properties' => [ 'LlmHistory' => [ 'description' => 'The conversation history context for the LLM/MLLM.', 'type' => 'array', 'items' => [ 'description' => 'A single conversational turn.', 'type' => 'object', 'properties' => [ 'Role' => ['description' => 'The role of the participant in the conversation. Valid values:'."\n" ."\n" .'- `user`'."\n" ."\n" .'- `assistant`'."\n" ."\n" .'- `system`'."\n" ."\n" .'- `function`'."\n" ."\n" .'- `plugin`'."\n" ."\n" .'- `tool`', 'type' => 'string', 'example' => 'user', 'title' => ''], 'Content' => ['description' => 'The text content of the message from this role.', 'type' => 'string', 'example' => '你好', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LlmHistoryLimit' => ['description' => 'The maximum number of recent conversational turns to include in the LLM/MLLM context. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'LlmSystemPrompt' => ['description' => 'The system prompt for the LLM after the call starts.', 'type' => 'string', 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'."\n", 'title' => ''], 'BailianAppParams' => ['description' => 'Parameters for Alibaba Cloud Model Studio, provided as a JSON string. For the parameter format, see'."\n" .'[Alibaba Cloud Model Studio Parameters](~~2858132~~)', 'type' => 'string', 'example' => '"{\\"biz_params\\":{\\"user_defined_params\\":{\\"your_plugin_id\\":{\\"article_index\\":2}}},\\"memory_id\\":\\"your_memory_id\\",\\"image_list\\":[\\"https://your_image_url\\"],\\"rag_options\\":{\\"pipeline_ids\\":[\\"your_id\\"],\\"file_ids\\":[\\"文档ID1\\",\\"文档ID2\\"],\\"metadata_filter\\":{\\"name\\":\\"张三\\"},\\"structured_filter\\":{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"},\\"tags\\":[\\"标签1\\",\\"标签2\\"]}}"', 'title' => ''], 'OpenAIExtraQuery' => ['description' => 'Additional query parameters for an OpenAI-compatible LLM. Parameters must be provided as a URL query string (e.g., `key1=value1&key2=value2`). All values must be strings.', 'type' => 'string', 'example' => 'api-version=2024-02-01&api-key=sk-xxx', 'title' => ''], 'LlmCompleteReply' => ['description' => 'When set to `true`, the agent sends the entire LLM response in a single message after it is fully generated, rather than streaming it. This setting does not affect the streaming of subtitles.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'FunctionMap' => [ 'description' => 'Maps built-in agent functions to custom LLM functions. Currently, this only supports function calling for custom, OpenAI-compatible LLMs.', 'type' => 'array', 'items' => [ 'description' => 'A single mapping rule.', 'type' => 'object', 'properties' => [ 'Function' => ['description' => 'The name of a built-in function provided by the AI agent system. Currently, only `hangup` is supported.', 'type' => 'string', 'example' => 'hangup', 'title' => ''], 'MatchFunction' => ['description' => 'The name of the custom LLM function that maps to the agent\'s built-in function. For details on the custom LLM protocol, see [LLM Standard Interface](~~2839094~~).', 'type' => 'string', 'example' => 'hangup', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'OutputMinLength' => ['description' => 'The minimum number of characters in a text chunk before it is sent to the TTS engine. Shorter chunks are buffered. Range: 0–100. A value of `0` or omitting this parameter disables buffering. Default: Not set.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'OutputMaxDelay' => ['description' => 'The maximum delay in milliseconds before buffered text is sent to the TTS engine, even if `OutputMinLength` is not met. Range: 1000–10000. A value of `0` or omitting this parameter disables the delay limit. Default: Not set.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''], 'HistorySyncWithTTS' => ['description' => 'Specifies whether the LLM message history is synchronized with the content played by the TTS. Default: `false`. When enabled, the saved LLM messages match the content actually played by the TTS.'."\n" ."\n" .'> When a user interrupts the agent, the `` tag is inserted into the message history at the point of interruption. This affects the next message sent to the LLM. For example:'."\n" ."\n" .'```'."\n" .'['."\n" .' {"role": "user", "content": "Tell me a story."},'."\n" .' {"role": "assistant", "content": "Okay, I can tell you a story about the Three Kingdoms. Would you like that?"},'."\n" .' {"role": "user", "content": "Tell me a different one."}'."\n" .']'."\n" .'```', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'example' => '', ], 'AvatarConfig' => [ 'description' => 'Configuration for the avatar. This takes effect only if the workflow includes an avatar node.', 'type' => 'object', 'properties' => [ 'AvatarId' => ['description' => 'The model ID of the avatar.', 'type' => 'string', 'example' => '5257', 'title' => ''], ], 'title' => '', 'example' => '', ], 'InterruptConfig' => [ 'description' => 'Configuration for the speech interruption policy.', 'type' => 'object', 'properties' => [ 'EnableVoiceInterrupt' => ['description' => 'Specifies whether to enable speech interruption. Default: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'InterruptWords' => [ 'description' => 'A list of specific words or phrases that trigger an interruption.', 'type' => 'array', 'items' => ['description' => 'A specific word or phrase that triggers an interruption.', 'type' => 'string', 'example' => '打断一下', 'title' => ''], 'title' => '', 'example' => '', ], 'NoInterruptMode' => ['description' => 'Specifies how to handle user speech that occurs during a non-interruptible section of the agent\'s utterance.'."\n" ."\n" .'- `cache`: Caches the user\'s speech and processes it in the next conversational turn.'."\n" ."\n" .'- `discard`: Discards the user\'s speech.'."\n" ."\n" .'Default: `cache`.', 'type' => 'string', 'title' => '', 'example' => 'cache'], 'KeepInterruptWordsForLLM' => ['description' => 'Specifies whether to include the interrupt words in the text sent to the LLM. Default: `false` (words are discarded).'."\n" ."\n" .'> For example, if "hold on" is an interrupt word and the user says "hold on, what is the weather like today?", setting this to `false` results in only "what is the weather like today?" being sent to the LLM.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'VoiceprintConfig' => [ 'description' => 'Configuration for voiceprint recognition.', 'type' => 'object', 'properties' => [ 'UseVoiceprint' => ['description' => 'Specifies whether to enable voiceprint recognition. Default: `false`. If set to `true`, you must also provide a valid `VoiceprintId`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'VoiceprintId' => ['description' => 'The unique identifier for the voiceprint. This is not set by default. The ID must correspond to a voiceprint registered using the voiceprint registration API. For more information, see [Register a voiceprint](~~2964738~~).', 'type' => 'string', 'example' => 'zhixiaoxia', 'title' => ''], 'RegistrationMode' => ['description' => 'The voiceprint registration mode. Default: `Explicit`.'."\n" ."\n" .'| Value | Description |'."\n" .'| ---------- | ------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `Explicit` | In `Explicit` mode, the user must register their voiceprint in advance by using the voiceprint registration API. |'."\n" .'| `Implicit` | In `Implicit` mode, the system automatically collects user speech during the conversation to register a voiceprint. |', 'type' => 'string', 'title' => '', 'example' => 'Explicit'], ], 'title' => '', 'example' => '', ], 'TurnDetectionConfig' => [ 'description' => 'Configuration for conversational turn detection.', 'type' => 'object', 'properties' => [ 'TurnEndWords' => [ 'description' => 'A list of keywords used to determine the end of a user\'s conversational turn.', 'type' => 'array', 'items' => ['description' => 'A keyword used to determine the end of a user\'s conversational turn.', 'type' => 'string', 'example' => '我说完了', 'title' => ''], 'title' => '', 'example' => '', ], 'Mode' => ['description' => 'The conversational turn detection mode.'."\n" ."\n" .'- `Normal` (Default): The agent relies on pauses to detect the end of a user\'s turn.'."\n" ."\n" .'- `Semantic`: The agent uses AI to analyze conversational context to determine if the user has finished speaking.', 'type' => 'string', 'example' => 'Semantic', 'title' => ''], 'SemanticWaitDuration' => ['description' => 'The pause detection time in AI mode, in milliseconds. Default: -1.'."\n" ."\n" .'- -1: The AI automatically determines a suitable wait time.'."\n" ."\n" .'- 0–10000: A custom wait time. A range of 0–1500 ms is recommended.'."\n" ."\n" .'> This parameter has no effect in `Normal` mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], 'Eagerness' => ['description' => 'Controls the agent\'s response speed after detecting a user pause. This parameter applies only in `Semantic` mode. A higher setting results in a faster response but increases the risk of interrupting the user:'."\n" ."\n" .'- `Low`: Waits patiently with a maximum wait time of 6 seconds, reducing the risk of interruption.'."\n" ."\n" .'- `Medium`: A balanced wait time (up to 4 seconds), suitable for most scenarios.'."\n" ."\n" .'- `High`: Responds quickly (up to 2 seconds), which improves speed but may increase the risk of incorrect turn-taking.'."\n" ."\n" .'This field is empty by default.', 'type' => 'string', 'title' => '', 'example' => 'High'], ], 'title' => '', 'example' => '', ], 'ExperimentalConfig' => ['description' => 'Parameters for experimental features. Contact support for assistance.', 'type' => 'string', 'example' => '""', 'title' => ''], 'VcrConfig' => [ 'description' => 'Configuration for video content recognition. This enables the system to send callbacks to the client about events detected in the video stream.', 'type' => 'object', 'properties' => [ 'StillFrameMotion' => [ 'description' => 'Configuration for still frame detection.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable still frame detection. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CallbackDelay' => ['description' => 'The duration in milliseconds that a frame must remain still before a notification is sent. If not specified, the setting from the console is used. Range: 200–5000.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'InvalidFrameMotion' => [ 'description' => 'Configuration for invalid frame detection.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable invalid frame detection.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CallbackDelay' => ['description' => 'The duration in milliseconds that an invalid frame must persist before a notification is sent. If not specified, the setting from the console is used. Range: 200–5000.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PeopleCount' => [ 'description' => 'Configuration for the people counting feature.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable people counting. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Equipment' => [ 'description' => 'Configuration for device identification.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable device identification. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'HeadMotion' => [ 'description' => 'Configuration for head motion detection.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable head motion detection. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'LookAway' => [ 'description' => 'Configuration for look-away detection.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable look-away detection. Default: `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AmbientSoundConfig' => [ 'description' => 'Configuration for ambient sound during the call.', 'type' => 'object', 'properties' => [ 'ResourceId' => ['description' => 'The ID of the ambient sound resource. You can obtain this ID from the advanced settings of the agent configuration in the console.', 'type' => 'string', 'example' => 'f67901c595834************', 'title' => ''], 'Volume' => ['description' => 'The volume of the ambient sound. Range: 0–100. A value of 0 disables the sound.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AutoSpeechConfig' => [ 'type' => 'object', 'properties' => [ 'UserIdle' => [ 'type' => 'object', 'properties' => [ 'WaitTime' => ['description' => 'The silence duration threshold in milliseconds. If the user is silent for longer than this period, a prompt is triggered. Range: 5000–600000. This is a required field.', 'type' => 'integer', 'title' => '', 'example' => '5000', 'format' => 'int32'], 'MaxRepeats' => ['description' => 'The maximum number of times the prompt can be repeated. Range: 0–10. This is a required field. If the limit is exceeded, the call is terminated.', 'type' => 'integer', 'title' => '', 'example' => '5', 'format' => 'int32'], 'Messages' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The text of the prompt message, up to 100 characters.', 'type' => 'string', 'title' => '', 'example' => '您还在吗？'], 'Probability' => ['description' => 'The probability of this message being selected. Range: 0–1, corresponding to 0%–100%.', 'type' => 'number', 'title' => '', 'example' => '0.5', 'format' => 'double'], ], 'description' => 'The structure of a prompt message.', 'title' => '', 'example' => '', ], 'description' => 'A collection of prompt messages. A maximum of 10 messages are supported, each up to 100 characters. The sum of all probabilities must be 100%.', 'title' => '', 'example' => '', ], 'HangupEndWord' => ['description' => 'A farewell message played before hanging up due to user inactivity.', 'type' => 'string', 'title' => '', 'example' => '我挂了，再见'], ], 'description' => 'Configuration for prompts to play when the user is silent for an extended period.', 'title' => '', 'example' => '', ], 'LlmPending' => [ 'type' => 'object', 'properties' => [ 'WaitTime' => ['description' => 'The wait time threshold for LLM responses. If the threshold is exceeded, a prompt is played. This is a required field. Unit: ms. Range: 500–10000. Set this value based on the actual performance of your LLM.', 'type' => 'integer', 'title' => '', 'example' => '3000', 'format' => 'int32'], 'Mode' => ['description' => 'The mode for handling LLM latency prompts. `random`: Plays a random message from the list. `sequence`: Plays messages in order. This is a required field.', 'type' => 'string', 'title' => '', 'example' => ''], 'Messages' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The text of the prompt message, up to 100 characters.', 'type' => 'string', 'title' => '', 'example' => '稍等一下'], 'Probability' => ['description' => 'The probability of this message being selected. Range: 0–1, corresponding to 0%–100%.', 'type' => 'number', 'title' => '', 'example' => '0.5', 'format' => 'double'], ], 'description' => 'The structure of a prompt message.', 'title' => '', 'example' => '', ], 'description' => 'A collection of prompt messages. A maximum of 10 messages are supported, each up to 100 characters. The sum of all probabilities must be 100%.', 'title' => '', 'example' => '', ], ], 'description' => 'Configuration for prompts to play during LLM response latency.', 'title' => '', 'example' => '', ], ], 'description' => 'Configuration for the agent\'s automatic speech, including prompts for LLM latency and long periods of user silence.', 'title' => '', 'example' => '', ], 'BackChannelingConfigs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable this back-channeling rule. This is a required field.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'TriggerStage' => ['description' => 'The trigger for the back-channeling. Valid value:'."\n" ."\n" .'- `pause_detected`: Triggered when a short pause in speech is detected.', 'type' => 'string', 'title' => '', 'example' => 'pause_detected'], 'Probability' => ['description' => 'The trigger probability. Range: 0.0–1.0. This is a required field.', 'type' => 'number', 'title' => '', 'example' => '0.5', 'format' => 'double'], 'Words' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Text' => ['description' => '短语文本，长度 ≤ 20 字符，支持多语言。必填。', 'type' => 'string', 'title' => '', 'example' => '嗯嗯'], 'Probability' => ['description' => '本短语的触发概率，范围 0.0–1.0，必填。', 'type' => 'number', 'title' => '', 'example' => '0.3', 'format' => 'double'], ], 'description' => 'Configuration for a responsive phrase.', 'title' => '', 'example' => '', ], 'description' => 'A collection of acknowledgment phrases. You can specify a maximum of 10 phrases. Each phrase must be 20 characters or less, and the sum of their probabilities must be 1.0.', 'title' => '', 'example' => '', ], ], 'description' => 'A single back-channeling configuration.', 'title' => '', 'example' => '', ], 'description' => 'Configuration for back-channeling. When enabled, the system plays short, responsive phrases at specific trigger points.', 'title' => '', 'example' => '', ], 'BackChannelingConfig' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => '是否启用附和功能。必填，取值 true/false。', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'TriggerStage' => ['description' => '附和触发的时机。可选值：'."\n" ."\n" .'- pause\\_detected（检测到说话短暂停顿）', 'type' => 'string', 'title' => '', 'example' => 'pause_detected'], 'Probability' => ['description' => '功能触发概率。范围 0.0–1.0。必填。', 'type' => 'number', 'title' => '', 'example' => '0.5', 'format' => 'double'], 'Words' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Text' => ['description' => '短语文本，长度 ≤ 20 字符，支持多语言。必填。', 'type' => 'string', 'title' => '', 'example' => '嗯嗯'], 'Probability' => ['description' => '本短语的触发概率，范围 0.0–1.0，必填。', 'type' => 'number', 'title' => '', 'example' => '0.3', 'format' => 'double'], ], 'description' => '附和短语配置', 'title' => '', 'example' => '', ], 'description' => '附和短语集合。最大 10 条，每条短语长度 ≤ 20 字符，概率总和为 1.0。', 'title' => '', 'example' => '', ], ], 'description' => '单个附和语配置', 'title' => '', 'example' => '', ], 'description' => '>'."\n" ."\n" .'已废弃，请使用 BackChannelingConfigs'."\n" ."\n" .'>', 'title' => '', 'example' => '', 'deprecated' => true, ], ], 'title' => '', 'example' => '', ], 'AIAgentOutboundCallConfig' => [ 'description' => 'Parameters for the AI agent template.', 'type' => 'object', 'properties' => [ 'Greeting' => ['description' => 'The welcome message. This change takes effect in the next call session. If this parameter is not set, no welcome message is played.', 'type' => 'string', 'example' => '你好', 'title' => ''], 'EnableIntelligentSegment' => ['description' => 'Specifies whether to enable intelligent segmentation. If you enable this feature, short and consecutive speech segments from the user are merged into a complete sentence. Default value: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AsrConfig' => [ 'description' => 'The automatic speech recognition (ASR) configurations.', 'type' => 'object', 'properties' => [ 'AsrMaxSilence' => ['description' => 'The sentence segmentation threshold. If the duration of a silence exceeds this threshold, the system determines that the sentence is complete. Valid values: 200 to 1200. Unit: ms. Default value: 400.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'AsrLanguageId' => ['description' => 'The language ID for ASR. Valid values:'."\n" ."\n" .'- `zh_mandarin`: Chinese'."\n" ."\n" .'- `en`: English'."\n" ."\n" .'- `zh_en`: Chinese and English'."\n" ."\n" .'- `es`: Spanish'."\n" ."\n" .'- `jp`: Japanese', 'type' => 'string', 'example' => 'zh_mandarin', 'title' => ''], 'AsrHotWords' => [ 'description' => 'The list of hotwords for ASR. You can specify a maximum of 128 hotwords in the list.', 'type' => 'array', 'items' => ['description' => 'The hotword string. The string can contain 1 to 10 characters in length.', 'type' => 'string', 'example' => '检查'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'VadLevel' => ['description' => 'The interruption threshold for voice activity detection (VAD). Valid values: 0 to 11. Default value: 11.'."\n" ."\n" .'- A value of 0 disables the VAD feature.'."\n" ."\n" .'- A value from 1 to 10 indicates that the higher the value, the less sensitive the interruption.'."\n" ."\n" .'- A value of 11 provides a significantly different experience from the previous values. It lowers audio distortion during conversations and enhances resistance to interference.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'CustomParams' => ['description' => 'The passthrough parameters for proprietary ASR.', 'type' => 'string', 'example' => 'mode=fast&sample=16000&format=wav'."\n", 'title' => ''], 'VadDuration' => ['description' => 'The minimum duration threshold for VAD. This parameter controls the interruption sensitivity. A value of 0 indicates that this feature is disabled. Valid values: 200 to 2000. Unit: ms. A value from 200 to 500 corresponds to 1 to 4 words. The default value is empty, which indicates that this parameter is not in effect.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], ], 'title' => '', 'example' => '', ], 'LlmConfig' => [ 'description' => 'The configurations of the large language model (LLM).', 'type' => 'object', 'properties' => [ 'LlmHistoryLimit' => ['description' => 'The maximum number of conversational turns to retain in the history of the LLM or multimodal large language model (MLLM). Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'LlmHistory' => [ 'description' => 'The conversation history of the LLM or MLLM.', 'type' => 'array', 'items' => [ 'description' => 'A single conversational turn.', 'type' => 'object', 'properties' => [ 'Role' => ['description' => 'The role of the participant in the conversation. Valid values:'."\n" ."\n" .'- `user`: the user'."\n" ."\n" .'- `assistant`: the AI assistant'."\n" ."\n" .'- `system`: the system'."\n" ."\n" .'- `function`: a function'."\n" ."\n" .'- `plugin`: a plug-in'."\n" ."\n" .'- `tool`: a tool', 'type' => 'string', 'example' => 'user', 'title' => ''], 'Content' => ['description' => 'The text of the conversation content that records the specific expressions or responses of the role in the conversation.', 'type' => 'string', 'example' => '你好', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LlmSystemPrompt' => ['description' => 'The system prompt for the LLM after the call is initiated.', 'type' => 'string', 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'."\n", 'title' => ''], 'BailianAppParams' => ['description' => 'The parameters for Alibaba Cloud Model Studio. For more information about the parameter format, see [Alibaba Cloud Model Studio parameters](~~2858132~~).', 'type' => 'string', 'example' => '"{\\"biz_params\\":{\\"user_defined_params\\":{\\"your_plugin_id\\":{\\"article_index\\":2}}},\\"memory_id\\":\\"your_memory_id\\",\\"image_list\\":[\\"https://your_image_url\\"],\\"rag_options\\":{\\"pipeline_ids\\":[\\"your_id\\"],\\"file_ids\\":[\\"文档ID1\\",\\"文档ID2\\"],\\"metadata_filter\\":{\\"name\\":\\"张三\\"},\\"structured_filter\\":{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"},\\"tags\\":[\\"标签1\\",\\"标签2\\"]}}"'."\n", 'title' => ''], 'OpenAIExtraQuery' => ['description' => 'The additional query parameters for an LLM that is compatible with the OpenAI protocol. The parameters must be in the key=value format. If you specify multiple parameters, separate them with ampersands (`&`). All values must be of the string type.', 'type' => 'string', 'example' => 'api-version=2024-02-01&api-key=sk-xxx', 'title' => ''], 'LlmCompleteReply' => ['description' => 'If you enable this feature, the system sends the complete LLM-generated result to the client after the generation is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'FunctionMap' => [ 'description' => 'The list of function mappings, which is used to map AI agent capabilities to LLM functions. This feature is supported only when function calls are used in custom LLMs that are compatible with the OpenAI protocol.', 'type' => 'array', 'items' => [ 'description' => 'A single mapping rule.', 'type' => 'object', 'properties' => [ 'Function' => ['description' => 'The name of the built-in function provided by the AI agent in Alibaba Cloud. The value hangup is supported.', 'type' => 'string', 'example' => 'hangup', 'title' => ''], 'MatchFunction' => ['description' => 'The name of the LLM function that corresponds to this function. This parameter is customized and used to call the corresponding function in the LLM. For more information about the protocol for custom LLMs, see [Standard LLM API](~~2839094~~).', 'type' => 'string', 'example' => 'hangup', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'OutputMinLength' => ['description' => 'The minimum length of text output. The unit is characters. Text shorter than this length is cached and waits for concatenation. Valid values: 0 to 100. A value of 0 or empty indicates that this parameter is not in effect. Default value: empty.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'OutputMaxDelay' => ['description' => 'The maximum delay for text output. If this threshold is exceeded, the cached text is forcibly output. Valid values: 1000 to 10000. Unit: ms. A value of 0 or empty indicates that this parameter is not in effect. Default value: empty.', 'type' => 'string', 'example' => '2000', 'title' => ''], 'HistorySyncWithTTS' => ['description' => 'Specifies whether to keep the LLM message history consistent with the TTS playback content. Default value: false. If you enable this feature, the saved LLM messages are consistent with the TTS playback content.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'example' => '', ], 'TtsConfig' => [ 'description' => 'The text-to-speech (TTS) configurations.', 'type' => 'object', 'properties' => [ 'VoiceId' => ['description' => 'The voice ID. The change takes effect on the next sentence. If you do not specify this parameter, the voice ID configured in the AI agent template is used. This parameter is valid only for preset TTS voices. The value can be up to 64 characters in length. For more information about the valid values, see [Intelligent speech effect samples](~~449563~~).', 'type' => 'string', 'example' => 'longcheng_v2', 'title' => ''], 'VoiceIdList' => [ 'description' => 'The list of available voices.', 'type' => 'array', 'items' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'zhixiaoxia', 'title' => ''], 'title' => '', 'example' => '', ], 'PronunciationRules' => [ 'description' => 'The TTS pronunciation rules. You can specify a maximum of 20 rules in the array. The rules are executed in sequence.', 'type' => 'array', 'items' => [ 'description' => 'The TTS pronunciation rule.', 'type' => 'object', 'properties' => [ 'Word' => ['description' => 'The word to be replaced. The word must be a Chinese character string of up to 10 characters in length and cannot contain spaces.', 'type' => 'string', 'example' => '大栅栏'."\n", 'title' => ''], 'Pronunciation' => ['description' => 'The target pronunciation. The pronunciation must be a Chinese character string of up to 10 characters in length and cannot contain spaces.', 'type' => 'string', 'example' => '大石烂儿'."\n", 'title' => ''], 'Type' => ['description' => 'The type of the pronunciation rule. Valid value:'."\n" ."\n" .'- `replacement`: replaces the word with the specified pronunciation.', 'type' => 'string', 'example' => 'replacement'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ModelId' => ['description' => 'Only MiniMax is supported. Valid values: `speech-01-turbo` and `speech-02-turbo`.', 'type' => 'string', 'example' => 'speech-01-turbo', 'title' => ''], 'LanguageId' => ['description' => 'Only MiniMax is supported. The default value is empty. This parameter enhances the recognition of specific minority languages and dialects. After you set this parameter, the speech performance in the specified minority language or dialect scenarios is improved. If the minority language type is unknown, you can set this parameter to `auto` to enable the model to automatically determine the minority language type. Valid values:'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'Supported languages'."\n" ."\n" .'

'."\n" ."\n" .'- `Chinese`: Chinese'."\n" ."\n" .'- `Chinese,Yue`: Cantonese'."\n" ."\n" .'- `English`: English'."\n" ."\n" .'- `Arabic`: Arabic'."\n" ."\n" .'- `Russian`: Russian'."\n" ."\n" .'- `Spanish`: Spanish'."\n" ."\n" .'- `French`: French'."\n" ."\n" .'- `Portuguese`: Portuguese'."\n" ."\n" .'- `German`: German'."\n" ."\n" .'- `Turkish`: Turkish'."\n" ."\n" .'- `Dutch`: Dutch'."\n" ."\n" .'- `Ukrainian`: Ukrainian'."\n" ."\n" .'- `Vietnamese`: Vietnamese'."\n" ."\n" .'- `Indonesian`: Indonesian'."\n" ."\n" .'- `Japanese`: Japanese'."\n" ."\n" .'- `Italian`: Italian'."\n" ."\n" .'- `Korean`: Korean'."\n" ."\n" .'- `Thai`: Thai'."\n" ."\n" .'- `Polish`: Polish'."\n" ."\n" .'- `Romanian`: Romanian'."\n" ."\n" .'- `Greek`: Greek'."\n" ."\n" .'- `Czech`: Czech'."\n" ."\n" .'- `Finnish`: Finnish'."\n" ."\n" .'- `Hindi`: Hindi'."\n" ."\n" .'- `auto`: Automatic detection'."\n" ."\n" .'

', 'type' => 'string', 'example' => 'Chinese', 'title' => ''], 'Emotion' => ['description' => 'Only MiniMax is supported. The following seven emotions are supported:'."\n" ."\n" .'- `happy`'."\n" ."\n" .'- `sad`'."\n" ."\n" .'- `angry`'."\n" ."\n" .'- `fearful`'."\n" ."\n" .'- `disgusted`'."\n" ."\n" .'- `surprised`'."\n" ."\n" .'- `calm`', 'type' => 'string', 'example' => 'happy', 'title' => ''], 'SpeechRate' => ['description' => 'This parameter is supported on all platforms. For CosyVoice, the default value is 1.0 and the valid values are 0.5 to 2.0. For MiniMax, the default value is 1.0 and the valid values are 0.5 to 2.0.', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'InterruptConfig' => [ 'description' => 'The speech interruption policy configurations.', 'type' => 'object', 'properties' => [ 'EnableVoiceInterrupt' => ['description' => 'Specifies whether to support speech interruption. Default value: true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'InterruptWords' => [ 'description' => 'The specific words or phrases that trigger a conversation interruption.', 'type' => 'array', 'items' => ['description' => 'A specific word or phrase that triggers a conversation interruption.', 'type' => 'string', 'example' => '打断一下'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'Eagerness' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', 'deprecated' => true], 'NoInterruptMode' => ['description' => 'The ASR processing policy in `NoInterruptMode`.'."\n" ."\n" .'- `cache`: caches the ASR text. The cached ASR text is processed in the next conversational turn.'."\n" ."\n" .'- `discard`: discards the ASR text.'."\n" ."\n" .'Default value: cache.', 'type' => 'string', 'title' => '', 'example' => 'cache'], 'KeepInterruptWordsForLLM' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'TurnDetectionConfig' => [ 'description' => 'The configurations for conversational turn detection.', 'type' => 'object', 'properties' => [ 'TurnEndWords' => [ 'description' => 'The list of keywords that are used to determine the end of a user\'s conversational turn.', 'type' => 'array', 'items' => ['description' => 'A keyword that is used to determine the end of a user\'s conversational turn.', 'type' => 'string', 'example' => '我说完了', 'title' => ''], 'title' => '', 'example' => '', ], 'Mode' => ['description' => 'The mode for conversational turn detection. Valid values:'."\n" ."\n" .'- `Normal`: a basic mode that does not use AI for semantic analysis.'."\n" ."\n" .'- `Semantic`: an AI-powered mode that determines whether the user has finished speaking based on the conversational context.'."\n" ."\n" .'Default value: `Normal`.', 'type' => 'string', 'example' => 'Semantic', 'title' => ''], 'SemanticWaitDuration' => ['description' => 'The pause duration in AI mode that is used to determine whether a conversational turn has ended. Unit: ms. Default value: -1.'."\n" ."\n" .'- `-1`: The AI automatically determines an appropriate wait time.'."\n" ."\n" .'- `0-10000`: A custom wait time. We recommend that you set this parameter to a value from 0 to 1500.'."\n" ."\n" .'Note: This parameter is invalid in Normal mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], 'Eagerness' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'Low'], ], 'title' => '', 'example' => '', ], 'GreetingDelay' => ['description' => 'The delay before the welcome message is played. Unit: ms. Default value: 0. Valid values: 0 to 5000.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'AmbientSoundConfig' => [ 'description' => 'The configurations for ambient sound.', 'type' => 'object', 'properties' => [ 'ResourceId' => ['description' => 'The ID of the ambient sound. You can obtain the ID from the advanced configurations of the AI agent on the console.', 'type' => 'string', 'example' => 'f67901c595834************'."\n", 'title' => ''], 'Volume' => ['description' => 'The volume of the ambient sound. Valid values: 0 to 100. A value of 0 disables the sound.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'ExperimentalConfig' => ['description' => 'The parameters for experimental features. If you have any requirements, contact technical support.', 'type' => 'string', 'title' => '', 'example' => '""'], 'AutoSpeechConfig' => [ 'type' => 'object', 'properties' => [ 'UserIdle' => [ 'type' => 'object', 'properties' => [ 'WaitTime' => ['description' => 'The silence duration threshold. This parameter is required. An inquiry is triggered if this threshold is exceeded. Unit: ms. Valid values: 5000 to 600000.', 'type' => 'integer', 'title' => '', 'example' => '5000', 'format' => 'int32'], 'MaxRepeats' => ['description' => 'The maximum number of inquiries. This parameter is required. Valid values: 0 to 10. After the maximum number of inquiries is reached, no more inquiries are triggered, and the call is disconnected.', 'type' => 'integer', 'title' => '', 'example' => '5', 'format' => 'int32'], 'Messages' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The text of the inquiry prompt. The text can be up to 100 characters in length.', 'type' => 'string', 'title' => '', 'example' => '您还在吗？'], 'Probability' => ['description' => 'The selection probability of the prompt. Valid values: 0 to 1, which corresponds to 0% to 100%.', 'type' => 'number', 'title' => '', 'example' => '0.5', 'format' => 'double'], ], 'description' => 'The structure of an inquiry word.', 'title' => '', 'example' => '', ], 'description' => 'The collection of inquiry prompts. You can specify a maximum of 10 prompts. Each prompt can be up to 100 characters in length. The sum of the probabilities of all prompts must be 100%.', 'title' => '', 'example' => '', ], 'HangupEndWord' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '我挂了，再见'], ], 'description' => 'The configurations for inquiry broadcasts during prolonged user silence.', 'title' => '', 'example' => '', ], 'LlmPending' => [ 'type' => 'object', 'properties' => [ 'WaitTime' => ['description' => 'The wait time threshold for LLM responses. This parameter is required. A broadcast prompt is triggered if this threshold is exceeded. Unit: ms. Valid values: 500 to 10000. You need to configure this parameter based on the actual usage of the LLM.', 'type' => 'integer', 'title' => '', 'example' => '3000', 'format' => 'int32'], 'Mode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Messages' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The text of the inquiry prompt. The text can be up to 100 characters in length.', 'type' => 'string', 'title' => '', 'example' => '稍等一下'], 'Probability' => ['description' => 'The selection probability of the prompt. Valid values: 0 to 1, which corresponds to 0% to 100%.', 'type' => 'number', 'title' => '', 'example' => '0.5', 'format' => 'double'], ], 'description' => 'The structure of an inquiry word.', 'title' => '', 'example' => '', ], 'description' => 'The collection of inquiry prompts. You can specify a maximum of 10 prompts. Each prompt can be up to 100 characters in length. The sum of the probabilities of all prompts must be 100%.', 'title' => '', 'example' => '', ], ], 'description' => 'The configurations for broadcasts during LLM response delays.', 'title' => '', 'example' => '', ], ], 'description' => 'The configurations for the automatic speech module of the AI agent, which includes prompts during LLM delays and inquiries during prolonged user silence.', 'title' => '', 'example' => '', ], 'MaxIdleTime' => ['description' => 'The maximum wait time for interaction with the AI agent. If the wait time is exceeded, the AI agent goes offline. Unit: seconds. Default value: 600.', 'type' => 'integer', 'title' => '', 'example' => '600', 'format' => 'int32'], 'BackChannelingConfig' => [ 'type' => 'object', 'properties' => [ 'Enabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'TriggerStage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Probability' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'double'], 'Words' => [ 'type' => 'object', 'properties' => [ 'Text' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Probability' => ['type' => 'number', 'description' => '', 'title' => '', 'example' => '', 'format' => 'double'], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '>'."\n" ."\n" .'This parameter is deprecated. Use `BackChannelingConfigs` instead.'."\n" ."\n" .'>', 'title' => '', 'example' => '', 'deprecated' => true, ], 'BackChannelingConfigs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Specifies whether to enable the back-channeling feature. This parameter is required. Valid values: true and false.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'TriggerStage' => ['description' => 'The trigger point for back-channeling. Valid value:'."\n" ."\n" .'- `pause_detected`: triggered when a short pause in speech is detected', 'type' => 'string', 'title' => '', 'example' => 'pause_detected'], 'Probability' => ['description' => 'The trigger probability. This parameter is required. Valid values: 0.0 to 1.0.', 'type' => 'number', 'title' => '', 'example' => '0.5', 'format' => 'double'], 'Words' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The text of the phrase. This parameter is required. The text can be up to 20 characters in length and supports multiple languages.', 'type' => 'string', 'title' => '', 'example' => '嗯嗯'], 'Probability' => ['description' => 'The selection probability of this phrase. This parameter is required. Valid values: 0.0 to 1.0.', 'type' => 'number', 'title' => '', 'example' => '0.3', 'format' => 'double'], ], 'description' => 'The configuration of a single back-channeling phrase.', 'title' => '', 'example' => '', ], 'description' => 'The collection of back-channeling phrases. You can specify a maximum of 10 phrases. Each phrase can be up to 20 characters in length. The sum of the probabilities of all phrases must be 1.0.', 'title' => '', 'example' => '', ], ], 'description' => 'A single back-channeling configuration.', 'title' => '', 'example' => '', ], 'description' => 'The configurations for the back-channeling feature module. If you enable this feature, the system randomly plays short and affirmative phrases at specific trigger points.', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AIAgentRuntimeConfig' => [ 'title' => '', 'description' => 'The runtime configuration of the AI agent.'."\n", 'type' => 'object', 'properties' => [ 'AvatarChat3D' => [ 'title' => '', 'description' => 'The runtime parameters of the avatar call.'."\n", 'type' => 'object', 'properties' => [ 'AgentUserId' => ['title' => '', 'description' => 'Required. The name of the agent in the ARTC channel.'."\n", 'type' => 'string', 'example' => '877ae632caae49b1afc81c2e8194ffb4'], 'AuthToken' => ['title' => '', 'description' => 'Required. The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", 'type' => 'string', 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx'], 'ChannelId' => ['title' => '', 'description' => 'Required. The ID of the ARTC channel.'."\n", 'type' => 'string', 'example' => '70f22d5784194938a7e387052f2b3208'], ], 'deprecated' => true, 'example' => '', ], 'VisionChat' => [ 'description' => 'The runtime parameters of the vision call.'."\n", 'type' => 'object', 'properties' => [ 'AgentUserId' => ['description' => 'Required. The name of the agent in the ARTC channel.'."\n", 'type' => 'string', 'example' => '877ae632caae49b1afc81c2e8194ffb4', 'title' => ''], 'AuthToken' => ['description' => 'Required. The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", 'type' => 'string', 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', 'title' => ''], 'ChannelId' => ['description' => 'Required. The ID of the ARTC channel.'."\n", 'type' => 'string', 'example' => '70f22d5784194938a7e387052f2b3208', 'title' => ''], ], 'deprecated' => true, 'title' => '', 'example' => '', ], 'VoiceChat' => [ 'title' => '', 'description' => 'The runtime parameters of the voice call.'."\n", 'type' => 'object', 'properties' => [ 'AgentUserId' => ['title' => '', 'description' => 'Required. The name of the agent in the ARTC channel.'."\n", 'type' => 'string', 'example' => '877ae632caae49b1afc81c2e8194ffb4'], 'AuthToken' => ['title' => '', 'description' => 'Required. The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", 'type' => 'string', 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx'], 'ChannelId' => ['title' => '', 'description' => 'Required. The ID of the ARTC channel.'."\n", 'type' => 'string', 'example' => '70f22d5784194938a7e387052f2b3208'], ], 'deprecated' => true, 'example' => '', ], 'AgentUserId' => ['description' => 'The name of the agent in the ARTC channel.'."\n", 'type' => 'string', 'example' => '877ae632caae49b1afc81c2e8194ffb4', 'title' => ''], 'AuthToken' => ['description' => 'The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", 'type' => 'string', 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', 'title' => ''], 'ChannelId' => ['description' => 'The ID of the ARTC channel.'."\n", 'type' => 'string', 'example' => '70f22d5784194938a7e387052f2b3208'."\n", 'title' => ''], ], 'example' => '', ], 'AIAgentTemplateConfig' => [ 'title' => '', 'description' => 'Agent template parameters.', 'type' => 'object', 'properties' => [ 'AvatarChat3D' => [ 'title' => '', 'description' => '3D avatar parameters.', 'type' => 'object', 'properties' => [ 'AsrMaxSilence' => ['description' => 'The maximum duration of silence in milliseconds before a sentence break is detected. Range: 200 to 1,200. Default: 400.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'AvatarId' => ['title' => '', 'description' => 'The ID of the avatar model.', 'type' => 'string', 'example' => '1231'], 'EnableIntelligentSegment' => ['description' => 'Specifies whether to enable intelligent segmentation. If enabled, this feature intelligently merges pauses in a user\'s speech into a single, complete sentence. Default: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnablePushToTalk' => ['description' => 'Specifies whether to enable Push-to-Talk mode. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EnableVoiceInterrupt' => ['title' => '', 'description' => 'Specifies whether to enable voice interruption. Default: `true`.', 'type' => 'boolean', 'example' => 'true'], 'GracefulShutdown' => ['title' => '', 'description' => 'Specifies whether to enable graceful shutdown. Default: `false`.'."\n" ."\n" .'- If enabled, the agent finishes its current speech (up to 10 seconds) before stopping.', 'type' => 'boolean', 'example' => 'false'], 'Greeting' => ['title' => '', 'description' => 'The greeting message delivered when a user joins the session. If this parameter is omitted, the greeting configured in the agent template is used. Maximum length: 128 characters.', 'type' => 'string', 'example' => '早上好，我的朋友！'], 'UseVoiceprint' => ['description' => 'Specifies whether to use voiceprint recognition. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserOnlineTimeout' => ['description' => 'The time in seconds that the agent waits for a user to join before closing the task. Default: 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], 'VoiceId' => ['title' => '', 'description' => 'The ID of the Text-to-Speech (TTS) voice. Changes take effect on the next utterance. If omitted, the default voice from the agent template is used. This parameter applies only to preset TTS voices. Maximum length: 64 characters. For available values, see [Intelligent voice effect samples](~~449563~~).', 'type' => 'string', 'example' => 'zhixiaoxia'], 'Volume' => ['title' => '', 'description' => 'The speaking volume of the agent.'."\n" ."\n" .'- If omitted, the system uses adaptive volume mode.'."\n" ."\n" .'- If specified, the valid range is 0 to 400. The output volume is calculated as: `Output Volume in Workflow` \\* (`volume`/100). For example:'."\n" ."\n" .'1. If `volume` is `0`, the output is silent.'."\n" ."\n" .'2. If `volume` is `100`, the output volume is the original volume.'."\n" ."\n" .'3. If `volume` is `200`, the output volume is twice the original volume.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'VoiceprintId' => ['description' => 'The unique ID for voiceprint recognition. Default: not specified.', 'type' => 'string', 'example' => 'uniqueId', 'title' => ''], 'BailianAppParams' => ['description' => 'Parameters for Alibaba Cloud Bailian. For details, see [Bailian App Params](~~2858132~~).', 'type' => 'string', 'example' => '{}', 'title' => ''], 'UserOfflineTimeout' => ['description' => 'The time in seconds that the agent waits after a user leaves before closing the task. Default: 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'MaxIdleTime' => ['description' => 'The maximum idle time in seconds with no interaction before the agent goes offline. Default: 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'WorkflowOverrideParams' => ['description' => 'Workflow override parameters. Default: empty.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'WakeUpQuery' => ['description' => 'An initial user query that the agent addresses immediately when the call starts.', 'type' => 'string', 'example' => '今天天气怎么样？', 'title' => ''], 'LlmHistory' => [ 'description' => 'The LLM/MLLM conversation history.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Role' => ['description' => 'The role of the conversation participant. Valid values:'."\n" ."\n" .'- `user`: The user.'."\n" ."\n" .'- `assistant`: The AI assistant.'."\n" ."\n" .'- `system`: The system.'."\n" ."\n" .'- `function`: A function call.'."\n" ."\n" .'- `plugin`: A plugin.'."\n" ."\n" .'- `tool`: A tool.', 'type' => 'string', 'example' => 'user', 'title' => ''], 'Content' => ['description' => 'The text content of the message.', 'type' => 'string', 'example' => '你好', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LlmHistoryLimit' => ['description' => 'The maximum number of conversation turns to retain in the LLM/MLLM history. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'VoiceIdList' => [ 'description' => 'A list of available voices.', 'type' => 'array', 'items' => ['description' => 'A voice ID.', 'type' => 'string', 'title' => '', 'example' => 'zhixiaoxia'], 'title' => '', 'example' => '', ], 'AsrLanguageId' => ['description' => 'The language ID for Automatic Speech Recognition (ASR). Possible values:'."\n" ."\n" .'- `zh_mandarin`: Chinese'."\n" ."\n" .'- `en`: English'."\n" ."\n" .'- `zh_en`: Chinese-English'."\n" ."\n" .'- `es`: Spanish'."\n" ."\n" .'- `jp`: Japanese', 'type' => 'string', 'title' => '', 'example' => 'zh_mandarin'], 'LlmSystemPrompt' => ['description' => 'The system prompt for the LLM, applied when the call starts.', 'type' => 'string', 'title' => '', 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'], 'InterruptWords' => [ 'description' => 'A list of specific words or phrases that trigger a conversation interruption.', 'type' => 'array', 'items' => ['description' => 'A specific word or phrase that triggers a conversation interruption.', 'type' => 'string', 'title' => '', 'example' => '停止'], 'title' => '', 'example' => '', ], 'VadLevel' => ['description' => 'The interruption sensitivity threshold. A higher value makes it more difficult to interrupt the agent. Range: 0 to 11. Default: 11.'."\n" ."\n" .'- `0`: Disables VAD.'."\n" ."\n" .'- `1` to `10`: A higher value makes it more difficult to interrupt the agent.'."\n" ."\n" .'- `11`: Offers lower audio distortion and stronger resistance to interference.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], 'CharBreak' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'AsrHotWords' => [ 'description' => 'A list of hot words to improve ASR accuracy. A maximum of 128 words is supported.', 'type' => 'array', 'items' => ['description' => 'A hot word. Must be 1 to 10 characters long.', 'type' => 'string', 'title' => '', 'example' => '检查'], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'VisionChat' => [ 'description' => 'Vision agent parameters.', 'type' => 'object', 'properties' => [ 'AsrMaxSilence' => ['description' => 'The maximum duration of silence in milliseconds before a sentence break is detected. Range: 200 to 1,200. Default: 400.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'EnableIntelligentSegment' => ['description' => 'Specifies whether to enable intelligent segmentation. If enabled, this feature intelligently merges pauses in a user\'s speech into a single, complete sentence. Default: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnablePushToTalk' => ['description' => 'Specifies whether to enable Push-to-Talk mode. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EnableVoiceInterrupt' => ['description' => 'Specifies whether to enable voice interruption. Default: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'GracefulShutdown' => ['description' => 'Specifies whether to enable graceful shutdown. Default: `false`.'."\n" ."\n" .'- If enabled, the agent finishes its current speech (up to 10 seconds) before stopping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Greeting' => ['description' => 'The greeting message delivered when a user joins the session. If this parameter is omitted, the greeting configured in the agent template is used. Maximum length: 128 characters.', 'type' => 'string', 'example' => '早上好，我的朋友！'."\n", 'title' => ''], 'UseVoiceprint' => ['description' => 'Specifies whether to use voiceprint recognition. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserOnlineTimeout' => ['description' => 'The time in seconds that the agent waits for a user to join before closing the task. Default: 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], 'VoiceId' => ['description' => 'The ID of the Text-to-Speech (TTS) voice. Changes take effect on the next utterance. If omitted, the default voice from the agent template is used. This parameter applies only to preset TTS voices. Maximum length: 64 characters. For available values, see [Intelligent voice effect samples](~~449563~~).', 'type' => 'string', 'example' => 'zhixiaoxia', 'title' => ''], 'Volume' => ['description' => 'The speaking volume of the agent.'."\n" ."\n" .'- If omitted, the system uses adaptive volume mode.'."\n" ."\n" .'- If specified, the valid range is 0 to 400. The output volume is calculated as: `Output Volume in Workflow` \\* (`volume`/100). For example:'."\n" ."\n" .'1. If `volume` is `0`, the output is silent.'."\n" ."\n" .'2. If `volume` is `100`, the output volume is the original volume.'."\n" ."\n" .'3. If `volume` is `200`, the output volume is twice the original volume.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'VoiceprintId' => ['description' => 'The unique ID for voiceprint recognition. Default: not specified.', 'type' => 'string', 'example' => 'uniqueId', 'title' => ''], 'BailianAppParams' => ['description' => 'Parameters for Alibaba Cloud Bailian. For details, see [Bailian App Params](~~2858132~~).', 'type' => 'string', 'example' => '{}', 'title' => ''], 'UserOfflineTimeout' => ['description' => 'The time in seconds that the agent waits after a user leaves before closing the task. Default: 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'MaxIdleTime' => ['description' => 'The maximum idle time in seconds with no interaction before the agent goes offline. Default: 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'WorkflowOverrideParams' => ['description' => 'Workflow override parameters. Default: empty.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'WakeUpQuery' => ['description' => 'An initial user query that the agent addresses immediately when the call starts.', 'type' => 'string', 'example' => '今天天气怎么样？', 'title' => ''], 'LlmHistory' => [ 'description' => 'The LLM/MLLM conversation history.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Role' => ['description' => 'The role of the conversation participant. Valid values:'."\n" ."\n" .'- `user`: The user.'."\n" ."\n" .'- `assistant`: The AI assistant.'."\n" ."\n" .'- `system`: The system.'."\n" ."\n" .'- `function`: A function call.'."\n" ."\n" .'- `plugin`: A plugin.'."\n" ."\n" .'- `tool`: A tool.', 'type' => 'string', 'example' => 'user', 'title' => ''], 'Content' => ['description' => 'The text content of the message.', 'type' => 'string', 'example' => '你好', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LlmHistoryLimit' => ['description' => 'The maximum number of conversation turns to retain in the LLM/MLLM history. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'VoiceIdList' => [ 'description' => 'A list of available voices.', 'type' => 'array', 'items' => ['description' => 'A voice ID.', 'type' => 'string', 'title' => '', 'example' => 'zhixiaoxia'], 'title' => '', 'example' => '', ], 'AsrLanguageId' => ['description' => 'The language ID for Automatic Speech Recognition (ASR). Possible values:'."\n" ."\n" .'- `zh_mandarin`: Chinese'."\n" ."\n" .'- `en`: English'."\n" ."\n" .'- `zh_en`: Chinese-English'."\n" ."\n" .'- `es`: Spanish'."\n" ."\n" .'- `jp`: Japanese', 'type' => 'string', 'title' => '', 'example' => 'zh_mandarin'], 'LlmSystemPrompt' => ['description' => 'The system prompt for the LLM, applied when the call starts.', 'type' => 'string', 'title' => '', 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'."\n"], 'InterruptWords' => [ 'description' => 'A list of specific words or phrases that trigger a conversation interruption.', 'type' => 'array', 'items' => ['description' => 'A specific word or phrase that triggers a conversation interruption.', 'type' => 'string', 'title' => '', 'example' => '停止'], 'title' => '', 'example' => '', ], 'VadLevel' => ['description' => 'The interruption sensitivity threshold. A higher value makes it more difficult to interrupt the agent. Range: 0 to 11. Default: 11.'."\n" ."\n" .'- `0`: Disables VAD.'."\n" ."\n" .'- `1` to `10`: A higher value makes it more difficult to interrupt the agent.'."\n" ."\n" .'- `11`: Offers lower audio distortion and stronger resistance to interference.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], 'CharBreak' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'AsrHotWords' => [ 'description' => 'A list of hot words to improve ASR accuracy. A maximum of 128 words is supported.', 'type' => 'array', 'items' => ['description' => 'Hotword string. Character length: [1, 10] characters. ', 'type' => 'string', 'example' => '检查', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'VoiceChat' => [ 'title' => '', 'description' => 'Voice chat parameters.', 'type' => 'object', 'properties' => [ 'AsrMaxSilence' => ['description' => 'The maximum duration of silence in milliseconds before a sentence break is detected. Range: 200 to 1,200. Default: 400.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'EnableIntelligentSegment' => ['description' => 'Specifies whether to enable intelligent segmentation. If enabled, this feature intelligently merges pauses in a user\'s speech into a single, complete sentence. Default: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnablePushToTalk' => ['description' => 'Specifies whether to enable Push-to-Talk mode. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EnableVoiceInterrupt' => ['title' => '', 'description' => 'Specifies whether to enable voice interruption. Default: `true`.', 'type' => 'boolean', 'example' => 'true'], 'GracefulShutdown' => ['title' => '', 'description' => 'Specifies whether to enable graceful shutdown. Default: `false`.'."\n" ."\n" .'- If enabled, the agent finishes its current speech (up to 10 seconds) before stopping.', 'type' => 'boolean', 'example' => 'false'], 'Greeting' => ['title' => '', 'description' => 'The greeting message delivered when a user joins the session. If this parameter is omitted, the greeting configured in the agent template is used. Maximum length: 128 characters.', 'type' => 'string', 'example' => '早上好，我的朋友'], 'UseVoiceprint' => ['description' => 'Specifies whether to use voiceprint recognition. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserOnlineTimeout' => ['description' => 'The time in seconds that the agent waits for a user to join before closing the task. Default: 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], 'VoiceId' => ['title' => '', 'description' => 'The ID of the Text-to-Speech (TTS) voice. Changes take effect on the next utterance. If omitted, the default voice from the agent template is used. This parameter applies only to preset TTS voices. Maximum length: 64 characters. For available values, see [Intelligent voice effect samples](~~449563~~).', 'type' => 'string', 'example' => 'zhixiaoxia'], 'Volume' => ['title' => '', 'description' => 'The speaking volume of the agent.'."\n" ."\n" .'- If omitted, the system uses adaptive volume mode.'."\n" ."\n" .'- If specified, the valid range is 0 to 400. The output volume is calculated as: `Output Volume in Workflow` \\* (`volume`/100). For example:'."\n" ."\n" .'1. If `volume` is `0`, the output is silent.'."\n" ."\n" .'2. If `volume` is `100`, the output volume is the original volume.'."\n" ."\n" .'3. If `volume` is `200`, the output volume is twice the original volume.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'VoiceprintId' => ['description' => 'The unique ID for voiceprint recognition. Default: not specified.', 'type' => 'string', 'example' => 'uniqueId', 'title' => ''], 'BailianAppParams' => ['description' => 'Parameters for Alibaba Cloud Bailian. For details, see [Bailian App Params](~~2858132~~).', 'type' => 'string', 'example' => '{}', 'title' => ''], 'UserOfflineTimeout' => ['description' => 'The time in seconds that the agent waits after a user leaves before closing the task. Default: 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'AvatarUrl' => ['description' => 'The URL of the agent\'s avatar for voice chat. Default: none.', 'type' => 'string', 'example' => 'http://example.com/a.jpg', 'title' => ''], 'AvatarUrlType' => ['description' => 'The type of the agent\'s avatar URL. Default: none.', 'type' => 'string', 'example' => 'USER', 'title' => ''], 'MaxIdleTime' => ['description' => 'The maximum idle time in seconds with no interaction before the agent goes offline. Default: 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'WorkflowOverrideParams' => ['description' => 'Workflow override parameters. Default: empty.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'WakeUpQuery' => ['description' => 'An initial user query that the agent addresses immediately when the call starts.', 'type' => 'string', 'example' => '今天天气怎么样？', 'title' => ''], 'LlmHistory' => [ 'description' => 'The LLM/MLLM conversation history.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Role' => ['description' => 'The role of the conversation participant. Valid values:'."\n" ."\n" .'- `user`: The user.'."\n" ."\n" .'- `assistant`: The AI assistant.'."\n" ."\n" .'- `system`: The system.'."\n" ."\n" .'- `function`: A function call.'."\n" ."\n" .'- `plugin`: A plugin.'."\n" ."\n" .'- `tool`: A tool.', 'type' => 'string', 'example' => 'user', 'title' => ''], 'Content' => ['description' => 'The text content of the message.', 'type' => 'string', 'example' => '你好', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LlmHistoryLimit' => ['description' => 'The maximum number of conversation turns to retain in the LLM/MLLM history. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'VoiceIdList' => [ 'description' => 'A list of available voices.', 'type' => 'array', 'items' => ['description' => 'Voice tone. ', 'type' => 'string', 'example' => 'zhixiaoxia', 'title' => ''], 'title' => '', 'example' => '', ], 'AsrLanguageId' => ['description' => 'The language ID for Automatic Speech Recognition (ASR).'."\n" .'Possible values:'."\n" ."\n" .'- `zh_mandarin`: Chinese'."\n" ."\n" .'- `en`: English'."\n" ."\n" .'- `zh_en`: Chinese-English'."\n" ."\n" .'- `es`: Spanish'."\n" ."\n" .'- `jp`: Japanese', 'type' => 'string', 'title' => '', 'example' => 'zh_mandarin'], 'LlmSystemPrompt' => ['description' => 'The system prompt for the LLM, applied when the call starts.', 'type' => 'string', 'title' => '', 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'], 'InterruptWords' => [ 'description' => 'A list of specific words or phrases that trigger a conversation interruption.', 'type' => 'array', 'items' => ['description' => 'Specific word or phrase that triggers conversation interruption. ', 'type' => 'string', 'example' => '停止', 'title' => ''], 'title' => '', 'example' => '', ], 'VadLevel' => ['description' => 'The interruption sensitivity threshold. A higher value makes it more difficult to interrupt the agent. Range: 0 to 11. Default: 11.'."\n" ."\n" .'- `0`: Disables Voice Activity Detection (VAD).'."\n" ."\n" .'- `1` to `10`: A higher value makes it more difficult to interrupt the agent.'."\n" ."\n" .'- `11`: Offers lower audio distortion and stronger resistance to interference.', 'type' => 'integer', 'title' => '', 'example' => '11', 'format' => 'int32'], 'CharBreak' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'AsrHotWords' => [ 'description' => 'A list of hot words to improve ASR accuracy. A maximum of 128 words is supported.', 'type' => 'array', 'items' => ['description' => 'A hot word. Must be 1 to 10 characters long.', 'type' => 'string', 'title' => '', 'example' => '检查'], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'AiRtcAuthCodeDTO' => [ 'title' => '', 'description' => 'Authorization code information.', 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'Status:'."\n" ."\n" .'- 1 - Activated'."\n" .'- 2 - Not activated', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Type' => ['title' => '', 'description' => 'Type:'."\n" ."\n" .'- 1 - Voice call'."\n" .'- 2 - Visual understanding', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'AuthCode' => ['title' => '', 'description' => 'Authorization code.', 'type' => 'string', 'example' => 'iU1IeJech7***'], 'ActivatedTime' => ['title' => '', 'description' => 'Activation time.', 'type' => 'string', 'example' => '2024-01-01 06:57:43'], 'DeviceId' => ['title' => '', 'description' => 'Device ID.', 'type' => 'string', 'example' => 'device-***'], 'CreationTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2023-12-23T13:33:49Z'], 'License' => ['title' => '', 'description' => 'license。', 'type' => 'string', 'example' => 'a659a06659a***'], 'ModificationTime' => ['title' => '', 'description' => 'Update time.', 'type' => 'string', 'example' => '2023-12-23T13:33:49Z'], 'LicenseItemId' => ['title' => '', 'description' => 'Batch ID.', 'type' => 'string', 'example' => '11096067***'], ], 'example' => '', ], 'AiRtcLicenseInfoDTO' => [ 'title' => '', 'description' => 'The license batch information.'."\n", 'type' => 'object', 'properties' => [ 'CreationTime' => ['title' => '', 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2020-12-23T13:33:49Z'], 'ModificationTime' => ['title' => '', 'description' => 'The update time.'."\n", 'type' => 'string', 'example' => '2020-12-23T13:33:49Z'], 'Type' => ['title' => '', 'description' => 'The license type. Valid values:'."\n" ."\n" .'* 1: Audio call'."\n" .'* 2: Vision call'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'LicenseItemId' => ['title' => '', 'description' => 'The ID of the batch.'."\n", 'type' => 'string', 'example' => '17712***'], 'Status' => ['title' => '', 'description' => 'The status of the batch. Valid values:'."\n" ."\n" .'* 1: Active'."\n" .'* 2\\. Expired'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ValidDays' => ['title' => '', 'description' => 'The validity period of the licenses in this batch, in days.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '365'], 'ExpiredOn' => ['title' => '', 'description' => 'The expiration time.'."\n", 'type' => 'string', 'example' => '2021-12-23T13:33:49Z'], 'BeginOn' => ['title' => '', 'description' => 'The time when the batch became active.'."\n", 'type' => 'string', 'example' => '2020-12-23T13:33:49Z'], 'LicenseCount' => ['title' => '', 'description' => 'The total number of licenses contained within this batch.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], 'AvailableCapacity' => ['title' => '', 'description' => 'The remaining usage capacity of the batch.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000000'], 'InstanceId' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'ice_CoverAILicense_public_cn***'], 'ContractNo' => ['title' => '', 'description' => 'The contract number.'."\n", 'type' => 'string', 'example' => '258396267390***'], ], 'example' => '', ], 'AppInfoDTO' => [ 'title' => 'A short description of struct', 'description' => '应用信息', 'type' => 'object', 'properties' => [ 'Platforms' => [ 'title' => '应用包含的平台信息列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['title' => '平台类型', 'type' => 'integer', 'format' => 'int64'], 'LicenseItemIds' => [ 'title' => '授权列表', 'type' => 'array', 'items' => ['type' => 'string', 'example' => '授权itemId'], ], 'PkgSignature' => ['title' => '包签名', 'type' => 'string'], 'PlatformType' => ['title' => '平台类型', 'type' => 'integer', 'format' => 'int64'], 'ItemId' => ['title' => '平台标志', 'type' => 'string'], 'PkgName' => ['title' => '包名', 'type' => 'string'], ], ], ], 'GmtCreate' => ['title' => '创建时间', 'type' => 'string'], 'UserId' => ['title' => '用户ID', 'type' => 'integer', 'format' => 'int64'], 'CreationTime' => ['title' => '创建时间', 'type' => 'string'], 'GmtModified' => ['title' => '更新时间', 'type' => 'string'], 'ModificationTime' => ['title' => '更新时间', 'type' => 'string'], 'AppType' => ['title' => '应用类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1-普通应用，2-内嵌SDK.'], 'ItemId' => ['title' => '应用标识', 'type' => 'string'], 'AppName' => ['title' => '应用名称', 'type' => 'string'], ], ], 'Channel' => [ 'description' => 'The MediaWeaver channel.'."\n", 'type' => 'object', 'properties' => [ 'FillerSourceName' => ['description' => 'The source name of the filler slate.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'FillerSourceLocationName' => ['description' => 'The source location of the filler slate.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2024-01-15T03:44:16Z', 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'ChannelTier' => ['description' => 'The tier of the channel.'."\n", 'type' => 'string', 'example' => 'basic', 'title' => ''], 'AccessToken' => ['description' => 'The token for accessing the channel.'."\n", 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'State' => ['description' => 'The state of the channel.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2024-09-01T10:09Z', 'title' => ''], 'Arn' => ['description' => 'The ARN of the channel.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::channel/myChannel', 'title' => ''], 'PlaybackMode' => ['description' => 'The playback mode.'."\n", 'type' => 'string', 'example' => 'loop', 'title' => ''], 'OutPutConfigList' => [ 'description' => 'The output configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The output configuration.'."\n", 'type' => 'object', 'properties' => [ 'ManifestName' => ['description' => 'The manifest name.'."\n", 'type' => 'string', 'example' => 'index1', 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'Format' => ['description' => 'The format.'."\n", 'type' => 'string', 'example' => 'hls', 'title' => ''], 'PlaybackUrl' => ['description' => 'The playback URL.'."\n", 'type' => 'string', 'example' => 'https://xxxxx.com/xxx.m3u8', 'title' => ''], 'ManifestSettings' => ['description' => 'The manifest settings.'."\n", 'type' => 'string', 'example' => '{"WindowDuration": 60,"AdMarkType":"Daterange"}', 'title' => ''], 'SourceGroupName' => ['description' => 'The name of the source group.'."\n", 'type' => 'string', 'example' => 'group1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AccessPolicy' => ['description' => 'Specifies whether to enable access control.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ChannelAssemblyChannel' => [ 'description' => 'The MediaWeaver channel.'."\n", 'type' => 'object', 'properties' => [ 'FillerSourceName' => ['description' => 'The source name of the filler slate.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'FillerSourceLocationName' => ['description' => 'The source location of the filler slate.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the channel was created.'."\n", 'type' => 'string', 'example' => '2024-01-15T03:44:16Z'."\n", 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'ChannelTier' => ['description' => 'The tier of the channel. Valid values: basic and standard.'."\n", 'type' => 'string', 'example' => 'basic', 'title' => ''], 'AccessToken' => ['description' => 'The token for accessing the channel.'."\n", 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'State' => ['description' => 'The channel status. A value of 0 specifies stopped. A value of 1 specifies running.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'GmtModified' => ['description' => 'The time when the channel was last modified.'."\n", 'type' => 'string', 'example' => '2024-09-01T10:09Z'."\n", 'title' => ''], 'Arn' => ['description' => 'The ARN of the channel.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::channel/myChannel'."\n", 'title' => ''], 'PlaybackMode' => ['description' => 'The playback mode. Valid values: loop and linear.'."\n", 'type' => 'string', 'example' => 'loop', 'title' => ''], 'OutPutConfigList' => [ 'description' => 'The channel output configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The output.'."\n", 'type' => 'object', 'properties' => [ 'ManifestName' => ['description' => 'The name of the manifest file.'."\n", 'type' => 'string', 'example' => 'index1', 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'Format' => ['description' => 'The streaming protocol. Only HTTP Live Streaming (HLS) is supported.'."\n", 'type' => 'string', 'example' => 'hls', 'title' => ''], 'PlaybackUrl' => ['description' => 'The playback URL.'."\n", 'type' => 'string', 'example' => 'https://xxxxx.com/xxx.m3u8'."\n", 'title' => ''], 'ManifestSettings' => ['description' => 'The manifest settings.'."\n", 'type' => 'string', 'example' => '{"WindowDuration": 60,"AdMarkType":"Daterange"}'."\n", 'title' => ''], 'SourceGroupName' => ['description' => 'The name of the source group.'."\n", 'type' => 'string', 'example' => 'group1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AccessPolicy' => ['description' => 'Specifies whether to enable access control.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ChannelAssemblyProgram' => [ 'description' => 'The information about the program.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The time when the program was created.'."\n", 'type' => 'string', 'example' => '2024-04-02T00:58:19Z'."\n", 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'AdBreaks' => [ 'description' => 'The ad breaks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TimeSignalSettings' => ['description' => 'The TimeSignal configurations.'."\n", 'type' => 'string', 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}'."\n", 'title' => ''], 'OffsetMillis' => ['description' => 'The position to insert the ad marker, as an offset relative to the beginning of the program. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'SpliceInsertSettings' => ['description' => 'The SpliceInsert configurations.'."\n", 'type' => 'string', 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MyAdSource', 'title' => ''], 'ProgramName' => ['description' => 'The name of the program.'."\n", 'type' => 'string', 'example' => 'program_name'."\n", 'title' => ''], 'MessageType' => ['description' => 'The SCTE-35 message type.'."\n", 'type' => 'string', 'example' => 'SPLICE_INSERT', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SourceType' => ['description' => 'The source type. Valid values: vodSource and liveSource.'."\n", 'type' => 'string', 'example' => 'vodSource', 'title' => ''], 'Transition' => ['description' => 'The program transition method.'."\n", 'type' => 'string', 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}'."\n", 'title' => ''], 'GmtModified' => ['description' => 'The time when the program was last modified.'."\n", 'type' => 'string', 'example' => '2024-04-02T00:58:19Z'."\n", 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'ClipRange' => ['description' => 'Extracts a clip from the source.'."\n", 'type' => 'string', 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}'."\n", 'title' => ''], 'Arn' => ['description' => 'The ARN of the program.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::program/myChannel/MyProgram'."\n", 'title' => ''], 'ProgramName' => ['description' => 'The name of the program.'."\n", 'type' => 'string', 'example' => 'program1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ChannelAssemblyScheduleData' => [ 'description' => 'The program schedule information.'."\n", 'type' => 'object', 'properties' => [ 'EntryType' => ['description' => 'The entry type.'."\n", 'type' => 'string', 'example' => 'program', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation'."\n", 'title' => ''], 'AdBreaks' => [ 'description' => 'The information about ad breaks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OffsetMillis' => ['description' => 'The position to insert the ad marker, as an offset relative to the beginning of the program. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '100000', 'title' => ''], 'TimeSignalSettings' => ['description' => 'The TimeSignal configurations.'."\n", 'type' => 'string', 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}'."\n", 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'SpliceInsertSettings' => ['description' => 'The SpliceInsert configurations.'."\n", 'type' => 'string', 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'MessageType' => ['description' => 'The SCTE-35 message type.'."\n", 'type' => 'string', 'example' => 'SPLICE_INSERT', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SourceType' => ['description' => 'The source type. Valid values: vodSource and liveSource.'."\n", 'type' => 'string', 'example' => 'vodSource', 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'ApproximateDurationSeconds' => ['description' => 'The scheduled playback duration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'ApproximateStartTime' => ['description' => 'The scheduled start time.'."\n", 'type' => 'string', 'example' => '1989128002313', 'title' => ''], 'ProgramName' => ['description' => 'The name of the program.'."\n", 'type' => 'string', 'example' => 'program1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ChannelAssemblySource' => [ 'description' => 'The source information.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The time when the source was created.'."\n", 'type' => 'string', 'example' => '2022-10-20T07:15:51Z', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation'."\n", 'title' => ''], 'State' => ['description' => 'The status of the source. 0: normal. 1: deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'SourceType' => ['description' => 'The source type. Valid values: vodSource and liveSource.'."\n", 'type' => 'string', 'example' => 'vodSource', 'title' => ''], 'GmtModified' => ['description' => 'The time when the source was last modified.'."\n", 'type' => 'string', 'example' => '2024-11-07T10:12:01Z'."\n", 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MyVodSource'."\n", 'title' => ''], 'HttpPackageConfigurations' => ['description' => 'The source configuration.'."\n", 'type' => 'string', 'example' => '[{'."\n" .' "sourceGroupName": "mySourceGroup-1",'."\n" .' "relativePath": "group1/hls.m3u8",'."\n" .' "packageType": "hls"'."\n" .'}]', 'title' => ''], 'Arn' => ['description' => 'The ARN of the source.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/mySource'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'ChannelAssemblySourceLocation' => [ 'description' => 'The source location information.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The time when the source location was created.'."\n", 'type' => 'string', 'example' => '2024-03-29T02:03:17Z', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation'."\n", 'title' => ''], 'State' => ['description' => 'The status of the source location. 0: normal. 1: deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'GmtModified' => ['description' => 'The time when the source location was last modified.'."\n", 'type' => 'string', 'example' => '2024-03-29T02:03:17Z'."\n", 'title' => ''], 'SegmentDeliveryConfigurations' => ['description' => 'The segment delivery server configurations.'."\n", 'type' => 'string', 'example' => 'http://segmentdelivery.com'."\n", 'title' => ''], 'BaseUrl' => ['description' => 'The base URL of the source location.'."\n", 'type' => 'string', 'example' => 'http://xxxx.com'."\n", 'title' => ''], 'Arn' => ['description' => 'The ARN of the source location.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::sourcelocation/MySourceLocation'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'EntityMediaBasicInfo' => [ 'type' => 'object', 'properties' => [ 'EntityMediaId' => ['type' => 'string'], 'EntityId' => ['type' => 'string'], 'Status' => ['type' => 'string'], 'Biz' => ['type' => 'string'], 'AppId' => ['type' => 'string'], 'UserData' => ['type' => 'string'], 'ModifiedTime' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], ], ], 'Hotword' => [ 'description' => 'The hotword information.'."\n", 'type' => 'object', 'properties' => [ 'TranspositionResultList' => [ 'description' => '* Predefined translation results for the hotword.'."\n" .'* This field is only used in translation-related scenarios.'."\n", 'type' => 'array', 'items' => ['description' => 'Predefined translation for the hotword.'."\n", '$ref' => '#/components/schemas/TranspositionResult', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'Language' => ['title' => '', 'description' => 'The language of the hotword text. Valid values:'."\n" ."\n" .'* For structured media analysis and ASR: zh: Chinese en: English'."\n" .'* For video translation: Supports 53 languages.'."\n" .'*'."\n", 'type' => 'string', 'example' => 'en'], 'Text' => ['title' => '', 'description' => 'The text of the hotword.'."\n" ."\n" .'* For structured media analysis and ASR:'."\n" .'* * Chinese: Up to 15 characters.'."\n" .'* * English: Up to 10 words, separated by spaces.'."\n" .'* * Mixed: Each letter is counted as one character (following the Chinese limit).'."\n" .'* For video translation: Up to 100 characters.'."\n" .'*'."\n", 'type' => 'string', 'example' => 'hello'], 'Weight' => ['description' => 'The weight of the hotword.'."\n" ."\n" .'1. Valid values: \\[-6,5].'."\n" .'2. A positive value increases the likelihood of the word being recognized, while a negative value decreases the likelihood.'."\n" .'3. A value of -6 specifies that recognition of this word should be minimized.'."\n" .'4. Recommended value: 2.'."\n" .'5. If the desired effect is not achieved, you can increase the weight. However, excessively high weights may negatively impact the recognition accuracy of other words.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'LicenseInstanceAppDTO' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'Status' => ['title' => 'status', 'type' => 'string'], 'AppId' => ['title' => 'appId', 'type' => 'string'], 'ContractNo' => ['title' => 'contractNo', 'type' => 'string'], 'InstanceId' => ['title' => 'instanceId', 'type' => 'string'], 'UserId' => ['title' => 'userId', 'type' => 'integer', 'format' => 'int64'], 'CreationTime' => ['title' => 'creationTime', 'type' => 'string'], 'BeginOn' => ['title' => 'beginOn', 'type' => 'string'], 'ModificationTime' => ['title' => 'modificationTime', 'type' => 'string'], 'ItemId' => ['title' => 'itemId', 'type' => 'string'], 'ExpiredOn' => ['title' => 'expiredOn', 'type' => 'string'], 'LicenseConfigs' => [ 'title' => 'LicenseConfigDTOS', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FeatureIds' => ['title' => 'featureIds', 'type' => 'string'], 'SdkId' => ['title' => 'sdkId', 'type' => 'integer', 'format' => 'int32'], 'IsTrial' => ['type' => 'boolean'], 'SdkName' => ['title' => 'sdkName', 'type' => 'string'], 'BusinessType' => ['title' => 'businessType', 'type' => 'string'], 'Subscription' => ['title' => 'subscription', 'type' => 'string'], 'SubscriptionImp' => ['title' => 'subscriptionImp', 'type' => 'string'], 'SubscriptionPkg' => ['title' => 'subscriptionPkg', 'type' => 'string'], ], ], 'required' => false, ], ], ], 'ListMediaQualityAnalysisJobsResponseItem' => [ 'type' => 'object', 'properties' => [ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'JobId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'ScheduleConfig' => [ 'type' => 'object', 'properties' => [ 'PipelineId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'TemplateConfig' => [ 'type' => 'object', 'properties' => [ 'TemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'State' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'UserData' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Input' => [ 'type' => 'object', 'properties' => [ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Media' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'CreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'FinishTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'LiveManifestConfig' => [ 'description' => 'Configuration for a live stream manifest.'."\n", 'type' => 'object', 'properties' => [ 'SegmentCount' => ['description' => 'The number of segments to include in the playlist. Applies to HLS and HLS-CMAF protocols. If not set, the channel\'s default configuration is used. Valid values: 2 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'AdMarkers' => [ 'description' => 'The type of ad markers to include in the manifest.'."\n" ."\n" .'* NONE: Removes all ad markers.'."\n" .'* DATE_RANGE: Inserts EXT-X-DATERANGE tags (HLS spec). Valid for HLS/HLS-CMAF endpoints.'."\n" .'* XML: Inserts XML-based ad markers (DASH spec). Valid for DASH endpoints.'."\n", 'type' => 'string', 'enumValueTitles' => ['XML' => 'XML', 'NONE' => 'NONE', 'DATE_RANGE' => 'DATE_RANGE'], 'example' => 'NONE', 'title' => '', ], 'MinVideoBitrate' => ['description' => 'The minimum bitrate threshold (in bits per second) that video tracks must be at or above to be available for playback from this endpoint. It must be a positive integer. If not set, no minimum bitrate is enforced.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000000', 'title' => ''], 'MinBufferTime' => ['description' => 'The minimum buffer time, in seconds. Valid values: 1 to 30. Default value: the duration of two segments. Applies only to DASH endpoints.'."\n" ."\n" .'Note: Setting this value too low may cause playback to stutter. We recommend a value no less than two segment durations.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'PresentationDelay' => ['description' => 'The suggested presentation delay, in seconds. Valid values: 1 to 60. Default value: the duration of three segments.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], 'StreamOrder' => [ 'description' => 'The order of streams in the master playlist. Valid values:'."\n" ."\n" .'* ORIGINAL: Preserves the original order of the input streams.'."\n" .'* VIDEO_BITRATE_ASCENDING: sorts the streams in ascending order of bitrates, from lowest to highest.'."\n" .'* VIDEO_BITRATE_DESCENDING: sorts the streams in descending order of bitrates, from highest to lowest.'."\n", 'type' => 'string', 'enumValueTitles' => ['VIDEO_BITRATE_ASCENDING' => 'VIDEO_BITRATE_ASCENDING', 'VIDEO_BITRATE_DESCENDING' => 'VIDEO_BITRATE_DESCENDING', 'ORIGINAL' => 'ORIGINAL'], 'example' => 'ORIGINAL', 'title' => '', ], 'MaxVideoBitrate' => ['description' => 'The maximum bitrate threshold (in bits per second) that video tracks must be at or below to be available for playback from this endpoint. It must be a positive integer. If not set, no maximum bitrate is enforced.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8000000', 'title' => ''], 'DateTimeInterval' => ['description' => 'The interval, in seconds, at which to insert the EXT-X-PROGRAM-DATE-TIME tag into the playlist. By default, no tags are inserted. Valid values: 1 to 3600. Applies only to HLS and HLS-CMAF endpoints.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'SegmentTemplateFormat' => [ 'description' => 'The format of the segment template. Only NUMBER_TIMELINE is supported (default). Applies only to DASH endpoints.'."\n", 'type' => 'string', 'enumValueTitles' => ['NUMBER_TIMELINE' => 'NUMBER_TIMELINE'], 'example' => 'NUMBER_TIMELINE', 'title' => '', ], 'MinUpdatePeriod' => ['description' => 'The minimum update period for the manifest, in seconds. Valid values: 1 to 3600. Default value: the duration of two segments. Applies only to DASH endpoints.'."\n" ."\n" .'Note: For smooth playback, set this value to be less than MinBufferTime.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'ManifestDuration' => ['description' => 'The duration of the startover window, in seconds. It defines the maximum time a viewer can seek backward in the live stream. Valid values: 1 to 3600. Default value: 60. Applies only to DASH endpoints.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], ], 'title' => '', 'example' => '', ], 'LivePackagingConfig' => [ 'description' => 'Live packaging configuration.'."\n", 'type' => 'object', 'properties' => [ 'LiveManifestConfigs' => [ 'description' => 'Live stream manifest configuration. Only one configuration is supported.'."\n", 'type' => 'array', 'items' => ['description' => 'Live stream manifest configuration.'."\n", '$ref' => '#/components/schemas/LiveManifestConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'UseAudioRenditionGroups' => ['title' => '', 'description' => 'Specifies whether to create separate audio rendition groups for TS segments.'."\n", 'type' => 'boolean', 'example' => 'true'], 'DrmConfig' => [ 'title' => '', 'description' => 'Configuration for the DRM provider. To disable DRM, leave all fields in this object empty.'."\n", 'type' => 'object', 'properties' => [ 'SystemIds' => [ 'title' => '', 'description' => 'The ID of the DRM system. The supported systems depend on the protocol.'."\n" ."\n" .'* DASH: Supports Google Widevine and Microsoft PlayReady.'."\n" .'* HLS: DRM is not supported.'."\n" .'* HLS-CMAF: Supports Apple FairPlay, Google Widevine, and Microsoft PlayReady.'."\n" ."\n" .'The corresponding System IDs are:'."\n" ."\n" .'* Apple FairPlay: 94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" .'* Google Widevine: edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'."\n" .'* Microsoft PlayReady: 9a04f079-9840-4286-ab92-e65be0885f95'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the DRM system.'."\n", 'type' => 'string', 'example' => '9a04f079-9840-4286-ab92-e65be0885f95', 'title' => ''], 'example' => '', ], 'RotatePeriod' => ['title' => '', 'description' => 'The key rotation interval for DRM, in seconds. The default value of 0 disables key rotation.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ContentId' => ['description' => 'The content ID in the DRM system. The maximum length is 256 characters. Letters, digits, underscores (\\_), and hyphens (-) are supported. You must ensure this ID is unique to prevent playback failures.'."\n", 'type' => 'string', 'example' => 'live-axb1-9dd2fa123', 'title' => ''], 'EncryptionMethod' => ['title' => '', 'description' => 'The encryption method. Valid value:'."\n" ."\n" .'* SAMPLE_AES'."\n" ."\n" .'If not specified, encryption is disabled.'."\n", 'type' => 'string', 'example' => 'SAMPLE_AES'], 'IV' => ['title' => '', 'description' => 'A 128-bit, 16-byte hex value represented by a 32-character string that is used with the key for encrypting data blocks. If you leave this parameter empty, MediaPackage creates a constant initialization vector (IV). If it is specified, the value is passed to the DRM service.'."\n", 'type' => 'string', 'example' => '00000000000000000000000000000000'], 'Url' => ['title' => '', 'description' => 'The URL of the DRM key provider.'."\n", 'type' => 'string', 'example' => 'https://exampledrm.com/path?arg1=xxx'], ], 'example' => '', ], 'SegmentDuration' => ['title' => '', 'description' => 'The duration of each output segment, in seconds. If not set, this defaults to the channel\'s configured segment duration. The final segment duration is a multiple of the source segment duration that is closest to and not less than this value. Valid values: 1 to 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6'], ], 'title' => '', 'example' => '', ], 'MediaConvertAudio' => [ 'description' => 'Parameters for audio transcoding.'."\n", 'type' => 'object', 'properties' => [ 'Codec' => ['title' => '音频编解码格式。'."\n" .'● 可选值：AAC、AC3、EAC3、MP2、MP3、FLAC、OPUS、VORBIS、WMA-V1、WMA-V2、pcm_s16le。'."\n" .'● 默认值：AAC。', 'description' => 'The audio codec.'."\n" ."\n" .'* Valid values: AAC, AC3, EAC3, MP2, MP3, FLAC, OPUS, VORBIS, WMA-V1, WMA-V2, and pcm_s16le.'."\n" .'* Default value: AAC.'."\n", 'type' => 'string', 'example' => 'AAC'], 'Remove' => ['title' => '是否删除音频流。'."\n" .'● true：删除。则本节所有Audio相关参数失效。'."\n" .'● false：保留。'."\n" .'● 默认值：false。', 'description' => 'Specifies whether to remove the audio stream from the output.'."\n" ."\n" .'* true: deletes the audio stream. All other parameters in the Audio object are ignored.'."\n" .'* false: retains the audio stream.'."\n" .'* Default value: false.'."\n", 'type' => 'boolean', 'example' => ''], 'Bitrate' => ['title' => '输出文件的音频码率。'."\n" .'● 单位：Kbps。'."\n" .'● 值范围：[8,1000]。'."\n" .'● 默认值：128。'."\n" .'● 常见值：64、128、256。', 'description' => 'The audio bitrate of the output file.'."\n" ."\n" .'* Unit: Kbps.'."\n" .'* Valid values: \\[8,1000].'."\n" .'* Default value: 128.'."\n" .'* Common values: 64, 128, and 256.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '128'], 'Samplerate' => ['title' => '采样率。'."\n" .'● 单位：Hz。'."\n" .'可选值：22050、32000、44100、48000、96000。'."\n" .'● 说明'."\n" .'不同封装和编码格式支持的采样率不同，完整信息请参见采样率支持。例如：音频Codec为MP3时，所有封装格式的采样率不支持96000，且封装格式为FLV时，采样率仅支持22050、44100。'."\n" .'● 默认值：44100', 'description' => 'The sample rate.'."\n" ."\n" .'* Unit: Hz'."\n" .'* Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" .'* Default value: 44100.'."\n" ."\n" .'The supported sample rates vary depending on the container and codec format. For example, when the audio codec is MP3, a sample rate of 96000 is not supported. If the container format is FLV, only sample rates of 22050 and 44100 are supported.'."\n", 'type' => 'string', 'example' => '44100'], 'Profile' => ['title' => '音频编码级别。'."\n" .'● 仅Codec为AAC时生效。'."\n" .'● 可选值：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。更多信息请参见基本概念。'."\n" .'● 默认值：aac_low。', 'description' => 'The audio codec profile.'."\n" ."\n" .'* This parameter takes effect only if the Codec parameter is set to AAC.'."\n" .'* Valid values: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n" .'* Default value: aac_low.'."\n", 'type' => 'string', 'example' => 'aac_low'], 'Channels' => ['title' => '声道数。'."\n" .'● 可选值：0、1、2、4、5、6、8。'."\n" .' ○ 音频Codec为MP3、OPUS时，支持0、1、2。'."\n" .' ○ 音频Codec为AAC、FLAC时，支持0、1、2、4、5、6、8。'."\n" .' ○ 音频Codec为VORBIS时，支持2。'."\n" .' ○ Format为mpd时，不支持8。'."\n" .'● 默认值：2。'."\n" .'● 若要保留原声道数，请设置为0。', 'description' => 'The number of audio channels.'."\n" ."\n" .'* Valid values: 0, 1, 2, 4, 5, 6, and 8.'."\n" ."\n" .' * If the Codec parameter is set to MP3 or OPUS, you can set this parameter to 0, 1, or 2.'."\n" .' * If the Codec parameter is set to AAC or FLAC, you can set this parameter to 0, 1, 2, 4, 5, 6, or 8.'."\n" .' * If the Codec parameter is set to VORBIS, you can set this parameter to 2.'."\n" .' * If the Format parameter is set to MPD, you cannot set this parameter to 8.'."\n" ."\n" .'* Default value: 2.'."\n" ."\n" .'* Set the value to 0 to preserve the original number of channels from the source file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], 'title' => '', 'example' => '', ], 'MediaConvertInput' => [ 'title' => '', 'description' => 'The input file for transcoding.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the input file. If Output contains InputRef, use this name to reference the input file.'."\n", 'type' => 'string', 'example' => 'InputVideo', 'title' => ''], 'InputFile' => ['title' => '', 'description' => 'The input file.'."\n", '$ref' => '#/components/schemas/MediaObject', 'example' => ''], ], 'example' => '', ], 'MediaConvertJob' => [ 'description' => 'A MediaConvert task.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '创建转码作业的请求ID', 'description' => 'The ID of the API request that created this task.'."\n", 'type' => 'string', 'example' => '7B117AF5-2A1******'], 'ClientToken' => ['title' => '创建转码作业请求的幂等参数', 'description' => 'The idempotency key of the request for creating the task.'."\n", 'type' => 'string', 'example' => '****12e8864746a0a398****'], 'JobId' => ['title' => '转码作业 ID', 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '****d80e4e4044975745c14b****'], 'Config' => [ 'title' => '', 'description' => 'The task configuration.'."\n", 'type' => 'object', 'properties' => [ 'JobName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'Name'], 'Outputs' => [ 'title' => '', 'description' => 'The output configurations.'."\n", 'type' => 'array', 'items' => ['title' => '', 'description' => 'The output configuration.'."\n", '$ref' => '#/components/schemas/MediaConvertOutput'], ], 'OutputGroups' => [ 'title' => '', 'description' => 'Output groups.'."\n", 'type' => 'array', 'items' => ['title' => '', 'description' => 'Output group configurations.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputGroup'], ], 'Inputs' => [ 'title' => '', 'description' => 'Inputs.'."\n", 'type' => 'array', 'items' => ['title' => '', 'description' => 'Input file configurations.'."\n", '$ref' => '#/components/schemas/MediaConvertInput'], ], ], '$ref' => '#/components/schemas/MediaConvertJobConfig', 'example' => '', ], 'PipelineId' => ['title' => '管道ID', 'description' => 'The ID of the queue that processed the task.'."\n", 'type' => 'string', 'example' => '****d80e4e4044975745c14b****'], 'UserData' => ['title' => '用户数据', 'description' => 'The user-defined data.'."\n", 'type' => 'string', 'example' => '{}'], 'Code' => ['title' => '作业失败码', 'description' => 'An error code returned if the task failed.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceContentBad'."\n"], 'Message' => ['title' => '作业失败详细信息', 'description' => 'The reason for a failed task.'."\n", 'type' => 'string', 'example' => 'The resource operated InputFile is bad'."\n"], 'State' => ['title' => '转码作业状态。'."\n" .'● Inited : 初始化；'."\n" .'● Running : 运行中；'."\n" .'● Success : 转码成功；'."\n" .'● Failed : 转码失败；'."\n" .'● Cancelled : 已取消'."\n", 'description' => 'The task status.'."\n" ."\n" .'* Inited: Initialized'."\n" .'* Running'."\n" .'* Complete'."\n" .'* Error'."\n" .'* Cancelled'."\n", 'type' => 'string', 'example' => 'Finished'], 'CreateTime' => ['description' => 'The time the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-07-07T07:16:11Z', 'title' => ''], 'FinishTime' => ['description' => 'The time the task was completed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-07-07T07:16:11Z'."\n", 'title' => ''], 'Percent' => ['description' => 'The completion percentage of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'OutputDetails' => [ 'title' => '转码输出结果详情', 'description' => 'An array containing the results for each output.'."\n", 'type' => 'array', 'items' => ['title' => '转码输出结果', 'description' => 'Output details.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputDetail', 'example' => ''], 'example' => '', ], 'OutputGroupDetails' => [ 'title' => '转码输出组结果列表', 'description' => 'The details of the output groups.'."\n", 'type' => 'array', 'items' => ['title' => '转码输出组结果', 'description' => 'The results for each output group.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', 'example' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaConvertJobConfig' => [ 'description' => 'The configurations of the transcoding task.'."\n", 'type' => 'object', 'properties' => [ 'JobName' => ['description' => 'The task name.'."\n" ."\n" .'* Maximum length: 64 bytes.'."\n", 'type' => 'string', 'example' => 'Name', 'title' => ''], 'Inputs' => [ 'description' => 'Inputs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Input file configurations.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the input file. InputRef can reference it in the output configuration.'."\n", 'type' => 'string', 'example' => 'InputVideo'."\n", 'title' => ''], 'InputFile' => [ 'description' => 'The input file.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media file. Valid values:'."\n" ."\n" .'* OSS: an OSS object.'."\n" .'* Media: a media asset.'."\n", 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The URL or ID of the media file.'."\n" ."\n" .'* If Type is OSS, this is the file URL (OSS or HTTP). Do not use a signed URL, as it may cause authentication failure.'."\n" .'* If Type is Media, this is the media asset ID. The source stream is used by default.'."\n", 'type' => 'string', 'example' => 'http://bucket.loction.aliyuncs.com/path/to/video.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'OutputGroups' => [ 'description' => 'An array of output group configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Output group configurations.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the output group.'."\n", 'type' => 'string', 'example' => 'hls-group'."\n", 'title' => ''], 'GroupConfig' => [ 'description' => 'The configuration for this output group.'."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the output group. Valid values:'."\n" ."\n" .'* File: An individual file.'."\n" .'* Hls: HLS files for adaptive bitrate streaming.'."\n", 'type' => 'string', 'enumValueTitles' => ['File' => 'File', 'Hls' => 'Hls'], 'example' => 'Hls', 'title' => '', ], 'OutputFileBase' => [ 'description' => 'The base output directory. All files generated by this OutputGroup are placed in this directory.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid values:'."\n" ."\n" .'* OSS: an OSS object.'."\n" .'* Media: a media asset.'."\n", 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media asset location.'."\n" ."\n" .'* If Type is OSS, this is the destination URL (OSS or HTTP).'."\n" .'* If Type is Media, this is the destination media asset ID.'."\n", 'type' => 'string', 'example' => 'oss://bucket/path/to/dir', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ManifestName' => ['description' => 'The name of the manifest file. This parameter is only applicable when Type is set to Hls or Dash.'."\n", 'type' => 'string', 'example' => 'manifest', 'title' => ''], 'ManifestExtend' => [ 'description' => 'Configures an extension to an existing manifest file. This allows you to reference an existing manifest and combine it with the results of the current output group to generate a new manifest.'."\n", 'type' => 'object', 'properties' => [ 'InputRef' => ['description' => 'References the Name of an input that contains the manifest to be extended.'."\n", 'type' => 'string', 'example' => 'Input-Manifest', 'title' => ''], 'Excludes' => [ 'description' => 'Specifies streams to exclude from the referenced manifest. Multiple conditions within a single exclusion object are combined using AND logic. Multiple exclusion objects in the array are combined using OR logic.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Stream exclusion condition.'."\n", 'type' => 'object', 'properties' => [ 'Language' => ['description' => 'Excludes streams based on their Language field. It must conform to RFC 5646.'."\n", 'type' => 'string', 'example' => 'en', 'title' => ''], 'Name' => ['description' => 'Excludes streams based on their Name field.'."\n", 'type' => 'string', 'example' => 'audio-1', 'title' => ''], 'Type' => ['description' => 'Excludes streams based on their Type field.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Audio'."\n" .'* Subtitle'."\n", 'type' => 'string', 'example' => 'Audio', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Outputs' => [ 'description' => 'A list of individual output stream configurations. Each object in this array defines a specific rendition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Individual output stream configuration.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'A name to label this output. This is for identification purposes only and does not affect the filename.'."\n", 'type' => 'string', 'example' => 'group-output'."\n", 'title' => ''], 'TemplateId' => ['description' => 'The ID of the transcoding template.'."\n", 'type' => 'string', 'example' => '****96e8864746a0b6f3****'."\n", 'title' => ''], 'OutputFileName' => ['description' => 'The filename for this output. It is used in conjunction with OutputFileBase from the GroupConfig.'."\n", 'type' => 'string', 'example' => '720p.mp4'."\n", 'title' => ''], 'Priority' => ['description' => 'The priority of the task, from 1 to 10. A higher value indicates a higher priority. Default: 6.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Features' => ['description' => 'Additional feature parameters. See [MediaConvertJobFeature](~~2979993~~) for details.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], 'OverrideParams' => ['description' => 'A JSON string of parameters to override the settings in the specified template.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], 'HlsGroupConfig' => [ 'description' => 'HLS-specific settings for this stream\'s behavior in the manifest. Effective only when the group Type is Hls.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Specifies the stream type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* video: Video stream.'."\n" .'* audio: Audio stream.'."\n" .'* subtitle: Subtitle stream.'."\n" .'* hybrid: A stream containing both audio and video.'."\n" ."\n" .'Default value: hybrid.'."\n", 'type' => 'string', 'example' => 'hybrid', 'title' => ''], 'AudioGroup' => ['description' => 'The audio group this video stream references. Effective when Type is video.'."\n" ."\n" .'Default value: audio.'."\n", 'type' => 'string', 'example' => 'audio', 'title' => ''], 'SubtitleGroup' => ['description' => 'The subtitle group this video or hybrid stream references. Effective when Type is video or hybrid.'."\n" ."\n" .'Default value: subtitle.'."\n", 'type' => 'string', 'example' => 'subtitle', 'title' => ''], 'Name' => ['description' => 'The NAME attribute for this stream in the HLS manifest. **Required** when Type is audio or subtitle.'."\n", 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Group' => ['description' => 'The GROUP-ID attribute for this stream in the HLS manifest. Effective when Type is audio or subtitle.'."\n" ."\n" .'Default value: Same as the Type value.'."\n", 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Language' => ['description' => 'The LANGUAGE attribute for this stream in the HLS manifest (must conform to RFC 5646). Effective when Type is audio or subtitle.'."\n", 'type' => 'string', 'example' => 'zh', 'title' => ''], 'IsDefault' => ['description' => 'Whether this is the default stream within its group. Effective when Type is audio or subtitle. Only one stream per group can be the default.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], 'Forced' => ['description' => 'Whether this stream must be played. Effective when Type is audio or subtitle.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'AutoSelect' => ['description' => 'Whether this stream should be automatically selected by the player. Effective when Type is audio or subtitle.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaConvertJobFeature' => [ 'description' => 'Parameters for transcoding features.', 'type' => 'object', 'properties' => [ 'Clip' => [ 'description' => 'Clip settings.', 'type' => 'object', 'properties' => [ 'TimeSpan' => [ 'description' => 'The time span for the clip.', 'type' => 'object', 'properties' => [ 'Seek' => ['description' => 'Specifies the start time of the clip. If this parameter is not set, the clip starts from the beginning of the video.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" .'- Value range: `[00:00:00.000, 23:59:59.999]` or `[0.000, 86399.999]`.'."\n" ."\n" .'- Example: `00:01:59.999` or `180.30`.', 'type' => 'string', 'example' => '180.30', 'title' => ''], 'Duration' => ['description' => 'Specifies the duration of the clip, relative to the `Seek` time. By default, the clip extends to the end of the video. You can specify either `Duration` or `End`, but not both. If `End` is specified, `Duration` is ignored.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" .'- Value range: `[00:00:00.000, 23:59:59.999]` or `[0.000, 86399.999]`.'."\n" ."\n" .'- Example: `00:01:59.999` or `180.30`.', 'type' => 'string', 'example' => '60.0', 'title' => ''], 'End' => ['description' => 'Specifies the end time of the clip. You can specify either `End` or `Duration`, but not both. If `End` is specified, `Duration` is ignored.'."\n" ."\n" .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" .'- Value range: `[00:00:00.000, 23:59:59.999]` or `[0.000, 86399.999]`.'."\n" ."\n" .'- Example: `00:01:59.999` or `180.30`.', 'type' => 'string', 'example' => '50', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ConfigToClipFirstPart' => ['description' => 'Specifies whether to clip the first segment before concatenation.'."\n" ."\n" .'- `true`: The system clips the first segment before concatenation and transcoding.'."\n" ."\n" .'- `false`: The system first concatenates and transcodes the segments, and then clips the resulting video.'."\n" ."\n" .'- Default value: `false`.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Watermarks' => [ 'description' => 'A list of watermark settings to overlay on the video. If specified, these settings override the corresponding parameters in the specified watermark template.'."\n" ."\n" .'- You can add a maximum of four watermarks per transcoding job.', 'type' => 'array', 'items' => [ 'description' => 'Settings for a single watermark.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the watermark.'."\n" ."\n" .'- `Text`: A text watermark. You must also set the text watermark parameters.'."\n" ."\n" .'- `Image`: An image watermark. You must also set the image watermark parameters.'."\n" ."\n" .'Default value: The system automatically determines the type based on the watermark template.', 'type' => 'string', 'example' => 'Image', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the watermark template.', 'type' => 'string', 'example' => '962e1332fa2d4e12bdfb76dd1402fcfa', 'title' => ''], 'X' => ['description' => 'The horizontal offset of the watermark relative to the output video. If specified, this value overrides the corresponding parameter in the watermark template. You can specify the value in two ways:'."\n" ."\n" .'- As an integer, representing the offset in pixels.'."\n" ."\n" .' - Unit: pixels.'."\n" ."\n" .' - Value range: \\[8, 4096].'."\n" ."\n" .'- As a decimal, representing the ratio of the offset to the width of the output video.'."\n" ."\n" .' - Value range: (0, 1).'."\n" ."\n" .' - Supports up to four decimal places, such as `0.9999`. The system truncates additional digits.', 'type' => 'string', 'example' => '0.08', 'title' => ''], 'Y' => ['description' => 'The vertical offset of the watermark relative to the output video. If specified, this value overrides the corresponding parameter in the watermark template. You can specify the value in two ways:'."\n" ."\n" .'- As an integer, representing the offset in pixels.'."\n" ."\n" .' - Unit: pixels.'."\n" ."\n" .' - Value range: \\[8, 4096].'."\n" ."\n" .'- As a decimal, representing the ratio of the offset to the height of the output video.'."\n" ."\n" .' - Value range: (0, 1).'."\n" ."\n" .' - Supports up to four decimal places, such as `0.9999`. The system truncates additional digits.', 'type' => 'string', 'example' => '0.08', 'title' => ''], 'Width' => ['description' => 'The width of the watermark. If specified, this value overrides the corresponding parameter in the watermark template. You can specify the value in two ways:'."\n" ."\n" .'- As an integer, representing the width in pixels.'."\n" ."\n" .' - Unit: pixels.'."\n" ."\n" .' - Value range: \\[8, 4096].'."\n" ."\n" .'- As a decimal, representing the ratio of the width to the width of the output video.'."\n" ."\n" .' - Value range: (0, 1).'."\n" ."\n" .' - Supports up to four decimal places, such as `0.9999`. The system truncates additional digits.', 'type' => 'string', 'example' => '0.1', 'title' => ''], 'Height' => ['description' => 'The height of the watermark. If specified, this value overrides the corresponding parameter in the watermark template. You can specify the value in two ways:'."\n" ."\n" .'- As an integer, representing the height in pixels.'."\n" ."\n" .' - Unit: pixels.'."\n" ."\n" .' - Value range: \\[8, 4096].'."\n" ."\n" .'- As a decimal, representing the ratio of the height to the height of the output video.'."\n" ."\n" .' - Value range: (0, 1).'."\n" ."\n" .' - Supports up to four decimal places, such as `0.9999`. The system truncates additional digits.', 'type' => 'string', 'example' => '0.1', 'title' => ''], 'Content' => ['description' => 'The content of the text watermark.', 'type' => 'string', 'example' => 'TextWatarmark', 'title' => ''], 'FontName' => ['description' => 'The font name for the text watermark.'."\n" ."\n" .'- Default value: `SimSun`.', 'type' => 'string', 'example' => 'SimSum', 'title' => ''], 'FontSize' => ['description' => 'The font size of the text watermark.'."\n" ."\n" .'- Value range: (4, 120).'."\n" ."\n" .'- Default value: `16`.', 'type' => 'string', 'title' => '', 'example' => ''], 'FontColor' => ['description' => 'The font color of the text watermark.'."\n" ."\n" .'- Default value: `black`.', 'type' => 'string', 'example' => 'black', 'title' => ''], 'FontAlpha' => ['description' => 'The opacity of the font.'."\n" ."\n" .'- Value range: (0, 1].'."\n" ."\n" .'- Default value: `1.0`.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'BorderWidth' => ['description' => 'The border width of the text watermark.'."\n" ."\n" .'- Unit: pixels.'."\n" ."\n" .'- Value range: \\[0, 4096].'."\n" ."\n" .'- Default value: `0`.', 'type' => 'string', 'example' => '0', 'title' => ''], 'BorderColor' => ['description' => 'The border color of the text watermark.'."\n" ."\n" .'- Default value: `black`.', 'type' => 'string', 'example' => 'Black', 'title' => ''], 'Adaptive' => ['description' => 'Specifies whether the font size of the text watermark adapts to the output video resolution.'."\n" ."\n" .'- `true`: The font size is adaptive.'."\n" ."\n" .'- `false`: The font size is fixed.'."\n" ."\n" .'- Default value: `false`.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Metadata' => [ 'description' => 'Specifies the metadata for the output video container format, provided as JSON key-value pairs. Example: `{"key1":"value1","key2":"value2"}`.'."\n" ."\n" .'- Maximum key length: 64 characters.'."\n" ."\n" .'- Maximum value length: 512 characters.'."\n" ."\n" .'You can add a maximum of four metadata key-value pairs.', 'type' => 'object', 'additionalProperties' => ['description' => 'The value for a metadata entry. In the `Metadata` object, each key is a field name, and this string is its corresponding value.', 'type' => 'string', 'example' => '{"AIGC": "xxx"}', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaConvertJobOverwiteParams' => [ 'description' => 'Overwrite parameters for the MediaConvert task.'."\n", 'type' => 'object', 'properties' => [ 'Subtitles' => [ 'description' => 'Subtitle stream configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Configuration for a single subtitle stream.'."\n", 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'The encoding format for the subtitle stream.'."\n", 'type' => 'string', 'example' => 'VTT', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaConvertJobWithoutDetail' => [ 'description' => 'A summary of a MediaConvert task without detailed information.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the API request that created this task.'."\n", 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'ClientToken' => ['title' => '', 'description' => 'The idempotency token provided during the task creation request.'."\n", 'type' => 'string', 'example' => '****12e8864746a0a398****'], 'JobId' => ['title' => '', 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '****d80e4e4044975745c14b****'], 'Config' => [ 'title' => '', 'description' => 'The task configuration.'."\n", 'type' => 'object', 'properties' => [ 'Inputs' => [ 'title' => '', 'description' => 'The input files for the task.'."\n", 'type' => 'array', 'items' => ['title' => '', 'description' => 'The input file for the task.'."\n", '$ref' => '#/components/schemas/MediaConvertInput', 'example' => ''], 'example' => '', ], 'Outputs' => [ 'title' => '', 'description' => 'The output configurations.'."\n", 'type' => 'array', 'items' => ['title' => '', 'description' => 'The output configuration.'."\n", '$ref' => '#/components/schemas/MediaConvertOutput', 'example' => ''], 'example' => '', ], 'OutputGroups' => [ 'title' => '', 'description' => 'The output groups.'."\n", 'type' => 'array', 'items' => ['title' => '', 'description' => 'The output group configuration.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputGroup', 'example' => ''], 'example' => '', ], 'JobName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'Name', 'title' => ''], ], 'example' => '', ], 'PipelineId' => ['title' => '', 'description' => 'The ID of the queue on which this task was processed.'."\n", 'type' => 'string', 'example' => '688c2a8bfa4e44ddbba0c8730db91b0c'], 'UserData' => ['title' => '', 'description' => 'The user-defined data.'."\n", 'type' => 'string', 'example' => '{"info": "xxx"}'], 'Code' => ['title' => '', 'description' => 'The error code for a failed task.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound'], 'Message' => ['title' => '', 'description' => 'The reason for a task failure.'."\n", 'type' => 'string', 'example' => 'The resource operated "%s" cannot be found'], 'State' => ['title' => '', 'description' => 'The status of the task.'."\n" ."\n" .'* Inited: The task is initialized.'."\n" .'* Running'."\n" .'* Complete'."\n" .'* Error'."\n" .'* Cancelled'."\n", 'type' => 'string', 'example' => 'Inited'], 'CreateTime' => ['description' => 'The time the task was created, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z).'."\n", 'type' => 'string', 'example' => '2024-12-07T13:01:07Z'."\n", 'title' => ''], 'FinishTime' => ['description' => 'The time the task finished processing, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z).'."\n", 'type' => 'string', 'example' => '2024-12-07T13:01:07Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MediaConvertMuxConfig' => [ 'description' => 'Packaging configuration.', 'type' => 'object', 'properties' => [ 'Segment' => ['description' => 'Shard configuration field. For more information, see Segment details.'."\n" ."\n" .'This field takes effect only when Container is set to m3u8, hls-fmp4, mpd, or cmaf.', '$ref' => '#/components/schemas/MediaConvertSegment', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'MediaConvertOutput' => [ 'title' => '', 'description' => 'The output configuration.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the output.'."\n", 'type' => 'string', 'example' => 'output-video'], 'OutputFile' => ['title' => '', 'description' => 'The output file.'."\n", '$ref' => '#/components/schemas/MediaObject', 'example' => ''], 'TemplateId' => ['title' => '', 'description' => 'The ID of the transcoding template.'."\n", 'type' => 'string', 'example' => '****96e8864746a0b6f3****'], 'Priority' => ['title' => '', 'description' => 'The priority. Valid values: 1 to 10. A larger value indicates a higher priority. Default value: 6.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '10', 'minimum' => '1', 'example' => '6'], 'Features' => ['description' => 'The feature parameters.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], 'OverrideParams' => ['description' => 'A JSON string containing parameters to overwrite the corresponding settings of the template.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'example' => '', ], 'MediaConvertOutputDetail' => [ 'description' => 'The details for the output of a MediaConvert task.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the output.'."\n", 'type' => 'string', 'example' => '720P-mp4'], 'TaskId' => ['title' => '', 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '******4215e042b3966ca5441e******'], 'Status' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" ."\n" .'* Init: Initializing the task.'."\n" .'* Scheduled: The task is scheduled for processing.'."\n" .'* Success: The task is completed.'."\n" .'* Failed: The task failed.'."\n" .'* Skipped: The task was skipped.'."\n", 'type' => 'string', 'example' => 'Success'], 'Code' => ['title' => '', 'description' => 'The error code for a failed task.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceContentBad'."\n"], 'Message' => ['title' => '', 'description' => 'The reason for a task failure.'."\n", 'type' => 'string', 'example' => 'The resource operated InputFile is bad'."\n"], 'Result' => [ 'description' => 'The detailed output results.'."\n", 'type' => 'object', 'properties' => [ 'OutputFile' => [ 'description' => 'Details about the generated output file.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid values:'."\n" ."\n" .'* OSS: an Object Storage Service (OSS) object.'."\n" .'* Media: a media asset.'."\n", 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The value depends on the Type field:'."\n" ."\n" .'* If Type is set to OSS, the value is the URL of the output file. The following formats are supported: oss://... and https://...'."\n" .'* If Type is set to Media, the value is the ID of the media asset.'."\n", 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4'."\n", 'title' => ''], 'Url' => ['description' => 'If Type is set to Media, this field provides the actual storage URL of the media asset.'."\n", 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'OutFileMeta' => ['description' => 'The metadata of the audio and video streams.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputDetailFileMeta', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time the output task was created, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z)'."\n", 'type' => 'string', 'example' => '2024-12-07T06:06:58Z', 'title' => ''], 'FinishTime' => ['description' => 'The time the output task finished, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z)'."\n", 'type' => 'string', 'example' => '2024-12-07T13:01:07Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MediaConvertOutputDetailFileMeta' => [ 'description' => 'The metadata of a media file.'."\n", 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'The basic information of the media file.'."\n", 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.'."\n", 'type' => 'string', 'example' => '9066406c306771f0bfa35107e0c90102'], 'FileName' => ['title' => '', 'description' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'file.m3u8'], 'FileStatus' => ['title' => '', 'description' => 'The status of the file.'."\n", 'type' => 'string', 'example' => 'Normal'], 'FileType' => ['title' => '', 'description' => 'Indicates if this is the source or a transcoded output. Valid values: source_file and transcode_file.'."\n", 'type' => 'string', 'example' => 'source_file'], 'FileSize' => ['title' => '', 'description' => 'The file size. Unit: bytes.'."\n", 'type' => 'string', 'example' => '31737'], 'FileUrl' => ['title' => '', 'description' => 'The URL of the file.'."\n", 'type' => 'string', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8'], 'Region' => ['title' => '', 'description' => 'The storage region of the file.'."\n", 'type' => 'string', 'example' => 'cn-shanghai'], 'FormatName' => ['title' => '', 'description' => 'The container format name.'."\n", 'type' => 'string', 'example' => 'hls,applehttp'], 'Duration' => ['title' => '', 'description' => 'The total duration of the media file. Unit: seconds.'."\n", 'type' => 'string', 'example' => '403.039999'], 'Bitrate' => ['title' => '', 'description' => 'The video bitrate.'."\n", 'type' => 'string', 'example' => '888.563'], 'Width' => ['title' => '', 'description' => 'The width of the video, in pixels.'."\n", 'type' => 'string', 'example' => '848'], 'Height' => ['title' => '', 'description' => 'The height of the video, in pixels.'."\n", 'type' => 'string', 'example' => '478'], ], 'example' => '', ], 'AudioStreamInfoList' => [ 'title' => '', 'description' => 'The audio stream information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The audio stream metadata.'."\n", 'type' => 'object', 'properties' => [ 'Index' => ['title' => '', 'description' => 'The index of this stream within the file.'."\n", 'type' => 'string', 'example' => '1'], 'CodecName' => ['title' => '', 'description' => 'The short name of the codec.'."\n", 'type' => 'string', 'example' => 'aac'], 'CodecLongName' => ['title' => '', 'description' => 'The full name of the codec.'."\n", 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)'], 'CodecTimeBase' => ['title' => '', 'description' => 'The time base used by the codec.'."\n", 'type' => 'string', 'example' => '1/44100'], 'CodecTagString' => ['title' => '', 'description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '[15][0][0][0]'], 'CodecTag' => ['title' => '', 'description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '0x000f'], 'SampleFmt' => ['title' => '', 'description' => 'The audio sample format.'."\n", 'type' => 'string', 'example' => 'fltp'], 'SampleRate' => ['title' => '', 'description' => 'The sample rate. Unit: Hz.'."\n", 'type' => 'string', 'example' => '44100'], 'Channels' => ['title' => '', 'description' => 'The number of audio channels.'."\n", 'type' => 'string', 'example' => '2'], 'ChannelLayout' => ['title' => '', 'description' => 'The layout of the audio channels.'."\n", 'type' => 'string', 'example' => 'stereo'], 'Timebase' => ['title' => '', 'description' => 'The time base of the stream\'s presentation timestamps.'."\n", 'type' => 'string', 'example' => '1/90000'], 'StartTime' => ['title' => '', 'description' => 'The start time of the stream. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1.473556'], 'Duration' => ['title' => '', 'description' => 'The duration of the stream. Unit: seconds.'."\n", 'type' => 'string', 'example' => '403.039989'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate.'."\n", 'type' => 'string', 'example' => '0.f'], 'Lang' => ['title' => '', 'description' => 'The language code for the stream.'."\n", 'type' => 'string', 'example' => 'cn'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoStreamInfoList' => [ 'title' => '', 'description' => 'The video stream information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The video stream metadata.'."\n", 'type' => 'object', 'properties' => [ 'Index' => ['title' => '', 'description' => 'The index of this stream within the file.'."\n", 'type' => 'string', 'example' => '0'], 'Codec_name' => ['title' => '', 'description' => 'The short name of the codec.'."\n", 'type' => 'string', 'example' => 'h264'], 'Codec_long_name' => ['title' => '', 'description' => 'The full name of the codec.'."\n", 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10'], 'Profile' => ['title' => '', 'description' => 'The codec profile.'."\n", 'type' => 'string', 'example' => 'High'], 'Codec_time_base' => ['description' => 'The time base used by the codec.'."\n", 'type' => 'string', 'example' => '1/50', 'title' => ''], 'Codec_tag_string' => ['title' => '', 'description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '[27][0][0][0]'], 'Codec_tag' => ['title' => '', 'description' => 'The tag of the codec.'."\n", 'type' => 'string', 'example' => '0x001b'], 'Width' => ['title' => '', 'description' => 'The width of the video stream, in pixels.'."\n", 'type' => 'string', 'example' => '848'], 'Height' => ['title' => '', 'description' => 'The height of the video stream, in pixels.'."\n", 'type' => 'string', 'example' => '478'], 'Has_b_frames' => ['title' => '', 'description' => 'Indicates whether the video stream contains B-frames. Valid value:'."\n" ."\n" .'* 0: None.'."\n" .'* 1: One B-frame.'."\n" .'* 2: Multiple consecutive B-frames.'."\n", 'type' => 'string', 'example' => '2'], 'Sar' => ['title' => '', 'description' => 'The sample aspect ratio.'."\n", 'type' => 'string', 'example' => '478:477'], 'Dar' => ['title' => '', 'description' => 'The display aspect ratio.'."\n", 'type' => 'string', 'example' => '16:9'], 'PixFmt' => ['title' => '', 'description' => 'The pixel format.'."\n", 'type' => 'string', 'example' => 'yuv420p'], 'Level' => ['title' => '', 'description' => 'The codec level.'."\n", 'type' => 'string', 'example' => '31'], 'Fps' => ['title' => '', 'description' => 'The frame rate.'."\n", 'type' => 'string', 'example' => '25.0'], 'Avg_fps' => ['title' => '', 'description' => 'The average frame rate.'."\n", 'type' => 'string', 'example' => '25.0'], 'Time_base' => ['title' => '', 'description' => 'The time base of the stream\'s presentation timestamps.'."\n", 'type' => 'string', 'example' => '1/90000'], 'Start_time' => ['title' => '', 'description' => 'The start time of the stream.'."\n", 'type' => 'string', 'example' => '1.473556'], 'Duration' => ['title' => '', 'description' => 'The duration of the stream. Unit: seconds.'."\n", 'type' => 'string', 'example' => '403.039989'], 'Bit_rate' => ['title' => '', 'description' => 'The bitrate.'."\n", 'type' => 'string', 'example' => '888.563'], 'NumFrames' => ['title' => '', 'description' => 'The total number of frames.'."\n", 'type' => 'string', 'example' => '10040'], 'Lang' => ['title' => '', 'description' => 'The language code for the stream.'."\n", 'type' => 'string', 'example' => 'cn'], 'Rotate' => ['title' => '', 'description' => 'The rotation angle applied to the video. Valid values: 0, 90, 180, and 270. Default value: 0.'."\n", 'type' => 'string', 'example' => '0'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaConvertOutputGroup' => [ 'description' => 'The output group configuration.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the output group.'."\n", 'type' => 'string', 'example' => 'hls-group'], 'GroupConfig' => ['title' => '', 'description' => 'The output group configuration.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputGroupConfig', 'example' => ''], 'Outputs' => [ 'title' => '', 'description' => 'A list of individual output stream configurations. Each object in this array defines a specific rendition.'."\n", 'type' => 'array', 'items' => ['description' => 'The configuration for a single output stream.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputGroupOutput', 'title' => '', 'example' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MediaConvertOutputGroupConfig' => [ 'title' => '', 'description' => 'A MediaConvert output group configuration.'."\n", 'type' => 'object', 'properties' => [ 'ManifestName' => ['title' => '', 'description' => 'The filename for the manifest. This parameter is only applicable when Type is set to Hls or Dash.'."\n", 'type' => 'string', 'example' => 'manifest'], 'Type' => ['title' => '', 'description' => 'The type of the output group. Valid values:'."\n" ."\n" .'* File: Generates one or more standalone files.'."\n" .'* Hls: Generates HLS manifests.'."\n" .'* Dash: Generates DASH manifests.'."\n", 'type' => 'string', 'example' => 'Hls'], 'OutputFileBase' => ['description' => 'The directory where all files for this output group are stored.'."\n", '$ref' => '#/components/schemas/MediaObject', 'title' => '', 'example' => ''], ], 'example' => '', ], 'MediaConvertOutputGroupDetail' => [ 'title' => '', 'description' => 'The result of a MediaConvert output group.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the output group.'."\n", 'type' => 'string', 'example' => 'hls-group'], 'TaskId' => ['title' => '', 'description' => 'The ID of the output group task.'."\n", 'type' => 'string', 'example' => '******22dad741d086a50325f9******'], 'Code' => ['title' => '', 'description' => 'The error code for the failed output group task.'."\n", 'type' => 'string', 'example' => 'InvalidParameter.ResourceContentBad'], 'Message' => ['title' => '', 'description' => 'The reason for a task failure.'."\n", 'type' => 'string', 'example' => 'The resource operated "InputFile" is bad'], 'Status' => ['title' => '', 'description' => 'The status of the output group task.'."\n" ."\n" .'* Init: The task is submitted.'."\n" .'* Running'."\n" .'* Success'."\n" .'* Failed'."\n" .'* Skipped'."\n", 'type' => 'string', 'example' => 'Success'], 'Outputs' => [ 'description' => 'The output details.'."\n", 'type' => 'array', 'items' => ['description' => 'The output details.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputDetail', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time the task was created.'."\n", 'type' => 'string', 'example' => '2025-03-21T01:48:41Z', 'title' => ''], 'FinishTime' => ['description' => 'The end time of the task.'."\n", 'type' => 'string', 'example' => '2025-03-21T01:48:41Z'."\n", 'title' => ''], ], 'example' => '', ], 'MediaConvertOutputGroupOutput' => [ 'description' => 'The configuration for a single output stream within an output group.'."\n", 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'A name to label this output. This is for identification purposes only and does not affect the filename.'."\n", 'type' => 'string', 'example' => 'group-output', 'title' => ''], 'OutputFileName' => ['description' => 'The filename for this output. This path is relative to OutputFileBase defined in MediaConvertOutputGroupConfig. The final output path is {OutputFileBase}/{OutputFileName}.'."\n", 'type' => 'string', 'example' => '720p.mp4', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the transcoding template.'."\n", 'type' => 'string', 'example' => '****96e8864746a0b6f3****'."\n", 'title' => ''], 'Priority' => ['description' => 'The processing priority for this output. Valid values: 1 to 10. A higher value indicates higher priority. Default value: 6.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Features' => ['description' => 'The feature parameters.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], 'OverrideParams' => ['description' => 'A JSON string containing parameters to override the settings from the associated transcoding template.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MediaConvertSegment' => [ 'title' => '视频转码切片配置', 'description' => 'Segment configuration during transcoding.'."\n", 'type' => 'object', 'properties' => [ 'ForceSegTime' => ['title' => '指定分片时间点列表。时间点之间逗号分隔，最多指定10个。'."\n" .'● 格式：{时间点},{时间点},{时间点}。'."\n" .'● 时间点格式：小数型，最多3位小数。'."\n" .'● 时间点单位：秒。'."\n" .'● 示例：1,2,4,6,10,14,18，代表在第1、2、4、6、10、14、18秒处强制分片。', 'description' => 'The points in time at which the video is forcibly segmented. Separate multiple points with commas (,). You can specify up to 10 points.'."\n" ."\n" .'* Format: {Point in time},{Point in time},{Point in time}.'."\n" .'* Type: decimal. This parameter supports up to three decimal places.'."\n" .'* Unit: seconds.'."\n" .'* Example: 1,2,4,6,10,14,18, which specifies that the video is forcibly segmented at the 1st, 2nd, 4th, 6th, 10th, 14th, and 18th seconds.'."\n", 'type' => 'string', 'example' => '1,2'], 'Duration' => ['title' => '分片时长。'."\n" .'● 单位：秒。'."\n" .'● 值范围：[1,60]。'."\n" .'● 默认值：10。代表在第10、20、30、40秒处强制分片。', 'description' => 'The length of the segment.'."\n" ."\n" .'* Unit: seconds.'."\n" .'* Valid values: \\[1,60].'."\n" .'* Default value: 10. A value of 10 will create segments at the 10s, 20s, 30s, and 40s marks of the video.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'MediaConvertTransConfig' => [ 'title' => '转码配置', 'description' => 'Transcoding configuration.'."\n", 'type' => 'object', 'properties' => [ 'IsCheckAudioBitrate' => ['title' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" .'● true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" .'● false：不检查。'."\n" .'● 默认值：'."\n" .' ○ 参数为空，并且codec和输入源不一样：false。'."\n" .' ○ 参数为空，并且codec和输入源一样：true。', 'description' => 'Specifies whether to check the audio bitrate. Mutually exclusive with IsCheckVideoBitrateFail. IsCheckVideoBitrateFail has a higher priority.'."\n" ."\n" .'* true: checks the audio bitrate. If the source bitrate is lower than the target, the task will transcode using the source bitrate.'."\n" ."\n" .'* false: does not check the audio bitrate.'."\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' => 'boolean', 'example' => ''], 'AdjDarMethod' => ['title' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" .'● 可选值：rescale、crop、pad、none。'."\n" .'● 默认值：none。'."\n" .'● 示例：请参见如何设置分辨率。', 'description' => 'The method for adjusting the resolution. This parameter takes effect only if both the Width and Height parameters are specified. You can use this parameter together with the LongShortMode parameter.'."\n" ."\n" .'* Valid values: rescale, crop, pad, and none.'."\n" .'* Default value: none.'."\n" .'*'."\n", 'type' => 'string', 'example' => 'rescale'], 'IsCheckAudioBitrateFail' => ['title' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" .'● true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" .'● false：不检查。'."\n" .'● 默认值：false。', 'description' => 'Specifies whether to check the audio bitrate. Mutually exclusive with IsCheckAudioBitrate. This parameter has a higher priority.'."\n" ."\n" .'* true: checks the audio bitrate. If the source bitrate is lower than the target, the task will fail.'."\n" .'* false: does not check the audio bitrate.'."\n" .'* Default value: false.'."\n", 'type' => 'boolean', 'example' => ''], 'IsCheckVideoBitrateFail' => ['title' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" .'● true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" .'● false：不检查。'."\n" .'● 默认值：false。', 'description' => 'Specifies whether to check the video bitrate. Mutually exclusive with IsCheckVideoBitrate. This parameter has a higher priority.'."\n" ."\n" .'* true: checks the video bitrate. If the source bitrate is lower than the target, the task will fail.'."\n" .'* false: does not check the video bitrate.'."\n" .'* Default value: false.'."\n", 'type' => 'boolean', 'example' => ''], 'IsCheckReso' => ['title' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" .'● true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" .'● false：不检查。'."\n" .'● 默认值：false。', 'description' => 'Specifies whether to check the video resolution. Mutually exclusive with IsCheckResoFail. IsCheckResoFail has a higher priority.'."\n" ."\n" .'* true: checks the video resolution. If the source resolution (width or height) is smaller than the target, the task will transcode using the source resolution.'."\n" .'* false: does not check the video resolution.'."\n" .'* Default value: false.'."\n", 'type' => 'boolean', 'example' => ''], 'IsCheckVideoBitrate' => ['title' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" .'● true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" .'● false：不检查。'."\n" .'● 默认值：false。', 'description' => 'Specifies whether to check the video bitrate. Mutually exclusive with IsCheckVideoBitrateFail. IsCheckVideoBitrateFail has a higher priority.'."\n" ."\n" .'* true: checks the video bitrate. If the source bitrate is lower than the target, the task will transcode using the source bitrate.'."\n" .'* false: does not check the video bitrate.'."\n" .'* Default value: false.'."\n", 'type' => 'boolean', 'example' => ''], 'TransMode' => ['title' => '视频转码模式。仅Codec为H.264、H.265、AV1时生效，且不同模式必须搭配Video的Bitrate、Crf正确设置。详细说明请参见下文视频码率控制模式。取值如下：'."\n" .'● CBR：固定码率模式。'."\n" .'● onepass：一般用于ABR。编码速度较twopass更快。'."\n" .'● twopass：一般用于VBR。编码速度较onepass更慢。'."\n" .'● fixCRF：Crf质量控制模式。'."\n" .'● 默认值：有Bitrate为onepass。没有Bitrate为fixCRF，Crf使用默认值。', 'description' => 'The video bitrate control mode. This is only valid for H.264, H.265, and AV1 codecs and must be used with the correct Bitrate or Crf settings. Valid values:'."\n" ."\n" .'* CBR: Constant bitrate mode.'."\n" .'* onepass: Typically used for Average bitrate mode (ABR). Faster than twopass.'."\n" .'* twopass: Typically used for variable bitrate mode (VBR). Slower than onepass.'."\n" .'* fixCRF: Constant Rate Factor (quality-based) mode.'."\n" .'* If you specify the Bitrate parameter, the default value of this parameter is onepass. If you do not specify the Bitrate parameter, the default value of this parameter is fixCRF, and the default value of the Crf parameter is used.'."\n", 'type' => 'string', 'example' => 'onepass'], 'IsCheckResoFail' => ['title' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" .'● true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" .'● false：不检查。'."\n" .'● 默认值：false。', 'description' => 'Specifies whether to check the video resolution. Mutually exclusive with IsCheckReso. This parameter has a higher priority.'."\n" ."\n" .'* true: checks the video resolution. If the source resolution (width or height) is smaller than the target, the task will fail.'."\n" .'* false: does not check the video resolution.'."\n" .'* Default value: false.'."\n", 'type' => 'boolean', 'example' => ''], ], 'example' => '', ], 'MediaConvertVideo' => [ 'title' => '转码视频流配置', 'description' => 'The configuration of a transcoded output.'."\n", 'type' => 'object', 'properties' => [ 'Bufsize' => ['title' => '码率控制缓冲区大小。用于控制码率波动。详细说明请参见视频码率控制模式。'."\n" .'说明'."\n" .'Bufsize值越大，码率的波动越大，视频质量越高。'."\n" .'● 单位：Kb。'."\n" .'● 值范围：[1000,128000]。'."\n" .'● 默认值：6000。', 'description' => 'The buffer size. It controls bitrate fluctuations. A larger value allows for more bitrate variation and potentially higher video quality.'."\n" ."\n" .'* Unit: Kbps.'."\n" .'* Valid values: \\[1000,128000].'."\n" .'* Default value: 6000.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20000'], 'Qscale' => ['title' => '视频质量控制值（VBR模式可用）。'."\n" .'说明'."\n" .'Qscale值越大，视频质量越低，压缩率越高。'."\n" .'● 仅Codec为H.264时生效。'."\n" .'● 值范围：[0,51]。', 'description' => 'The video quality scale. This parameter applies to VBR mode. A higher value means lower video quality and a higher compression ratio.'."\n" ."\n" .'* This parameter takes effect only if Codec is set to H.264.'."\n" .'* Valid values: \\[0,51].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '13'], 'ScanMode' => ['title' => '扫描模式。取值如下：'."\n" .'● 不设置：按输入文件的原始模式。'."\n" .'● auto：自动去隔行。'."\n" .'● progressive：顺序扫描（逐行扫描）。'."\n" .'● interlaced：交叉扫描（隔行扫描）。'."\n" .'● 默认值：空，即不设置。'."\n" .'最佳实践：交叉扫描虽然比顺序扫描更节省数据量，但画质不佳，所以现在主流视频制作都采用顺序扫描。'."\n" .'● 如果您设置了顺序扫描或交叉扫描，但与原视频模式不符，会导致转码失败。'."\n" .'● 建议您设置原视频模式或自动去隔行，以提高兼容性。', 'description' => 'The scan mode. Valid values:'."\n" ."\n" .'* If you leave this parameter empty, the output follows the source\'s original scan mode.'."\n" .'* auto: automatic deinterlacing'."\n" .'* progressive'."\n" .'* interlaced'."\n" .'* By default, this parameter is left empty.'."\n" ."\n" .'Best practice: The interlaced scan mode saves data traffic than the progressive scan mode but provides poor image quality. Therefore, the latter is commonly used in mainstream video production.'."\n" ."\n" .'* If you set ScanMode to progressive or interlaced, but this scan mode does not match that of the input, the video fails to be transcoded.'."\n" .'* To improve compatibility, leave this parameter empty or set it to auto.'."\n", 'type' => 'string', 'example' => 'auto'], 'LongShortMode' => [ 'title' => '是否开启横竖屏自适应（又称，长短边自适应）。当Width或Height至少填写一项时生效。'."\n" .'● true：开启。'."\n" .'● false：关闭。'."\n" .'● 默认值：false。'."\n" .'● 最佳实践：如果您的输入视频既有横屏视频也有竖屏视频，为了避免视频拉伸变形，请开启横竖屏自适应开关，并结合分辨率参数设置等比缩放。示例请参见设置横竖屏自适应。', 'description' => 'Specifies whether to enable orientation-adaptive scaling. This parameter takes effect if at least one of the Width and Height parameters is specified. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n" .'* Default value: false.'."\n" ."\n" .'Best practice: Enable this feature when your inputs include both horizontal and vertical videos. This prevents videos from stretching.'."\n", 'type' => 'boolean', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], 'Fps' => ['title' => '帧率。'."\n" .'● 单位：fps，帧每秒。'."\n" .'● 值范围：(0,60]。'."\n" .'● 默认值：输入文件的视频原始帧率，超过60时取60。'."\n" .'● 常见值：24、25、30。', 'description' => 'The frame rate of the video stream.'."\n" ."\n" .'* Unit: frames per second (FPS).'."\n" .'* Valid values: (0,60].'."\n" .'* Default value: the frame rate of the input file. If the original frame rate exceeds 60 FPS, 60 is used.'."\n" .'* Recommended values: 24, 25, and 30.'."\n", 'type' => 'any', 'example' => '25'], 'Gop' => ['title' => '设置相邻两个I帧之间的时间或者帧数间隔。'."\n" .'● 关键帧间最大时间间隔：{时间}s，时间范围[1,100000]。'."\n" .'● 关键帧间最大帧数间隔：{帧数}，帧数范围[1,100000]。'."\n" .'● 默认值：10s，代表每10s一个关键帧。'."\n" .'● 最佳实践：流媒体播放场景下，为了提高播放器开播速度和seek响应时长，建议设置为[2,7]s。', 'description' => 'The keyframe interval.'."\n" ."\n" .'* Set by time: The time interval, in seconds. Valid values: \\[1,100000].'."\n" .'* Set by frame count: The number of frames. Valid values: \\[1,100000].'."\n" .'* Default value: 10s.'."\n" ."\n" .'Best practice: Set this parameter to 2-7s to improve the Time-to-First-Frame and seeking performance.'."\n", 'type' => 'any', 'example' => '10s'], 'Remove' => ['title' => '是否删除视频流。'."\n" .'● true：删除。则本节所有Video相关参数失效。'."\n" .'● false：保留。'."\n" .'● 默认值：false。', 'description' => 'Specifies whether to delete the video stream. Valid values:'."\n" ."\n" .'* true: deletes the video stream. All video-related parameters are invalid.'."\n" .'* false: retains the video stream.'."\n" .'* Default value: false.'."\n", 'type' => 'boolean', 'example' => 'false'], 'Bitrate' => ['title' => '输出文件的视频平均码率。使用CBR、ABR、VBR码控必须设置Bitrate，且TransMode需正确配对设置。详细说明请参见视频码率控制模式。'."\n" .'● 单位：Kbps。'."\n" .'● 值范围：-1、[10,50000]。-1代表使用输入视频的原始码率。'."\n" .'● 最佳实践：'."\n" .' ○ CBR固定码率模式：需设置TransMode为CBR，且Bitrate=Maxrate=Bufsize。'."\n" .' ○ ABR平均码率模式：需设置TransMode为onepass，且指定Bitrate。还可指定Maxrate和Bufsize控制码率波动范围。'."\n" .' ○ VBR动态码率模式：需设置TransMode为twopass，且指定Maxrate（或BitrateBnd）和Bufsize参数。', 'description' => 'The average bitrate of the output. If you use the CRB, ABR, or VBR bitrate control mode, you must specify Bitrate, and you must set TransMode to a valid value.'."\n" ."\n" .'* Unit: Kbps.'."\n" .'* Valid values: -1 and \\[10,50000]. A value of -1 indicates that the original bitrate of the input is used.'."\n" ."\n" .'Best practices:'."\n" ."\n" .'* CBR: Set TransMode to CBR and Bitrate, Maxrate, and Bufsize to the same value.'."\n" .'* ABR: Set TransMode to onepass and specify Bitrate. You can also specify Maxrate and Bufsize to control the bitrate range.'."\n" .'* VBR: Set TransMode to twopass and specify Maxrate/BitrateBnd and Bufsize.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6000'], 'Profile' => ['title' => '编码级别。更多信息请参见基本概念。'."\n" .'● 仅Codec为H.264时生效。'."\n" .'● 可选值：baseline、main、high。'."\n" .'● 默认值：high。'."\n" .'● 最佳实践：一个视频输出多清晰度时，建议最低清晰度设置baseline，以保证最低端设备可播放。其他清晰度设置为main或high。', 'description' => 'The codec profile.'."\n" ."\n" .'* This parameter takes effect only if Codec is set to H.264.'."\n" .'* Valid values: baseline, main, and high.'."\n" .'* Default value: high.'."\n" ."\n" .'Best practice: For multi-bitrate streaming, use baseline for the lowest quality rendition to ensure maximum compatibility with older devices. Use main or high for other renditions.'."\n", 'type' => 'string', 'example' => 'high'], 'Crop' => ['title' => '视频画面剪裁。支持自动去黑边或自定义剪裁。'."\n" .'● 请在输入视频分辨率大于输出视频分辨率时使用。不要设置分辨率改写参数AdjDarMethod。'."\n" .'● 自动去黑边：border。'."\n" .'● 自定义剪裁：参数格式为{width}:{height}:{left}:{top}。'."\n" .' ○ width：剪裁后，输出视频的宽度。'."\n" .' ○ height：剪裁后，输出视频的高度。'."\n" .' ○ left：输出画面距离原画面的左边距。'."\n" .' ○ top：输出画面距离原画面的上边距。'."\n" .'● 自定义剪裁示例：1920:800:0:140。', 'description' => 'Crops the video frame. You can set automatic black border removal or custom cropping.'."\n" ."\n" .'* Specify this parameter if the input resolution is greater than the output resolution. Do not specify AdjDarMethod if this parameter is specified.'."\n" ."\n" .'* To automatically remove black borders, set this parameter to border.'."\n" ."\n" .'* To use custom cropping, set the parameter in the format of {width}:{height}:{left}:{top}.'."\n" ."\n" .' * width: the width of the output video.'."\n" .' * height: the height of the output video.'."\n" .' * left: the distance between the left border of the output and that of the original frame.'."\n" .' * top: the distance between the top border of the output and that of the original frame.'."\n" ."\n" .'Example: 1920:800:0:140.'."\n", 'type' => 'string', 'example' => '1920:800:0:140'], 'Codec' => ['title' => '视频编码格式。'."\n" .'● 可选值：H.264、H.265、AV1、GIF、WEBP。更多格式和与Container的兼容要求，请参见格式支持。'."\n" .'● 默认值：H.264。', 'description' => 'The video codec.'."\n" ."\n" .'* Valid values: H.264, H.265, AV1, GIF, and WEBP.'."\n" .'* Default value: H.264.'."\n", 'type' => 'string', 'example' => 'H.264'], 'Maxrate' => ['title' => '输出文件的视频码率峰值。详细说明请参见视频码率控制模式。'."\n" .'● 单位：Kbps。'."\n" .'● 值范围：[10,50000]。', 'description' => 'The maximum bitrate of the output.'."\n" ."\n" .'* Unit: Kbps.'."\n" .'* Valid values: \\[10,50000].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], 'Pad' => ['title' => '视频贴黑边。'."\n" .'● 请在输入视频分辨率小于输出视频分辨率时使用。不要设置分辨率检查参数IsCheckReso和IsCheckResoFail、不要设置分辨率改写参数AdjDarMethod。'."\n" .'● 参数格式：{width}:{height}:{left}:{top}。'."\n" .' ○ width：贴黑边后，输出视频的宽度。'."\n" .' ○ height：贴黑边后，输出视频的高度。'."\n" .' ○ left：原画面距离输出画面的左边距。'."\n" .' ○ top：原画面距离输出画面的上边距。'."\n" .'● 示例：1920:1080:0:140。', 'description' => 'The black borders added to the video.'."\n" ."\n" .'* Specify this parameter if the input resolution is smaller than the output resolution. If you specify this parameter, do not specify IsCheckReso, IsCheckResoFail, or AdjDarMethod.'."\n" ."\n" .'* Format: {width}:{height}:{left}:{top}.'."\n" ."\n" .' * width: the width of the output video.'."\n" .' * height: the height of the output video.'."\n" .' * left: the distance between the left border of the output and that of the original frame.'."\n" .' * top: the distance between the top border of the output and that of the original frame.'."\n" ."\n" .'Example: 1920:1080:0:140.'."\n", 'type' => 'string', 'example' => '1920:1080:0:140'], 'MaxFps' => ['title' => '最大帧率。', 'description' => 'The maximum frame rate.'."\n", 'type' => 'any', 'example' => '25'], 'Crf' => ['title' => '质量控制因子。使用Crf码控必须设置Crf，且TransMode需设置为fixCRF，详细说明请参见视频码率控制模式。'."\n" .'说明'."\n" .'Crf值越大，视频质量越低，压缩率越高。'."\n" .'● 值范围：[20,51]。'."\n" .'● 默认值：Codec为H.264时，默认值为23；Codec为H.265时，默认值为26；Codec为AV1时，默认值为32。'."\n" .'● 最佳实践：'."\n" .' ○ 0为无损，51为最差。建议取值[23,29]。您可根据画面复杂度进行调节。每增加或减少6，码率会减少一半或增加一倍，通常同等清晰度下动画片可以比实拍设置得更高。'."\n" .' ○ Crf以质量为目标，输出视频码率不可预知，可结合Maxrate、Bufsize来控制码率波动范围。', 'description' => 'The quality control factor. To use the CRF mode, you must specify Crf and set TransMode to fixCRF. A larger value means lower quality and a higher compression ratio.'."\n" ."\n" .'* Valid values: \\[20,51].'."\n" .'* If Codec is set to H.264, the default value is 23. If Codec is set to H.265, the default value is 26. If Codec is set to AV1, the default value is 32.'."\n" ."\n" .'Best Practice:'."\n" ."\n" .'* A value of 0 specifies lossless quality. A value of 51 specifies the worst quality. A recommended range is \\[23, 29]. You can adjust the value based on the complexity of the image. If you increase the value by six, the bitrate is reduced by half. Under the same definition, you can set the value for an animated cartoon higher than that for a shot video.'."\n" .'* CRF targets perceptual quality, not a fixed bitrate. Use it with Maxrate and Bufsize to control bitrate fluctuations.'."\n", 'type' => 'any', 'example' => '23'], 'Height' => ['title' => '高度（或短边）。当LongShortMode为false或未设置时，代表视频的高度。当LongShortMode为true时，代表视频的短边。'."\n" .'● 单位：px。'."\n" .'● 值范围：[128,4096]，必须为偶数。'."\n" .'● 默认值'."\n" .' ○ 当Width和Height都未设置：使用输入视频的原始高度（或短边）。'."\n" .' ○ 当仅设置Width：按照输入视频的原始比例计算。', 'description' => 'The height or short edge of the output. If LongShortMode is set to false or left empty, this parameter specifies the height of the output. If LongShortMode is set to true, this parameter specifies the short edge of the output.'."\n" ."\n" .'* Unit: pixel.'."\n" ."\n" .'* Valid values: \\[128,4096]. The value must be an even number.'."\n" ."\n" .'* Default value:'."\n" ."\n" .' * If neither Width nor Height is specified, the dimension of the input is used.'."\n" .' * If only Width is specified, Height is auto-scaled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1080'], 'Width' => ['title' => '宽度（或长边）。当LongShortMode为false或未设置时，代表宽度。当LongShortMode为true时，代表视频的长边。'."\n" .'● 单位：px。'."\n" .'● 值范围：[128,4096]，必须为偶数。'."\n" .'● 默认值'."\n" .' ○ 当Width和Height都未设置：使用输入视频的原始宽度（或长边）。'."\n" .' ○ 当仅设置Height：按照输入视频的原始比例来计算。', 'description' => 'The width or long edge of the output. If LongShortMode is set to false or left empty, this parameter specifies the width of the output. If LongShortMode is set to true, this parameter specifies the long edge of the output.'."\n" ."\n" .'* Unit: pixel.'."\n" ."\n" .'* Valid values: \\[128,4096]. The value must be an even number.'."\n" ."\n" .'* Default value:'."\n" ."\n" .' * If neither Width nor Height is specified, the dimension of the input is used.'."\n" .' * If only Height is specified, Width is auto-scaled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1920'], ], 'example' => '', ], 'MediaConvertVolume' => [ 'description' => 'The parameters for adjusting the audio volume.'."\n", 'type' => 'object', 'properties' => [ 'LoudnessRangeTarget' => ['title' => '相对目标音量的波动范围。'."\n" .'● 当指定Method为dynamic时生效。'."\n" .'● 单位：db。'."\n" .'● 值范围：[1,20]。'."\n" .'● 默认值：8。', 'description' => 'The target loudness range.'."\n" ."\n" .'* This parameter takes effect only if Method is set to dynamic.'."\n" .'* Unit: dB.'."\n" .'* Valid values: \\[1,20].'."\n" .'* Default value: 8.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8'], 'TruePeak' => ['title' => '最大峰值。'."\n" .'● 当指定Method为dynamic时生效。'."\n" .'● 单位：db。'."\n" .'● 值范围：[-9,0]。'."\n" .'● 默认值：-1。', 'description' => 'The maximum volume.'."\n" ."\n" .'* This parameter takes effect only if Method is set to dynamic.'."\n" .'* Unit: dB.'."\n" .'* Valid values: \\[-9,0].'."\n" .'* Default value: -1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-1'], 'IntegratedLoudnessTarget' => ['title' => '目标音量。'."\n" .'● 当指定Method为dynamic时生效。'."\n" .'● 单位：db。'."\n" .'● 值范围：[-70,-5]。'."\n" .'● 默认值：-6。', 'description' => 'The output volume.'."\n" ."\n" .'* This parameter takes effect only if Method is set to dynamic.'."\n" .'* Unit: dB.'."\n" .'* Valid values: \\[-70,-5].'."\n" .'* Default value: -6.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-6'], 'Level' => ['title' => '相对输入音频的音量提升的幅度。'."\n" .'● 当指定Method为linear时生效。'."\n" .'● 单位：db。'."\n" .'● 值范围：不超过20db。'."\n" .'● 默认值：-20db。', 'description' => 'The amount of gain to apply, relative to the input audio.'."\n" ."\n" .'* This parameter takes effect only if Method is set to linear.'."\n" .'* Unit: dB.'."\n" .'* Valid values: less than or equal to 20.'."\n" .'* Default value: -20.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-20'], 'Method' => [ 'title' => '音量调整方式。'."\n" .'● auto：自动调整。'."\n" .'● dynamic：动态调整。'."\n" .'● linear：线性调整。'."\n" .'● 默认值：dynamic。', 'description' => 'The volume adjustment method. Valid values:'."\n" ."\n" .'* auto'."\n" .'* dynamic'."\n" .'* linear'."\n" .'* Default value: dynamic.'."\n" ."\n" .''."\n" ."\n" .'*'."\n" .'*'."\n" .'*'."\n" .'*'."\n", 'type' => 'string', 'enumValueTitles' => ['adaptive' => 'adaptive', 'auto' => 'auto', 'linear' => 'linear', 'dynamic' => 'dynamic'], 'example' => 'linear', ], ], 'title' => '', 'example' => '', ], 'MediaObject' => [ 'title' => '', 'description' => 'The media file.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The type of media source. Valid values:'."\n" ."\n" .'* OSS: an OSS object.'."\n" .'* Media: a media asset.'."\n" .'* ExternalURL: a publicly accessible external URL. This is not available for public use.'."\n", 'type' => 'string', 'example' => 'OSS'], 'Media' => ['title' => '', 'description' => 'The identifier for the media file.'."\n" ."\n" .'* If Type is set to OSS, the value is the URL of the media file. The following formats are supported: oss://... and https://...'."\n" .'* If Type is set to Media, the value is the ID of the media asset.'."\n", 'type' => 'string', 'example' => 'http://bucket.loction.aliyuncs.com/path/to/video.mp4'], ], 'example' => '', ], 'MediaQualityAnalysisJob' => [ 'type' => 'object', 'properties' => [ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'JobId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'ScheduleConfig' => [ 'type' => 'object', 'properties' => [ 'PipelineId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'TemplateConfig' => [ 'type' => 'object', 'properties' => [ 'TemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'State' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'UserData' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Input' => [ 'type' => 'object', 'properties' => [ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Media' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'VqaResult' => ['$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaResult', 'description' => '', 'title' => '', 'example' => ''], 'CreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'FinishTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'MediaQualityAnalysisJobVqaResult' => [ 'type' => 'object', 'properties' => [ 'Detail' => ['$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', 'description' => '', 'title' => '', 'example' => ''], 'Sharp' => ['$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', 'description' => '', 'title' => '', 'example' => ''], 'Block' => ['$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', 'description' => '', 'title' => '', 'example' => ''], 'Noise' => ['$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', 'description' => '', 'title' => '', 'example' => ''], 'Color' => ['$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', 'description' => '', 'title' => '', 'example' => ''], 'State' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'ScoreResult' => [ 'type' => 'object', 'properties' => [ 'Block' => [ 'type' => 'object', 'properties' => [ 'IntensityValue' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'PerceptualScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Color' => [ 'type' => 'object', 'properties' => [ 'IntensityValue' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'PerceptualScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Detail' => [ 'type' => 'object', 'properties' => [ 'IntensityValue' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'PerceptualScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Noise' => [ 'type' => 'object', 'properties' => [ 'IntensityValue' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'PerceptualScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Sharp' => [ 'type' => 'object', 'properties' => [ 'IntensityValue' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'PerceptualScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Score' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'MediaQualityAnalysisJobVqaScoreDetail' => [ 'type' => 'object', 'properties' => [ 'PerceptualScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'IntensityValue' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Program' => [ 'description' => 'The information about the program.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2024-04-02T00:58:19Z', 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'AdBreaks' => [ 'description' => 'The ad breaks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ad break.'."\n", 'type' => 'object', 'properties' => [ 'TimeSignalSettings' => ['description' => 'The TimeSignal configurations.'."\n", 'type' => 'string', 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}', 'title' => ''], 'OffsetMillis' => ['description' => 'The offset.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'ChannelName' => ['description' => 'The name of the channel.'."\n", 'type' => 'string', 'example' => 'MyChannel', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'SpliceInsertSettings' => ['description' => 'The SpliceInsert configurations.'."\n", 'type' => 'string', 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}', 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MyAdSource', 'title' => ''], 'ProgramName' => ['description' => 'The name of the program.'."\n", 'type' => 'string', 'example' => 'program_name', 'title' => ''], 'MessageType' => ['description' => 'MessageType'."\n", 'type' => 'string', 'example' => 'SPLICE_INSERT', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SourceType' => ['description' => 'The source type.'."\n", 'type' => 'string', 'example' => 'vodSource', 'title' => ''], 'Transition' => ['description' => 'The program transition method.'."\n", 'type' => 'string', 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', 'title' => ''], 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2024-04-02T00:58:19Z'."\n", 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'ClipRange' => ['description' => 'The information about the clip.'."\n", 'type' => 'string', 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}'."\n", 'title' => ''], 'Arn' => ['description' => 'The ARN of the program.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::program/myChannel/MyProgram', 'title' => ''], 'ProgramName' => ['description' => 'The name of the program.'."\n", 'type' => 'string', 'example' => 'program1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ScheduleData' => [ 'description' => 'The program schedule information.'."\n", 'type' => 'object', 'properties' => [ 'EntryType' => [ 'description' => 'The entry type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* FillerSlate'."\n" .'* program'."\n", 'type' => 'string', 'enumValueTitles' => ['FillerSlate' => 'FillerSlate', 'program' => 'program'], 'example' => 'program', 'title' => '', ], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'AdBreaks' => [ 'description' => 'The information about ad breaks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OffsetMillis' => ['description' => 'The time offset.'."\n", 'type' => 'string', 'example' => '100000', 'title' => ''], 'TimeSignalSettings' => ['description' => 'The TimeSignal configurations.'."\n", 'type' => 'string', 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'SpliceInsertSettings' => ['description' => 'The SpliceInsert configurations.'."\n", 'type' => 'string', 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'MessageType' => ['description' => 'MessageType'."\n", 'type' => 'string', 'example' => 'SPLICE_INSERT', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SourceType' => ['description' => 'The source type.'."\n", 'type' => 'string', 'example' => 'vodSource', 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MySource', 'title' => ''], 'ApproximateDurationSeconds' => ['description' => 'The scheduled playback duration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'ApproximateStartTime' => ['description' => 'The scheduled start time.'."\n", 'type' => 'string', 'example' => '1989128002313', 'title' => ''], 'ProgramName' => ['description' => 'The name of the program.'."\n", 'type' => 'string', 'example' => 'program1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Source' => [ 'description' => 'The source information.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2024-11-07T10:12:01Z', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'State' => ['description' => 'The status of the source. 0: normal. 1: deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'SourceType' => ['description' => 'The source type. Valid values: vodSource and liveSource.'."\n", 'type' => 'string', 'example' => 'vodSource', 'title' => ''], 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2024-11-07T10:12:01Z', 'title' => ''], 'SourceName' => ['description' => 'The name of the source.'."\n", 'type' => 'string', 'example' => 'MyVodSource', 'title' => ''], 'HttpPackageConfigurations' => ['description' => 'The source configuration.'."\n", 'type' => 'string', 'example' => '[{'."\n" .' "sourceGroupName": "mySourceGroup-1",'."\n" .' "relativePath": "group1/hls.m3u8",'."\n" .' "packageType": "hls"'."\n" .'}]', 'title' => ''], 'Arn' => ['description' => 'The ARN of the source.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/mySource', 'title' => ''], ], 'title' => '', 'example' => '', ], 'SourceLocation' => [ 'description' => 'The source location information.'."\n", 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2023-09-12T07:15:52Z', 'title' => ''], 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'State' => ['description' => 'The status of the source location. 0: normal. 1: deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'GmtModified' => ['description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2023-10-22T10:49:14Z', 'title' => ''], 'SegmentDeliveryConfigurations' => ['description' => 'The segment delivery server configurations.'."\n", 'type' => 'string', 'example' => 'http://segmentdelivery.com', 'title' => ''], 'BaseUrl' => ['description' => 'The base URL of the source location.'."\n", 'type' => 'string', 'example' => 'http://xxxx.com', 'title' => ''], 'Arn' => ['description' => 'The ARN of the source location.'."\n", 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::sourcelocation/MySourceLocation', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TranspositionResult' => [ 'description' => 'The translation result where hotwords are replaced with predefined translations.'."\n", 'type' => 'object', 'properties' => [ 'TranslatedText' => ['title' => '', 'description' => '* The translated text corresponding to the matched hotwords. Maximum length: 100 characters.'."\n" .'* This field is only used in translation-related scenarios.'."\n", 'type' => 'string', 'example' => '你好'], 'TargetLanguage' => ['title' => '', 'description' => '* The target language of the translation.'."\n" .'* This field is only used in translation-related scenarios.'."\n", 'type' => 'string', 'example' => 'zh'], ], 'title' => '', 'example' => '', ], 'VodPackagingAsset' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['title' => '打包组名称。', 'type' => 'string'], 'Input' => [ 'title' => '资产输入配置。', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '输入类型，暂支持OSS。', 'type' => 'string'], 'Media' => ['title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', 'type' => 'string'], ], ], 'CreateTime' => ['title' => '创建时间，格式 2024-11-21T06:45:32Z表示北京时间 2024-11-21 14:45:32。', 'type' => 'string'], 'ContentId' => ['title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', 'type' => 'string'], 'AssetName' => ['title' => 'asset名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', 'type' => 'string'], ], ], 'VodPackagingConfig' => [ 'type' => 'object', 'properties' => [ 'ManifestName' => ['title' => 'manifest名称，[A-Za-z0-9_]+，长度不超过128。', 'type' => 'string'], 'StreamSelection' => [ 'title' => '打包输出流选择配置。', 'type' => 'object', 'properties' => [ 'MinVideoBitsPerSecond' => ['title' => '最小视频流码率，单位bps。', 'type' => 'integer', 'format' => 'int64'], 'StreamOrder' => ['title' => '流排序规则，支持值：'."\n" .'- ORIGINAL：保持输入序号；'."\n" .'- VIDEO_BITRATE_ASCENDING：按视频流码率递增；'."\n" .'- VIDEO_BITRATE_DESCENDING：按视频流码率递减。', 'type' => 'string'], 'MaxVideoBitsPerSecond' => ['title' => '最大视频流码率，单位bps。', 'type' => 'integer', 'format' => 'int64'], ], ], 'DrmProvider' => [ 'title' => 'DRM加密提供商配置。', 'type' => 'object', 'properties' => [ 'SystemIds' => [ 'title' => 'drm 系统id，system id数量由使用的协议类型决定。'."\n" .'- DASH -- 最多两个'."\n" .'- HLS -- 提供一个'."\n" .'- HLS_CMAF-- 最多提供两个。'."\n" .'只支持 Apple FairPlay、Google Widevine、Microsoft PlayReady 三个DRM System，对应SystemId分别为 ：'."\n" .'Apple FairPlay：'."\n" .'94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" .'Google Widevine：'."\n" .'edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'."\n" .'Microsoft PlayReady：'."\n" .'9a04f079-9840-4286-ab92-e65be0885f95。', 'type' => 'array', 'items' => ['type' => 'string'], ], 'EncryptionMethod' => ['title' => '加密算法，支持值：'."\n" .'- AES_128'."\n" .'- SAMPLE_AES', 'type' => 'string'], 'IV' => ['title' => '一个可选的128位（16字节）十六进制值，由32个字符的字符串表示，与密钥一起用于加密数据块。如果您不指定该值，则MediaPackage将创建一个常量初始化向量（IV）。默认值：空，如果填写，则透传到供应商Constant initialization vector。', 'type' => 'string'], 'Url' => ['title' => 'DRM key提供商url。', 'type' => 'string'], ], ], 'SegmentDuration' => ['title' => '每个片段的时长（以秒为单位）。实际片段将会被四舍五入到最接近的源片段时长的倍数。取值范围【1，30】。', 'type' => 'integer', 'format' => 'int64'], ], ], 'VodPackagingConfiguration' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['title' => '打包组名称，长度128个字符，格式：[A-Za-z0-9_-]+。', 'type' => 'string'], 'Description' => ['title' => '打包配置描述信息。', 'type' => 'string'], 'CreateTime' => ['title' => '创建时间。', 'type' => 'string'], 'ConfigurationName' => ['title' => '打包配置名称，长度128个字符，格式：[A-Za-z0-9_-]+，用户维度唯一。', 'type' => 'string'], 'Protocol' => ['title' => '打包类型，支持：'."\n" .'- HLS: HLC协议播放格式；'."\n" .'- HLS_CMAF： HLS协议的CMAF播放格式；'."\n" .'- DASH: DASH协议播放格式。', 'type' => 'string'], 'PackageConfig' => ['$ref' => '#/components/schemas/VodPackagingConfig'], ], ], 'VodPackagingGroup' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['title' => '打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', 'type' => 'string'], 'Description' => ['title' => '打包组描述信息。', 'type' => 'string'], 'DomainName' => ['title' => '打包组播放域名，同一个打包组所有点播打包资产域名相同。', 'type' => 'string'], 'CreateTime' => ['title' => '打包组创建时间。', 'type' => 'string'], 'ApproximateAssetCount' => ['title' => '打包组中打包资产数量近似值。', 'type' => 'integer', 'format' => 'int64'], 'ConfigurationCount' => ['title' => '打包组中打包配置数量。', 'type' => 'integer', 'format' => 'int64'], ], ], ], ], 'apis' => [ 'ActiveAiRtcLicense' => [ 'summary' => 'Activates a specified license using the batch ID, authorization code, and device SN.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'LicenseItemId', 'in' => 'query', 'schema' => ['description' => 'The batch ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '17712***', 'title' => ''], ], [ 'name' => 'AuthCode', 'in' => 'query', 'schema' => ['description' => 'The authorization code.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'iU1IeJech7***', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'device-***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'ApiResponse\\', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4F9C14FE-1147-15AC-8EDF-A590FF12***', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'License' => ['description' => 'The license information.', 'type' => 'string', 'example' => 'a659a06659a***', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'ActiveAiRtcLicense', 'description' => '## [](#)Usage notes'."\n" ."\n" .'Activate a specific license for Real-time Conversational AI by providing a batch ID (`LicenseItemId`), authorization code (`AuthCode`), and device ID (`DeviceId`). Upon successful activation, the API returns a response containing the request ID, an error code, the request status, the HTTP status code, and the activated license information.'."\n" ."\n" .'**Note**: Ensure that the provided batch ID, authorization code, and device ID are correct. Incorrect information may cause the activation to fail.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActiveAiRtcLicense'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:ActiveAiRtcLicense', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F9C14FE-1147-15AC-8EDF-A590FF12***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"License\\": \\"a659a06659a***\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'AddAdInsertion' => [ 'summary' => 'Adds an ad insertion configuration.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238117', 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the configuration. The name must be unique and can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_ad'], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'allowEmptyValue' => false, 'schema' => ['description' => 'The idempotency key that is used to avoid repeated submission. The value can be up to 200 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****0311a423d11a5f7dee713535****'], ], [ 'name' => 'ContentUrlPrefix', 'in' => 'formData', 'schema' => ['description' => 'The URL prefix for the source content. HTTP and HTTPS are supported. The maximum length is 512 characters.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'https://source.com/'], ], [ 'name' => 'SlateAdUrl', 'in' => 'formData', 'schema' => ['description' => 'The HTTP or HTTPS URL of the slate ad. Only MP4 format is supported. The maximum length is 2,048 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://storage.com/slate1.mp4'], ], [ 'name' => 'ConfigAliases', 'in' => 'formData', 'schema' => ['description' => 'A JSON string that specifies the player parameter variables and aliases. You can add up to 20 player\\_params.{name} entries. The name field can be up to 150 characters in length. Each player parameter can include up to 50 key-value pairs. A key can be up to 150 characters long, and a value can be up to 500 characters. Example: { "player\\_params.{name}": { "{key}": "{value}" } }', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{ "player_params.p1": { "1": "abc" } }'], ], [ 'name' => 'CdnContentSegmentUrlPrefix', 'in' => 'formData', 'schema' => ['description' => 'The CDN prefix for content segments. HTTP and HTTPS are supported. The maximum length is 512 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://cdn.com/'], ], [ 'name' => 'CdnAdSegmentUrlPrefix', 'in' => 'formData', 'schema' => ['description' => 'The CDN prefix for ad segments. HTTP and HTTPS are supported. The maximum length is 512 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://cdn.com/'], ], [ 'name' => 'AdMarkerPassthrough', 'in' => 'formData', 'schema' => [ 'description' => 'Specifies whether to enable ad marker passthrough. Default value: OFF.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- OFF: Disable.'."\n" ."\n" .'- ON: Enable.', 'enumValueTitles' => ['OFF' => '', 'ON' => ''], 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ON', ], ], [ 'name' => 'PersonalizationThreshold', 'in' => 'formData', 'schema' => ['description' => 'Specifies the maximum duration of underfilled time allowed in an ad break. Unit: seconds. Default value: 8 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '5'], ], [ 'name' => 'AdsUrl', 'in' => 'formData', 'schema' => ['description' => 'The request URL of the ad decision server (ADS). HTTP and HTTPS are supported. The maximum length is 2,048 characters.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Config' => [ 'description' => 'The ad insertion configuration.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'title' => '', 'example' => '2024-06-13T08:26:09Z'], 'LastModified' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'title' => '', 'example' => '2024-06-13T08:26:09Z'."\n"], 'Name' => ['description' => 'The name of the ad insertion configuration.', 'type' => 'string', 'title' => '', 'example' => 'my_ad'], 'ContentUrlPrefix' => ['description' => 'The URL prefix for the source content.', 'type' => 'string', 'title' => '', 'example' => 'https://source.com/'."\n"], 'AdsUrl' => ['description' => 'The request URL of ADS.', 'type' => 'string', 'title' => '', 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'."\n"], 'ConfigAliases' => ['description' => 'The player parameter variables and aliases.', 'type' => 'string', 'title' => '', 'example' => '{ "player_params.p1": { "1": "abc" } }'."\n"], 'PersonalizationThreshold' => ['description' => 'The personalization threshold.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'SlateAdUrl' => ['description' => 'The URL of the slate ad.', 'type' => 'string', 'title' => '', 'example' => 'http://storage.com/slate1.mp4'."\n"], 'CdnConfig' => [ 'title' => '', 'description' => 'The CDN configurations.', 'type' => 'object', 'properties' => [ 'ContentSegmentUrlPrefix' => ['description' => 'The CDN prefix for content segments.', 'type' => 'string', 'title' => '', 'example' => 'http://cdn.com/'."\n"], 'AdSegmentUrlPrefix' => ['description' => 'The CDN prefix for ad segments.', 'type' => 'string', 'title' => '', 'example' => 'http://cdn.com/'."\n"], ], 'example' => '', ], 'AdMarkerPassthrough' => ['description' => 'Indicates whether ad marker passthrough is enabled.', 'type' => 'string', 'title' => '', 'example' => 'ON'], 'ManifestEndpointConfig' => [ 'title' => '', 'description' => 'The playback endpoint configuration.', 'type' => 'object', 'properties' => [ 'HlsPrefix' => ['description' => 'The prefix of the playback endpoint for HLS manifests.', 'type' => 'string', 'title' => '', 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'."\n"], 'DashPrefix' => ['description' => 'DASH manifest playback endpoint prefix', 'type' => 'string', 'title' => '', 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\\\n\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\\\n\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\\\n\\",\\n \\"ConfigAliases\\": \\"{ \\\\\\"player_params.p1\\\\\\": { \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\" } }\\\\n\\",\\n \\"PersonalizationThreshold\\": 5,\\n \\"SlateAdUrl\\": \\"http://storage.com/slate1.mp4\\\\n\\",\\n \\"CdnConfig\\": {\\n \\"ContentSegmentUrlPrefix\\": \\"http://cdn.com/\\\\n\\",\\n \\"AdSegmentUrlPrefix\\": \\"http://cdn.com/\\\\n\\"\\n },\\n \\"AdMarkerPassthrough\\": \\"ON\\",\\n \\"ManifestEndpointConfig\\": {\\n \\"HlsPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\\\n\\",\\n \\"DashPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\"\\n }\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'AddAdInsertion', 'changeSet' => [ ['createdAt' => '2025-05-29T03:34:26.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAdInsertion'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:AddAdInsertion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AddCategory' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'CateName', 'in' => 'query', 'schema' => ['description' => 'The category name.'."\n" ."\n" .'- The value can be up to 64 bytes in length.'."\n" ."\n" .'- The value must be encoded in UTF-8.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Third-level subcategory', 'title' => ''], ], [ 'name' => 'ParentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parent category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The type of the category. Valid values:'."\n" ."\n" .'- default: audio, video, and image files. This is the default value.'."\n" ."\n" .'- material: short video materials.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'Category' => [ 'description' => 'The information about the category.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the category. Valid values:'."\n" ."\n" .'- **default**: audio, video, and image files. This is the default value.'."\n" ."\n" .'- **material**: short video materials.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'ParentId' => ['description' => 'The ID of the parent category. By default, if ParentId is left empty or less than 1, -1 is returned, which indicates that the created category is the root directory.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], 'CateName' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'Category 1', 'title' => ''], 'CateId' => ['description' => 'The ID of the created category.', 'type' => 'integer', 'format' => 'int64', 'example' => '45', 'title' => ''], 'Level' => ['description' => 'The level of the category. A value of **0** indicates a level-1 category, a value of **1** indicates a level-2 category, and a value of **2** indicates a level-3 category.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'AddCategory', 'summary' => 'Creates a category.', 'description' => 'You can create at most three levels of categories. Each category level can contain a maximum of 100 subcategories.', 'changeSet' => [ ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCategory'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:AddCategory', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"ParentId\\": -1,\\n \\"CateName\\": \\"Category 1\\",\\n \\"CateId\\": 45,\\n \\"Level\\": 0\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'AddEditingProjectMaterials' => [ 'summary' => 'Adds one or more materials to an online editing project.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'PrivateKey' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '*****b2101cb318c*****'], ], [ 'name' => 'MaterialMaps', 'in' => 'query', 'schema' => ['description' => 'The material ID. Separate multiple material IDs with commas (,). Each type supports up to 10 material IDs. The following material types are supported:'."\n" ."\n" .'- video'."\n" ."\n" .'- audio'."\n" ."\n" .'- image'."\n" ."\n" .'- liveStream'."\n" ."\n" .'- editingProject', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\\"appName\\":\\"testrecord\\",\\"domainName\\":\\"test.alivecdn.com\\",\\"liveUrl\\":\\"rtmp://test.alivecdn.com/testrecord/teststream\\",\\"streamName\\":\\"teststream\\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'example' => '*****67ae06542b9b93e0d1c387*****', 'title' => ''], 'MediaInfos' => [ 'title' => '', 'description' => 'The media assets that meet the specified conditions.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => '*****5cb2e35433198daae94a72*****'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'The basic information of the media assets.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '*****5cb2e35433198daae94a72*****'], 'InputURL' => ['description' => 'The URL of the media asset in another service.', 'type' => 'string', 'title' => '', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4'], 'MediaType' => ['description' => 'The type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Video'], 'BusinessType' => ['description' => 'The business type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'general'], 'Source' => ['description' => 'The source of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'The title of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'default_title_2020-12-23T03:32:59Z'], 'Description' => ['description' => 'The description of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'sample_description'], 'Category' => ['description' => 'The category of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'audio'], 'MediaTags' => ['description' => 'The tags of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'sample_tag'], 'CoverURL' => ['description' => 'The thumbnail URL of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'title' => '', 'example' => 'userData'], 'Snapshots' => ['description' => 'The snapshots of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'null'], 'Status' => ['description' => 'The status of the media asset. Valid values:'."\n" ."\n" .'\\- Init'."\n" ."\n" .'\\- Preparing'."\n" ."\n" .'\\- PrepareFail'."\n" ."\n" .'\\- Normal', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'TranscodeStatus' => ['description' => 'The transcoding status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Init'], 'CreateTime' => ['description' => 'The time when the media asset was created.', 'type' => 'string', 'title' => '', 'example' => '2020-12-23T03:32:59Z'], 'ModifiedTime' => ['description' => 'The time when the media asset was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-12-23T03:32:59Z'], 'DeletedTime' => ['description' => 'The time when the media asset was deleted.', 'type' => 'string', 'title' => '', 'example' => '2020-12-23T03:32:59Z'], 'SpriteImages' => ['description' => 'The sprite of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'http://outin-example.oss-cn-shanghai.aliyuncs.com/test.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], ], 'example' => '', ], 'FileInfoList' => [ 'title' => '', 'description' => 'FileInfos', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'The basic information of the file, including the duration and size.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'example.mp4'], 'FileStatus' => ['description' => 'The file status.'."\n" ."\n" .'-Uploading'."\n" ."\n" .'-Normal'."\n" ."\n" .'-UploadFail'."\n" ."\n" .'-Disable'."\n" ."\n" .'-Deleted', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'title' => '', 'example' => 'source_file'], 'FileSize' => ['description' => 'The file size. Unit: bytes.', 'type' => 'string', 'title' => '', 'example' => '30611502'], 'FileUrl' => ['description' => 'The Object Storage Service (OSS) URL of the file.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['description' => 'The region in which the file resides.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'FormatName' => ['description' => 'The container format.', 'type' => 'string', 'title' => '', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2'], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'title' => '', 'example' => '216.206667'], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'title' => '', 'example' => '1132.68'], 'Width' => ['description' => 'The width.', 'type' => 'string', 'title' => '', 'example' => '960'], 'Height' => ['description' => 'The height.', 'type' => 'string', 'title' => '', 'example' => '540'], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'LiveMaterials' => [ 'description' => 'The materials associated with the live stream.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AppName' => ['description' => 'The application name of the live stream.', 'type' => 'string', 'example' => 'testrecord', 'title' => ''], 'StreamName' => ['description' => 'The name of the live stream.', 'type' => 'string', 'example' => 'teststream', 'title' => ''], 'DomainName' => ['description' => 'The domain name of the live stream.', 'type' => 'string', 'example' => 'test.alivecdn.com', 'title' => ''], 'LiveUrl' => ['description' => 'The URL of the live stream.', 'type' => 'string', 'example' => 'rtmp://test.alivecdn.com/testrecord/teststream', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ProjectMaterials' => [ 'description' => 'The materials associated with the editing project. A live stream editing project will be associated with a regular editing project after the live streaming ends.', 'type' => 'array', 'items' => ['description' => 'The ID of the regular editing project associated with the live stream editing project.', 'type' => 'string', 'example' => '*****c38767ae06542b9b93e0d1*****', 'title' => ''], 'example' => '*****9b145c5cafc2e057304fcd*****', 'title' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], ], 404 => [ ['errorCode' => 'ProjectNotFound', 'errorMessage' => 'The specified project not found', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"ProjectId\\": \\"*****67ae06542b9b93e0d1c387*****\\",\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"*****5cb2e35433198daae94a72*****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"*****5cb2e35433198daae94a72*****\\",\\n \\"InputURL\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4\\",\\n \\"MediaType\\": \\"Video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"default_title_2020-12-23T03:32:59Z\\",\\n \\"Description\\": \\"sample_description\\",\\n \\"Category\\": \\"audio\\",\\n \\"MediaTags\\": \\"sample_tag\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"null\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-23T03:32:59Z\\",\\n \\"ModifiedTime\\": \\"2020-12-23T03:32:59Z\\",\\n \\"DeletedTime\\": \\"2020-12-23T03:32:59Z\\",\\n \\"SpriteImages\\": \\"http://outin-example.oss-cn-shanghai.aliyuncs.com/test.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"216.206667\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"LiveMaterials\\": [\\n {\\n \\"AppName\\": \\"testrecord\\",\\n \\"StreamName\\": \\"teststream\\",\\n \\"DomainName\\": \\"test.alivecdn.com\\",\\n \\"LiveUrl\\": \\"rtmp://test.alivecdn.com/testrecord/teststream\\"\\n }\\n ],\\n \\"ProjectMaterials\\": [\\n \\"*****c38767ae06542b9b93e0d1*****\\"\\n ]\\n}","type":"json"}]', 'title' => 'AddEditingProjectMaterials', 'changeSet' => [ ['createdAt' => '2021-11-26T03:21:26.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-03-31T06:11:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddEditingProjectMaterials'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:AddEditingProjectMaterials', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AddFavoritePublicMedia' => [ 'summary' => 'Adds one or more public Media Assets to your Favorites list by their media IDs.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the Media Assets.'."\n" ."\n" .'- Separate multiple IDs with commas.', 'type' => 'string', 'required' => false, 'example' => 'icepublic-****7213c6050cbc66750b469701****,icepublic-****0b4697017213c6050cbc6675****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'IgnoredList' => [ 'type' => 'array', 'items' => ['description' => 'The ID of a Media Asset that was not added to your Favorites.', 'type' => 'string', 'example' => 'icepublic-****7213c6050cbc66750b469701****', 'title' => ''], 'description' => 'A list of Media Asset IDs that were not added to your Favorites. This happens if a Media Asset does not exist or is already in your Favorites.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"icepublic-****7213c6050cbc66750b469701****\\"\\n ]\\n}","type":"json"}]', 'title' => 'Collect public copyright media assets', 'changeSet' => [ ['createdAt' => '2021-11-25T06:45:51.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFavoritePublicMedia'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:AddFavoritePublicMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'AddMediaConnectFlowInput' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'Flow instance ID', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ 'name' => 'InputProtocol', 'in' => 'query', 'schema' => [ 'description' => 'Input type', 'enumValueTitles' => ['RTMP-PUSH' => 'RTMP-PUSH', 'SRT-Caller' => 'SRT-Caller', 'RTMP-PULL' => 'RTMP-PULL', 'SRT-Listener' => 'SRT-Listener', 'Flow' => 'Flow'], 'type' => 'string', 'required' => true, 'example' => 'RTMP-PUSH', 'title' => '', ], ], [ 'name' => 'InputName', 'in' => 'query', 'schema' => ['description' => 'Input name', 'type' => 'string', 'required' => true, 'example' => 'AliTestInput', 'title' => ''], ], [ 'name' => 'MaxBitrate', 'in' => 'query', 'schema' => ['description' => 'Maximum bitrate in bits per second (bps)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000000', 'title' => ''], ], [ 'name' => 'Cidrs', 'in' => 'query', 'schema' => ['description' => 'IP address whitelist in CIDR notation. Separate multiple CIDR blocks with commas.', 'type' => 'string', 'required' => false, 'example' => '19.168.1.1/32,18.168.1.1/16', 'title' => ''], ], [ 'name' => 'InputFromUrl', 'in' => 'query', 'schema' => ['description' => 'Input URL. Required only when the input type is RTMP-PULL or SRT-Listener.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://pull.test.alivecdn.com/live/alitest', 'title' => ''], ], [ 'name' => 'PairFlowId', 'in' => 'query', 'schema' => ['description' => 'Upstream Flow ID. Required only when the input type is Flow.', 'type' => 'string', 'required' => false, 'example' => '805fbdd0-575e-4146-b35d-ec7f63937b20', 'title' => ''], ], [ 'name' => 'PairOutputName', 'in' => 'query', 'schema' => ['description' => 'Upstream Flow output name. Required only when the input type is Flow.', 'type' => 'string', 'required' => false, 'example' => 'AliTestOutput', 'title' => ''], ], [ 'name' => 'SrtLatency', 'in' => 'query', 'schema' => ['description' => 'SRT latency in milliseconds. Required only when the input type is SRT-Listener or SRT-Caller.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'SrtPassphrase', 'in' => 'query', 'schema' => ['description' => 'SRT encryption key. Required only when the input type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => 'BETTERG08S01', 'title' => ''], ], [ 'name' => 'SrtPbkeyLen', 'in' => 'query', 'schema' => [ 'description' => 'SRT encryption key length in bytes. Required only when the input type is SRT-Listener or SRT-Caller.', 'enumValueTitles' => ['0', 16 => '16', 24 => '24', 32 => '32'], 'type' => 'string', 'required' => false, 'example' => '32', 'title' => '', ], ], [ 'name' => 'WithInternalVip', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'InputUrl' => ['description' => 'Input URL', 'type' => 'string', 'example' => 'rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be', 'title' => ''], 'InnerInputUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'API call description', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'Error code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '11357BE8-4C54-58EA-890A-5AB646EDE4B2', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddMediaConnectFlowInput', 'summary' => 'Adds an input to a MediaConnect Flow instance.', 'description' => '- If the specified flow instance ID does not exist, the API returns an error.'."\n" ."\n" .'- By default, a flow instance supports only one input. After you enable dual-stream disaster recovery, you can add a second input.'."\n" ."\n" .'### Input type descriptions'."\n" ."\n" .'- RTMP-PUSH: Creates an RTMP listener input. You can push your stream to the URL returned by the API using the RTMP protocol.'."\n" ."\n" .'- RTMP-PULL: Creates an RTMP origin fetch input. The flow instance pulls an RTMP live stream from your specified origin server.'."\n" ."\n" .'- SRT-Listener: Creates an SRT listener input. You can push your stream to the URL returned by the API using the SRT protocol.'."\n" ."\n" .'- SRT-Caller: Creates an SRT origin fetch input. The flow instance pulls an SRT live stream from your specified origin server.'."\n" ."\n" .'- Flow: Uses the output of another upstream flow instance as the input. You must specify both the upstream flow instance ID and the output name. The output of the upstream flow instance must be of the SRT-Listener or RTMP-PULL type. When flow instances cascade, they use a leased line by default. This supports cross-region distribution across multiple flow instances.', 'changeSet' => [ ['createdAt' => '2025-01-23T06:18:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:AddMediaConnectFlowInput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"InputUrl\\": \\"rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be\\",\\n \\"InnerInputUrl\\": \\"\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"11357BE8-4C54-58EA-890A-5AB646EDE4B2\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'AddMediaConnectFlowOutput' => [ 'summary' => 'Creates an output for a MediaConnect flow.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f'."\n", 'title' => ''], ], [ 'name' => 'OutputProtocol', 'in' => 'query', 'schema' => [ 'description' => 'The output type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- RTMP-PUSH'."\n" ."\n" .'- SRT-Caller'."\n" ."\n" .'- RTMP-PULL'."\n" ."\n" .'- SRT-Listener'."\n" ."\n" .'- Flow', 'enumValueTitles' => ['RTMP-PUSH' => 'RTMP-PUSH', 'SRT-Caller' => 'SRT-Caller', 'RTMP-PULL' => 'RTMP-PULL', 'SRT-Listener' => 'SRT-Listener', 'Flow' => 'Flow'], 'type' => 'string', 'required' => true, 'example' => 'RTMP-PULL', 'title' => '', ], ], [ 'name' => 'OutputToUrl', 'in' => 'query', 'schema' => ['description' => 'The output URL. This parameter is required when OutputProtocol is set to RTMP-PUSH or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://push.test.alivecdn.com/live/alitest', 'title' => ''], ], [ 'name' => 'OutputName', 'in' => 'query', 'schema' => ['description' => 'The output name.', 'type' => 'string', 'required' => true, 'example' => 'AliTestOutput', 'title' => ''], ], [ 'name' => 'Cidrs', 'in' => 'query', 'schema' => ['description' => 'The IP address whitelist in CIDR format. Separate multiple CIDR blocks with commas (,).', 'type' => 'string', 'required' => false, 'example' => '83.17.231.31/32', 'title' => ''], ], [ 'name' => 'PlayerLimit', 'in' => 'query', 'schema' => ['description' => 'The maximum number of viewers.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'PairInputName', 'in' => 'query', 'schema' => ['description' => 'The source name of the destination flow. This parameter is required when OutputProtocol is set to Flow.', 'type' => 'string', 'required' => false, 'example' => 'AliTestInput', 'title' => ''], ], [ 'name' => 'SrtLatency', 'in' => 'query', 'schema' => ['description' => 'The latency for the SRT stream. This parameter is required when the source type is SRT-Listener or SRT-Caller.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'SrtPbkeyLen', 'in' => 'query', 'schema' => ['description' => 'The encryption key length. This parameter is required when the source type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => '32', 'title' => ''], ], [ 'name' => 'SrtPassphrase', 'in' => 'query', 'schema' => ['description' => 'The SRT key. This parameter is required when the source type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => 'BETTERG08S01', 'title' => ''], ], [ 'name' => 'PairFlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination flow. This parameter is required when OutputProtocol is set to Flow.', 'type' => 'string', 'required' => false, 'example' => '8666ec062190f00e263012666319a5be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'OutputUrl' => ['description' => 'The output URL.', 'type' => 'string', 'example' => 'srt://1.2.3.4:1025', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '11AA9E73-FBA0-58DC-97BA-D606D847BCB6', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates that the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"OutputUrl\\": \\"srt://1.2.3.4:1025\\"\\n },\\n \\"Description\\": \\"ok\\",\\n \\"RequestId\\": \\"11AA9E73-FBA0-58DC-97BA-D606D847BCB6\\",\\n \\"RetCode\\": 0\\n}","type":"json"}]', 'title' => 'AddMediaConnectFlowOutput', 'description' => '- When the specified flow ID is not available, an error code is returned.'."\n" ."\n" .'- A flow can have a maximum of four outputs.'."\n" ."\n" .'- The output names in the same flow cannot be duplicated.'."\n" ."\n" .'- You can set an upper limit on the number of concurrent viewers for each output. If this limit is exceeded, any new playback requests will fail. Each output supports up to five streams.'."\n" ."\n" .'### [](#)Output types'."\n" ."\n" .'- RTMP-PUSH: An output that the MediaConnect flow pushes to the server you specified over the RTMP protocol.'."\n" ."\n" .'- RTMP-PULL: An output that you can pull using the returned streaming URL over the RTMP protocol.'."\n" ."\n" .'- SRT-Caller: An output that the MediaConnect flow pushes to the server you specified over the SRT protocol.'."\n" ."\n" .'- SRT-Listener: An output that you can pull using the returned streaming URL over the SRT protocol.'."\n" ."\n" .'- Flow: An output that is pushed to the source URL of another MediaConnect flow. The source type of the destination flow must be SRT-Listener or RTMP-PUSH. By default, a dedicated line is used when flows are cascaded. This allows for cross-region distribution among multiple flows.', 'changeSet' => [ ['createdAt' => '2025-02-10T05:42:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-01-23T06:18:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:AddMediaConnectFlowOutput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AddMediaMarks' => [ 'summary' => 'Adds marks for a media asset.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '53afdf003a2171ed9c6a16b5feac6402'], ], [ 'name' => 'MediaMarks', 'in' => 'query', 'schema' => ['description' => 'The mark information. The value must be a JSONArray.', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "MarkStartTime": "12.1",'."\n" .' "MarkEndTime": "12.2",'."\n" .' "MarkTag": "tag-1",'."\n" .' "MarkContent": "content-1",'."\n" .' "MarkStatus": "a"'."\n" .' },{'."\n" .' "MarkStartTime": "12.3",'."\n" .' "MarkEndTime": "12.4",'."\n" .' "MarkTag": "tag-2",'."\n" .' "MarkContent": "content-2",'."\n" .' "MarkStatus": "online"'."\n" .' }'."\n" .']', 'required' => true, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', 'title' => ''], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => '53afdf003a******6a16b5feac6402'], 'MediaMarkIds' => ['description' => 'The IDs of the marks that are added.', 'type' => 'string', 'title' => '', 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], 500 => [ ['errorCode' => 'AddMediaMarksFailed', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\",\\n \\"MediaId\\": \\"53afdf003a******6a16b5feac6402\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', 'title' => 'AddMediaMarks', 'requestParamsDescription' => '## MediaMark'."\n" ."\n" .'| Field | Type | Required | Description |'."\n" .'| ------------- | ------ | -------- | --------------------------------------- |'."\n" .'| MarkId | String | No | The mark ID. |'."\n" .'| MarkStartTime | Float | No | The start time of the mark. |'."\n" .'| MarkEndTime | Float | No | The end time of the mark. |'."\n" .'| MarkTag | String | No | The custom tag for easy classification. |'."\n" .'| MarkContent | String | No | The mark content. |'."\n" .'| MarkStatus | String | No | The mark status. |', 'changeSet' => [ ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMediaMarks'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:AddMediaMarks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AddStreamTagToSearchLib' => [ 'summary' => 'Adds tags for a specific live stream media asset.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******', 'title' => ''], ], [ 'name' => 'MsgBody', 'in' => 'query', 'schema' => ['description' => 'The message body.', 'type' => 'string', 'required' => false, 'example' => '{"startTime":1657684600793,"endTime":1657684600793,"userData":"{}"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'Success' => ['description' => 'Indicates whether the request is successful. Default value: true. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', 'title' => 'AddStreamTagToSearchLib', 'description' => 'Tagging media assets created for live streams.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:AddStreamTagToSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AddTemplate' => [ 'summary' => 'Creates a template.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the custom template.', 'type' => 'string', 'example' => 'Template name', 'title' => '', 'required' => false], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The template type. Valid values:'."\n" ."\n" .'- Timeline: a regular template created based on the timeline of a video editing project, in which multiple materials are arranged in sequence across multiple layers. It can be used to convert text and images into videos, create photo albums, add opening and closing parts, and apply the default watermark.'."\n" ."\n" .'- VETemplate: an advanced template created using effects of Adobe After Effects (AE). It can be used to produce complex animations and advanced media effects.'."\n" ."\n" .'', 'enumValueTitles' => ['Timeline' => '', 'VETemplate' => ''], 'type' => 'string', 'example' => 'Timeline', 'title' => '', 'required' => false, ], ], [ 'name' => 'Config', 'in' => 'formData', 'schema' => ['description' => '- The template configurations. The Config object of a regular template is encapsulated based on the Timeline object of an online editing project. The Config object of a custom template provides more flexible features. If you have special requirements, we recommend that you understand the structure of a Config object and configure a custom template. For more information, see [Config object of a regular template](~~456193~~).'."\n" ."\n" .'- For more information about Config object examples, see [Basic template configurations](~~451634~~).', 'type' => 'string', 'example' => '参见Timeline模板Config文档', 'title' => '', 'required' => false], ], [ 'name' => 'CoverUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the template thumbnail.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', 'title' => '', 'required' => false], ], [ 'name' => 'PreviewMedia', 'in' => 'query', 'schema' => ['description' => 'The ID of the template preview video.', 'type' => 'string', 'example' => '****01bf24bf41c78b2754cb3187****', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The template state. Valid values:'."\n" ."\n" .'- Available: The template is available.'."\n" ."\n" .'- Created: The template is created but not ready for use.'."\n" ."\n" .'- Uploading: The video is being uploaded.'."\n" ."\n" .'- Processing: The advanced template is being processed.'."\n" ."\n" .'- UploadFailed: Failed to upload the video.'."\n" ."\n" .'- ProcessFailed: Failed to process the advanced template.'."\n" ."\n" .'', 'enumValueTitles' => ['UploadFailed' => '', 'ProcessFailed' => '', 'Available' => '', 'Uploading' => '', 'Created' => '', 'Processing' => ''], 'type' => 'string', 'example' => 'Available', 'title' => '', 'required' => false, ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'The source from which the template is created. Valid values:'."\n" ."\n" .'- OpenAPI'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- WebSDK'."\n" ."\n" .'', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'example' => 'OpenAPI', 'title' => '', 'required' => false, ], ], [ 'name' => 'RelatedMediaids', 'in' => 'query', 'schema' => ['description' => 'The IDs of the materials associated with the template for use by the regular template editor.', 'type' => 'string', 'example' => '{"video":["1805a0c6ca544fb395a06ca683619655"]}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', 'title' => ''], 'Template' => [ 'title' => '', 'description' => 'The template information.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****01bf24bf41c78b2754cb3187****', 'title' => ''], 'Name' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template name', 'title' => ''], 'Type' => [ 'description' => 'The template type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Timeline: regular template.'."\n" ."\n" .'- VETemplate: advanced template.', 'enumValueTitles' => ['Timeline' => '', 'VETemplate' => ''], 'type' => 'string', 'example' => 'Timeline', 'title' => '', ], 'Config' => ['description' => 'The template configurations.', 'type' => 'string', 'example' => '参见Config文档', 'title' => ''], 'CoverUrl' => ['description' => 'The URL of the template thumbnail.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', 'title' => ''], 'PreviewMedia' => ['description' => 'The ID of the preview video.', 'type' => 'string', 'example' => '****01bf24bf41c78b2754cb3187****', 'title' => ''], 'Status' => [ 'description' => 'The template state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- UploadFailed: Failed to upload the video.'."\n" ."\n" .'- ProcessFailed: Failed to process the advanced template.'."\n" ."\n" .'- Available: The template is available.'."\n" ."\n" .'- Uploading: The video is being uploaded.'."\n" ."\n" .'- Created: The template is created but not ready for use.'."\n" ."\n" .'- Processing: The advanced template is being processed.', 'enumValueTitles' => ['UploadFailed' => '', 'ProcessFailed' => '', 'Available' => '', 'Uploading' => '', 'Created' => '', 'Processing' => ''], 'type' => 'string', 'example' => 'Available', 'title' => '', ], 'CreateSource' => [ 'description' => 'The source from which the template was created.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- WebSDK'."\n" ."\n" .'- OpenAPI', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'example' => 'OpenAPI', 'title' => '', ], 'ModifiedSource' => [ 'description' => 'The source from which the template was modified.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- WebSDK'."\n" ."\n" .'- OpenAPI', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'example' => 'OpenAPI', 'title' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"Template\\": {\\n \\"TemplateId\\": \\"****01bf24bf41c78b2754cb3187****\\",\\n \\"Name\\": \\"Template name\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"参见Config文档\\",\\n \\"CoverUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg\\",\\n \\"PreviewMedia\\": \\"****01bf24bf41c78b2754cb3187****\\",\\n \\"Status\\": \\"Available\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\"\\n }\\n}","type":"json"}]', 'title' => 'AddTemplate', 'description' => '- For more information about how to use a regular template, see [Create and use a regular template](~~445399~~).'."\n" ."\n" .'- For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).'."\n" ."\n" .'- After an advanced template is created, it enters the Processing state. In this case, the template is unavailable. The template can be used only when it is in the Available state. The time required for template processing varies based on the size of the template file. Generally, it ranges from 10 seconds to 5 minutes.', 'changeSet' => [ ['createdAt' => '2023-11-23T01:57:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:AddTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AddYikeUserCredit' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'YikeUserId', 'in' => 'query', 'schema' => ['description' => 'The user ID of the sub-account.', 'type' => 'string', 'required' => true, 'example' => 'id', 'title' => ''], ], [ 'name' => 'Credit', 'in' => 'query', 'schema' => ['description' => 'The number of credits to add. The value must be greater than 0.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'Result' => ['description' => 'Indicates whether the operation was successful.'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the operation fails. The following value is supported:'."\n" ."\n" .'- NOT\\_ENOUGH\\_ALLOCATE\\_CREDIT\\_QUOTA: The credit balance of the main account is insufficient.', 'type' => 'string', 'example' => 'NOT_ENOUGH_ALLOCATE_CREDIT_QUOTA', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'AddYikeUserCredit', 'summary' => 'Adds credits to a user account.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:AddYikeUserCredit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Result\\": true,\\n \\"ErrorCode\\": \\"NOT_ENOUGH_ALLOCATE_CREDIT_QUOTA\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'AlterSearchIndex' => [ 'summary' => 'Modifies search index information including index status and configurations.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.'."\n" ."\n" .'- If you leave this parameter empty, the search index is created in the default search library of Intelligent Media Service (IMS). Default value: ims-default-search-lib.'."\n" ."\n" .'- To query information about an existing search library, call the [QuerySearchLib](~~2584455~~) API operation.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'IndexType', 'in' => 'query', 'schema' => [ 'description' => 'The category of the index. Valid values:'."\n" ."\n" .'- mm: large visual model.'."\n" ."\n" .'- face: face recognition.'."\n" ."\n" .'- aiLabel: smart tagging.', 'enumValueTitles' => ['mm' => 'mm', 'face' => 'face', 'aiLabel' => 'aiLabel'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mm', ], ], [ 'name' => 'IndexStatus', 'in' => 'query', 'schema' => [ 'description' => 'The state of the index. Valid values:'."\n" ."\n" .'- active (default): the index is enabled.'."\n" ."\n" .'- Deactive: the index is not enabled.'."\n" ."\n" .'> You must specify either IndexStatus or IndexConfig.', 'enumValueTitles' => ['Active' => 'Active', 'Deactive' => 'Deactive'], 'type' => 'string', 'required' => false, 'example' => 'Active', 'title' => '', ], ], [ 'name' => 'IndexConfig', 'in' => 'query', 'schema' => ['description' => 'The configurations of the index.'."\n" ."\n" .'> You must specify either IndexStatus or IndexConfig.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'AlterSearchIndex', 'changeSet' => [ ['createdAt' => '2023-11-23T03:41:49.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-22T08:19:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AlterSearchIndex'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:AlterSearchIndex', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'AlterSearchLib' => [ 'summary' => 'Modifies a search library.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'SearchLibConfig', 'in' => 'query', 'schema' => ['description' => 'The configuration of the search library, in JSON string format. The fields include the following:'."\n" ."\n" .'- faceGroupIds: The IDs of custom face recognition libraries. You can create these libraries by calling the CreateRecognitionLib operation. You can specify up to three library IDs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'SearchLibName' => ['description' => 'The name of the search library.', 'type' => 'string', 'example' => 'test1', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AlterSearchLib', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:AlterSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'BatchCreateVodPackagingAsset' => [ 'summary' => 'Ingests multiple assets for VOD packaging.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'Assets', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The assets that you want to ingest.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'An asset that you want to ingest.', 'type' => 'object', 'properties' => [ 'AssetName' => ['description' => 'The name of the asset. The name must be unique and can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '30min_movie'], 'ContentId' => ['description' => 'The content ID in the digital rights management (DRM) system. The maximum length is 256 characters. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'movie'], 'Input' => [ 'title' => '', 'description' => 'The asset input configurations.', 'type' => 'object', 'properties' => [ 'Media' => ['description' => 'The URL of the media file. You can only specify a M3U8 file stored in Object Storage Service (OSS).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'OSS://***test-bucket***/***video/input.m3u8'], 'Type' => ['description' => 'The input type. Only OSS is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'OSS'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The results of asset ingestion.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'GroupName' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'example' => 'vod_hls'], 'ResultList' => [ 'title' => '', 'description' => 'The results of asset ingestion.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The result of ingesting an asset.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The error code for failed ingestion.', 'type' => 'string', 'title' => '', 'example' => 'InvalidParameter.PackagingAssetAlreadyExists'], 'Message' => ['description' => 'The error message for failed ingestion.', 'type' => 'string', 'title' => '', 'example' => 'The specified packagingAsset "inputMovie" already exists'], 'Asset' => ['description' => 'The information about the ingested asset.', '$ref' => '#/components/schemas/VodPackagingAsset', 'title' => '', 'example' => ''], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"GroupName\\": \\"vod_hls\\",\\n \\"ResultList\\": [\\n {\\n \\"Code\\": \\"InvalidParameter.PackagingAssetAlreadyExists\\",\\n \\"Message\\": \\"The specified packagingAsset \\\\\\"inputMovie\\\\\\" already exists\\",\\n \\"Asset\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\"\\n },\\n \\"CreateTime\\": \\"\\",\\n \\"ContentId\\": \\"\\",\\n \\"AssetName\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'BatchCreateVodPackagingAsset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:BatchCreateVodPackagingAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'BatchGetMediaInfos' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of media asset IDs to query.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', 'title' => ''], ], [ 'name' => 'AdditionType', 'in' => 'query', 'schema' => ['description' => 'The types of additional media asset information to return. If this parameter is not specified, only basic information is returned. Valid values are:'."\n" ."\n" .'-FileInfo'."\n" ."\n" .'-DynamicMetaData', 'type' => 'string', 'required' => false, 'example' => 'FileInfo,DynamicMetaData', 'title' => ''], ], [ 'name' => 'AuthTimeout', 'in' => 'query', 'schema' => ['description' => 'The authentication timeout, in seconds.'."\n" ."\n" .'- Minimum value: **1**.'."\n" ."\n" .'- Maximum value: 86400.'."\n" ."\n" .'- Default value: 3600.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaInfos' => [ 'title' => '', 'description' => 'A list of media assets.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'title' => '', 'example' => '******c48fb37407365d4f2cd8******'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'The basic information about the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The media ID.', 'type' => 'string', 'example' => '******c48fb37407365d4f2cd8******'], 'InputURL' => ['description' => 'The URL of the media asset in its source system.', 'type' => 'string', 'title' => '', 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], 'MediaType' => ['description' => 'The media type. Valid values:'."\n" ."\n" .'- `Image`'."\n" ."\n" .'- `Video`'."\n" ."\n" .'- `Audio`'."\n" ."\n" .'- `Text`', 'type' => 'string', 'title' => '', 'example' => 'video'], 'BusinessType' => ['description' => 'The business type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'general'], 'Source' => ['description' => 'The source. Valid values:'."\n" ."\n" .'- `OSS`'."\n" ."\n" .'- `VOD`', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'The title.', 'type' => 'string', 'title' => '', 'example' => 'title'], 'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'description'], 'Category' => ['description' => 'The category.', 'type' => 'string', 'title' => '', 'example' => 'category1'], 'MediaTags' => ['description' => 'The tags.', 'type' => 'string', 'title' => '', 'example' => 'tag1, tag2'], 'CoverURL' => ['description' => 'The cover URL.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'title' => '', 'example' => 'userDataTest'], 'Snapshots' => ['description' => 'The snapshots.', 'type' => 'string', 'title' => '', 'example' => '['."\n" .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",'."\n" .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=",'."\n" .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token="'."\n" .']'], 'Status' => ['description' => 'The status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'TranscodeStatus' => ['description' => 'The transcoding status.', 'type' => 'string', 'title' => '', 'example' => 'Init'], 'CreateTime' => ['description' => 'The time the media asset was created.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:10Z'], 'ModifiedTime' => ['description' => 'The time the media asset was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:12Z'], 'DeletedTime' => ['description' => 'The time the media asset was deleted.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:10Z'], 'SpriteImages' => ['description' => 'The sprite images.', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], 'Biz' => ['description' => 'The business associated with the media asset.', 'type' => 'string', 'example' => 'ICE', 'title' => ''], ], 'example' => '', ], 'FileInfoList' => [ 'title' => '', 'description' => 'A list of basic file information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'The basic information about the file, such as the duration and file size.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'example'], 'FileStatus' => ['description' => 'The file status.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'title' => '', 'example' => 'source_file'], 'FileSize' => ['description' => 'The file size, in bytes.', 'type' => 'string', 'title' => '', 'example' => '30611502'], 'FileUrl' => ['description' => 'The OSS URL of the file.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['description' => 'The region where the file is stored.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'FormatName' => ['description' => 'The container format.', 'type' => 'string', 'title' => '', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2'], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'title' => '', 'example' => '1132.68'], 'Width' => ['description' => 'The width.', 'type' => 'string', 'title' => '', 'example' => '1920'], 'Height' => ['description' => 'The height.', 'type' => 'string', 'title' => '', 'example' => '1080'], ], 'example' => '', ], 'AudioStreamInfoList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The index of the stream.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecName' => ['description' => 'The short name of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecLongName' => ['description' => 'The full name of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTimeBase' => ['description' => 'The time base of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTagString' => ['description' => 'The codec tag string.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTag' => ['description' => 'The codec tag.', 'type' => 'string', 'title' => '', 'example' => ''], 'Profile' => ['description' => 'The profile.', 'type' => 'string', 'title' => '', 'example' => ''], 'SampleFmt' => ['description' => 'The sample format.', 'type' => 'string', 'title' => '', 'example' => ''], 'SampleRate' => ['description' => 'The sample rate.', 'type' => 'string', 'title' => '', 'example' => ''], 'Channels' => ['description' => 'The number of audio channels.', 'type' => 'string', 'title' => '', 'example' => ''], 'ChannelLayout' => ['description' => 'The channel layout.', 'type' => 'string', 'title' => '', 'example' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'title' => '', 'example' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'title' => '', 'example' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'title' => '', 'example' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'title' => '', 'example' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'title' => '', 'example' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'title' => '', 'example' => ''], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'description' => 'The details of an audio stream.', 'title' => '', 'example' => '', ], 'description' => 'The audio streams.', 'title' => '', 'example' => '', ], 'VideoStreamInfoList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The index of the stream.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecName' => ['description' => 'The short name of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecLongName' => ['description' => 'The full name of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'Profile' => ['description' => 'The profile.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTimeBase' => ['description' => 'The time base of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTagString' => ['description' => 'The codec tag string.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTag' => ['description' => 'The codec tag.', 'type' => 'string', 'title' => '', 'example' => ''], 'Width' => ['description' => 'The width of the video.', 'type' => 'string', 'title' => '', 'example' => ''], 'Height' => ['description' => 'The height of the video.', 'type' => 'string', 'title' => '', 'example' => ''], 'HasBFrames' => ['description' => 'Indicates whether B-frames exist.', 'type' => 'string', 'title' => '', 'example' => ''], 'Sar' => ['description' => 'The sample aspect ratio (SAR).', 'type' => 'string', 'title' => '', 'example' => ''], 'Dar' => ['description' => 'The display aspect ratio (DAR).', 'type' => 'string', 'title' => '', 'example' => ''], 'PixFmt' => ['description' => 'The pixel format.', 'type' => 'string', 'title' => '', 'example' => ''], 'Level' => ['description' => 'The level.', 'type' => 'string', 'title' => '', 'example' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'title' => '', 'example' => ''], 'AvgFPS' => ['description' => 'The average frame rate.', 'type' => 'string', 'title' => '', 'example' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'title' => '', 'example' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'title' => '', 'example' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'title' => '', 'example' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'title' => '', 'example' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'title' => '', 'example' => ''], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'title' => '', 'example' => ''], 'Rotate' => ['description' => 'The rotation angle.', 'type' => 'string', 'title' => '', 'example' => ''], 'Nb_frames' => ['description' => 'This parameter is an alias for `NumFrames`.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'description' => 'The details of a video stream.', 'title' => '', 'example' => '', ], 'description' => 'The video streams.', 'title' => '', 'example' => '', ], 'SubtitleStreamInfoList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The index of the stream.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecName' => ['description' => 'The short name of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecLongName' => ['description' => 'The full name of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTimeBase' => ['description' => 'The time base of the codec.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTagString' => ['description' => 'The codec tag string.', 'type' => 'string', 'title' => '', 'example' => ''], 'CodecTag' => ['description' => 'The codec tag.', 'type' => 'string', 'title' => '', 'example' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'title' => '', 'example' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'title' => '', 'example' => ''], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'title' => '', 'example' => ''], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'description' => 'The details of a subtitle stream.', 'title' => '', 'example' => '', ], 'description' => 'The subtitle streams.', 'title' => '', 'example' => '', ], ], 'description' => 'The basic information about the file.', 'title' => '', 'example' => '', ], 'example' => '', ], 'MediaDynamicInfo' => [ 'type' => 'object', 'properties' => [ 'DynamicMetaData' => [ 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The content of the dynamic metadata.', 'type' => 'string', 'example' => 'system', 'title' => ''], ], 'description' => 'The type of dynamic metadata. Valid values:'."\n" ."\n" .'- `"ai"`: Standardized data derived from raw AI results.'."\n" ."\n" .'- `"user-defined"`: The user-defined metadata.'."\n" ."\n" .'- `"system"`: The system-generated data.', 'title' => '', 'example' => '', ], ], 'description' => 'The dynamic information about the media asset.', 'title' => '', 'example' => '', ], ], 'description' => 'The details of a media asset.', 'title' => '', 'example' => '', ], 'example' => '', ], 'IgnoredList' => [ 'type' => 'array', 'items' => ['description' => 'The ID of a media asset for which information could not be retrieved.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'description' => 'A list of media IDs for which information could not be retrieved.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => [], 'title' => 'BatchGetMediaInfos', 'summary' => 'Retrieves information for multiple media assets in a single request by providing their `mediaId` values.', 'changeSet' => [ ['createdAt' => '2025-11-30T06:01:24.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-07-02T09:50:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-04-22T09:50:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetMediaInfos'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:BatchGetMediaInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"******c48fb37407365d4f2cd8******\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"******c48fb37407365d4f2cd8******\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"category1\\",\\n \\"MediaTags\\": \\"tag1, tag2\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"UserData\\": \\"userDataTest\\",\\n \\"Snapshots\\": \\"[\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\\\\\",\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=\\\\\\",\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=\\\\\\"\\\\n]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:12Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"Biz\\": \\"ICE\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"200\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"SampleFmt\\": \\"\\",\\n \\"SampleRate\\": \\"\\",\\n \\"Channels\\": \\"\\",\\n \\"ChannelLayout\\": \\"\\",\\n \\"Timebase\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"Duration\\": \\"\\",\\n \\"Bitrate\\": \\"\\",\\n \\"Fps\\": \\"\\",\\n \\"NumFrames\\": \\"\\",\\n \\"Lang\\": \\"\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"Profile\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Width\\": \\"\\",\\n \\"Height\\": \\"\\",\\n \\"HasBFrames\\": \\"\\",\\n \\"Sar\\": \\"\\",\\n \\"Dar\\": \\"\\",\\n \\"PixFmt\\": \\"\\",\\n \\"Level\\": \\"\\",\\n \\"Fps\\": \\"\\",\\n \\"AvgFPS\\": \\"\\",\\n \\"Timebase\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"Duration\\": \\"\\",\\n \\"Bitrate\\": \\"\\",\\n \\"NumFrames\\": \\"\\",\\n \\"Lang\\": \\"\\",\\n \\"Rotate\\": \\"\\",\\n \\"Nb_frames\\": \\"\\"\\n }\\n ],\\n \\"SubtitleStreamInfoList\\": [\\n {\\n \\"Index\\": \\"\\",\\n \\"CodecName\\": \\"\\",\\n \\"CodecLongName\\": \\"\\",\\n \\"CodecTimeBase\\": \\"\\",\\n \\"CodecTagString\\": \\"\\",\\n \\"CodecTag\\": \\"\\",\\n \\"Timebase\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"Duration\\": \\"\\",\\n \\"Lang\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"MediaDynamicInfo\\": {\\n \\"DynamicMetaData\\": {\\n \\"Data\\": \\"system\\"\\n }\\n }\\n }\\n ],\\n \\"IgnoredList\\": [\\n \\"****20b48fb04483915d4f2cd8ac****\\"\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'BatchGetYikeAIAppJob' => [ 'summary' => 'Retrieves a batch of Yike AI Application Generation Tasks.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'A list of job IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'cec2c13da767c090,ca3d3c9737f04586', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'JobList' => [ 'description' => 'The list of jobs. Each object mirrors the details returned by the `GetYikeAIAppJob` operation.', 'type' => 'array', 'items' => [ 'description' => 'A job object.', 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => '9e09955d662a', 'title' => ''], 'AppInputConfig' => ['description' => 'The AI application\'s input parameters, formatted as a JSON-serialized string.', 'type' => 'string', 'example' => '{\\"LoadImage.1.TargetImage\\":\\"MediaId1\\"}', 'title' => ''], 'ExecutionFinishTime' => ['description' => 'The time the job execution finished. The time is in UTC and formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2026-02-06T18:53:34.001+08:00', 'title' => ''], 'ExecutionStartTime' => ['description' => 'The time the job execution started. The time is in UTC and formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2026-02-06T18:53:18.809+08:00', 'title' => ''], 'FolderId' => ['description' => 'The ID of the folder.', 'type' => 'string', 'example' => 'pd_0617169475', 'title' => ''], 'JobId' => ['description' => 'The ID of the job.', 'type' => 'string', 'example' => '****a046-263c-3560-978a-fb287782****', 'title' => ''], 'ProductionId' => ['description' => 'The ID of the project.', 'type' => 'string', 'example' => 'pd_0617169475', 'title' => ''], 'Result' => [ 'description' => 'The execution result of the job.', 'type' => 'object', 'properties' => [ 'ImageResult' => [ 'description' => 'The image result.', 'type' => 'array', 'items' => [ 'description' => 'An image result object.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '318d6350a57d71f08c9ae7f7d4496302', 'title' => ''], 'OutputUrl' => ['description' => 'The output URL.', 'type' => 'string', 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AudioResult' => [ 'description' => 'The audio result.', 'type' => 'array', 'items' => [ 'description' => 'An audio result object.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => 'bb1dfa20a0c971f08c94e7f6d6496202', 'title' => ''], 'OutputUrl' => ['description' => 'The output URL.', 'type' => 'string', 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.mp3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'VideoResult' => [ 'description' => 'The video result.', 'type' => 'array', 'items' => [ 'description' => 'A video result object.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => 'ec2de25068fd71f0a48cf7e6c4596302', 'title' => ''], 'OutputUrl' => ['description' => 'The output URL.', 'type' => 'string', 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Status' => ['description' => 'The status of the job. Valid values are:'."\n" ."\n" .'- `Created`: The job has been created.'."\n" ."\n" .'- `Queuing`: The job is in the queue.'."\n" ."\n" .'- `Executing`: The job is executing.'."\n" ."\n" .'- `Finished`: The job completed successfully.'."\n" ."\n" .'- `Failed`: The job failed to complete.', 'type' => 'string', 'example' => 'Created', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Batch retrieve AI application jobs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:BatchGetYikeAIAppJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobList\\": [\\n {\\n \\"AppId\\": \\"9e09955d662a\\",\\n \\"AppInputConfig\\": \\"{\\\\\\\\\\\\\\"LoadImage.1.TargetImage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MediaId1\\\\\\\\\\\\\\"}\\",\\n \\"ExecutionFinishTime\\": \\"2026-02-06T18:53:34.001+08:00\\",\\n \\"ExecutionStartTime\\": \\"2026-02-06T18:53:18.809+08:00\\",\\n \\"FolderId\\": \\"pd_0617169475\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"ProductionId\\": \\"pd_0617169475\\",\\n \\"Result\\": {\\n \\"ImageResult\\": [\\n {\\n \\"MediaId\\": \\"318d6350a57d71f08c9ae7f7d4496302\\",\\n \\"OutputUrl\\": \\"https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg\\\\n\\"\\n }\\n ],\\n \\"AudioResult\\": [\\n {\\n \\"MediaId\\": \\"bb1dfa20a0c971f08c94e7f6d6496202\\",\\n \\"OutputUrl\\": \\"https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.mp3\\"\\n }\\n ],\\n \\"VideoResult\\": [\\n {\\n \\"MediaId\\": \\"ec2de25068fd71f0a48cf7e6c4596302\\",\\n \\"OutputUrl\\": \\"https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.mp4\\"\\n }\\n ]\\n },\\n \\"Status\\": \\"Created\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'BatchGetYikeAssetMediaInfos' => [ 'summary' => 'Retrieves multiple media assets.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'The media asset IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaInfos' => [ 'description' => 'The list of matched media assets.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A media asset object.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '******c48fb37407365d4f2cd8******'], 'MediaBasicInfo' => [ 'description' => 'The basic information about the media asset.', 'title' => '', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '*****64623a94eca8516569c8f*****'], 'InputURL' => ['title' => '', 'description' => 'The source URL of the media asset.', 'type' => 'string', 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], 'MediaType' => ['title' => '', 'description' => 'The type of the media asset.', 'type' => 'string', 'example' => 'video'], 'BusinessType' => ['title' => '', 'description' => 'The business type.', 'type' => 'string', 'example' => 'general'], 'Source' => ['title' => '', 'description' => 'The source of the media asset.', 'type' => 'string', 'example' => 'oss'], 'Title' => ['title' => '', 'description' => 'The title of the media asset.', 'type' => 'string', 'example' => 'title'], 'Description' => ['title' => '', 'description' => 'The description of the media asset.', 'type' => 'string', 'example' => 'sample_description'], 'Category' => ['title' => '', 'description' => 'The category of the media asset.', 'type' => 'string', 'example' => 'category'], 'MediaTags' => ['title' => '', 'description' => 'The tags of the media asset.', 'type' => 'string', 'example' => 'tag1，tag2'], 'CoverURL' => ['title' => '', 'description' => 'The URL of the cover image.', 'type' => 'string', 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg'], 'UserData' => ['title' => '', 'description' => 'The custom user data.', 'type' => 'string', 'example' => 'UserData'], 'Snapshots' => ['title' => '', 'description' => 'The snapshots.', 'type' => 'string', 'example' => '[]'], 'Status' => ['title' => '', 'description' => 'The status of the media asset.', 'type' => 'string', 'example' => 'Normal'], 'TranscodeStatus' => ['title' => '', 'description' => 'The transcoding status.', 'type' => 'string', 'example' => 'Init'], 'CreateTime' => ['title' => '', 'description' => 'The time when the media asset was created.', 'type' => 'string', 'example' => '2020-12-26T04:11:08Z'], 'ModifiedTime' => ['title' => '', 'description' => 'The time when the media asset was last modified.', 'type' => 'string', 'example' => '2021-01-08T16:52:04Z'], 'DeletedTime' => ['title' => '', 'description' => 'The time when the media asset was deleted.', 'type' => 'string', 'example' => '2021-01-08T16:52:07Z'], 'SpriteImages' => ['title' => '', 'description' => 'The sprite images.', 'type' => 'string', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], 'Biz' => ['description' => 'The business to which the media asset belongs.', 'type' => 'string', 'example' => 'ICE', 'title' => ''], ], 'example' => '', ], 'FileInfoList' => [ 'description' => 'The list of file information.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The file information.', 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'description' => 'The basic information about the file, including the duration and size.', 'title' => '', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'The name of the file.', 'type' => 'string', 'example' => 'example.mp4'], 'FileStatus' => ['title' => '', 'description' => 'The status of the file.', 'type' => 'string', 'example' => 'Normal'], 'FileType' => ['title' => '', 'description' => 'The type of the file.', 'type' => 'string', 'example' => 'source_file'], 'FileSize' => ['title' => '', 'description' => 'The size of the file, in bytes.', 'type' => 'string', 'example' => '191'], 'FileUrl' => ['title' => '', 'description' => 'The OSS URL of the file.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['title' => '', 'description' => 'The region where the file is stored.', 'type' => 'string', 'example' => 'cn-shanghai'], 'FormatName' => ['title' => '', 'description' => 'The container format of the file.', 'type' => 'string', 'example' => 'jpg'], 'Duration' => ['title' => '', 'description' => 'The duration of the file.', 'type' => 'string', 'example' => '200'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate.', 'type' => 'string', 'example' => '30'], 'Width' => ['title' => '', 'description' => 'The width.', 'type' => 'string', 'example' => '640'], 'Height' => ['title' => '', 'description' => 'The height.', 'type' => 'string', 'example' => '416'], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'BizData' => [ 'description' => 'The business data.', 'type' => 'object', 'properties' => [ 'FolderId' => ['description' => 'The ID of the folder.', 'type' => 'string', 'example' => 'pd_0617169475', 'title' => ''], 'ProductionId' => ['description' => 'The ID of the production.', 'type' => 'string', 'example' => 'pd_0617169475', 'title' => ''], 'AuditBlockedLabel' => ['description' => 'The audit label.', 'type' => 'string', 'example' => 'Label', 'title' => ''], 'AuditStatus' => ['description' => 'The audit status.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'MediaAssetType' => ['description' => 'The type of the media asset.', 'type' => 'string', 'example' => 'HistoricalUpload', 'title' => ''], 'MediaAssetSubType' => ['description' => 'The sub-type of the media asset.', 'type' => 'string', 'example' => 'Image', 'title' => ''], 'SourceType' => ['description' => 'The source type.', 'type' => 'string', 'example' => 'MainBody', 'title' => ''], 'SourceId' => ['description' => 'The source ID.', 'type' => 'string', 'example' => 'f4a26390f02371f0a1f4e6e7c7586706', 'title' => ''], 'SourceName' => ['description' => 'The source name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'IsFavorite' => ['description' => 'Indicates whether the media asset is a favorite.', 'type' => 'string', 'example' => '1', 'title' => ''], 'IsLogicalDeleted' => ['description' => 'Indicates whether the media asset is logically deleted.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CreationJobId' => ['description' => 'The ID of the creation job.', 'type' => 'string', 'example' => 'ID', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'IgnoredList' => [ 'description' => 'The list of IDs of media assets that failed to be obtained.', 'type' => 'array', 'items' => ['description' => 'The ID of the media asset that failed to be obtained.', 'type' => 'string', 'example' => '****fb2101bf24bf41cb318787dc****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => [], 'title' => 'Batch Retrieve Media Asset Details ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:BatchGetYikeAssetMediaInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"******c48fb37407365d4f2cd8******\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"*****64623a94eca8516569c8f*****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title\\",\\n \\"Description\\": \\"sample_description\\",\\n \\"Category\\": \\"category\\",\\n \\"MediaTags\\": \\"tag1，tag2\\",\\n \\"CoverURL\\": \\"https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg\\",\\n \\"UserData\\": \\"UserData\\",\\n \\"Snapshots\\": \\"[]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"DeletedTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"Biz\\": \\"ICE\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"191\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"jpg\\",\\n \\"Duration\\": \\"200\\",\\n \\"Bitrate\\": \\"30\\",\\n \\"Width\\": \\"640\\",\\n \\"Height\\": \\"416\\"\\n }\\n }\\n ],\\n \\"BizData\\": {\\n \\"FolderId\\": \\"pd_0617169475\\",\\n \\"ProductionId\\": \\"pd_0617169475\\",\\n \\"AuditBlockedLabel\\": \\"Label\\",\\n \\"AuditStatus\\": \\"pass\\",\\n \\"MediaAssetType\\": \\"HistoricalUpload\\",\\n \\"MediaAssetSubType\\": \\"Image\\",\\n \\"SourceType\\": \\"MainBody\\",\\n \\"SourceId\\": \\"f4a26390f02371f0a1f4e6e7c7586706\\",\\n \\"SourceName\\": \\"name\\",\\n \\"IsFavorite\\": \\"1\\",\\n \\"IsLogicalDeleted\\": \\"1\\",\\n \\"CreationJobId\\": \\"ID\\"\\n }\\n }\\n ],\\n \\"IgnoredList\\": [\\n \\"****fb2101bf24bf41cb318787dc****\\"\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'CancelDNAJob' => [ 'summary' => 'Cancels a media fingerprint analysis job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media fingerprint analysis job that you want to cancel.', 'type' => 'string', 'required' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58'], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\"\\n}","type":"json"}]', 'title' => 'CancelDNAJob', 'description' => '- You can cancel a media fingerprint analysis job only if the job is in the Queuing state.'."\n" ."\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.', 'changeSet' => [ ['createdAt' => '2023-05-25T07:23:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelDNAJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CancelDNAJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CancelFavoritePublicMedia' => [ 'summary' => 'Removes all specified media assets from favorites based on the input mediaId list.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'IMS media asset ID.'."\n" ."\n" .'- Separate multiple IDs with commas.', 'type' => 'string', 'required' => false, 'example' => 'icepublic-****7213c6050cbc66750b469701****,icepublic-****0b4697017213c6050cbc6675****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'IgnoredList' => [ 'type' => 'array', 'items' => ['description' => 'List of IDs for which removing from favorites failed.', 'type' => 'string', 'example' => 'icepublic-****7213c6050cbc66750b469701****', 'title' => ''], 'description' => 'List of IDs for which removing from favorites failed.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"icepublic-****7213c6050cbc66750b469701****\\"\\n ]\\n}","type":"json"}]', 'title' => 'Remove public copyright media assets from favorites', 'changeSet' => [ ['createdAt' => '2021-11-25T06:45:51.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelFavoritePublicMedia'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CancelFavoritePublicMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CancelIProductionJob' => [ 'summary' => 'Invoke CancelIProductionJob to cancel an Intelligent Production job.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the intelligent production job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'Idempotency parameter', 'type' => 'string', 'required' => false, 'example' => '****12e8864746a0a398****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'AccessDeniedDetail' => [ 'description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.', 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => 'The operation that failed the permission check.', 'type' => 'string', 'example' => 'ice:CancelIProductionJob', 'title' => ''], 'AuthPrincipalDisplayName' => ['description' => 'The identity. Values:'."\n" ."\n" .'- RAM user: a UID'."\n" ."\n" .'- RAM role: RoleName:RoleSessionName'."\n" ."\n" .'- Federated user: ProviderType/ProviderName', 'type' => 'string', 'example' => '****4522705967****', 'title' => ''], 'AuthPrincipalOwnerId' => ['description' => 'The account to which the principal belongs.', 'type' => 'string', 'example' => '****82303720****', 'title' => ''], 'AuthPrincipalType' => ['description' => 'The type of identity that made the request. Valid values:'."\n" ."\n" .'- SubUser: RAM user'."\n" ."\n" .'- AssumedRoleUser: RAM role'."\n" ."\n" .'- Federated: SSO federated user', 'type' => 'string', 'example' => 'SubUser', 'title' => ''], 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => '******AAZ/h8jzNEODc5QUUyLUZCOTAtNUQyQy1BMEFBLUUzODQxODUx******==', 'title' => ''], 'NoPermissionType' => ['description' => 'The type of policy that resulted in the denial. Valid values:'."\n" ."\n" .'- **ImplicitDeny**: The resource holder has not configured a policy for the current user. By default, unauthorized operations are denied.'."\n" ."\n" .'- **ExplicitDeny**: The RAM policy configured by the resource holder explicitly denies the current user access to the corresponding resources.', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], 'PolicyType' => ['description' => 'The type of policy that triggered the permission failure.'."\n" ."\n" .'- **ControlPolicy**: control policy'."\n" ."\n" .'- **SessionPolicy**: an additional policy attached to a temporary token.'."\n" ."\n" .'- **AssumeRolePolicy**: the trust policy of a RAM role.'."\n" ."\n" .'- **AccountLevelIdentityBasedPolicy**: an identity-based policy at the account level (custom or system).'."\n" ."\n" .'- **ResourceGroupLevelIdentityBasedPolicy**: an identity-based policy scoped to a resource group.', 'type' => 'string', 'example' => 'AssumeRolePolicy', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Message\\": \\"Success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"ice:CancelIProductionJob\\",\\n \\"AuthPrincipalDisplayName\\": \\"****4522705967****\\",\\n \\"AuthPrincipalOwnerId\\": \\"****82303720****\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"******AAZ/h8jzNEODc5QUUyLUZCOTAtNUQyQy1BMEFBLUUzODQxODUx******==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"AssumeRolePolicy\\"\\n }\\n}","type":"json"}]', 'title' => 'Cancel Intelligent Production Job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:CancelIProductionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ClearAIAgentVoiceprint' => [ 'summary' => 'Clears the voiceprint associated with a voiceprint ID.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'VoiceprintId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the voiceprint to clear.', 'type' => 'string', 'required' => false, 'example' => 'vp_1699123456_8527', 'title' => ''], ], [ 'name' => 'RegistrationMode', 'in' => 'query', 'schema' => [ 'description' => 'The registration mode. The default is `Explicit`.', 'enumValueTitles' => ['Explicit' => 'Explicit registration mode', 'Implicit' => 'Implicit registration mode'], 'type' => 'string', 'required' => false, 'example' => 'Explicit', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'ClearAIAgentVoiceprint', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ClearAIAgentVoiceprint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CloseMediaConnectFlowFailover' => [ 'summary' => 'Disables Source Failover for a MediaConnect flow.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => false, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '391DDF25-705C-5B38-9DB9-7A6B00D6065A'], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Content' => ['description' => 'The response body.', 'type' => 'string', 'example' => '""', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"391DDF25-705C-5B38-9DB9-7A6B00D6065A\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', 'title' => 'CloseMediaConnectFlowFailover', 'description' => '- If a flow has two sources, you cannot disable Source Failover. Delete one of them before this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CloseMediaConnectFlowFailover', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CloseStreamToSearchLib' => [ 'summary' => 'Stops the tagging and analysis process for a live stream media asset.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****c469e944b5a856828dc2****'."\n", 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\\\n\\"\\n}","type":"json"}]', 'title' => 'CloseStreamToSearchLib', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:CloseStreamToSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateAudit' => [ 'summary' => 'Submits manual review results for media assets.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'AuditContent', 'in' => 'query', 'schema' => ['description' => 'The review results. You can specify the results for a maximum of 20 videos at a time. The value must be converted to a string. For more information about the parameters in AuditContent, see the "AuditContent" section of this topic.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '['."\n" .' {'."\n" .' "MediaId": "93ab850b4f*****b54b6e91d24d81d4",'."\n" .' "Status": "Normal"'."\n" .' },'."\n" .' {'."\n" .' "MediaId": "f867fbfb58*****8bbab65c4480ae1d",'."\n" .' "Status": "Blocked",'."\n" .' "Reason": "xxxx",'."\n" .' "Comment": "xxxx"'."\n" .' }'."\n" .']', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'CreateAudit', 'requestParamsDescription' => '## AuditContent'."\n" ."\n" .'| Parameter | Type | Required | Description |'."\n" .'| --------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| MediaId | String | Yes | The ID of the audio or video file. |'."\n" .'| Status | String | Yes | The review result of the audio or video file. Value values: **Blocked** and **Normal**. |'."\n" .'| Reason | String | No | The reason for blocking the audio or video file if you set Status to Blocked. The reason can be up to 128 bytes in length. |'."\n" .'| Comment | String | No | The review comment. The review comment can be up to 512 bytes in length. |', 'changeSet' => [ ['createdAt' => '2023-09-13T05:49:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-08T10:53:22.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudit'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:CreateAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateAvatarTrainingJob' => [ 'summary' => 'Creates an avatar training job. You can configure the basic information of the avatar and the materials required for the training.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AvatarName', 'in' => 'query', 'schema' => ['description' => '- The name of the digital human.'."\n" ."\n" .'- The name can be up to seven characters in length.', 'type' => 'string', 'example' => 'Decimal', 'required' => true, 'maxLength' => 7, 'title' => ''], ], [ 'name' => 'AvatarDescription', 'in' => 'query', 'schema' => ['description' => '- The description of the digital human.'."\n" ."\n" .'- The description can be up to 1,000 characters in length.', 'type' => 'string', 'example' => 'This is a digital human used for a specific scenario.', 'maxLength' => 1027, 'required' => false, 'title' => ''], ], [ 'name' => 'AvatarType', 'in' => 'query', 'schema' => ['description' => 'The type of the digital human.', 'type' => 'string', 'required' => false, 'example' => '2DAvatar', 'title' => ''], ], [ 'name' => 'Thumbnail', 'in' => 'query', 'schema' => ['description' => '- The thumbnail URL.'."\n" ."\n" .'- After the digital human is trained, the thumbnail is uploaded to this URL.'."\n" ."\n" .'- The URL must be a valid public Object Storage Service (OSS) URL.'."\n" ."\n" .'- The URL can be up to 512 characters in length.', 'type' => 'string', 'maxLength' => 512, 'required' => false, 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', 'title' => ''], ], [ 'name' => 'Portrait', 'in' => 'query', 'schema' => ['description' => '- The media asset ID of the portrait image.'."\n" ."\n" .'- The value must be 32 characters in length.', 'type' => 'string', 'maxLength' => 32, 'minLength' => 32, 'required' => false, 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], ], [ 'name' => 'Video', 'in' => 'query', 'schema' => ['description' => '- The ID of the video used for training.'."\n" ."\n" .'- The value must be 32 characters in length.'."\n" ."\n" .'- Supported formats: MP4, MOV, and WebM.'."\n" ."\n" .'- The duration of the video must be 5 to 15 minutes.'."\n" ."\n" .'- The resolution of the video must be 1920×1080 or 1080×1920.', 'type' => 'string', 'maxLength' => 32, 'minLength' => 32, 'required' => false, 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], ], [ 'name' => 'Transparent', 'in' => 'query', 'schema' => ['description' => '- Specifies whether the training video supports alpha channels.'."\n" ."\n" .' \\*\\*'."\n" ."\n" .' **Note**: Make sure that the current settings are consistent with those of the submitted training video. Otherwise, the digital human may malfunction.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'example' => '****d718e2ff4f018ccf419a7b71****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateAvatarTrainingJob', 'description' => 'This API is only used to initialize trainingTaskrelatedInformation,And will not submit training,To officially submit training, you need toCall [SubmitAvatarTrainingJob](~~2526196~~) API.', 'changeSet' => [ ['createdAt' => '2023-08-17T08:43:05.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAvatarTrainingJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateAvatarTrainingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateChannel' => [ 'summary' => 'Creates a channel in MediaWeaver.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ 'name' => 'ChannelTier', 'in' => 'query', 'schema' => ['description' => 'The tier of the channel. Valid values: basic and standard.', 'type' => 'string', 'required' => true, 'example' => 'basic', 'title' => ''], ], [ 'name' => 'PlaybackMode', 'in' => 'query', 'schema' => ['description' => 'The playback mode. Valid values: loop and linear.', 'type' => 'string', 'required' => true, 'example' => 'loop', 'title' => ''], ], [ 'name' => 'AccessPolicy', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable access control.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AccessToken', 'in' => 'query', 'schema' => ['description' => 'The token for accessing the channel.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''], ], [ 'name' => 'FillerSourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The source location of the filler slate.', 'type' => 'string', 'required' => false, 'example' => 'MySourceLocation', 'title' => ''], ], [ 'name' => 'FillerSourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the filler slate.', 'type' => 'string', 'required' => false, 'example' => 'FillerSource', 'title' => ''], ], [ 'name' => 'OutPutConfigList', 'in' => 'query', 'schema' => ['description' => 'The channel output configurations.', 'type' => 'string', 'required' => true, 'example' => '[{'."\n" .' "ManifestName": "manifest-1",'."\n" .' "Format": "HLS",'."\n" .' "SourceGroupName": "source-group-1",'."\n" .' "ManifestSettings": {'."\n" .' "WindowDuration": 60,'."\n" .' "AdMarkType": "Daterange"'."\n" .' }'."\n" .'}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Channel' => ['description' => 'The channel information.', '$ref' => '#/components/schemas/ChannelAssemblyChannel', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"MySource\\",\\n \\"FillerSourceLocationName\\": \\"MySourceLocation\\",\\n \\"GmtCreate\\": \\"2024-01-15T03:44:16Z\\\\n\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"ChannelTier\\": \\"basic\\",\\n \\"AccessToken\\": \\"xxxxx\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"2024-09-01T10:09Z\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::channel/myChannel\\\\n\\",\\n \\"PlaybackMode\\": \\"loop\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"index1\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"Format\\": \\"hls\\",\\n \\"PlaybackUrl\\": \\"https://xxxxx.com/xxx.m3u8\\\\n\\",\\n \\"ManifestSettings\\": \\"{\\\\\\"WindowDuration\\\\\\": 60,\\\\\\"AdMarkType\\\\\\":\\\\\\"Daterange\\\\\\"}\\\\n\\",\\n \\"SourceGroupName\\": \\"group1\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', 'title' => 'CreateChannel', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateCustomTemplate' => [ 'summary' => 'Creates a custom media processing template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'test-template', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The template type. Valid values:'."\n" ."\n" .'- 1: transcoding template.'."\n" ."\n" .'- 2: snapshot template.'."\n" ."\n" .'- 3: animated image template.'."\n" ."\n" .'- 4\\. image watermark template.'."\n" ."\n" .'- 5: text watermark template.'."\n" ."\n" .'- 6: subtitle template.'."\n" ."\n" .'- 7: AI-assisted content moderation template.'."\n" ."\n" .'- 8: AI-assisted intelligent thumbnail template.'."\n" ."\n" .'- 9: AI-assisted intelligent erasure template.'."\n" ."\n" .'- 10: AI-assisted media fingerprint analysis template.'."\n" ."\n" .'- 11: AI-assisted smart tagging template.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Subtype', 'in' => 'query', 'schema' => ['description' => 'The template subtype.'."\n" ."\n" .'Valid values for transcoding templates:'."\n" ."\n" .'- 1 (Normal): regular template.'."\n" ."\n" .'- 2 (AudioTranscode): audio transcoding template.'."\n" ."\n" .'- 3 (Remux): container format conversion template.'."\n" ."\n" .'- 4 (NarrowBandV1): Narrowband HD 1.0 template.'."\n" ."\n" .'- 5 (NarrowBandV2): Narrowband HD 2.0 template.'."\n" ."\n" .'Valid values for snapshot templates:'."\n" ."\n" .'- 1 (Normal): regular template.'."\n" ."\n" .'- 2 (Sprite): sprite template.'."\n" ."\n" .'- 3 (WebVtt): WebVTT template.'."\n" ."\n" .'Valid values for AI-assisted content moderation templates:'."\n" ."\n" .'- 1 (Video): video moderation template.'."\n" ."\n" .'- 2 (Audio): audio moderation template.'."\n" ."\n" .'- 3 (Image): image moderation template.'."\n" ."\n" .'Valid values for AI-assisted intelligent erasure templates.'."\n" ."\n" .'- 1 (VideoDelogo): logo erasure template.'."\n" ."\n" .'- 2 (VideoDetext): subtitle erasure template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'schema' => ['description' => 'The template configurations. For more information, see [Template parameters](~~448291~~).', 'type' => 'string', 'required' => true, 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'CustomTemplate' => [ 'title' => '', 'description' => 'The template information.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'test-template', 'title' => ''], 'Type' => ['description' => 'The type ID of the template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TypeName' => ['description' => 'The type name of the template.', 'type' => 'string', 'example' => 'TranscodeTemplate', 'title' => ''], 'Subtype' => ['description' => 'The subtype name of the template.', 'type' => 'string', 'example' => 'Remux', 'title' => ''], 'Status' => ['description' => 'The template state.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the template is the default template.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TemplateConfig' => ['description' => 'The template configurations.', 'type' => 'string', 'title' => '', 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}'], 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2022-04-19T02:04:31Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2022-04-19T02:04:31Z', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"CustomTemplate\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": \\"Remux\\",\\n \\"Status\\": \\"Normal\\",\\n \\"IsDefault\\": true,\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"flv\\\\\\"},\\\\\\"Video\\\\\\":{},\\\\\\"Audio\\\\\\":{}}\\",\\n \\"CreateTime\\": \\"2022-04-19T02:04:31Z\\",\\n \\"ModifiedTime\\": \\"2022-04-19T02:04:31Z\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateCustomTemplate', 'changeSet' => [ ['createdAt' => '2022-07-18T03:29:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-11T09:38:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CreateCustomTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateCustomizedVoiceJob' => [ 'summary' => 'Creates a voice cloning job and initializes its basic information.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'VoiceId', 'in' => 'query', 'schema' => ['description' => 'The custom voice ID. This is typically an English name or Pinyin.'."\n" ."\n" .'- Must be unique among your other custom voices.'."\n" ."\n" .'- Must be 32 characters or fewer.'."\n" ."\n" .'- Can contain only letters and numbers.', 'type' => 'string', 'required' => true, 'maxLength' => 32, 'minLength' => 0, 'example' => 'xiaozhuan', 'title' => ''], ], [ 'name' => 'VoiceName', 'in' => 'query', 'schema' => ['description' => 'The voice name, typically in Chinese.'."\n" ."\n" .'- Must be 32 characters or fewer.', 'type' => 'string', 'required' => false, 'maxLength' => 32, 'minLength' => 0, 'example' => '小专', 'title' => ''], ], [ 'name' => 'VoiceDesc', 'in' => 'query', 'schema' => ['description' => 'The voice description.'."\n" ."\n" .'- Must be 256 characters or fewer.', 'type' => 'string', 'maxLength' => 256, 'minLength' => 0, 'required' => false, 'example' => '这是一个个性化声音', 'title' => ''], ], [ 'name' => 'Gender', 'in' => 'query', 'schema' => [ 'description' => 'The gender. Valid values:'."\n" ."\n" .'- female'."\n" ."\n" .'- male', 'type' => 'string', 'required' => true, 'enum' => ['female', 'male'], 'example' => 'female', 'title' => '', ], ], [ 'name' => 'Scenario', 'in' => 'query', 'schema' => [ 'description' => 'The scenario. Valid values:'."\n" ."\n" .'- story'."\n" ."\n" .'- interaction'."\n" ."\n" .'- navigation', 'type' => 'string', 'required' => true, 'enum' => ['story', 'interaction', 'navigation'], 'example' => 'story', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'VoiceId' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'xiaozhuan', 'title' => ''], 'JobId' => ['description' => 'The voice cloning job ID.', 'type' => 'string', 'example' => '****29faef8144638ba42eb8e037****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"JobId\\": \\"****29faef8144638ba42eb8e037****\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateCustomizedVoiceJob', 'description' => ''."\n" ."\n" .'- Billing for voice cloning is based on customization and usage. For more information, see [Voice cloning billing](~~2399891#section-gy3-80e-clt~~).'."\n" ."\n" .''."\n" ."\n\n" .'- Call this operation to achieve entertainment-grade results. You need to record 20 predefined scripts. The system then extracts key voiceprint features to perform voice cloning quickly and cost-effectively.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomizedVoiceJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateCustomizedVoiceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateDNADB' => [ 'summary' => 'Use the CreateDNADB operation to create a DNA database.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the DNA database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example name', 'title' => ''], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => ['description' => 'The DNA database model. Valid values:'."\n" ."\n" .'- **Video**: For video content.'."\n" ."\n" .'- **Audio**: For audio content.'."\n" ."\n" .'- **Image**: For image content. (Deprecated)'."\n" ."\n" .'- **Text**: For text content. Supported only in the China (Shanghai) region. (Deprecated)', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => 'Video', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the DNA database.', 'type' => 'string', 'required' => false, 'example' => '这是一个视频DNA库。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58'], 'DBInfo' => [ 'description' => 'The details of the DNA database.', 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'The description of the DNA database.', 'type' => 'string', 'example' => '这是一个视频DNA库。', 'title' => ''], 'Name' => ['description' => 'The name of the DNA database.', 'type' => 'string', 'example' => 'example name', 'title' => ''], 'Status' => ['description' => 'After you create the database, its status is `offline` by default. The status automatically changes to `active` after the backend completes processing.', 'type' => 'string', 'example' => 'offline', 'title' => ''], 'DBId' => ['description' => 'The DNA database ID. Save this ID for use in subsequent API calls.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'Model' => ['description' => 'The DNA database model.', 'type' => 'string', 'example' => 'Video', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"DBInfo\\": {\\n \\"Description\\": \\"这是一个视频DNA库。\\",\\n \\"Name\\": \\"example name\\",\\n \\"Status\\": \\"offline\\",\\n \\"DBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Model\\": \\"Video\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateDNADB', 'description' => 'By default, each user can create up to five DNA databases. To increase this limit, please [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?spm=a2c4g.11186623.0.0.645019b6Btnu4q). You can use the DeleteDNADB operation to delete DNA databases that you no longer need.', 'changeSet' => [ ['createdAt' => '2023-05-25T07:23:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDNADB'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CreateDNADB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateEditingProject' => [ 'summary' => 'Creates an online editing project. You can specify configurations such as the title, description, timeline, and thumbnail for the project.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the online editing project.', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the online editing project.', 'type' => 'string', 'example' => 'Description', 'title' => '', 'required' => false], ], [ 'name' => 'Timeline', 'in' => 'formData', 'schema' => ['description' => 'The timeline of the online editing project, in the JSON format.', 'type' => 'string', 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', 'title' => '', 'required' => false], ], [ 'name' => 'CoverURL', 'in' => 'query', 'schema' => ['description' => 'The thumbnail URL of the online editing project.', 'type' => 'string', 'example' => 'https://example.com/example.png', 'title' => '', 'required' => false], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID. This parameter is used to quickly build a timeline with ease. Note: Only one of Timeline and TemplateId can be specified. If TemplateId is specified, ClipsParam must also be specified.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****96e8864746a0b6f3****'], ], [ 'name' => 'ClipsParam', 'in' => 'query', 'schema' => ['description' => 'The material parameter corresponding to the template, in the JSON format. If TemplateId is specified, ClipsParam must also be specified. For more information, see [Create and use a regular template](https://help.aliyun.com/document_detail/328557.html) and [Create and use an advanced template](https://help.aliyun.com/document_detail/291418.html).', 'type' => 'string', 'example' => 'See the template user guide.', 'title' => '', 'required' => false], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => 'The template type. This parameter is required if you create a template-based online editing project. Default value: Timeline. Valid values:'."\n" ."\n" .'- Timeline: a regular template.'."\n" ."\n" .'- VETemplate: an advanced template.', 'enumValueTitles' => ['Timeline' => '', 'VETemplate' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Timeline', ], ], [ 'name' => 'MaterialMaps', 'in' => 'query', 'schema' => ['description' => 'The material associated with the project. Separate multiple material IDs with commas (,). Each type supports up to 10 material IDs.', 'type' => 'string', 'example' => '{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\\"appName\\":\\"testrecord\\",\\"domainName\\":\\"test.alivecdn.com\\",\\"liveUrl\\":\\"rtmp://test.alivecdn.com/testrecord/teststream\\",\\"streamName\\":\\"teststream\\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"}', 'title' => '', 'required' => false], ], [ 'name' => 'BusinessConfig', 'in' => 'query', 'schema' => ['description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.'."\n" ."\n" .'For a live stream editing project, observe the following rules: OutputMediaConfig.StorageLocation is required. OutputMediaConfig.Path is optional. If you do not specify this option, the live streaming clips are stored in the root directory by default.'."\n" ."\n" .'Valid values of OutputMediaTarget include vod-media and oss-object. If you do not specify OutputMediaTarget, the default value oss-object is used.'."\n" ."\n" .'If you set OutputMediaTarget to vod-media, the setting of OutputMediaConfig.Path does not take effect.', 'type' => 'string', 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', 'title' => '', 'required' => false], ], [ 'name' => 'ProjectType', 'in' => 'query', 'schema' => ['description' => 'The type of the editing project. Valid values: EditingProject and LiveEditingProject. A value of EditingProject indicates a regular editing project, and a value of LiveEditingProject indicates a live stream editing project.', 'type' => 'string', 'example' => 'LiveEditingProject', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'Project' => [ 'description' => 'The information about the online editing project.', 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'example' => '****01bf24bf41c78b2754cb3187****', 'title' => ''], 'Title' => ['description' => 'The title of the online editing project.', 'type' => 'string', 'example' => 'example_title', 'title' => ''], 'Description' => ['description' => 'The description of the online editing project.', 'type' => 'string', 'example' => 'example_description', 'title' => ''], 'Timeline' => ['description' => 'The timeline of the online editing project, in the JSON format.For more information about objects in a timeline, see [Timeline configurations](https://help.aliyun.com/document_detail/198823.htm?spm=a2c4g.11186623.2.9.90dc653dF67srN#topic-2024662). If you leave this parameter empty, an empty timeline is created and the duration of the online editing project is zero.', 'type' => 'string', 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => '****96e8864746a0b6f3****'], 'ClipsParam' => ['description' => 'The template material parameters.', 'type' => 'string', 'example' => 'See the template user guide.', 'title' => ''], 'CoverURL' => ['description' => 'The thumbnail URL of the online editing project.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', 'title' => ''], 'Status' => ['description' => 'The status of the online editing project.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'\\- 1: Draft'."\n" ."\n" .'\\- 2: Editing'."\n" ."\n" .'\\- 3: Producing'."\n" ."\n" .'\\- 4: Produced'."\n" ."\n" .'\\- 5: ProduceFailed'."\n" ."\n" .'\\- 7: Deleted', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'StatusName' => ['description' => 'The status of the online editing project. For more information, see the status list.', 'type' => 'string', 'example' => 'Editing', 'title' => ''], 'CreateTime' => ['description' => 'The time when the online editing project was created.', 'type' => 'string', 'example' => '2021-01-08T16:52:07Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the online editing project was last edited.', 'type' => 'string', 'example' => '2021-01-08T16:52:07Z', 'title' => ''], 'Duration' => ['description' => 'The duration of the online editing project.', 'type' => 'number', 'format' => 'float', 'example' => '3.4200000', 'title' => ''], 'CreateSource' => ['description' => 'The method for creating the online editing project. Valid values:'."\n" ."\n" .'\\- OpenAPI'."\n" ."\n" .'\\- AliyunConsole'."\n" ."\n" .'\\- WebSDK'."\n" ."\n" .'\\- LiveEditingOpenAPI'."\n" ."\n" .'\\- LiveEditingConsole', 'type' => 'string', 'example' => 'WebSDK', 'title' => ''], 'ModifiedSource' => ['description' => 'The method for editing the online editing project. Valid values:'."\n" ."\n" .'\\- OpenAPI'."\n" ."\n" .'\\- AliyunConsole'."\n" ."\n" .'\\- WebSDK'."\n" ."\n" .'\\- LiveEditingOpenAPI'."\n" ."\n" .'\\- LiveEditingConsole', 'type' => 'string', 'example' => 'WebSDK', 'title' => ''], 'TemplateType' => ['description' => 'The template type of the online editing project. Valid values:'."\n" ."\n" .'\\- Timeline'."\n" ."\n" .'\\- VETemplate', 'type' => 'string', 'example' => 'Timeline', 'title' => ''], 'BusinessConfig' => ['description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.', 'type' => 'string', 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', 'title' => ''], 'ProjectType' => ['description' => 'The type of the editing project. Default value: EditingProject. Valid values:'."\n" ."\n" .'\\- EditingProject: a regular editing project.'."\n" ."\n" .'\\- LiveEditingProject: a live stream editing project.', 'type' => 'string', 'example' => 'LiveEditingProject', 'title' => ''], 'BusinessStatus' => ['description' => 'The business status of the project. This parameter can be ignored for general editing projects. Valid values:'."\n" ."\n" .'- Reserving'."\n" ."\n" .'- ReservationCanceled'."\n" ."\n" .'- BroadCasting'."\n" ."\n" .'- LoadingFailed'."\n" ."\n" .'- LiveFinished', 'type' => 'string', 'example' => 'Reserving', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Project\\": {\\n \\"ProjectId\\": \\"****01bf24bf41c78b2754cb3187****\\",\\n \\"Title\\": \\"example_title\\",\\n \\"Description\\": \\"example_description\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"}]}]}\\",\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"ClipsParam\\": \\"See the template user guide.\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Status\\": 2,\\n \\"StatusName\\": \\"Editing\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"Duration\\": 3.42,\\n \\"CreateSource\\": \\"WebSDK\\",\\n \\"ModifiedSource\\": \\"WebSDK\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"BusinessConfig\\": \\"{ \\\\\\"OutputMediaConfig\\\\\\" : { \\\\\\"StorageLocation\\\\\\": \\\\\\"test-bucket.oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Path\\\\\\": \\\\\\"test-path\\\\\\" }, \\\\\\"OutputMediaTarget\\\\\\": \\\\\\"oss-object\\\\\\", \\\\\\"ReservationTime\\\\\\": \\\\\\"2021-06-21T08:05:00Z\\\\\\" }\\",\\n \\"ProjectType\\": \\"LiveEditingProject\\",\\n \\"BusinessStatus\\": \\"Reserving\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateEditingProject', 'description' => '- Billing is based on the duration of the edited video,For more informationPlease referSee[VideoEditing](~~2840899~~) and [LiveEditing](~~2840900~~) .If processing fails,No charge.'."\n" ."\n" .'- After creating the editing project,You canCall[SubmitMediaProducingJob - SubmitEditingCompositing jobAPI](~~441147~~)Submit mediaEditingSynthesisTask.Call[SubmitLiveEditingJob - Submit liveEditingTask](~~441148~~)Submit liveEditingTask.', 'changeSet' => [ ['createdAt' => '2023-11-23T01:57:57.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-03-14T03:59:43.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEditingProject'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CreateEditingProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateHotwordLibrary' => [ 'summary' => 'Creates a hotword library.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the hotword library. It can be up to 100 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'my_hotwords', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the hotword library. It can be up to 200 characters in length.', 'type' => 'string', 'example' => 'Lexicon containing celebrity names', 'title' => '', 'required' => false], ], [ 'name' => 'UsageScenario', 'in' => 'query', 'schema' => ['description' => 'The usage scenario of the hotword library. Valid values:'."\n" ."\n" .'· ASR: Automatic Speech Recognition'."\n" ."\n" .'· StructuredMediaAssets: structured media analysis'."\n" ."\n" .'· VideoTranslation: Video translation.'."\n" ."\n" .'This field cannot be modified after the hotword library is created.', 'type' => 'string', 'required' => true, 'example' => 'ASR', 'title' => ''], ], [ 'name' => 'Hotwords', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The hotword list. You can add up to 300 hotword entries to a single library.', 'type' => 'array', 'items' => ['description' => 'The hotword information.', '$ref' => '#/components/schemas/Hotword', 'title' => '', 'required' => false, 'example' => ''], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '13cbb83e-043c-4728-ac35-*****'], 'HotwordLibraryId' => ['description' => 'The ID of the hotword library.', 'type' => 'string', 'example' => '****96e8864746a0b6f3****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\",\\n \\"HotwordLibraryId\\": \\"****96e8864746a0b6f3****\\"\\n}","type":"json"}]', 'title' => 'CreateHotwordLibrary', 'description' => 'Call CreateHotwordLibrary API to create hotword library.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateHotwordLibrary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateIpcOrder' => [ 'summary' => 'Creates an IPC order with shared capacity at the account level.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'example' => 'd123', 'title' => ''], ], [ 'name' => 'Capability', 'in' => 'query', 'schema' => [ 'description' => 'The capability. Valid values:'."\n" ."\n" .'- understand: Image understanding. Supports the analysis of 300 images per day.'."\n" ."\n" .'- understand-reid: Image understanding with person re-identification (ReID). Supports the analysis of 300 images per day.'."\n" ."\n" .'- search: Search. Supports 75 searches per day.'."\n" ."\n" .'- understand-search: Image understanding and search. Supports the analysis of 300 images and 75 searches per day.'."\n" ."\n" .'- understand-reid-search: Image understanding with ReID and search. Supports the analysis of 300 images and 75 searches per day.', 'enumValueTitles' => ['understand-reid-search' => 'understand-reid-search', 'search' => 'search', 'understand-search' => 'understand-search', 'understand' => 'understand', 'understand-reid' => 'understand-reid'], 'type' => 'string', 'required' => false, 'example' => 'understand', 'title' => '', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription period. Valid values:'."\n" ."\n" .'- month: A monthly subscription, calculated as 30 days.'."\n" ."\n" .'- quarter: A quarterly subscription, calculated as 90 days.'."\n" ."\n" .'- year: An annual subscription, calculated as 365 days.', 'enumValueTitles' => ['month' => 'month', 'year' => 'year', 'quarter' => 'quarter'], 'type' => 'string', 'required' => false, 'example' => 'month', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'], 'PurchaseStatus' => ['description' => 'The purchase status.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create IPC Order', 'description' => 'Before you call this operation, make sure you understand the [billing and pricing for the IPC product](~~3004591~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateIpcOrder', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"PurchaseStatus\\": \\"Success\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateLivePackageChannel' => [ 'summary' => 'Creates a live package channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'formData', 'schema' => ['description' => 'The channel group name. It can contain letters, digits, hyphens (-), and underscores (\\_). The name must be 1 to 200 characters in length. Format: \\[A-Za-z0-9\\_-]+', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ 'name' => 'SegmentCount', 'in' => 'formData', 'schema' => ['description' => 'The number of M3U8 segments. Valid values: 2 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '3'], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['description' => 'The channel description. It can be up to 1,000 characters in length.', 'type' => 'string', 'example' => 'This is a test channel.', 'title' => '', 'required' => false], ], [ 'name' => 'SegmentDuration', 'in' => 'formData', 'schema' => ['description' => 'The segment duration. Valid values: 1 to 30.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '6'], ], [ 'name' => 'ChannelName', 'in' => 'formData', 'schema' => ['description' => 'The channel name. It can contain letters, digits, hyphens (-), and underscores (\\_). The name must be 1 to 200 characters in length. Format: \\[A-Za-z0-9\\_-]+', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****12e8864746a0a398****'], ], [ 'name' => 'Protocol', 'in' => 'formData', 'schema' => ['description' => 'The ingest protocol. Only HLS is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'HLS'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageChannel' => [ 'description' => 'The information about the live package channel.', 'type' => 'object', 'properties' => [ 'ChannelName' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'example-channel'], 'CreateTime' => ['description' => 'The time when the channel was created. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The channel description.', 'type' => 'string', 'example' => 'This is a test channel.', 'title' => ''], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'channel-group-1'], 'IngestEndpoints' => [ 'description' => 'The ingest endpoints.', 'type' => 'array', 'items' => [ 'description' => 'The information about the ingest endpoint.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The ingest endpoint ID.', 'type' => 'string', 'example' => 'ingest1', 'title' => ''], 'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => '2F9e******b569c8', 'title' => ''], 'Url' => ['description' => 'The ingest endpoint URL.', 'type' => 'string', 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', 'title' => ''], 'Username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'us12******das', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LastModified' => ['description' => 'The time when the channel was last modified. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Protocol' => ['description' => 'The ingest protocol. Only HLS is supported.', 'type' => 'string', 'title' => '', 'example' => 'HLS'], 'SegmentCount' => ['description' => 'The number of M3U8 segments.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], 'SegmentDuration' => ['description' => 'The segment duration.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"example-channel\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"This is a test channel.\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"ingest1\\",\\n \\"Password\\": \\"2F9e******b569c8\\",\\n \\"Url\\": \\"http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"Username\\": \\"us12******das\\"\\n }\\n ],\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'CreateLivePackageChannel', 'description' => '## [](#)Usage notes'."\n" ."\n" .'After you call this operation to create a live package channel, the system will automatically generate the ingest endpoint URL, and username and password required for authentication.'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'- Channel group names and channel names can contain only letters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- Only `HLS` is supported.'."\n" ."\n" .'- The segment duration must be from 1 to 30 seconds.'."\n" ."\n" .'- The number of M3U8 segments must be from 2 to 100.'."\n" ."\n" .'If the request succeeds, the system will return the details of the newly created channel, including the channel name, creation time, modification time, and ingest endpoint details.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateLivePackageChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateLivePackageChannelGroup' => [ 'summary' => 'Creates a live package channel group with a custom name and description.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238117', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'formData', 'schema' => ['description' => 'The channel group name. It can contain letters, digits, hyphens (-), and underscores (\\_). The name must be 1 to 200 characters in length. Format: \\[A-Za-z0-9\\_-]+', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-01'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****12e8864746a0a398****'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The channel group description. It can be up to 1,000 characters in length.', 'type' => 'string', 'example' => 'This is an example description.', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageChannelGroup' => [ 'description' => 'The information about the channel group.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the channel group was created. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The channel group description.', 'type' => 'string', 'example' => 'This is an example description.', 'title' => ''], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'example-group'], 'LastModified' => ['description' => 'The time when the channel group was last modified. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'OriginDomain' => ['description' => 'The origin domain.', 'type' => 'string', 'title' => '', 'example' => 'example.com'], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-426614174000', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroup\\": {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"This is an example description.\\",\\n \\"GroupName\\": \\"example-group\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"OriginDomain\\": \\"example.com\\"\\n },\\n \\"RequestId\\": \\"123e4567-e89b-12d3-a456-426614174000\\"\\n}","type":"json"}]', 'title' => 'CreateLivePackageChannelGroup', 'description' => 'After you create a channel group, the assigned origin domain is returned.', 'extraInfo' => '访问[错误中心](https://api.aliyun.com/document/ICE/2020-11-09/errorCode)查看错误码。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateLivePackageChannelGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateLivePackageOriginEndpoint' => [ 'summary' => '\\[responses_200_schema_properties_LivePackageOriginEndpoint_properties_EndpointUrl_description]Endpoint playback URL', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239771', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'formData', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ 'name' => 'ChannelName', 'in' => 'formData', 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ 'name' => 'EndpointName', 'in' => 'formData', 'schema' => ['description' => 'The origin endpoint name. It can contain letters, digits, hyphens (-), and underscores (\\_). The name must be 1 to 200 characters in length. Format: \\[A-Za-z0-9\\_-]+', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'endpoint-1'], ], [ 'name' => 'Protocol', 'in' => 'formData', 'schema' => ['description' => 'The distribution protocol.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'HLS'], ], [ 'name' => 'ManifestName', 'in' => 'formData', 'schema' => ['description' => 'The playlist name. Default value: manifest.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'manifest'], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['description' => 'The endpoint description.', 'type' => 'string', 'example' => 'This is an origin endpoint.', 'title' => '', 'required' => false], ], [ 'name' => 'TimeshiftVision', 'in' => 'formData', 'schema' => ['description' => 'The number of days that time-shifted content is available. Maximum value: 30. Default value: 0, which indicates that time shifting is not supported.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'AuthorizationCode', 'in' => 'formData', 'schema' => ['description' => 'The authorization code. It can be up to 200 characters in length. You must configure AuthorizationCode, IpWhitelist, or both. Format: \\[A-Za-z0-9-\\_.]+', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'AbcDef123'], ], [ 'name' => 'IpWhitelist', 'in' => 'formData', 'schema' => ['description' => 'The IP address whitelist. It supports subnet masks. 0.0.0.0/0 is not allowed. It can be up to 1,000 characters in length. Separate multiple IP addresses with commas (,). You must configure AuthorizationCode, IpWhitelist, or both.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '192.168.1.0/24,10.0.0.1/24'], ], [ 'name' => 'IpBlacklist', 'in' => 'formData', 'schema' => ['description' => 'The IP address blacklist. It supports subnet masks. 0.0.0.0/0 is not allowed. It can be up to 1,000 characters in length. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '103.21.222.1/32,192.168.100.0/24'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****0311a423d11a5f7dee713535****'], ], [ 'name' => 'LivePackagingConfig', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'Live stream encapsulation configuration', '$ref' => '#/components/schemas/LivePackagingConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageOriginEndpoint' => [ 'description' => 'The information about the origin endpoint.', 'type' => 'object', 'properties' => [ 'AuthorizationCode' => ['description' => 'The authorization code.', 'type' => 'string', 'title' => '', 'example' => 'Abcded123'], 'ChannelName' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'channel-1'], 'CreateTime' => ['description' => 'The time when the endpoint was created.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The endpoint description.', 'type' => 'string', 'example' => 'This is an origin endpoint.', 'title' => ''], 'EndpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'title' => '', 'example' => 'endpoint-1'], 'EndpointUrl' => ['description' => 'The endpoint URL.', 'type' => 'string', 'title' => '', 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest'], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'channel-group-1'], 'IpBlacklist' => ['description' => 'The IP address blacklist.', 'type' => 'string', 'title' => '', 'example' => '103.21.222.1/32,192.168.100.0/24'], 'IpWhitelist' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'title' => '', 'example' => '192.168.1.0/24,10.0.0.1/24'], 'LastModified' => ['description' => 'The time when the endpoint was last modified.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'ManifestName' => ['description' => 'The playlist name.', 'type' => 'string', 'title' => '', 'example' => 'manifest'], 'Protocol' => ['description' => 'The protocol. Only HLS is supported.', 'type' => 'string', 'title' => '', 'example' => 'HLS'], 'TimeshiftVision' => ['description' => 'The number of days that time-shifted content is available. Maximum value: 30.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'LivePackagingConfig' => ['description' => 'Live packaging configuration', '$ref' => '#/components/schemas/LivePackagingConfig', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abcded123\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"This is an origin endpoint.\\",\\n \\"EndpointName\\": \\"endpoint-1\\",\\n \\"EndpointUrl\\": \\"https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IpBlacklist\\": \\"103.21.222.1/32,192.168.100.0/24\\",\\n \\"IpWhitelist\\": \\"192.168.1.0/24,10.0.0.1/24\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"TimeshiftVision\\": 1,\\n \\"LivePackagingConfig\\": {\\n \\"LiveManifestConfigs\\": [\\n {\\n \\"SegmentCount\\": 3,\\n \\"AdMarkers\\": \\"NONE\\",\\n \\"MinVideoBitrate\\": 1000000,\\n \\"MinBufferTime\\": 8,\\n \\"PresentationDelay\\": 12,\\n \\"StreamOrder\\": \\"ORIGINAL\\",\\n \\"MaxVideoBitrate\\": 8000000,\\n \\"DateTimeInterval\\": 5,\\n \\"SegmentTemplateFormat\\": \\"NUMBER_TIMELINE\\",\\n \\"MinUpdatePeriod\\": 8,\\n \\"ManifestDuration\\": 60\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"9a04f079-9840-4286-ab92-e65be0885f95\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"live-axb1-9dd2fa123\\",\\n \\"EncryptionMethod\\": \\"SAMPLE_AES\\",\\n \\"IV\\": \\"00000000000000000000000000000000\\",\\n \\"Url\\": \\"https://exampledrm.com/path?arg1=xxx\\"\\n },\\n \\"SegmentDuration\\": 6\\n }\\n },\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => '创建实时打包源站端点', 'description' => '\\[responses\\_200\\_schema\\_properties\\_LivePackageOriginEndpoint\\_properties\\_EndpointUrl\\_title]Endpoint URL', 'changeSet' => [ ['createdAt' => '2025-05-29T03:09:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateLivePackageOriginEndpoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateLiveRecordTemplate' => [ 'summary' => 'Use this operation to create a Live Record Template. You can use the template to submit Live Recording Jobs.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RecordFormat', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of recording formats.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'A recording format object.', 'type' => 'object', 'properties' => [ 'Format' => [ 'description' => 'The recording format.'."\n" ."\n" .'> If you set this parameter to `m3u8`, you must also specify the `SliceOssObjectPrefix` and `SliceDuration` parameters.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'enum' => ['m3u8', 'mp4', 'flv'], 'title' => '', 'example' => 'm3u8', ], 'SliceDuration' => ['description' => 'The duration of each slice in seconds.'."\n" ."\n" .'> This parameter is valid only when `Format` is set to `m3u8`.'."\n" ."\n" .'The default value is 30. The value must be an integer from 5 to 30.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'required' => false, 'example' => '30'], 'OssObjectPrefix' => ['description' => 'The name of the Recording File stored in Object Storage Service (OSS).'."\n" ."\n" .'- The file name must be less than 256 bytes and supports the following variables: {JobId}, {Sequence}, {StartTime}, {EndTime}, {EscapedStartTime}, and {EscapedEndTime}.'."\n" ."\n" .'- The value must include either the {StartTime} or {EscapedStartTime} variable and either the {EndTime} or {EscapedEndTime} variable.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}'], 'SliceOssObjectPrefix' => ['description' => 'The name of the TS slice.'."\n" ."\n" .'> This parameter is required only when `Format` is set to `m3u8`.'."\n" ."\n" .'- The file name must be less than 256 bytes and supports the following variables: {JobId}, {UnixTimestamp}, and {Sequence}.'."\n" ."\n" .'- The value must include the {UnixTimestamp} and {Sequence} variables.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'required' => false, 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}'], 'CycleDuration' => ['description' => 'The duration of a recording cycle in seconds. If you omit this parameter, it defaults to 6 hours.'."\n" ."\n" .'> - If a stream interruption during a recording cycle lasts less than 3 minutes, the recording continues in the same Recording File.'."\n" ."\n" .'- A Recording File is finalized only after a stream interruption lasts for more than 3 minutes. To change this default 3-minute threshold, submit a ticket.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'required' => false, 'example' => '3600', 'title' => ''], ], 'deprecated' => false, 'required' => false, 'example' => '', ], 'deprecated' => false, 'required' => true, 'example' => '', ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the Live Record Template.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The ID of the Live Record Template.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'readOnly' => true, 'default' => '', 'title' => '', 'example' => '****96e8864746a0b6f3****'], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\"\\n}","type":"json"}]', 'title' => 'CreateLiveRecordTemplate', 'description' => 'Live recording requires a Live Record Template. You can use a template to configure settings such as the recording format (for example, M3U8, MP4, or FLV) and the duration of Recording Files.', 'changeSet' => [ ['createdAt' => '2022-08-18T07:45:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-08-17T07:09:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveRecordTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CreateLiveRecordTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateLiveSnapshotTemplate' => [ 'summary' => 'Create a live stream snapshot template to facilitate the creation of snapshot jobs.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateName', 'in' => 'formData', 'schema' => ['description' => 'The name of the template.'."\n" ."\n" .'- It cannot exceed 128 characters in length.', 'type' => 'string', 'example' => 'Template 1', 'required' => true, 'title' => ''], ], [ 'name' => 'OverwriteFormat', 'in' => 'formData', 'schema' => ['description' => 'The naming format of the snapshot captured in overwrite mode.'."\n" ."\n" .'- The value cannot start with a forward slash (/). Only the suffix .jpg is supported.'."\n" ."\n" .'- It cannot exceed 255 characters in length.'."\n" ."\n" .'- The {JobId} placeholder is supported. It specifies the ID of the snapshot job.'."\n" ."\n" .'- Placeholders such as {UnixTimestamp}, {Sequence}, and {Date} are not allowed.'."\n" ."\n" .'- You must specify at least one of the OverwriteFormat and SequenceFormat parameters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'snapshot/{JobId}.jpg'], ], [ 'name' => 'SequenceFormat', 'in' => 'formData', 'schema' => ['description' => 'The naming format of the snapshot captured in time series mode.'."\n" ."\n" .'- The value cannot start with a forward slash (/). Only the suffix .jpg is supported.'."\n" ."\n" .'- It cannot exceed 255 characters in length.'."\n" ."\n" .'- The {JobId}, {Date}, {UnixTimestamp}, and {Sequence} placeholders are supported. {JobId} specifies the ID of the snapshot job. {Date} specifies the date on which the snapshot is captured. {UnixTimestamp} specifies the timestamp of the snapshot. {Sequence} specifies the sequence number of the snapshot. You must specify at least one of the {UnixTimestamp} and {Sequence} placeholders.'."\n" ."\n" .'- You must specify at least one of the OverwriteFormat and SequenceFormat parameters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg'], ], [ 'name' => 'TimeInterval', 'in' => 'formData', 'schema' => ['description' => 'The interval between two adjacent snapshots. Unit: seconds.'."\n" ."\n" .'- Valid values: \\[5,3600].', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '5'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\"\\n}","type":"json"}]', 'title' => 'CreateLiveSnapshotTemplate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveSnapshotTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CreateLiveSnapshotTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateLiveTranscodeTemplate' => [ 'summary' => 'Creates a live stream transcoding template, which can be referenced when submitting a transcoding job.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the template. Valid values:'."\n" ."\n" .'- normal'."\n" ."\n" .'- narrow-band'."\n" ."\n" .'- audio-only'."\n" ."\n" .'- origin', 'type' => 'string', 'required' => true, 'enum' => ['normal', 'narrow-band', 'audio-only', 'origin'], 'title' => '', 'example' => 'normal', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the template.', 'type' => 'string', 'required' => true, 'maxLength' => 20, 'minLength' => 1, 'example' => 'my template', 'title' => ''], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The configuration of the template.', 'type' => 'object', 'properties' => [ 'VideoParams' => [ 'description' => 'The video parameters.', 'type' => 'object', 'properties' => [ 'Codec' => [ 'description' => 'The encoding type. Valid values:'."\n" ."\n" .'- H.264'."\n" ."\n" .'- H.265', 'type' => 'string', 'required' => false, 'enum' => ['H.264', 'H.265'], 'example' => 'H.264', 'title' => '', ], 'Height' => ['description' => 'The height of the output video. Valid values: Height ≥ 128 max (Height,Width) ≤ 2560 min (Height,Width) ≤ 1440'."\n" ."\n" .'Note: The resolution of the output video that is transcoded by using the H.265 Narrowband HD transcoding template cannot exceed 1280 × 720 pixels.', 'type' => 'string', 'required' => false, 'example' => '720', 'title' => ''], 'Width' => ['description' => 'The width of the output video. Valid values: Width ≥ 128 max (Height,Width) ≤ 2560 min (Height,Width) ≤ 1440'."\n" ."\n" .'Note: The resolution of the output video that is transcoded by using the H.265 Narrowband HD transcoding template cannot exceed 1280 × 720 pixels.', 'type' => 'string', 'required' => false, 'example' => '1280', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the output video. Unit: frames per second (FPS). Valid values: 1 to 60.', 'type' => 'string', 'required' => false, 'example' => '25', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the output video. Unit: Kbit/s. Valid values: 1 to 6000.', 'type' => 'string', 'required' => false, 'example' => '2500', 'title' => ''], 'Gop' => ['description' => 'The group of pictures (GOP) of the output video. Unit: frame. Valid values: 1 to 3000.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], 'Profile' => [ 'description' => 'The encoding profile. The profile determines how a video is encoded. In most cases, a greater value indicates better image quality and higher resource consumption. Valid values: 1: baseline. This value is suitable for mobile devices. 2: main. This value is suitable for standard-definition devices. 3: high. This value is suitable for high-definition devices.', 'type' => 'string', 'enum' => ['1', '2', '3'], 'required' => false, 'example' => '2', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'AudioParams' => [ 'description' => 'The audio parameters.', 'type' => 'object', 'properties' => [ 'Codec' => [ 'description' => 'The audio codec. Valid values:'."\n" ."\n" .'- AAC'."\n" ."\n" .'- MP3', 'type' => 'string', 'enum' => ['AAC', 'MP3'], 'required' => false, 'example' => 'AAC', 'title' => '', ], 'Bitrate' => ['description' => 'The bitrate of the output audio. Unit: Kbit/s. Valid values: 1 to 1000.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], 'Samplerate' => ['description' => 'The audio sampling rate. Valid values: 22050 to 96000.'."\n" ."\n" .'Note: If you set AudioProfile to aac\\_ld, the audio sampling rate cannot exceed 44,100.', 'type' => 'string', 'required' => false, 'example' => '44100', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels. Valid values: 1: mono 2: binaural', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], 'Profile' => [ 'description' => 'The audio codec profile. Valid values when the Codec parameter is set to AAC:'."\n" ."\n" .'- aac\\_low'."\n" ."\n" .'- aac\\_he'."\n" ."\n" .'- aac\\_he\\_v2'."\n" ."\n" .'- aac\\_ld', 'type' => 'string', 'enum' => ['aac_low', 'aac_he', 'aac_he_v2', 'aac_ld'], 'required' => false, 'example' => 'aaclow', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the template.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParam.Height', 'errorMessage' => 'Invalid Parameters: Height', 'description' => ''], ['errorCode' => 'InvalidParam.Width', 'errorMessage' => 'Invalid Parameters: Width', 'description' => ''], ['errorCode' => 'InvalidParam.Fps', 'errorMessage' => 'Invalid Parameters: Fps', 'description' => ''], ], 403 => [ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', 'title' => 'CreateLiveTranscodeTemplate', 'description' => 'Only Shanghai region supports real-time media transcoding.', 'changeSet' => [ ['createdAt' => '2022-08-23T07:57:11.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveTranscodeTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CreateLiveTranscodeTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateMediaConnectFlow' => [ 'summary' => 'Creates a MediaConnect flow.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'query', 'schema' => ['description' => 'The flow name.', 'type' => 'string', 'required' => true, 'example' => 'AliTestFlow', 'title' => ''], ], [ 'name' => 'FlowRegion', 'in' => 'query', 'schema' => ['description' => 'The region in which the flow resides.', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '86D92F9D-65E8-58A2-85D1-9DEEECC172E8', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"FlowId\\": \\"34900dc6-90ec-4968-af3c-fcd87f231a5f\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"86D92F9D-65E8-58A2-85D1-9DEEECC172E8\\"\\n}","type":"json"}]', 'title' => 'CreateMediaConnectFlow', 'description' => '- The flow names cannot be duplicated in the same region.'."\n" ."\n" .'- Take note of the returned flow ID. You may reference it in other API operations.', 'changeSet' => [ ['createdAt' => '2025-01-23T06:18:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateMediaConnectFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateMediaLiveChannel' => [ 'summary' => 'Creates a MediaLive channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the channel. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mych'], ], [ 'name' => 'InputAttachments', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The associated inputs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InputId' => ['description' => 'The ID of the associated input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myinput'], 'LanguageName' => ['description' => 'The tag that identifies the language of the RTMP input. It can be referenced by the output. The maximum length is 32 characters. Supported characters:'."\n" ."\n" .'- Unicode letters'."\n" ."\n" .'- Digits (0-9)'."\n" ."\n" .'- Underscore (\\_)'."\n" ."\n" .'- Hyphen (-)'."\n" ."\n" .'- Space (a space cannot be at the beginning or end)', 'type' => 'string', 'required' => false, 'example' => 'English', 'title' => ''], 'AudioSelectors' => [ 'title' => '', 'description' => 'The audio selectors.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the audio selector. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myselector'], 'AudioLanguageSelection' => [ 'title' => '', 'description' => 'The audio language selection.', 'type' => 'object', 'properties' => [ 'LanguageCode' => ['description' => 'Enter a three-letter ISO 639-2 language code from within an audio source.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eng'], ], 'required' => false, 'example' => '', ], 'AudioPidSelection' => [ 'title' => '', 'description' => 'The audio PID selection.', 'type' => 'object', 'properties' => [ 'Pid' => ['title' => '', 'description' => 'Enter a specific PID from within a source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], 'required' => false, 'example' => '', ], 'AudioTrackSelection' => [ 'title' => '', 'description' => 'The audio track selection.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TrackId' => ['description' => 'Specify one or more audio tracks from within a source using Track ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], [ 'name' => 'OutputGroups', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The output groups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the output group. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'group1'], 'Type' => ['description' => 'The output group type. Only MediaPackage is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'MediaPackage'], 'Outputs' => [ 'title' => '', 'description' => 'The outputs in the output group.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the output. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'output1'], 'MediaType' => ['description' => 'The media type of the output. Valid values:'."\n" ."\n" .'- 0: Audio and Video.'."\n" ."\n" .'- 1: Audio. If you set the value to 1, you cannot reference VideoSettings.'."\n" ."\n" .'- 2: Video. If you set the value to 2, you cannot reference AudioSettings.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], 'MediaPackageOutputSetting' => [ 'title' => '', 'description' => 'The settings of the output delivered to MediaPackage.', 'type' => 'object', 'properties' => [ 'NameModifier' => ['description' => 'The manifest name modifier. The child manifests include this modifier in their M3U8 file names. Letters, digits, hyphens (-), and underscores (\\_) are supported. The maximum length is 40 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '480p'], 'AudioGroupId' => ['description' => 'The manifest audio group ID. To associate several audio tracks into one group, assign the same audio group ID. Viewers can select a track as needed. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 40 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'audiogroup'], ], 'required' => false, 'example' => '', ], 'VideoSettingName' => ['description' => 'The name of the referenced VideoSettings.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'myVideo1'], 'AudioSettingNames' => [ 'title' => '', 'description' => 'The referenced AudioSettings.', 'type' => 'array', 'items' => ['description' => 'The name of the referenced AudioSettings.', 'type' => 'string', 'required' => false, 'example' => 'myAudio1', 'title' => ''], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'MediaPackageGroupSetting' => [ 'title' => '', 'description' => 'The MediaPackage destination.', 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => 'GroupName in MediaPackage.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myPackageGroup'], 'ChannelName' => ['description' => 'ChannelName in MediaPackage.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myPackageChannel'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], [ 'name' => 'AudioSettings', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The audio settings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the audio settings. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'audio1'], 'AudioSelectorName' => ['description' => 'The name of the audio selector.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'a1'], 'LanguageCode' => ['description' => 'Enter a three-letter ISO 639-2 language code. If the audio track selected by the audio selector has a language code, the language code specified in the audio selector is used. If the selected audio track does not have a language code, or if the audio selector cannot find a track that matches its criteria, this language code is used.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'eng'], 'LanguageName' => ['description' => 'The tag that identifies the language of the RTMP input. It can be referenced by the output. The maximum length is 32 characters. Supported characters:'."\n" ."\n" .'- Unicode letters'."\n" ."\n" .'- Digits (0-9)'."\n" ."\n" .'- Underscore (\\_)'."\n" ."\n" .'- Hyphen (-)'."\n" ."\n" .'- Space (a space cannot be at the beginning or end)', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'English'], 'AudioCodec' => ['description' => 'The audio codec. If it is not specified, the source specification is used. Valid values: aac and libfdk\\_aac.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'libfdk_aac'], 'AudioCodecSetting' => [ 'title' => '', 'description' => 'The audio encoding settings.', 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The audio codec profile. When AudioCodec is set to aac, AAC-LOW and AAC-MAIN are supported. When AudioCodec is set to libfdk\\_aac, AAC-LOW, AAC-HE, and AAC-HEV2 are supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AAC-LOW'], 'Bitrate' => ['description' => 'The audio bitrate. Unit: bit/s. Valid values: 8000 to 1000000. The value must be divisible by 1000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '200000'], 'SampleRate' => ['description' => 'The audio sample rate. Unit: Hz. Valid values: 22050, 32000, 44100, 48000, and 96000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '44100'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'VideoSettings', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The video settings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the video settings. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'video1'], 'Width' => ['description' => 'The width of the output. If you set it to 0 or leave it empty, the width automatically adapts to the specified height to maintain the original aspect ratio.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- For regular transcoding, the larger dimension cannot exceed 3840 px, and the smaller one cannot exceed 2160 px.'."\n" ."\n" .'- For Narrowband HD™ transcoding, the larger dimension cannot exceed 1920 px, and the smaller one cannot exceed 1080 px.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1280'], 'Height' => ['description' => 'The height of the output. If you set it to 0 or leave it empty, the height automatically adapts to the specified width to maintain the original aspect ratio.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- For regular transcoding, the larger dimension cannot exceed 3840 px, and the smaller one cannot exceed 2160 px.'."\n" ."\n" .'- For Narrowband HD™ transcoding, the larger dimension cannot exceed 1920 px, and the smaller one cannot exceed 1080 px.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '720'], 'VideoCodec' => ['description' => 'The video codec. Valid values: H264 and H265.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'H264'], 'VideoCodecSetting' => [ 'title' => '', 'description' => 'The video encoding settings.', 'type' => 'object', 'properties' => [ 'Rate' => [ 'title' => '', 'description' => 'The video encoding rate. If it is not specified, the source specification is used.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'The video bitrate. Unit: bit/s. If you set it to 0 or leave it empty, the source specification is used. Valid values: 50000 to 6000000. The value must be divisible by 1000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '2500000'], 'RateControlMode' => ['description' => 'The bitrate control mode. Valid values: CBR, ABR, and VBR.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ABR'], 'MaxBitrate' => ['description' => 'The maximum bitrate. Unit: bit/s. Valid values: 100000 to 6000000. The value must be divisible by 1000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '6000000'], 'BufferSize' => ['description' => 'The video buffer size. Unit: bit/s. Valid values: 100000 to 6000000. The value must be divisible by 1000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '6000000'], ], 'required' => false, 'example' => '', ], 'Framerate' => [ 'title' => '', 'description' => 'The frame rate. If it is not specified, the source specification is used.', 'type' => 'object', 'properties' => [ 'FramerateControl' => ['description' => 'The frame rate mode. Valid values: SPECIFIED (fixed frame rate) and FROM\\_SOURCE (use source specification).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'SPECIFIED'], 'FramerateNumerator' => ['description' => 'The numerator of the fixed frame rate. The parameter is required when FramerateControl is set to SPECIFIED. Valid values: 1 to 60. The numerator must be divisible by the denominator.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '25'], 'FramerateDenominator' => ['description' => 'The denominator of the fixed frame rate. The parameter is required when FramerateControl is set to SPECIFIED. Valid values: 1 to 60. The numerator must be divisible by the denominator.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], 'required' => false, 'example' => '', ], 'Gop' => [ 'title' => '', 'description' => 'The GOP setting. If it is not specified, the source specification is used.', 'type' => 'object', 'properties' => [ 'GopSizeUnits' => ['description' => 'The GOP size unit. Valid values: FRAMES and SECONDS.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FRAMES'], 'GopSize' => ['description' => 'The GOP size. When GopSizeUnits is set to SECONDS, the value range is from 1 to 20. When GopSizeUnits is set to FRAMES, the value range is from 1 to 3000.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '90'], 'BframesNum' => ['description' => 'The number of B frames. Valid values: 1 to 3.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '3'], ], 'required' => false, 'example' => '', ], 'CodecDetail' => [ 'title' => '', 'description' => 'The video encoding settings.', 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The H.264 profile. Valid values: BASELINE, HIGH, and MAIN. Default value: MAIN. The parameter takes effect only when the codec is H.264.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'MAIN'], 'Level' => ['description' => 'The video encoding level. It is not supported yet.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'H264_LEVEL_AUTO'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'VideoCodecType' => ['description' => 'The video transcoding method. Valid values:'."\n" ."\n" .'- NORMAL: regular transcoding'."\n" ."\n" .'- NBHD: Narrowband HD™ transcoding'."\n" ."\n" .'If not specified, regular transcoding is used by default.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'NORMAL'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'ChannelId' => ['description' => 'The ID of the channel.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"ChannelId\\": \\"SEGK5KA6KYKAWQQH\\"\\n}","type":"json"}]', 'title' => 'CreateMediaLiveChannel', 'description' => '## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [ ['createdAt' => '2025-05-14T07:43:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMediaLiveChannel'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateMediaLiveChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateMediaLiveInput' => [ 'summary' => 'Create a live media input.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the input. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myinput'], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => ['description' => 'The input type. Valid values: RTMP\\_PUSH, RTMP\\_PULL, SRT\\_PUSH, SRT\\_PULL, and MEDIA\\_CONNECT.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'RTMP_PUSH'], ], [ 'name' => 'SecurityGroupIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The IDs of the security groups to be associated with the input. This parameter is required for PUSH inputs.', 'type' => 'array', 'items' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => false, 'example' => 'G6G4X5T4SZYPSTT5', 'title' => ''], 'required' => false, 'example' => '["G6G4X5T4SZYPSTT5"]', ], ], [ 'name' => 'InputSettings', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The input settings. An input can have up to two sources: primary and backup sources.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StreamName' => ['description' => 'The name of the pushed stream. This parameter is required for PUSH inputs. It can be up to 255 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'mystream', 'title' => ''], 'SourceUrl' => ['description' => 'The source URL from which the stream is pulled. This parameter is required for PULL inputs.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://domain/app/stream', 'title' => ''], 'FlowId' => ['description' => 'The ID of the flow from MediaConnect. This parameter is required when Type is set to MEDIA\\_CONNECT.', 'type' => 'string', 'required' => false, 'example' => '******81-9693-40dc-bbab-db5e49******', 'title' => ''], 'FlowOutputName' => ['description' => 'The output name of the MediaConnect flow. This parameter is required when Type is set to MEDIA\\_CONNECT.', 'type' => 'string', 'required' => false, 'example' => 'myFlowOutputName', 'title' => ''], 'SrtMaxBitrate' => ['title' => '', 'description' => 'The maximum bitrate of the SRT stream, in bits per second (bps). Valid values: \\[100, 100000000]. This parameter is optional when Type is SRT\\_PUSH or SRT\\_PULL.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000000'], 'SrtLatency' => ['title' => '', 'description' => 'The latency of the SRT stream, in milliseconds (ms). Valid values: \\[100, 10000]. This parameter is optional when Type is SRT\\_PUSH or SRT\\_PULL.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], 'SrtPassphrase' => ['title' => '', 'description' => 'The SRT encryption configuration. The password for the SRT stream consists of 10 to 79 visible ASCII characters. This parameter is optional when Type is SRT\\_PUSH or SRT\\_PULL.'."\n" ."\n" .'If the encryption configuration is not empty, all SRT clients must use the correct password to publish or playback; otherwise, the SRT connection will be denied.', 'type' => 'string', 'required' => false, 'example' => 'srtencryption'], 'SrtPbKeyLen' => ['title' => '', 'description' => 'The SRT encryption configuration. The key length for the SRT stream. Valid values: 0, 16, 24, 32. This parameter is optional when Type is SRT\\_PUSH or SRT\\_PULL.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'InputId' => ['description' => 'The ID of the input.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\"\\n}","type":"json"}]', 'title' => 'Create a live media input', 'description' => '- Create a live media input.'."\n" ."\n" .'## Queries per second (QPS) limit'."\n" ."\n" .'The queries per second (QPS) limit for this API is 50 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.', 'changeSet' => [ ['createdAt' => '2025-08-07T07:13:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-27T07:59:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMediaLiveInput'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateMediaLiveInput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateMediaLiveInputSecurityGroup' => [ 'summary' => 'Creates a security group in MediaLive.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the security group. Letters, digits, hyphens (-), and underscores (\\_) are supported. The maximum length is 64 characters.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mysg'], ], [ 'name' => 'WhitelistRules', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The security group rules.', 'type' => 'array', 'items' => ['description' => 'The IPv4 addresses that are allowed to push content to MediaLive. Specify IP addresses as CIDR blocks.', 'type' => 'string', 'required' => false, 'example' => '10.1.1.0/24', 'title' => ''], 'required' => true, 'example' => '["10.1.1.0/24", "11.11.11.11/0"]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'SecurityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SecurityGroupId\\": \\"SEGK5KA6KYKAWQQH\\"\\n}","type":"json"}]', 'title' => 'CreateMediaLiveInputSecurityGroup', 'description' => '## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMediaLiveInputSecurityGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateMediaLiveInputSecurityGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreatePipeline' => [ 'summary' => 'Creates an ApsaraVideo Media Processing (MPS) queue.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'required' => true, 'example' => 'test-pipeline', 'title' => ''], ], [ 'name' => 'Speed', 'in' => 'query', 'schema' => [ 'description' => 'The type of the MPS queue. Valid values:'."\n" ."\n" .'1. Standard: standard MPS queue.'."\n" ."\n" .'2. Boost: MPS queue with transcoding speed boosted.'."\n" ."\n" .'3. NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0.', 'enumValueTitles' => ['Boost' => '', 'Standard' => '', 'NarrowBandHDV2' => ''], 'type' => 'string', 'required' => true, 'example' => 'Standard', 'title' => '', ], ], [ 'name' => 'Priority', 'in' => 'query', 'schema' => ['description' => 'The priority. Default value: 6. Valid values: 1 to 10. A greater value specifies a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Pipeline' => [ 'title' => '', 'description' => 'The information about the MPS queue.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Name' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'example' => 'test-pipeline', 'title' => ''], 'Speed' => [ 'description' => 'The type of the MPS queue.'."\n" ."\n" .'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.', 'enumValueTitles' => ['Boost' => '', 'Standard' => '', 'NarrowBandHDV2' => ''], 'type' => 'string', 'example' => 'Standard', 'title' => '', ], 'Priority' => ['description' => 'The priority of the MPS queue.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Status' => [ 'description' => 'The state of the MPS queue.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Active'."\n" ."\n" .'- Paused', 'enumValueTitles' => ['Active' => '', 'Paused' => ''], 'type' => 'string', 'example' => 'Active', 'title' => '', ], 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Pipeline\\": {\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"test-pipeline\\",\\n \\"Speed\\": \\"Standard\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Active\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\"\\n }\\n}","type":"json"}]', 'title' => 'CreatePipeline', 'changeSet' => [ ['createdAt' => '2022-07-18T03:28:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-11T09:38:09.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipeline'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:CreatePipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateProgram' => [ 'summary' => 'Creates a program in a MediaWeaver channel.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProgramName', 'in' => 'query', 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => true, 'example' => 'program1', 'title' => ''], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The source type of the program.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLcation', 'title' => ''], ], [ 'name' => 'SourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MySource', 'title' => ''], ], [ 'name' => 'Transition', 'in' => 'query', 'schema' => ['description' => 'The program transition method.', 'type' => 'string', 'required' => true, 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', 'title' => ''], ], [ 'name' => 'ClipRange', 'in' => 'query', 'schema' => ['description' => 'Extracts a clip from the source.', 'type' => 'string', 'required' => false, 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}', 'title' => ''], ], [ 'name' => 'AdBreaks', 'in' => 'query', 'schema' => ['description' => 'The information about ad breaks.', 'type' => 'string', 'required' => false, 'example' => '[{"MessageType":"SPLICE_INSERT","OffsetMillis":1000,"SourceLocationName":"MySourceLocation","SourceName":"MyAdSource","SpliceInsertSettings":{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Program' => ['description' => 'The information about the program.', '$ref' => '#/components/schemas/ChannelAssemblyProgram', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"2024-04-02T00:58:19Z\\\\n\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"{\\\\\\"segmentationEventID\\\\\\":0,\\\\\\"segmentationUPIDType\\\\\\":14,\\\\\\"segmentationUPID\\\\\\":\\\\\\"upid\\\\\\",\\\\\\"segmentationTypeID\\\\\\":48,\\\\\\"segmentNumber\\\\\\":0,\\\\\\"segmentsExpected\\\\\\":0,\\\\\\"subSegmentNumber\\\\\\":1,\\\\\\"subSegmentsExpected\\\\\\":0}\\\\n\\",\\n \\"OffsetMillis\\": 1000,\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\",\\n \\"SpliceInsertSettings\\": \\"{\\\\\\"AvailNumber\\\\\\":0,\\\\\\"AvailExpected\\\\\\":0,\\\\\\"SpliceEventID\\\\\\":1,\\\\\\"UniqueProgramID\\\\\\":0}\\\\n\\",\\n \\"SourceName\\": \\"MyAdSource\\",\\n \\"ProgramName\\": \\"program_name\\\\n\\",\\n \\"MessageType\\": \\"SPLICE_INSERT\\"\\n }\\n ],\\n \\"SourceType\\": \\"vodSource\\",\\n \\"Transition\\": \\"{\\\\\\"Type\\\\\\": \\\\\\"RELATIVE\\\\\\", \\\\\\"RelativePosition\\\\\\": \\\\\\"AFTER_PROGRAM\\\\\\", \\\\\\"RelativeProgram\\\\\\": \\\\\\"program2\\\\\\"}\\\\n\\",\\n \\"GmtModified\\": \\"2024-04-02T00:58:19Z\\\\n\\",\\n \\"SourceName\\": \\"MySource\\",\\n \\"ClipRange\\": \\"{StartOffsetMillis: 213123, EndOffsetMillis: 213134}\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::program/myChannel/MyProgram\\\\n\\",\\n \\"ProgramName\\": \\"program1\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateProgram', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateProgram', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateRecognitionEntity' => [ 'summary' => 'Creates an entity to be recognized in a custom recognition library. The entity can be a landmark, object, logo, or person.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], [ 'name' => 'EntityName', 'in' => 'query', 'schema' => ['description' => 'The name of the custom entity. Max length: 64 bytes.', 'type' => 'string', 'example' => 'Custom library entity name', 'required' => true, 'docRequired' => true, 'title' => ''], ], [ 'name' => 'EntityInfo', 'in' => 'query', 'schema' => ['description' => 'The extra information about the custom entity, provided as a JSON string. Max length: 256 bytes.', 'type' => 'string', 'example' => '{"description": "Book classification"}', 'required' => false, 'docRequired' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EntityId' => ['description' => 'The ID of the created entity.', 'type' => 'string', 'example' => '**************544cb84754************', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EntityId\\": \\"**************544cb84754************\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'CreateRecognitionEntity', 'description' => '- This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- Callable up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateRecognitionEntity', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateRecognitionLib' => [ 'summary' => 'Creates a custom library to store the entity information for recognition.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibName', 'in' => 'query', 'schema' => ['description' => 'The name of the recognition library. Max length: 64 bytes.', 'type' => 'string', 'example' => 'Landmark test library', 'required' => true, 'docRequired' => true, 'title' => ''], ], [ 'name' => 'LibDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the recognition library. Max length: 128 bytes.', 'type' => 'string', 'example' => 'For storing product recognition samples', 'required' => false, 'docRequired' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'LibId' => ['description' => 'The ID of the recognition library created.', 'type' => 'string', 'example' => '*************24b47865c6**************', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LibId\\": \\"*************24b47865c6**************\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'CreateRecognitionLib', 'description' => '- This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- Workflow for using a custom recognition library: Create a library, create a custom object entity within the library, register sample images for the entity, create an analysis template that uses your custom library, and then submit an analysis task using the template.'."\n" ."\n" .'- Callable up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateRecognitionLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateRecognitionSample' => [ 'summary' => 'Adds a sample image or a text label to a specific entity within a recognition library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition this sample is for.'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the specific entity within the library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '**************544cb84754************', 'title' => ''], ], [ 'name' => 'ImageUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the sample image.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'https://example.com/sample.png', 'title' => ''], ], [ 'name' => 'LabelPrompt', 'in' => 'query', 'schema' => ['description' => 'The custom text label.', 'type' => 'string', 'example' => 'Complete front view', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SampleId' => ['description' => 'The ID of the sample.', 'type' => 'string', 'example' => '**************4d2ba728e2f**************', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SampleId\\": \\"**************4d2ba728e2f**************\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'CreateRecognitionSample', 'description' => '- This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- Callable up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateRecognitionSample', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateSearchIndex' => [ 'summary' => 'You can create a search index under a search library. A search library can contain multiple search indexes of different types.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'Search library name.'."\n" ."\n" .'- If no search library name is specified, the search index is created under the default IMS search library by default. The default value is ims-default-search-lib.'."\n" ."\n" .'- You can also use the [QuerySearchLib](~~2584455~~) API to retrieve information about existing search libraries.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'IndexType', 'in' => 'query', 'schema' => [ 'description' => 'The category of the index. Valid values:'."\n" ."\n" .'- mm: large visual model. You can use this model to describe complex visual features and identify and search for specific actions, movements, and events in videos, such as when athletes score a goal or get injured.'."\n" ."\n" .'> This feature is in the public preview phase. You can use this feature for free for 1,000 hours of videos.'."\n" ."\n" .'- face: face recognition. You can use the face recognition technology to describe face characteristics and automatically mark or search for faces in videos.'."\n" ."\n" .'- aiLabel: smart tagging. The smart tagging category is used to describe content such as subtitles and audio in videos. You can use the speech recognition technology to automatically extract, mark, and search for subtitles and dialog content from videos. This helps you quickly locate the video content that is related to specific topics or keywords.', 'enumValueTitles' => ['mm' => 'mm', 'face' => 'face', 'aiLabel' => 'aiLabel'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mm', ], ], [ 'name' => 'IndexStatus', 'in' => 'query', 'schema' => [ 'description' => 'Index status. Default value is Active. Valid values:'."\n" ."\n" .'- Active: Activated.'."\n" ."\n" .'- Deactive: Deactivated.', 'enumValueTitles' => ['Active' => 'Active', 'Deactive' => 'Deactive'], 'type' => 'string', 'required' => false, 'example' => 'Active', 'title' => '', ], ], [ 'name' => 'IndexConfig', 'in' => 'query', 'schema' => ['description' => 'Index configuration', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'Success' => ['description' => 'Indicates whether the invocation succeeded. Valid values:'."\n" ."\n" .'- true: Invocation succeeded'."\n" ."\n" .'- false: Failed to invoke', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Return code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'Create Search Index'."\n", 'description' => ''."\n" ."\n" .'Before using this API, ensure that you fully understand the [Intelligent Search billing](~~2840897~~) method and pricing.'."\n" ."\n" .'', 'requestParamsDescription' => '### IndexConfig Description'."\n" ."\n" .'| Feature | Name | Type | Required | Description | Example Value |'."\n" .'| ------------- | ----------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |'."\n" .'| | IndexConfig | object | No | This parameter contains the configuration parameters for the index. | {"level":"Shared"} |'."\n" .'| Specification | level | string | No | Resource specification parameter for face or LLM (large model) analysis. Default value is "Shared".
Valid values:* Shared – Shared type, supports 1 million faces or 1,000 hours of video LLM analysis
* S.large – Dedicated type, supports 1 million faces or 10,000 hours of video LLM analysis
* S.2xlarge – Dedicated type, supports 2 million faces or 20,000 hours of video LLM analysis
* S.4xlarge – Dedicated type, supports 4 million faces or 40,000 hours of video LLM analysis
* S.8xlarge – Dedicated type, supports 8 million faces or 80,000 hours of video LLM analysis
* S.16xlarge – Dedicated type, supports 16 million faces or 160,000 hours of video LLM analysis | "Shared" |', 'changeSet' => [ ['createdAt' => '2023-11-23T03:41:49.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-22T08:19:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSearchIndex'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateSearchIndex', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateSearchLib' => [ 'summary' => 'Creates a search library to store media assets.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library. The name can contain letters and digits. For IP camera (IPC) monitoring scenarios, the name must start with the `IPCamera_` prefix. For other scenarios, you can use a custom name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'SearchLibConfig', 'in' => 'query', 'schema' => ['description' => 'The configuration of the search library, in JSON string format. The fields include the following:'."\n" ."\n" .'- faceGroupIds: The IDs of custom face recognition libraries. You can create these libraries by calling the CreateRecognitionLib operation. You can specify up to three library IDs, separated by commas (,).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'SearchLibName' => ['description' => 'The name of the search library.', 'type' => 'string', 'example' => 'test1', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\"\\n}","type":"json"}]', 'title' => 'CreateSearchLib', 'changeSet' => [ ['createdAt' => '2023-11-22T08:19:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSearchLib'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateSource' => [ 'summary' => 'Creates a source in MediaWeaver.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The source type. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ 'name' => 'SourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MyVodSource', 'title' => ''], ], [ 'name' => 'HttpPackageConfigurations', 'in' => 'query', 'schema' => ['description' => 'The source configurations.', 'type' => 'string', 'required' => true, 'example' => '“[{'."\n" .' "sourceGroupName": "mySourceGroup-1",'."\n" .' "relativePath": "group1/hls.m3u8",'."\n" .' "type": "hls"'."\n" .'}]”', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Source' => ['description' => 'The source information.', '$ref' => '#/components/schemas/ChannelAssemblySource', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"2022-10-20T07:15:51Z\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\\\n\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"vodSource\\",\\n \\"GmtModified\\": \\"2024-11-07T10:12:01Z\\\\n\\",\\n \\"SourceName\\": \\"MyVodSource\\\\n\\",\\n \\"HttpPackageConfigurations\\": \\"[{\\\\n\\\\t\\\\\\"sourceGroupName\\\\\\": \\\\\\"mySourceGroup-1\\\\\\",\\\\n\\\\t\\\\\\"relativePath\\\\\\": \\\\\\"group1/hls.m3u8\\\\\\",\\\\n\\\\t\\\\\\"packageType\\\\\\": \\\\\\"hls\\\\\\"\\\\n}]\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::vodSource/mySourceLocation/mySource\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateSource', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateSourceLocation' => [ 'summary' => 'Creates a source location.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourcelocation', 'title' => ''], ], [ 'name' => 'BaseUrl', 'in' => 'query', 'schema' => ['description' => 'The protocol and hostname of the source location.', 'type' => 'string', 'required' => true, 'example' => 'http://xxx.com', 'title' => ''], ], [ 'name' => 'EnableSegmentDelivery', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use an independent domain name to access the segments.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'SegmentDeliveryUrl', 'in' => 'query', 'schema' => ['description' => 'The domain name used to access the segments.', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'SourceLocation' => ['description' => 'The source location information.', '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"2024-03-29T02:03:17Z\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\\\n\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"2024-03-29T02:03:17Z\\\\n\\",\\n \\"SegmentDeliveryConfigurations\\": \\"http://segmentdelivery.com\\\\n\\",\\n \\"BaseUrl\\": \\"http://xxxx.com\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::sourcelocation/MySourceLocation\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateSourceLocation', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateSourceLocation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateStreamToSearchLib' => [ 'summary' => 'Registers a live stream as a media asset.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The URL of the live stream to be ingested and analyzed.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true: succeeded.'."\n" ."\n" .'- false: failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', 'title' => 'CreateStreamToSearchLib', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:CreateStreamToSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateUploadMedia' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'The application ID. The default value is `app-1000000`.', 'type' => 'string', 'required' => false, 'example' => 'app-1000000', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the entity. You can call the `CreateEntity` operation to create an entity and define a custom schema for dynamic metadata.', 'type' => 'string', 'required' => false, 'example' => '9e177cac2fb44f8b8c67b199fcc7bffd', 'title' => ''], ], [ 'name' => 'FileInfo', 'in' => 'query', 'schema' => ['description' => 'The file information, provided as a JSON string containing the following fields:'."\n" ."\n" .'- `Type` (Required): The file type. Valid values: `video`, `image`, `audio`, `text`, and `other`.'."\n" ."\n" .'- `Name` (Required): The filename without the extension.'."\n" ."\n" .'- `Size` (Optional): The file size.'."\n" ."\n" .'- `Ext` (Required): The file extension.', 'type' => 'string', 'required' => false, 'example' => '{\\"Type\\":\\"video\\",\\"Name\\":\\"test\\",\\"Size\\":108078336,\\"Ext\\":\\"mp4\\"}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'A JSON string for custom settings, such as configuring a message callback.', 'type' => 'string', 'required' => false, 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', 'title' => ''], ], [ 'name' => 'UploadTargetConfig', 'in' => 'query', 'schema' => ['description' => 'The destination storage configuration, provided as a JSON string.'."\n" ."\n" .'- `StorageType`: Only `oss` is supported.'."\n" ."\n" .'- `StorageLocation`: Only VOD storage is supported. You cannot upload to your own OSS buckets.', 'type' => 'string', 'required' => false, 'example' => '{\\"StorageType\\":\\"oss\\",\\"StorageLocation\\":\\"outin-***.oss-cn-shanghai.aliyuncs.com\\"}', 'title' => ''], ], [ 'name' => 'MediaMetaData', 'in' => 'query', 'schema' => ['description' => 'The media asset metadata, provided as a JSON string.'."\n" ."\n" .'`Title` (Required):'."\n" ."\n" .'- The title can be up to 128 characters in length.'."\n" ."\n" .'- The title must be UTF-8 encoded.'."\n" ."\n" .'`Description` (Optional):'."\n" ."\n" .'- The description can be up to 1,024 characters in length.'."\n" ."\n" .'- The description must be UTF-8 encoded.'."\n" ."\n" .'`CateId` (Optional): The category ID.'."\n" ."\n" .'`Tags` (Optional): The tags of the media asset, separated by commas.'."\n" ."\n" .'`BusinessType` (Required): The business type. Valid values depend on the `Type` specified in `FileInfo`.'."\n" ."\n" .'- If `Type` is `video`: `opening` or `ending`.'."\n" ."\n" .'- If `Type` is `image`: `default`, `cover`, or `watermark`.'."\n" ."\n" .'- If `Type` is `text`: `subtitles` or `font`.'."\n" ."\n" .'-'."\n" ."\n" .'- If `Type` is `other`: `general`.'."\n" ."\n" .'`CoverURL` (Optional): The URL of the cover image.
`DynamicMetaData` (Optional): A string for custom dynamic metadata.
', 'type' => 'string', 'required' => false, 'example' => '{\\"Title\\": \\"UploadTest\\", \\"Description\\": \\"UploadImageTest\\", \\"Tags\\": \\"tag1,tag2\\",\\"BusinessType\\":\\"cover\\"}', 'title' => ''], ], [ 'name' => 'PostProcessConfig', 'in' => 'query', 'schema' => ['description' => 'The post-processing configuration for `video` or `audio` uploads.'."\n" ."\n" .'Set `ProcessType` to `Workflow`.'."\n" ."\n" .'> - This parameter specifies an [asynchronous task](~~3027141~~), which is queued and runs in the background after you submit the request.', 'type' => 'string', 'required' => false, 'example' => '{\\"ProcessType\\":\\"Workflow\\",\\"ProcessID\\":\\"74ba870f1a4873a3ba238e0bf6fa9***\\"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94'], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'MediaURL' => ['description' => 'The URL of the media asset.'."\n" ."\n" .'> This will be a CDN URL if a CDN domain is configured, or an OSS URL otherwise. If you receive a 403 error when accessing this URL in a browser, it is likely because URL authentication is enabled for the VOD domain. To resolve this, either disable URL authentication or generate a signed URL for access.', 'type' => 'string', 'example' => 'https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4', 'title' => ''], 'FileURL' => ['description' => 'The OSS URL of the file, without authentication parameters.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4', 'title' => ''], 'UploadAddress' => ['description' => 'The upload address.'."\n" ."\n" .'> The returned upload address is Base64-encoded and must be decoded before use. You only need to manually decode this address if you are using a native OSS SDK or an OSS API to perform the upload.', 'type' => 'string', 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', 'title' => ''], 'UploadAuth' => ['description' => 'The upload credential.'."\n" ."\n" .'> The returned upload credential is Base64-encoded and must be decoded before use. You only need to manually decode this credential if you are using a native OSS SDK or an OSS API to perform the upload.', 'type' => 'string', 'example' => 'eyJFbmRwb2ludCI6Imm****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'CreateUploadMedia', 'summary' => 'This operation retrieves an upload address and upload credential for audio, video, image, and auxiliary media assets, and creates the corresponding media asset.', 'description' => '### Overview'."\n" ."\n" .'- Obtaining an upload address and upload credential is a prerequisite for all uploads in Intelligent Media Service.'."\n" ."\n" .'- If an upload credential expires (the default validity is 3,000 seconds), call the `RefreshUploadMedia` operation to get a new one.'."\n" ."\n" .'- After an upload is complete, you can confirm its success by either configuring a callback for event notifications or calling the `GetMediaInfo` operation to check the media asset\'s status.'."\n" ."\n" .'- Use the returned `MediaId` for media asset lifecycle management or media processing.'."\n" ."\n" .'### Limitations'."\n" ."\n" .'- This operation supports uploads only to VOD storage, not to your own Object Storage Service (OSS) buckets. If you use your own OSS buckets, first upload the files by using the [OSS SDK](~~32006~~), and then call the [RegisterMediaInfo](~~441152~~) operation to register the OSS files in your media library.'."\n" ."\n" .'- This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.', 'changeSet' => [ ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUploadMedia'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateUploadMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"MediaURL\\": \\"https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateUploadStream' => [ 'summary' => 'Obtains the upload URL and credential of a media stream.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'Definition', 'in' => 'query', 'schema' => ['description' => 'The quality of the media stream. Valid values:'."\n" ."\n" .'- FD: low definition.'."\n" ."\n" .'- LD: standard definition.'."\n" ."\n" .'- SD: high definition.'."\n" ."\n" .'- HD: ultra-high definition.'."\n" ."\n" .'- OD: original quality.'."\n" ."\n" .'- 2K: 2K resolution.'."\n" ."\n" .'- 4K: 4K resolution.'."\n" ."\n" .'- SQ: standard sound quality.'."\n" ."\n" .'- HQ: high sound quality.', 'type' => 'string', 'required' => false, 'example' => 'HD', 'title' => ''], ], [ 'name' => 'FileExtension', 'in' => 'query', 'schema' => ['description' => 'The file name extension of the media stream.', 'type' => 'string', 'required' => false, 'example' => 'MP4', 'title' => ''], ], [ 'name' => 'HDRType', 'in' => 'query', 'schema' => ['description' => 'The high dynamic range (HDR) format of the transcoded stream. Valid values:'."\n" ."\n" .'- HDR'."\n" ."\n" .'- HDR10'."\n" ."\n" .'- HLG'."\n" ."\n" .'- DolbyVision'."\n" ."\n" .'- HDRVivid'."\n" ."\n" .'- SDR+'."\n" ."\n" .'>'."\n" ."\n" .'- The value is not case-sensitive,'."\n" ."\n" .'- You can leave this parameter empty for non-HDR streams.', 'type' => 'string', 'required' => false, 'example' => 'HDR10', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user data.', 'type' => 'string', 'required' => false, 'example' => '{"MessageCallback":{"CallbackURL":"http://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****c469e944b5a856828dc2****', 'title' => ''], 'FileURL' => ['description' => 'The Object Storage Service (OSS) URL of the file. The URL does not contain the information used for authentication.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', 'title' => ''], 'UploadAddress' => ['description' => 'The upload URL.'."\n" ."\n" .'> The returned upload URL is a Base64-encoded URL. You must decode the Base64-encoded upload URL before you use an SDK or call an API operation to upload media files. You need to parse UploadAddress only if you use OSS SDK or call an OSS API operation to upload media files.', 'type' => 'string', 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', 'title' => ''], 'UploadAuth' => ['description' => 'The upload credential.'."\n" ."\n" .'> The returned upload credential is a Base64-encoded value. You must decode the Base64-encoded upload URL before you use an SDK or call an API operation to upload media files. You need to parse UploadAuth only if you use OSS SDK or call an OSS API operation to upload media files.', 'type' => 'string', 'example' => 'eyJFbmRwb2ludCI6Imm****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', 'title' => 'CreateUploadStream', 'description' => '- Upload only a local media stream. After the media stream is uploaded, it is associated with the specified media asset ID.'."\n" ."\n" .'- Upload media streams only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media stream to your own OSS bucket, you can upload the file to your OSS bucket by using [OSS SDK](~~32006~~), and then call the [RegisterMediaStream](~~440765~~) operation to associate the media stream with the specified media asset ID.'."\n" ."\n" .'- This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.', 'changeSet' => [ ['createdAt' => '2022-07-13T06:51:39.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUploadStream'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateUploadStream', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateVodPackagingAsset' => [ 'summary' => 'Ingests an asset for VOD packaging.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], [ 'name' => 'AssetName', 'in' => 'query', 'schema' => ['description' => 'The name of the asset. The name must be unique and can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hls_3s'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The asset description.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'HLS 3 second packaging'], ], [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The asset input configurations.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The input type. Only Object Storage Service (OSS) is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'OSS'], 'Media' => ['description' => 'The URL of the media file. Only M3U8 files stored in OSS are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'OSS://***test-bucket***/***video/input.m3u8'], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ContentId', 'in' => 'query', 'schema' => ['description' => 'The content ID in the digital rights management (DRM) system. The maximum length is 256 characters. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'movie'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58'], 'Asset' => ['description' => 'The information about the asset.', '$ref' => '#/components/schemas/VodPackagingAsset', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"Asset\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\"\\n },\\n \\"CreateTime\\": \\"\\",\\n \\"ContentId\\": \\"\\",\\n \\"AssetName\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'CreateVodPackagingAsset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateVodPackagingAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateVodPackagingConfiguration' => [ 'summary' => 'Creates a VOD packaging configuration.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group. The name can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], [ 'name' => 'ConfigurationName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging configuration. The name must be unique in an account and can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hls_3s'], ], [ 'name' => 'Protocol', 'in' => 'query', 'schema' => ['description' => 'The package type.'."\n" ."\n" .'- HLS: packages content into TS segments for delivery over the HLS protocol.'."\n" ."\n" .'- HLS\\_CMAF: packages content into CMAF segments for delivery over the HLS protocol.'."\n" ."\n" .'- DASH: packages content for delivery over the DASH protocol.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'HLS'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the packaging configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'HLS 3s vod packaging'], ], [ 'name' => 'PackageConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The packaging configuration.', 'type' => 'object', 'properties' => [ 'ManifestName' => ['description' => 'The manifest name. The name can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'index'], 'SegmentDuration' => ['description' => 'The duration of each segment in a packaged stream. Unit: seconds. MediaPackage rounds segments to the nearest multiple of the input segment duration. Valid values: 1 to 30.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '6'], 'StreamSelection' => [ 'title' => '', 'description' => 'The settings of stream selection.', 'type' => 'object', 'properties' => [ 'MinVideoBitsPerSecond' => ['description' => 'The minimum bitrate of the video stream. Unit: bit/s.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '100000'], 'MaxVideoBitsPerSecond' => ['description' => 'The maximum bitrate of the video stream. Unit: bit/s.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1000000000'], 'StreamOrder' => ['description' => 'The order of manifest files in the master playlist. Valid values:'."\n" ."\n" .'- ORIGINAL: sorts the manifest files in the same order as the source.'."\n" ."\n" .'- VIDEO\\_BITRATE\\_ASCENDING: sorts the manifest files in ascending order of bitrates, from lowest to highest.'."\n" ."\n" .'- VIDEO\\_BITRATE\\_DESCENDING: sorts the manifest files in descending order of bitrates, from highest to lowest.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ORIGINAL'], ], 'required' => false, 'example' => '', ], 'DrmProvider' => [ 'title' => '', 'description' => 'The settings of digital rights management (DRM) encryption.', 'type' => 'object', 'properties' => [ 'EncryptionMethod' => ['description' => 'The encryption method. Valid values:'."\n" ."\n" .'- AES\\_128: Advanced Encryption Standard (AES) with 128-bit key length.'."\n" ."\n" .'- SAMPLE\\_AES: an encryption method that encrypts individual media samples.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'AES_128'], 'IV' => ['description' => 'A 128-bit, 16-byte hex value represented by a 32-character string that is used with the key for encrypting data blocks. If you leave this parameter empty, MediaPackage creates a constant initialization vector (IV). If it is specified, the value is passed to the DRM service.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '00001111222233334444555566667777'], 'SystemIds' => [ 'title' => '', 'description' => 'The ID of the DRM system. The maximum number of system IDs allowed is determined by the protocol type. Limits:'."\n" ."\n" .'- DASH: 2'."\n" ."\n" .'- HLS: 1'."\n" ."\n" .'- HLS\\_CMAF: 2'."\n" ."\n" .'Apple FairPlay, Google Widevine, and Microsoft PlayReady are supported. Their system IDs are as follows:'."\n" ."\n" .'- Apple FairPlay: 94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" ."\n" .'- Google Widevine: edef8ba9-79d6-4ace-a3c8-27dcd51d21e'."\n" ."\n" .'- Microsoft PlayReady: 9a04f079-9840-4286-ab92-e65be0885f95', 'type' => 'array', 'items' => ['description' => 'The ID of the DRM system.', 'type' => 'string', 'required' => false, 'example' => '94ce86fb-07ff-4f43-adb8-93d2fa968ca2', 'title' => ''], 'required' => false, 'example' => '', ], 'Url' => ['description' => 'The URL of the DRM key provider.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'https://***drm***/getcontent'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'PackagingConfiguration' => ['description' => 'The packaging configuration.', '$ref' => '#/components/schemas/VodPackagingConfiguration', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PackagingConfiguration\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ConfigurationName\\": \\"\\",\\n \\"Protocol\\": \\"\\",\\n \\"PackageConfig\\": {\\n \\"ManifestName\\": \\"\\",\\n \\"StreamSelection\\": {\\n \\"MinVideoBitsPerSecond\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitsPerSecond\\": 0\\n },\\n \\"DrmProvider\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n }\\n}","type":"json"}]', 'title' => 'CreateVodPackagingConfiguration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateVodPackagingConfiguration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateVodPackagingGroup' => [ 'summary' => 'Creates a VOD packaging group.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group. The name must be unique in an account and can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The packaging group description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod hls packaging'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The result of creating the packaging group.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'PackagingGroup' => ['description' => 'The packaging group information.', '$ref' => '#/components/schemas/VodPackagingGroup', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PackagingGroup\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DomainName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ApproximateAssetCount\\": 0,\\n \\"ConfigurationCount\\": 0\\n }\\n}","type":"json"}]', 'title' => 'CreateVodPackagingGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateVodPackagingGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateYikeAssetUpload' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'FileExt', 'in' => 'query', 'schema' => ['description' => 'File extension.', 'type' => 'string', 'required' => true, 'example' => 'mp4', 'title' => ''], ], [ 'name' => 'FileType', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'StoryboardInput', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'FileURL' => ['description' => 'OSS URL of the file without authentication.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', 'title' => ''], 'UploadAddress' => ['description' => 'Upload URL.', 'type' => 'string', 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', 'title' => ''], 'UploadAuth' => ['description' => 'Upload credential.', 'type' => 'string', 'example' => 'eyJFbmRwb2ludCI6Imm****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Obtain audio and video upload URL and credential ', 'summary' => 'Obtains an upload credential for a Yike media asset.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateYikeAssetUpload', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateYikeProduction' => [ 'summary' => 'Creates a Yike production.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the Yike production.', 'type' => 'string', 'required' => true, 'maxLength' => 50, 'pattern' => '^[^\';<>=|\\(\\)]+$', 'example' => 'title', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '581236', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'ProductionId' => ['description' => 'The production ID.', 'type' => 'string', 'example' => 'ProductionId', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'CreateYikeProduction', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateYikeProduction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"ProductionId\\": \\"ProductionId\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateYikeUser' => [ 'summary' => 'Creates a Yike user.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-az2gglkjauwnnhpq', 'title' => ''], ], [ 'name' => 'UserNamePrefix', 'in' => 'query', 'schema' => ['description' => 'The user name prefix for the sub-account. The prefix must meet the following requirements:'."\n" ."\n" .'- The prefix can be up to 50 characters long and must be unique within the workspace.'."\n" ."\n" .'- The system automatically generates a user login name in the format: {UserNamePrefix}.{WorkspaceCode}@{AlibabaCloudUID}.yikeai.', 'type' => 'string', 'required' => true, 'maxLength' => 50, 'pattern' => '^[^\';<>=|\\(\\)]+$', 'example' => 'test.xxx@xxx.yikeai', 'title' => ''], ], [ 'name' => 'Nickname', 'in' => 'query', 'schema' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'required' => true, 'maxLength' => 100, 'pattern' => '^[^\';<>=|\\(\\)]+$', 'example' => 'nick', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The user\'s password.', 'type' => 'string', 'required' => true, 'maxLength' => 32, 'minLength' => 32, 'pattern' => '^[\\w.-]+$', 'example' => '***', 'title' => ''], ], [ 'name' => 'ProductionIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of productions to add the user to. You can specify multiple IDs separated by commas.'."\n" ."\n" .'> - A user can be added to multiple productions.', 'type' => 'string', 'required' => true, 'example' => 'id1,id2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'UserInfo' => [ 'type' => 'object', 'properties' => [ 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'id', 'title' => ''], 'UserName' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'Nickname' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'example' => 'nick', 'title' => ''], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'spaceId', 'title' => ''], ], 'description' => 'The user information.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'CreateYikeUser', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateYikeUser', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"UserInfo\\": {\\n \\"UserId\\": \\"id\\",\\n \\"UserName\\": \\"name\\",\\n \\"Nickname\\": \\"nick\\",\\n \\"WorkspaceId\\": \\"spaceId\\"\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateYikeWorkspace' => [ 'summary' => 'Creates a workspace.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The workspace title.', 'type' => 'string', 'required' => true, 'maxLength' => 50, 'pattern' => '^[^\';<>=|\\(\\)]+$', 'example' => 'title', 'title' => ''], ], [ 'name' => 'UserCountLimit', 'in' => 'query', 'schema' => ['description' => 'The maximum number of users in the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '1000', 'minimum' => '2', 'example' => '50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'llm-zna577pdximvztk5', 'title' => ''], 'ProductionId' => ['description' => 'The ID of the project.', 'type' => 'string', 'example' => 'ProductionId', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'CreateYikeWorkspace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:CreateYikeWorkspace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"WorkspaceId\\": \\"llm-zna577pdximvztk5\\",\\n \\"ProductionId\\": \\"ProductionId\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DecryptKMSDataKey' => [ 'summary' => 'Decrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CiphertextBlob', 'in' => 'query', 'schema' => ['description' => 'The ciphertext that you want to decrypt.', 'type' => 'string', 'required' => true, 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'DataKey' => [ 'description' => 'The information about the decryption result.', 'type' => 'object', 'properties' => [ 'KeyId' => ['description' => 'The ID of the customer master key (CMK) that was used to decrypt the ciphertext.', 'type' => 'string', 'example' => '202b9877-5a25-46e3-a763-e20791b5****'."\n", 'title' => ''], 'Plaintext' => ['description' => 'The plaintext that is generated after decryption.', 'type' => 'string', 'example' => 'tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"DataKey\\": {\\n \\"KeyId\\": \\"202b9877-5a25-46e3-a763-e20791b5****\\\\n\\",\\n \\"Plaintext\\": \\"tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'DecryptKMSDataKey', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DecryptKMSDataKey'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DecryptKMSDataKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteAIAgentDialogue' => [ 'summary' => 'Deletes dialog records of an AI agent.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '235498', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => '6d594e7f55624c47a48789******', 'title' => ''], ], [ 'name' => 'DialogueId', 'in' => 'query', 'schema' => ['description' => 'The ID of the dialogue to delete.', 'type' => 'string', 'required' => true, 'example' => 'f27f9b9be28642a88e18*******', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node to delete.', 'type' => 'string', 'required' => false, 'example' => 'c22f9b9be2864g46fse73*******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7B117AF5-2A1******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A1******\\"\\n}","type":"json"}]', 'title' => 'DeleteAIAgentDialogue', 'changeSet' => [ ['createdAt' => '2025-04-28T10:34:51.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DeleteAIAgentDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteAdInsertion' => [ 'summary' => 'Deletes an ad insertion configuration.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238117', 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the configuration that you want to delete.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_ad'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteAdInsertion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAdInsertion'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteAdInsertion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteAvatarTrainingJob' => [ 'summary' => 'Deletes a digital human training job that is in the Init or Fail state.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'example' => '****d718e2ff4f018ccf419a7b71****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', 'title' => 'DeleteAvatarTrainingJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAvatarTrainingJob'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteAvatarTrainingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteCategory' => [ 'summary' => 'Deletes a media asset category.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'CateId', 'in' => 'query', 'schema' => ['description' => 'The category ID. You can use one of the following methods to obtain the ID:'."\n" ."\n" .'- Log on to the [Intelligent Media Services (IMS) console](https://ims.console.aliyun.com) and choose **Media Asset Management** > **Category Management** to view the category ID.'."\n" ."\n" .'- View the value of CateId returned by the AddCategory operation that you called to create a category.'."\n" ."\n" .'- View the value of CateId returned by the GetCategories operation that you called to query a category.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '46', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteCategory', 'description' => 'This operation also deletes the subcategories, including the level-2 and level-3 categories, of the category.', 'changeSet' => [ ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCategory'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteCategory', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteChannel' => [ 'summary' => 'Deletes a channel.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteChannel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteCustomTemplate' => [ 'summary' => 'Deletes a custom template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom template.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteCustomTemplate', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteCustomTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteCustomizedVoiceJob' => [ 'summary' => 'Deletes a human voice cloning job that is not in the Training or Success state.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the human voice cloning job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteCustomizedVoiceJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomizedVoiceJob'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteCustomizedVoiceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteDNADB' => [ 'summary' => 'Deletes a media fingerprint library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DBId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media fingerprint library that you want to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fb712a6890464059b1b2ea7c8647****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\"\\n}","type":"json"}]', 'title' => 'DeleteDNADB', 'changeSet' => [ ['createdAt' => '2023-05-25T07:23:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDNADB'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteDNADB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteDNAFiles' => [ 'summary' => 'Deletes files from a media fingerprint library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DBId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media fingerprint library from which you want to delete files.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fb712a6890464059b1b2ea7c8647****', 'title' => ''], ], [ 'name' => 'PrimaryKeys', 'in' => 'query', 'schema' => ['description' => 'The primary key values of the files that you want to delete. Separate multiple values with commas (,). You can delete up to 50 files at a time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '41e6536e4f2250e2e9bf26cdea19****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\"\\n}","type":"json"}]', 'title' => 'DeleteDNAFiles', 'changeSet' => [ ['createdAt' => '2023-05-25T07:23:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDNAFiles'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteDNAFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteEditingProjectMaterials' => [ 'summary' => 'Deletes one or more materials from an online editing project.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'PrivateKey' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '*****fb2101cb318*****'], ], [ 'name' => 'MaterialIds', 'in' => 'query', 'schema' => ['description' => 'The material ID. Separate multiple material IDs with commas (,). You can specify up to 10 IDs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '*****cbd721b418a89a7dafb1dc*****,*****86f5d534c95997c55c96f*****'], ], [ 'name' => 'MaterialType', 'in' => 'query', 'schema' => ['description' => 'The material type. Valid values:'."\n" ."\n" .'\\- video'."\n" ."\n" .'\\- image'."\n" ."\n" .'\\- audio'."\n" ."\n" .'\\- subtitle'."\n" ."\n" .'\\- text', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'video'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******36-3C1E-4417-BDB2-1E034F******'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], ], 404 => [ ['errorCode' => 'ProjectNotFound', 'errorMessage' => 'The specified project not found', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\"\\n}","type":"json"}]', 'title' => 'DeleteEditingProjectMaterials', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEditingProjectMaterials'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteEditingProjectMaterials', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteEditingProjects' => [ 'summary' => 'Deletes one or more online editing project.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ProjectIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the online editing project. You can specify multiple IDs separated with commas (,).', 'type' => 'string', 'title' => '', 'required' => true, 'example' => '****fb2101bf24bf41cb318787dc****,****87dcfb2101bf24bf41cb3187****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****25818875-5F78-4AF6-D7393642CA58****'], ], 'example' => '', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****25818875-5F78-4AF6-D7393642CA58****\\"\\n}","type":"json"}]', 'title' => 'DeleteEditingProjects', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEditingProjects'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteEditingProjects', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteHotwordLibrary' => [ 'summary' => 'Deletes a specified hotword library based on the ID.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'HotwordLibraryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the hotword library that you want to delete.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '****83B7-7F87-4792-BFE9-63CD2137****'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'DeleteHotwordLibrary', 'description' => '## [](#)'."\n" ."\n" .'- Delete a specified hotword library.'."\n" ."\n" .'- The delete operation is irreversible.'."\n" ."\n" .'- You can create up to 100 hotword libraries in an account.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteHotwordLibrary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLivePackageChannel' => [ 'summary' => 'Deletes a live package channel by GroupName and ChannelName.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239701', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\"\\n}","type":"json"}]', 'title' => 'DeleteLivePackageChannel', 'description' => '## [](#)Usage notes'."\n" ."\n" .'You need to provide GroupName and ChannelName as parameters to specify exactly which channel to delete. Before you delete a channel, you must delete the origin endpoints associated with the channel.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteLivePackageChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLivePackageChannelGroup' => [ 'summary' => 'Deletes a live package channel group by name.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238118', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'group1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', 'title' => 'DeleteLivePackageChannelGroup', 'description' => '## [](#)Usage notes'."\n" ."\n" .'Make sure that no channels are included in the channel group before you delete it.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteLivePackageChannelGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLivePackageOriginEndpoint' => [ 'summary' => 'Deletes an origin endpoint associated with a live package channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239772', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ 'name' => 'EndpointName', 'in' => 'query', 'schema' => ['description' => 'The endpoint name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'endpoint-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', 'title' => 'DeleteLivePackageOriginEndpoint', 'description' => '## [](#)Usage notes'."\n" ."\n" .'This API operation is used to delete an origin endpoint associated with a live package channel by specifying `GroupName`, `ChannelName`, and `EndpointName`. This operation will permanently delete the relevant configurations. Exercise caution when you perform this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteLivePackageOriginEndpoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLiveRecordFiles' => [ 'summary' => 'Deletes live stream recording files. You can choose to delete only the recording files or delete both the recording files and the original Object Storage Service (OSS) files.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RecordIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The collection of IDs of recording files.', 'type' => 'array', 'items' => ['description' => 'The ID of the recording file in the UUID format.', 'type' => 'string', 'required' => false, 'example' => '13cbb83e-043c-4728-ac35-****', 'title' => ''], 'required' => true, 'maxItems' => 100, 'title' => '', 'example' => '', ], ], [ 'name' => 'RemoveFile', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to delete the original files in OSS.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '13cbb83e-043c-4728-ac35-*****'], 'DeleteFileInfoList' => [ 'description' => 'The list of files deleted.', 'type' => 'array', 'items' => [ 'description' => 'The file deleted.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The code that identifies the result of the deletion.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The result of deletion.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RecordId' => ['description' => 'The ID of the deleted recording file.', 'type' => 'string', 'example' => '13cbb83e-043c-4728-ac35-*****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The description of the state returned.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\",\\n \\"DeleteFileInfoList\\": [\\n {\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RecordId\\": \\"13cbb83e-043c-4728-ac35-*****\\"\\n }\\n ],\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', 'title' => 'DeleteLiveRecordFiles', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveRecordFiles'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteLiveRecordFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLiveRecordTemplate' => [ 'summary' => 'Deletes a live stream recording template without affecting existing jobs.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the template to be deleted. To obtain the template ID, log on to the [Intelligent Media Services (IMS) console](https://ice.console.aliyun.com/live-processing/template/list/record), choose Real-time Media Processing > Template Management, and then click the Recording tab. Alternatively, find the ID from the response parameters of the [CreateLiveRecordTemplate](~~448213~~) operation.', 'properties' => [], 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'readOnly' => true, 'default' => '', 'title' => '', 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b7****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E5330CF-B4C8-5BEF-AA6B-8E70BD20FAEE', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5330CF-B4C8-5BEF-AA6B-8E70BD20FAEE\\"\\n}","type":"json"}]', 'title' => 'DeleteLiveRecordTemplate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveRecordTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteLiveRecordTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLiveSnapshotFiles' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceP3TB74'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ 'name' => 'CreateTimestampList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'A list of creation timestamps for the files to delete. You can specify up to 200 timestamps per request.', 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'example' => '1660638613798', 'title' => ''], 'required' => true, 'maxItems' => 200, 'example' => '', ], ], [ 'name' => 'DeleteOriginalFile', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to delete the original OSS files. The default value is false.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****'], 'DeleteFileResultList' => [ 'title' => '', 'description' => 'An array of deletion results.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => 'The deletion result. A value of `OK` indicates the operation succeeded. Other values indicate that it failed.', 'enumValueTitles' => ['OK' => 'The operation succeeded.', 'NotFound' => 'The snapshot was not found.'], 'type' => 'string', 'title' => '', 'example' => 'OK', ], 'CreateTimestamp' => ['description' => 'The creation timestamp of the file.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1660638613798'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'OverlayNotSupported', 'errorMessage' => 'Not Sopport to remove overlay snapshot, please remove overlay snapshot from OSS console.', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'BucketNotAuthorized', 'errorMessage' => 'Bucket is not authorised.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], [ ['errorCode' => 'JobNotFound', 'errorMessage' => 'No such job.', 'description' => ''], ['errorCode' => 'NoValidSnapshot', 'errorMessage' => 'No snapshots found with given parameters.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'DeleteLiveSnapshotFiles', 'summary' => 'Deletes live snapshot files. You can delete only the records, or both the records and the original Object Storage Service (OSS) files.', 'changeSet' => [ ['createdAt' => '2024-02-02T02:24:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveSnapshotFiles'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteLiveSnapshotFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"DeleteFileResultList\\": [\\n {\\n \\"Result\\": \\"OK\\",\\n \\"CreateTimestamp\\": 1660638613798\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeleteLiveSnapshotTemplate' => [ 'summary' => 'Deletes a live stream snapshot template.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], [ ['errorCode' => 'TemplateNotFound', 'errorMessage' => 'No such template.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteLiveSnapshotTemplate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveSnapshotTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteLiveSnapshotTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLiveTranscodeJob' => [ 'summary' => 'Delete the specified real-time transcoding job.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the transcoding job.', 'type' => 'string', 'required' => true, 'enum' => [], 'title' => '', 'example' => '****20b48fb04483915d4f2cd8ac****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'Delete a real-time ApsaraVideo Media Processing job', 'changeSet' => [ ['createdAt' => '2022-08-24T03:10:25.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveTranscodeJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteLiveTranscodeJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteLiveTranscodeTemplate' => [ 'summary' => 'Deletes a live stream transcoding template.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The template ID. To obtain the template ID, log on to the [Intelligent Media Services (IMS) console](https://ice.console.aliyun.com/summary), choose Real-time Media Processing > Template Management, and then click the Transcoding tab. Alternatively, find the ID from the response parameters of the [CreateLiveTranscodeTemplate](~~449217~~) operation.', 'type' => 'string', 'required' => true, 'enum' => [], 'title' => '', 'example' => '****d80e4e4044975745c14b****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameters: templateId is inuse.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'DeleteLiveTranscodeTemplate', 'changeSet' => [ ['createdAt' => '2022-08-23T11:40:01.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveTranscodeTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteLiveTranscodeTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaConnectFlow' => [ 'summary' => 'Deletes a MediaConnect flow.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'Description' => ['title' => '', 'description' => 'The call description.', 'type' => 'string', 'example' => 'OK'], 'RetCode' => ['description' => 'The returned error code. A value of `0` indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Content' => ['description' => 'The response body.', 'type' => 'string', 'example' => '""', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5AEC17BD-D80B-5F78-BE1B-F07DFA0C8622', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"5AEC17BD-D80B-5F78-BE1B-F07DFA0C8622\\"\\n}","type":"json"}]', 'title' => 'DeleteMediaConnectFlow', 'description' => '- When the specified flow ID is not available, an error code is returned.'."\n" ."\n" .'- When a flow is deleted, its source and outputs are also deleted.'."\n" ."\n" .'- When a flow is in the online state, it cannot be deleted.', 'changeSet' => [ ['createdAt' => '2025-01-23T06:18:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:DeleteMediaConnectFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaConnectFlowInput' => [ 'summary' => 'Delete the input of a specific MediaConnect instance', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', 'title' => ''], ], [ 'name' => 'InputName', 'in' => 'query', 'schema' => ['description' => 'Input name. Required when primary/standby input is enabled for the instance.', 'type' => 'string', 'required' => false, 'example' => 'input', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'Description' => ['title' => '', 'description' => 'The call description.', 'type' => 'string', 'example' => 'OK'], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Content' => ['description' => 'The response body.', 'type' => 'string', 'example' => '""', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C0C02296-113C-5838-8FE9-8F3A32998DDC', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"C0C02296-113C-5838-8FE9-8F3A32998DDC\\"\\n}","type":"json"}]', 'title' => 'Delete Input of a MediaConnect Flow Instance', 'description' => '- If the provided Flow instance ID does not exist, the interface will return an error.'."\n" ."\n" .'- When the Flow instance status is online, the input cannot be deleted.'."\n" ."\n" .'- Only after all outputs under the Flow instance have been deleted can the input be deleted.', 'changeSet' => [ ['createdAt' => '2025-04-24T06:29:32.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:DeleteMediaConnectFlowInput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaConnectFlowOutput' => [ 'summary' => 'Deletes an output of a MediaConnect flow.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ 'name' => 'OutputName', 'in' => 'query', 'schema' => ['description' => 'The name of the output that you want to delete.', 'type' => 'string', 'required' => true, 'example' => 'AliTestOutput', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The response body.', 'type' => 'string', 'example' => '""'], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'DF73E08E-F807-50F5-A2BD-B76391EAE8FF', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"DF73E08E-F807-50F5-A2BD-B76391EAE8FF\\"\\n}","type":"json"}]', 'title' => 'DeleteMediaConnectFlowOutput', 'description' => '- When the specified flow ID is not available, an error code is returned.'."\n" ."\n" .'- When a flow is in the online state, its outputs cannot be deleted.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:DeleteMediaConnectFlowOutput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaFromSearchLib' => [ 'summary' => 'Delete the specified media asset from the search library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library. Default value: ims-default-search-lib.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'MsgBody', 'in' => 'query', 'schema' => ['description' => 'The message body.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '******b48fb04483915d4f2cd8******', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'Delete Media Asset from Search Library ', 'changeSet' => [ ['createdAt' => '2025-07-09T08:14:41.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-23T03:41:49.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-22T08:19:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaFromSearchLib'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteMediaFromSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaInfos' => [ 'summary' => 'Deletes multiple media assets at a time. You can delete at most 20 media assets at a time. If MediaIds is specified, it is preferentially used. If MediaIds is empty, InputURLs must be specified.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset that you want to delete from Intelligent Media Services (IMS).'."\n" ."\n" .'- Separate multiple IDs with commas (,).'."\n" ."\n" .'If you leave MediaIds empty, you must specify InputURLs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****'], ], [ 'name' => 'InputURLs', 'in' => 'query', 'schema' => ['description' => 'The URL of the media asset that you want to delete. The file corresponding to the URL must be registered with IMS. Separate multiple URLs with commas (,). The following two formats are supported:'."\n" ."\n" .'1. http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?'."\n" ."\n" .'2. OSS://example-bucket/example.mp4?
'."\n" .' In this format, it is considered by default that the region of the OSS bucket in which the media asset resides is the same as the region in which IMS is activated.', 'type' => 'string', 'example' => 'Http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4? or oss://example-bucket/example.mp4?', 'required' => false, 'title' => ''], ], [ 'name' => 'DeletePhysicalFiles', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to delete the physical file of the media asset.'."\n" ."\n" .'If the media asset is stored in your own OSS bucket, you must authorize the service role AliyunICEDefaultRole in advance. For more information, see [Authorize IMS to delete recording files in OSS](https://help.aliyun.com/zh/ims/user-guide/record?spm=a2c4g.11186623.0.i8#0737d9c437bmn).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0622C702-41BE-467E-AF2E-883D4517962E'], 'IgnoredList' => [ 'title' => '', 'description' => 'The IDs or URLs of ignored media assets. An error occurred while obtaining such media assets.', 'type' => 'array', 'items' => ['description' => 'The ID or URL of the ignored media asset. An error occurred while obtaining the media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'example' => '', ], 'ForbiddenList' => [ 'description' => 'The IDs or URLs of media assets that cannot be deleted. Generally, media assets cannot be deleted if you do not have the required permissions.', 'type' => 'array', 'items' => ['description' => 'The ID or URL of the media asset that cannot be deleted.', 'type' => 'string', 'example' => '****15d4a4b0448391508f2cb486****'."\n", 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"IgnoredList\\": [\\n \\"****20b48fb04483915d4f2cd8ac****\\"\\n ],\\n \\"ForbiddenList\\": [\\n \\"****15d4a4b0448391508f2cb486****\\\\n\\"\\n ]\\n}","type":"json"}]', 'title' => 'DeleteMediaInfos', 'changeSet' => [ ['createdAt' => '2022-08-16T07:44:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaInfos'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteMediaInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaLiveChannel' => [ 'summary' => 'Deletes a MediaLive channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'ChannelId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteMediaLiveChannel', 'description' => '- You can only delete a channel that is not running.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaLiveChannel'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteMediaLiveChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaLiveInput' => [ 'summary' => 'Deletes a MediaLive input.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'InputId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteMediaLiveInput', 'description' => '- You can delete an input only when it is not associated with a MediaLive channel.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaLiveInput'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteMediaLiveInput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaLiveInputSecurityGroup' => [ 'summary' => 'Deletes a security group in MediaLive.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'SecurityGroupId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteMediaLiveInputSecurityGroup', 'description' => '- You can only delete a security group not associated with an input.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaLiveInputSecurityGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteMediaLiveInputSecurityGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteMediaMarks' => [ 'summary' => 'Deletes the marks of a media asset.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '****c469e944b5a856828dc2****', 'title' => ''], ], [ 'name' => 'MediaMarkIds', 'in' => 'query', 'schema' => ['description' => 'The mark ID. You can specify multiple mark IDs separated with commas (,).'."\n" ."\n" .'If you do not specify MediaMarkIds, all the marks of the media asset are deleted.', 'type' => 'string', 'required' => false, 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****019b82e24b37a1c2958dec38****'], 'MediaMarkIds' => ['title' => '', 'description' => 'The IDs of the deleted marks separated with commas (,).', 'type' => 'string', 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', 'title' => 'DeleteMediaMarks', 'changeSet' => [ ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaMarks'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteMediaMarks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeletePipeline' => [ 'summary' => 'Deletes an ApsaraVideo Media Processing (MPS) queue.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeletePipeline', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeletePipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeletePlayInfo' => [ 'summary' => 'Deletes media streams such as video streams and audio streams.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '1d3518e0027d71ed80cd909598416303', 'title' => ''], ], [ 'name' => 'FileURLs', 'in' => 'query', 'schema' => ['description' => 'The URL of the media stream file that you want to delete. Separate multiple URLs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4', 'title' => ''], ], [ 'name' => 'DeletePhysicalFiles', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to delete the physical file of the media stream.'."\n" ."\n" .'If the media asset is stored in your own Object Storage Service (OSS) bucket, you must authorize the service role AliyunICEDefaultRole in advance. For more information, see [Authorize IMS to delete recording files in OSS](https://help.aliyun.com/document_detail/449331.html#p-ko2-wc7-iad).'."\n" ."\n" .'You can delete only the physical files of transcoded streams, but not the physical files of source files.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'IgnoredList' => [ 'description' => 'The URLs of ignored media streams. An error occurred while obtaining such media assets because the IDs or URLs of the media assets do not exist.', 'type' => 'array', 'items' => ['description' => 'The URL of the ignored media stream. An error occurred while obtaining the media stream.', 'type' => 'string', 'example' => 'https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'ForbiddenList' => [ 'description' => 'The URLs of the media streams that cannot be deleted. Generally, media streams cannot be deleted if you do not have the required permissions.', 'type' => 'array', 'items' => ['description' => 'The URL of the media stream that cannot be deleted.', 'type' => 'string', 'example' => 'https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4'."\n", 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4\\\\n\\"\\n ],\\n \\"ForbiddenList\\": [\\n \\"https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4\\\\n\\"\\n ]\\n}","type":"json"}]', 'title' => 'DeletePlayInfo', 'changeSet' => [ ['createdAt' => '2022-08-16T07:44:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlayInfo'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeletePlayInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'description' => 'Delete multiple media streams at a time.', 'translator' => 'manual', ], 'DeleteProgram' => [ 'summary' => 'Deletes a program from a channel.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProgramName', 'in' => 'query', 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => true, 'example' => 'program_name', 'title' => ''], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteProgram', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteProgram', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteRecognitionEntity' => [ 'summary' => 'Deletes an entity from the specified custom recognition library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm associated with the entity. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the entity to be deleted.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '**************544cb84754************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteRecognitionEntity', 'description' => '- This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- Callable up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteRecognitionEntity', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteRecognitionLib' => [ 'summary' => 'Deletes a custom recognition library, including all entities and samples within it.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteRecognitionLib', 'description' => '- This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- Callable up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteRecognitionLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteRecognitionSample' => [ 'summary' => 'Deletes a sample for a custom entity.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the entity.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '**************544cb84754************', 'title' => ''], ], [ 'name' => 'SampleId', 'in' => 'query', 'schema' => ['description' => 'The ID of the sample that you want to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '**************4d2ba728e2f**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteRecognitionSample', 'description' => '- This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- Callable up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteRecognitionSample', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteSmartJob' => [ 'summary' => 'Deletes intelligent jobs based on job IDs.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The IDs of the jobs to delete. Separate multiple IDs with commas (,).', 'type' => 'string', 'example' => '******b48fb04483915d4f2cd8******,******042d5e4db6866f6289d1******', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteSmartJob', 'changeSet' => [ ['createdAt' => '2022-01-05T06:18:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmartJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteSmartJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteSource' => [ 'summary' => 'Deletes a source from MediaWeaver.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The source type. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ 'name' => 'SourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MyVodSource', 'title' => ''], ], [ 'name' => 'SoftDelete', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use delete markers.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteSource', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteSourceLocation' => [ 'summary' => 'Deletes a source location.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ 'name' => 'SoftDelete', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use delete markers.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid value:'."\n" ."\n" .'- true: The request succeeded.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteSourceLocation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteSourceLocation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteTemplate' => [ 'summary' => 'Deletes templates.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the templates that you want to delete. Separate multiple IDs with commas (,).', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****,****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteTemplate', 'description' => 'A template is an encapsulation of the timeline of a media editing and production job. You can define a common timeline as a template. When you have the same requirements, you need to only specify key parameters and materials to produce videos.'."\n" ."\n" .'- For more information about how to use a regular template, see [Create and use a regular template](~~445399~~).'."\n" ."\n" .'- For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DeleteTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteVodPackagingAsset' => [ 'summary' => 'Deletes a VOD packaging asset.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'AssetName', 'in' => 'query', 'schema' => ['description' => 'The name of the VOD packaging asset.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '30min_movie'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The result of asset deletion.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteVodPackagingAsset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteVodPackagingAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteVodPackagingConfiguration' => [ 'summary' => 'Deletes a VOD packaging configuration.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'ConfigurationName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hls_3s'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The result of deletion.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'DeleteVodPackagingConfiguration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteVodPackagingConfiguration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteVodPackagingGroup' => [ 'summary' => 'Deletes a VOD packaging group.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The result of deletion.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '13cbb83e-043c-4728-ac35-*****'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\"\\n}","type":"json"}]', 'title' => 'DeleteVodPackagingGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteVodPackagingGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DeleteYikeAssetMediaInfos' => [ 'summary' => 'Deletes one or more media assets.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'A comma-separated list of media asset IDs.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****'], ], [ 'name' => 'LogicDelete', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform a logical delete or a permanent delete. Valid values:'."\n" ."\n" .'- true (default): Performs a logical delete. This action moves the media asset to the recycle bin and retains its associated file.'."\n" ."\n" .'- false: Performs a permanent delete. This action deletes both the media asset information and the associated file.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'IgnoredList' => [ 'description' => 'A list of the IDs or InputUrl values of media assets that could not be deleted.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The ID or InputUrl of a media asset that could not be deleted.', 'type' => 'string', 'example' => '****fb2101bf24bf41cb318787dc****', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Details of deleting media asset information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'ice:DeleteYikeAssetMediaInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"****fb2101bf24bf41cb318787dc****\\"\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'DescribeAIAgentInstance' => [ 'summary' => 'Retrieves information about a specified AI agent instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236522', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI agent instance.'."\n" ."\n" .'> The `InstanceId` is the unique ID returned when an AI agent instance starts successfully. For APIs that start an AI agent, see [StartAIAgentInstance](~~2846201~~) and [GenerateAIAgentCall](~~2846209~~).', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'Instance' => [ 'description' => 'Information about the AI agent instance.', 'type' => 'object', 'properties' => [ 'CallLogUrl' => ['description' => 'The URL of the call log.', 'type' => 'string', 'example' => 'https://example.com/call_logs/12345', 'title' => ''], 'RuntimeConfig' => ['description' => 'The runtime configuration of the AI agent.', '$ref' => '#/components/schemas/AIAgentRuntimeConfig', 'example' => '{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}', 'title' => ''], 'Status' => [ 'description' => 'The status of the AI agent instance, such as `Finished` or `Executing`.', 'enumValueTitles' => ['Finished' => 'The instance has finished its task.', 'Executing' => 'The instance is running.'], 'type' => 'string', 'example' => 'Finished', 'title' => '', ], 'TemplateConfig' => ['description' => 'The AI agent template configuration.', 'deprecated' => true, '$ref' => '#/components/schemas/AIAgentTemplateConfig', 'example' => '{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}', 'title' => ''], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}', 'title' => ''], 'SessionId' => ['description' => 'The session ID for the conversation. This parameter is empty by default.', 'type' => 'string', 'example' => '955535**************', 'title' => ''], 'AgentConfig' => ['description' => 'The configuration of the AI agent.', '$ref' => '#/components/schemas/AIAgentConfig', 'title' => '', 'example' => ''], 'GmtCreate' => ['description' => 'The creation time (UTC).', 'type' => 'string', 'example' => '2025-07-18T06:39:08.000+00:00', 'title' => ''], 'GmtModified' => ['description' => 'The modification time (UTC).', 'type' => 'string', 'example' => '2025-07-18T06:40:12.000+00:00', 'title' => ''], 'CallInfo' => ['description' => 'Information about the call.', '$ref' => '#/components/schemas/AIAgentCallInfo', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instance\\": {\\n \\"CallLogUrl\\": \\"https://example.com/call_logs/12345\\",\\n \\"RuntimeConfig\\": {\\n \\"AvatarChat3D\\": {\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\"\\n },\\n \\"VisionChat\\": {\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\"\\n },\\n \\"VoiceChat\\": {\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\"\\n },\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\\\n\\"\\n },\\n \\"Status\\": \\"Finished\\",\\n \\"TemplateConfig\\": {\\n \\"AvatarChat3D\\": {\\n \\"AsrMaxSilence\\": 400,\\n \\"AvatarId\\": \\"1231\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"EnablePushToTalk\\": false,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"GracefulShutdown\\": false,\\n \\"Greeting\\": \\"早上好，我的朋友！\\",\\n \\"UseVoiceprint\\": false,\\n \\"UserOnlineTimeout\\": 60,\\n \\"VoiceId\\": \\"zhixiaoxia\\",\\n \\"Volume\\": 100,\\n \\"VoiceprintId\\": \\"uniqueId\\",\\n \\"BailianAppParams\\": \\"{}\\",\\n \\"UserOfflineTimeout\\": 5,\\n \\"MaxIdleTime\\": 600,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\",\\n \\"InterruptWords\\": [\\n \\"停止\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CharBreak\\": false,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ]\\n },\\n \\"VisionChat\\": {\\n \\"AsrMaxSilence\\": 400,\\n \\"EnableIntelligentSegment\\": true,\\n \\"EnablePushToTalk\\": false,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"GracefulShutdown\\": false,\\n \\"Greeting\\": \\"早上好，我的朋友！\\\\n\\",\\n \\"UseVoiceprint\\": false,\\n \\"UserOnlineTimeout\\": 60,\\n \\"VoiceId\\": \\"zhixiaoxia\\",\\n \\"Volume\\": 100,\\n \\"VoiceprintId\\": \\"uniqueId\\",\\n \\"BailianAppParams\\": \\"{}\\",\\n \\"UserOfflineTimeout\\": 5,\\n \\"MaxIdleTime\\": 600,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\\\n\\",\\n \\"InterruptWords\\": [\\n \\"停止\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CharBreak\\": false,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ]\\n },\\n \\"VoiceChat\\": {\\n \\"AsrMaxSilence\\": 400,\\n \\"EnableIntelligentSegment\\": true,\\n \\"EnablePushToTalk\\": false,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"GracefulShutdown\\": false,\\n \\"Greeting\\": \\"早上好，我的朋友\\",\\n \\"UseVoiceprint\\": false,\\n \\"UserOnlineTimeout\\": 60,\\n \\"VoiceId\\": \\"zhixiaoxia\\",\\n \\"Volume\\": 100,\\n \\"VoiceprintId\\": \\"uniqueId\\",\\n \\"BailianAppParams\\": \\"{}\\",\\n \\"UserOfflineTimeout\\": 5,\\n \\"AvatarUrl\\": \\"http://example.com/a.jpg\\",\\n \\"AvatarUrlType\\": \\"USER\\",\\n \\"MaxIdleTime\\": 600,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\",\\n \\"InterruptWords\\": [\\n \\"停止\\"\\n ],\\n \\"VadLevel\\": 11,\\n \\"CharBreak\\": false,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ]\\n }\\n },\\n \\"UserData\\": \\"{\\\\\\"Email\\\\\\":\\\\\\"johndoe@example.com\\\\\\",\\\\\\"Preferences\\\\\\":{\\\\\\"Language\\\\\\":\\\\\\"en\\\\\\"}}\\",\\n \\"SessionId\\": \\"955535**************\\",\\n \\"AgentConfig\\": {\\n \\"Greeting\\": \\"你好\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\\\n\\",\\n \\"MaxIdleTime\\": 600,\\n \\"UserOnlineTimeout\\": 60,\\n \\"UserOfflineTimeout\\": 5,\\n \\"EnablePushToTalk\\": false,\\n \\"GracefulShutdown\\": true,\\n \\"Volume\\": 100,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"AvatarUrl\\": \\"http://example.com/a.jpg\\\\n\\",\\n \\"AvatarUrlType\\": \\"USER\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AsrConfig\\": {\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"AsrMaxSilence\\": 400,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ],\\n \\"VadLevel\\": 11,\\n \\"CustomParams\\": \\"mode=fast&sample=16000&format=wav\\",\\n \\"VadDuration\\": 300\\n },\\n \\"TtsConfig\\": {\\n \\"VoiceId\\": \\"longcheng_v2\\\\n\\\\n\\",\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"PronunciationRules\\": [\\n {\\n \\"Word\\": \\"一一零\\",\\n \\"Pronunciation\\": \\"幺幺零\\",\\n \\"Type\\": \\"replacement\\"\\n }\\n ],\\n \\"ModelId\\": \\"speech-01-turbo\\",\\n \\"LanguageId\\": \\"Chinese\\",\\n \\"Emotion\\": \\"happy\\",\\n \\"SpeechRate\\": 1\\n },\\n \\"LlmConfig\\": {\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\\\n\\",\\n \\"BailianAppParams\\": \\"\\\\\\"{\\\\\\\\\\\\\\"biz_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"user_defined_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"your_plugin_id\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"article_index\\\\\\\\\\\\\\":2}}},\\\\\\\\\\\\\\"memory_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"your_memory_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"image_list\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"https://your_image_url\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"rag_options\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"pipeline_ids\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"your_id\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"file_ids\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"文档ID1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"文档ID2\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"metadata_filter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"张三\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"structured_filter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key2\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value2\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"tags\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"标签2\\\\\\\\\\\\\\"]}}\\\\\\"\\",\\n \\"OpenAIExtraQuery\\": \\"api-version=2024-02-01&api-key=sk-xxx\\",\\n \\"LlmCompleteReply\\": true,\\n \\"FunctionMap\\": [\\n {\\n \\"Function\\": \\"hangup\\",\\n \\"MatchFunction\\": \\"hangup\\"\\n }\\n ],\\n \\"OutputMinLength\\": 5,\\n \\"OutputMaxDelay\\": 2000,\\n \\"HistorySyncWithTTS\\": false\\n },\\n \\"AvatarConfig\\": {\\n \\"AvatarId\\": \\"5257\\"\\n },\\n \\"InterruptConfig\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"InterruptWords\\": [\\n \\"打断一下\\"\\n ],\\n \\"NoInterruptMode\\": \\"cache\\",\\n \\"KeepInterruptWordsForLLM\\": true\\n },\\n \\"VoiceprintConfig\\": {\\n \\"UseVoiceprint\\": false,\\n \\"VoiceprintId\\": \\"zhixiaoxia\\",\\n \\"RegistrationMode\\": \\"Explicit\\"\\n },\\n \\"TurnDetectionConfig\\": {\\n \\"TurnEndWords\\": [\\n \\"我说完了\\"\\n ],\\n \\"Mode\\": \\"Semantic\\",\\n \\"SemanticWaitDuration\\": -1,\\n \\"Eagerness\\": \\"High\\"\\n },\\n \\"ExperimentalConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"VcrConfig\\": {\\n \\"StillFrameMotion\\": {\\n \\"Enabled\\": false,\\n \\"CallbackDelay\\": 3000\\n },\\n \\"InvalidFrameMotion\\": {\\n \\"Enabled\\": false,\\n \\"CallbackDelay\\": 3000\\n },\\n \\"PeopleCount\\": {\\n \\"Enabled\\": false\\n },\\n \\"Equipment\\": {\\n \\"Enabled\\": false\\n },\\n \\"HeadMotion\\": {\\n \\"Enabled\\": false\\n },\\n \\"LookAway\\": {\\n \\"Enabled\\": true\\n }\\n },\\n \\"AmbientSoundConfig\\": {\\n \\"ResourceId\\": \\"f67901c595834************\\",\\n \\"Volume\\": 50\\n },\\n \\"AutoSpeechConfig\\": {\\n \\"UserIdle\\": {\\n \\"WaitTime\\": 5000,\\n \\"MaxRepeats\\": 5,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"您还在吗？\\",\\n \\"Probability\\": 0.5\\n }\\n ],\\n \\"HangupEndWord\\": \\"我挂了，再见\\"\\n },\\n \\"LlmPending\\": {\\n \\"WaitTime\\": 3000,\\n \\"Mode\\": \\"\\",\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"稍等一下\\",\\n \\"Probability\\": 0.5\\n }\\n ]\\n }\\n },\\n \\"BackChannelingConfigs\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"pause_detected\\",\\n \\"Probability\\": 0.5,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"嗯嗯\\",\\n \\"Probability\\": 0.3\\n }\\n ]\\n }\\n ],\\n \\"BackChannelingConfig\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"pause_detected\\",\\n \\"Probability\\": 0.5,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"嗯嗯\\",\\n \\"Probability\\": 0.3\\n }\\n ]\\n }\\n ]\\n },\\n \\"GmtCreate\\": \\"2025-07-18T06:39:08.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-18T06:40:12.000+00:00\\",\\n \\"CallInfo\\": {\\n \\"Status\\": \\"4\\",\\n \\"CallStartTime\\": \\"2026-04-01T16:53:53.184797+00:00\\",\\n \\"CallEndTime\\": \\"2026-04-01T16:53:58.875932+00:00\\",\\n \\"CallDuration\\": 5,\\n \\"HangupRole\\": 0,\\n \\"CallerNumber\\": \\"183*****333\\",\\n \\"CalleeNumber\\": \\"136******794\\"\\n }\\n },\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', 'title' => 'Query Agent Instance Details', 'description' => '- **Description**: Retrieves detailed information for a specific AI agent instance.'."\n" ."\n" .'- **Use cases**: Use this operation to monitor or analyze the performance of an AI agent during a call, or to debug its configuration.', 'changeSet' => [ ['createdAt' => '2025-08-07T12:21:57.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-05-29T07:43:21.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-01-23T09:26:49.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeAIAgentInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DescribeMeterImsEditUsage' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '146735', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'StartTs', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1654403036', 'title' => ''], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656995036', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => ['description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '86400', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7F3AE2C6-5CC6-5712-BAC5-5A735A157687'], 'Data' => [ 'description' => 'The usage statistics of IMS on VOD editing.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Time' => ['description' => 'The beginning time of usage. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1656950400', 'title' => ''], 'Duration' => ['description' => 'The usage duration, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1.23', 'title' => ''], 'Profile' => ['description' => 'The video profile.', 'type' => 'string', 'example' => '1080P', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''], ], 403 => [ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''], ], 500 => [ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''], ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''], ], 502 => [ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F3AE2C6-5CC6-5712-BAC5-5A735A157687\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Duration\\": 1.23,\\n \\"Profile\\": \\"1080P\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeMeterImsEditUsage', 'summary' => 'Queries the usage statistics of Intelligent Media Services (IMS) on video-on-demand (VOD) editing. The maximum query range is 31 days. You can query data within the last 90 days.', 'changeSet' => [ ['createdAt' => '2022-07-26T13:04:28.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsEditUsage'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeMeterImsEditUsage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DescribeMeterImsMediaConvertUHDUsage' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '146742', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'StartTs', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1654403036', 'title' => ''], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656995036', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => '3600'."\n", 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C'], 'Data' => [ 'description' => 'The usage statistics of IMS on UHD transcoding of MPS.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Time' => ['description' => 'The beginning time of usage. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1656950400', 'title' => ''], 'Specification' => ['description' => 'The transcoding specifications.', 'type' => 'string', 'example' => 'SuperResolution.Standard.1080P'."\n", 'title' => ''], 'Duration' => ['description' => 'The usage duration, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '308028', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''], ], 403 => [ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''], ], 500 => [ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''], ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''], ], 502 => [ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Specification\\": \\"SuperResolution.Standard.1080P\\\\n\\",\\n \\"Duration\\": 308028\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeMeterImsMediaConvertUHDUsage', 'summary' => 'Queries the usage statistics of Intelligent Media Services (IMS) on ultra high definition (UHD) transcoding of ApsaraVideo Media Processing (MPS). The maximum query range is 31 days. You can query data within the last 90 days.', 'changeSet' => [ ['createdAt' => '2022-07-26T13:04:28.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsMediaConvertUHDUsage'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeMeterImsMediaConvertUHDUsage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DescribeMeterImsMediaConvertUsage' => [ 'summary' => 'Queries the usage statistics of Intelligent Media Services (IMS) on video-on-demand (VOD) transcoding. The maximum query range is 31 days. You can query data within the last 90 days.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '146741', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'StartTs', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The value is a 10-digit timestamp. You can query data within the last 90 days.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1654403036', 'title' => ''], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The value is a 10-digit timestamp. The maximum query range is 31 days. The duration between StartTs and EndTs cannot exceed 31 days.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656995036', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'."\n", 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => ['description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '86400', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FBBB5210-2B78-58FB-A6FE-9DD887BB2C61'], 'Data' => [ 'description' => 'The usage statistics of IMS on VOD transcoding.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Time' => ['description' => 'The beginning time of usage. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1656950400', 'title' => ''], 'Specification' => ['description' => 'The transcoding specifications.', 'type' => 'string', 'example' => 'H264.HD'."\n", 'title' => ''], 'Duration' => ['description' => 'The usage duration, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''], ], 403 => [ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''], ], 500 => [ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''], ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''], ], 502 => [ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBB5210-2B78-58FB-A6FE-9DD887BB2C61\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Specification\\": \\"H264.HD\\\\n\\",\\n \\"Duration\\": 20\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeMeterImsMediaConvertUsage', 'changeSet' => [ ['createdAt' => '2022-07-26T13:04:28.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsMediaConvertUsage'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeMeterImsMediaConvertUsage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DescribeMeterImsMpsAiUsage' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '146716', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'StartTs', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The value is a 10-digit timestamp. You can query data within the last 90 days.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1654403036', 'title' => ''], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The value is a 10-digit timestamp. The maximum query range is 31 days. The duration between StartTs and EndTs cannot exceed 31 days.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656995036', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => ['description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '86400', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0622C702-41BE-467E-AF2E-883D4517962E'], 'Data' => [ 'description' => 'The usage statistics of IMS on AI processing of MPS.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Time' => ['description' => 'The beginning time of usage. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1656950400', 'title' => ''], 'Type' => ['description' => 'The AI type. Valid values:', 'type' => 'string', 'example' => 'Censor：审核类型'."\n" .'Product：生产类型', 'title' => ''], 'Duration' => ['description' => 'The usage duration, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '644', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''], ], 403 => [ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''], ], 500 => [ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''], ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''], ], 502 => [ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Type\\": \\"Censor：审核类型\\\\nProduct：生产类型\\",\\n \\"Duration\\": 644\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeMeterImsMpsAiUsage', 'summary' => 'Queries the usage statistics of Intelligent Media Services (IMS) on AI processing of ApsaraVideo Media Processing (MPS). The maximum query range is 31 days. You can query data within the last 90 days.', 'changeSet' => [ ['createdAt' => '2022-07-26T13:04:28.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsMpsAiUsage'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeMeterImsMpsAiUsage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DescribeMeterImsSummary' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '146724', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'StartTs', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1654403036', 'title' => ''], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The value is a 10-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656995036', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C'], 'Data' => [ 'description' => 'The usage statistics of IMS.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MpsTranscodeDuration' => ['description' => 'The duration of video-on-demand (VOD) transcoding.', 'type' => 'integer', 'format' => 'int64', 'example' => '17337', 'title' => ''], 'MpsTranscodeUHDDuration' => ['description' => 'The duration of audio and video enhancement.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], 'LiveTranscodeDuration' => ['description' => 'The duration of live stream transcoding.', 'type' => 'integer', 'format' => 'int64', 'example' => '12356', 'title' => ''], 'EditingDuration' => ['description' => 'The duration of video editing.', 'type' => 'string', 'example' => '8722', 'title' => ''], 'MpsAiDuration' => ['description' => 'The duration of AI processing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LiveRecordDuration' => ['description' => 'The duration of live stream recording.', 'type' => 'string', 'example' => '100', 'title' => ''], 'LiveEditDuration' => ['description' => 'The duration of live editing.', 'type' => 'string', 'example' => '2000', 'title' => ''], 'LiveSnapshotCount' => ['description' => 'The number of live stream snapshots.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''], ], 403 => [ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''], ], 500 => [ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''], ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''], ], 502 => [ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"Data\\": [\\n {\\n \\"MpsTranscodeDuration\\": 17337,\\n \\"MpsTranscodeUHDDuration\\": 300,\\n \\"LiveTranscodeDuration\\": 12356,\\n \\"EditingDuration\\": \\"8722\\",\\n \\"MpsAiDuration\\": 0,\\n \\"LiveRecordDuration\\": \\"100\\",\\n \\"LiveEditDuration\\": \\"2000\\",\\n \\"LiveSnapshotCount\\": \\"100\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeMeterImsSummary', 'summary' => 'Queries the usage statistics of Intelligent Media Services (IMS). The maximum query range is 31 days. You can query data within the last 90 days.', 'changeSet' => [ ['createdAt' => '2022-08-23T07:18:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsSummary'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeMeterImsSummary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DescribeNotifyConfig' => [ 'summary' => 'Retrieves the event callback configuration for a specified AIAgent.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236017', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AIAgent.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'CallbackUrl' => ['description' => 'The URL where event callbacks are sent.', 'type' => 'string', 'example' => 'http://customer.com/callback', 'title' => ''], 'EnableNotify' => ['description' => 'Indicates whether notifications are enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EventTypes' => [ 'description' => 'The event types. If you do not specify this parameter, all event types are selected by default.'."\n" ."\n" .'- `agent_start`: The agent is ready.'."\n" ."\n" .'- `agent_stop`: The agent is stopped.'."\n" ."\n" .'- `error`: The task encountered an error.', 'enumValueTitles' => ['agent_start' => 'agent\\_start', 'error' => 'error', 'agent_stop' => 'agent\\_stop'], 'type' => 'string', 'example' => 'agent_start,agent_stop,error', 'title' => '', ], 'Token' => ['description' => 'The authentication token used to verify the callback. This token is included in the `Authorization` field of the request header for each event callback.', 'type' => 'string', 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', 'title' => ''], 'AudioOssPath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EnableAudioRecording' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CallbackUrl\\": \\"http://customer.com/callback\\",\\n \\"EnableNotify\\": true,\\n \\"EventTypes\\": \\"agent_start,agent_stop,error\\",\\n \\"Token\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"AudioOssPath\\": \\"\\",\\n \\"EnableAudioRecording\\": false,\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', 'title' => 'Query Agent Notification Configuration', 'description' => 'Retrieves the event callback configuration for a specified AIAgent.', 'changeSet' => [ ['createdAt' => '2025-04-08T03:25:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeNotifyConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DescribePlayList' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '146436', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'TraceId', 'in' => 'query', 'schema' => ['description' => 'The TraceId of the player.', 'type' => 'string', 'required' => false, 'example' => '0bc5e70516766285805381012d271e', 'title' => ''], ], [ 'name' => 'BeginTs', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. By default, the system queries data of the current day.', 'type' => 'string', 'required' => true, 'example' => '1676170500011', 'title' => ''], ], [ 'name' => 'EndTs', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The time range cannot exceed 24 hours.', 'type' => 'string', 'required' => true, 'example' => '1682474405173', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => ['description' => 'The sort order. Valid values:'."\n" ."\n" .'- DESC: descending order.'."\n" ."\n" .'- ASC: ascending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'OrderName', 'in' => 'query', 'schema' => ['description' => 'The criteria by which the sorting is performed. Valid values:'."\n" ."\n" .'- FirstFrameDuration'."\n" ."\n" .'- PlayDuration'."\n" ."\n" .'- VideoDuration'."\n" ."\n" .'- StuckDuration', 'type' => 'string', 'required' => false, 'example' => 'FirstFrameDuration', 'title' => ''], ], [ 'name' => 'PlayType', 'in' => 'query', 'schema' => ['description' => 'The playback type. Valid value:'."\n" ."\n" .'- vod', 'type' => 'string', 'required' => false, 'example' => 'vod', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The playback status. Valid values:'."\n" ."\n" .'- complete'."\n" ."\n" .'- playing'."\n" ."\n" .'- unusual: A playback error occurs.', 'type' => 'string', 'required' => false, 'example' => 'complete', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalNum' => ['description' => 'The total playback count.', 'type' => 'integer', 'format' => 'int64', 'example' => '49', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B960580D-26FA-5547-8AFC-3CDC812DBF27'], 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'PlayList' => [ 'description' => 'The playback records.', 'type' => 'array', 'items' => [ 'description' => 'The playback record.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The playback status.', 'type' => 'string', 'example' => 'complete', 'title' => ''], 'VideoId' => ['description' => 'The ID of the video.', 'type' => 'string', 'example' => '250314203f0171eebff17035d0b20102', 'title' => ''], 'StuckDuration' => ['description' => 'The stuttering duration.', 'type' => 'string', 'example' => '20', 'title' => ''], 'PlayDuration' => ['description' => 'The playback duration.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'FirstFrameDuration' => ['description' => 'Time to first frame.', 'type' => 'string', 'example' => '200', 'title' => ''], 'TraceId' => ['description' => 'The TraceId of the player.', 'type' => 'string', 'example' => '0b736abf16724820210842673d9543', 'title' => ''], 'PlayType' => ['description' => 'The playback type.', 'type' => 'string', 'example' => 'vod', 'title' => ''], 'SessionId' => ['description' => 'The ID of the player session.', 'type' => 'string', 'example' => '91488be2-8381-40c9-8494-e8afe22c4a2d', 'title' => ''], 'VideoDuration' => ['description' => 'The duration of the video.', 'type' => 'string', 'example' => '2000', 'title' => ''], 'PlayTs' => ['description' => 'The timestamp when the playback started.', 'type' => 'string', 'example' => '1675922209572', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Meter.ParamError', 'errorMessage' => 'Param Error:%s,Please Check Again.', 'description' => ''], ], 403 => [ ['errorCode' => 'Meter.AuthError', 'errorMessage' => 'Authentication Failed,Please Try Again.', 'description' => ''], ], 500 => [ ['errorCode' => 'Meter.ServerInternalError', 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', 'description' => ''], ['errorCode' => 'Meter.DataSourceQueryError', 'errorMessage' => 'Data Source Error:%s,Please Try Again.', 'description' => ''], ], 502 => [ ['errorCode' => 'Meter.ReadyTsError', 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalNum\\": 49,\\n \\"RequestId\\": \\"B960580D-26FA-5547-8AFC-3CDC812DBF27\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"PlayList\\": [\\n {\\n \\"Status\\": \\"complete\\",\\n \\"VideoId\\": \\"250314203f0171eebff17035d0b20102\\",\\n \\"StuckDuration\\": \\"20\\",\\n \\"PlayDuration\\": \\"1000\\",\\n \\"FirstFrameDuration\\": \\"200\\",\\n \\"TraceId\\": \\"0b736abf16724820210842673d9543\\",\\n \\"PlayType\\": \\"vod\\",\\n \\"SessionId\\": \\"91488be2-8381-40c9-8494-e8afe22c4a2d\\",\\n \\"VideoDuration\\": \\"2000\\",\\n \\"PlayTs\\": \\"1675922209572\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribePlayList', 'summary' => 'Retrieves playback records based on the player\'s TraceId. This API supports pagination.', 'responseParamsDescription' => '{'."\n" .'"code":"200",'."\n" .'"data":{'."\n" .'"PlayList":\\['."\n" .'{'."\n" .'"Status":"unusual",'."\n" .'"PlayTs":1700533661526,'."\n" .'"PlayDuration":0.0000,'."\n" .'"VideoId":"11222223333",'."\n" .'"VideoDuration":227285.0000,'."\n" .'"PlayType":"vod",'."\n" .'"TraceId":"1840527851",'."\n" .'"SessionId":"c031504c-c43c-5628-a1b7-3cddddjhd34370",'."\n" .'"FirstFrameDuration":220,'."\n" .'"StuckDuration":0.0000'."\n" .'}'."\n" .'],'."\n" .'"TotalNum":1,'."\n" .'"RequestId":"54D95240-6BE7-1BCB-B8FB-27141AE6A5E6",'."\n" .'"PageNum":1,'."\n" .'"PageSize":1'."\n" .'},'."\n" .'"httpStatusCode":"200",'."\n" .'"requestId":"54D95240-6BE7-1BCB-B8FB-27141AE6A5E6",'."\n" .'"successResponse":true'."\n" .'}', 'changeSet' => [ ['createdAt' => '2022-09-08T06:33:48.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlayList'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribePlayList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DescribeRtcRobotInstance' => [ 'summary' => 'Retrieves information about an RTC Robot Instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230670', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => '727dc0e296014bb58670940a3da95592', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'AuthToken' => ['description' => 'The authentication token for the RTC Channel.', 'type' => 'string', 'example' => '**********', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'testId', 'title' => ''], 'Config' => [ 'description' => 'The advanced configurations of the AI agent.', 'type' => 'object', 'properties' => [ 'EnableVoiceInterrupt' => ['description' => 'Specifies whether to allow voice interruption.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Greeting' => ['description' => 'The welcome message.', 'type' => 'string', 'example' => 'Hello', 'title' => ''], 'VoiceId' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'zhixiaoxia', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91'], 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" ."\n" .'- `Executing`: The instance is running.'."\n" ."\n" .'- `Finished`: The instance has stopped.', 'type' => 'string', 'example' => 'Executing', 'title' => ''], 'UserData' => ['description' => 'The custom user data.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'UserId' => ['description' => 'The ID of the AI agent in the channel.', 'type' => 'string', 'example' => 'my-robot', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthToken\\": \\"**********\\",\\n \\"ChannelId\\": \\"testId\\",\\n \\"Config\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"Greeting\\": \\"Hello\\",\\n \\"VoiceId\\": \\"zhixiaoxia\\"\\n },\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\",\\n \\"Status\\": \\"Executing\\",\\n \\"UserData\\": \\"{}\\",\\n \\"UserId\\": \\"my-robot\\"\\n}","type":"json"}]', 'title' => 'Query an RTC interactive AI agent instance ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:DescribeRtcRobotInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DetectAudioForCustomizedVoiceJob' => [ 'summary' => 'Checks whether the reading of users has issues, such as noticeable pronunciation errors or background noise. After the audio is checked on the cloud, the qualified audio is temporarily stored on the cloud for subsequent training. Do not skip this step.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'VoiceId', 'in' => 'query', 'schema' => ['description' => 'The voice ID.', 'type' => 'string', 'required' => true, 'example' => 'xiaozhuan', 'title' => ''], ], [ 'name' => 'RecordUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the recording file.'."\n" ."\n" .'> : The URL must be an Object Storage Service (OSS) URL within your Alibaba Cloud account. The OSS bucket must be in the same region in which IMS is activated.'."\n" ."\n" .'> : The audio file must be in the WAV or PCM format and must be a 16-bit mono audio file at 48000 Hz.', 'type' => 'string', 'required' => true, 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/record1.wav', 'title' => ''], ], [ 'name' => 'AudioRecordId', 'in' => 'query', 'schema' => ['description' => 'The sequence number of the recording file.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Pass' => ['description' => 'Indicates whether the audio file passes the check. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Reason' => ['description' => 'The reason returned if the audio file failed to pass the check.', 'type' => 'string', 'example' => '发音错误，请准确读出文案中的内容', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Pass\\": false,\\n \\"Reason\\": \\"发音错误，请准确读出文案中的内容\\"\\n }\\n}","type":"json"}]', 'title' => 'DetectAudioForCustomizedVoiceJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectAudioForCustomizedVoiceJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:DetectAudioForCustomizedVoiceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DropSearchIndex' => [ 'summary' => 'Deletes a search index. After you delete a search index, the existing index data is cleared and index-based analysis, storage, and query are not supported for subsequent media assets.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.'."\n" ."\n" .'- If you leave this parameter empty, the search index is created in the default search library of Intelligent Media Service (IMS). Default value: ims-default-search-lib.'."\n" ."\n" .'- To query information about an existing search library, call the [QuerySearchLib](~~2584455~~) API operation.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'IndexType', 'in' => 'query', 'schema' => [ 'description' => 'The category of the index. Valid values:'."\n" ."\n" .'- mm: large visual model.'."\n" ."\n" .'- face: face recognition.'."\n" ."\n" .'- aiLabel: smart tagging.', 'enumValueTitles' => ['mm' => 'mm'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'DropSearchIndex', 'changeSet' => [ ['createdAt' => '2023-11-22T08:19:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DropSearchIndex'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DropSearchIndex', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'DropSearchLib' => [ 'summary' => 'Deletes a search library and all media assets in the library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'DropSearchLib', 'changeSet' => [ ['createdAt' => '2023-11-22T08:19:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DropSearchLib'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:DropSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ForbidMediaConnectFlowOutput' => [ 'summary' => 'Disables an output of a MediaConnect flow. When disabled, the output retains its configuration, but no live stream is delivered to the destination.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => false, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ 'name' => 'OutputName', 'in' => 'query', 'schema' => ['description' => 'The name of the output.', 'type' => 'string', 'required' => false, 'example' => 'AliTestOutput', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1BCA0CFC-CBD4-5656-9D04-21B1FADBB92A'], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Content' => ['description' => 'The response body.', 'type' => 'string', 'example' => '""', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1BCA0CFC-CBD4-5656-9D04-21B1FADBB92A\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', 'title' => 'ForbidMediaConnectFlowOutput', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:ForbidMediaConnectFlowOutput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ForwardAIAgentCall' => [ 'summary' => 'Transfer the call to the target phone number.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Current call instance ID, used only in inbound call transfer scenarios.', 'type' => 'string', 'required' => false, 'example' => 'call_instance_202******', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => ['description' => 'The target phone number for call transfer.', 'type' => 'string', 'required' => false, 'example' => '13**********', 'title' => ''], ], [ 'name' => 'TransferPrompt', 'in' => 'query', 'schema' => ['description' => 'Prompt message played before initiating the transfer. If empty, the system skips the prompt and plays the ringing tone directly. Default is empty.', 'type' => 'string', 'required' => false, 'example' => 'Please hold while I transfer your call.', 'title' => ''], ], [ 'name' => 'ErrorPrompt', 'in' => 'query', 'schema' => ['description' => 'Abnormal prompt text played when the transfer fails. Default is empty.', 'type' => 'string', 'required' => false, 'example' => 'We’re sorry, we’re unable to transfer your call at the moment. Please try again later.'."\n", 'title' => ''], ], [ 'name' => 'CallerNumber', 'in' => 'query', 'schema' => ['description' => 'The caller phone number for the transferred call. Optional.'."\n" ."\n" .'>'."\n" ."\n" .'By default, the CallerNumber is the agent\'s phone number after the call starts:'."\n" .'1\\. For inbound lines, the agent number is the agent’s seat number.'."\n" .'2\\. For outbound lines, the agent number is the original caller number.'."\n" ."\n\n" .'>'."\n" ."\n" .'>'."\n" ."\n" .'Alibaba Cloud lines do not support this parameter.'."\n" ."\n" .'>', 'type' => 'string', 'required' => false, 'example' => '13**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '550e8400********55440000'."\n"], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"550e8400********55440000\\\\n\\"\\n}","type":"json"}]', 'title' => 'Call Transfer API ', 'changeSet' => [ ['createdAt' => '2025-12-01T09:15:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-11-13T11:24:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ForwardAIAgentCall', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GenerateAIAgentCall' => [ 'summary' => 'Creates an agent instance and returns the channel, username, and token to join the channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236524', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The AI agent ID.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => ['description' => 'Optional. The expiration time of the token in seconds. Default value: 3600. Value range: 0 to 604800.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The username in the channel. If you do not specify a username, one is automatically generated. The username can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '877ae632caae49b1afc81c2e8194ffb4', 'title' => ''], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => '- This configuration merges with the agent template configuration in the console.'."\n" ."\n" .'- If you omit this parameter, the agent uses the default configuration from the console.'."\n" ."\n" .'> The agent template configuration. This parameter is deprecated. Use the AgentConfig parameter instead.', 'deprecated' => true, '$ref' => '#/components/schemas/AIAgentTemplateConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'User data.', 'type' => 'string', 'required' => false, 'example' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}'."\n", 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'A unique identifier for the session. If not provided, a new session is created.', 'type' => 'string', 'required' => false, 'example' => 'fw1gr0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'AgentConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The agent template configuration. The configuration you provide merges with the agent template configuration in the console. If you omit this parameter, the agent uses the default configuration from the console.'."\n" ."\n" .'> Compatibility with `TemplateConfig`: Fields in `AgentConfig` take precedence. If a field is specified in `TemplateConfig` but not in `AgentConfig`, the system uses the value from `TemplateConfig`. We recommend using `AgentConfig` instead of `TemplateConfig`.', '$ref' => '#/components/schemas/AIAgentConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'ChatSyncConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The chat synchronization configuration.', 'type' => 'object', 'properties' => [ 'IMAIAgentId' => ['description' => 'The ID of the Instant Messaging (IM) agent.', 'type' => 'string', 'required' => false, 'example' => '******005e4f309379701645f4****'."\n", 'title' => ''], 'ReceiverId' => ['description' => 'The user ID of the recipient.', 'type' => 'string', 'required' => false, 'example' => '4167626d312034b2b1c3b7f2f3e41884', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'AIAgentUserId' => ['description' => 'The name of the agent in the Alibaba Real-time Communication (ARTC) channel.', 'type' => 'string', 'example' => '877ae632caae49b1afc81c2e8194ffb4', 'title' => ''], 'ChannelId' => ['description' => 'The ID of the ARTC channel.', 'type' => 'string', 'example' => '70f22d5784194938a7e387052f2b3208', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the generated agent instance.', 'type' => 'string', 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], 'Token' => ['description' => 'The client-side ARTC token.', 'type' => 'string', 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', 'title' => ''], 'UserId' => ['description' => 'The username in the ARTC channel.', 'type' => 'string', 'example' => 'user123', 'title' => ''], 'AvatarUserId' => ['description' => 'The user ID of the avatar in the channel.', 'type' => 'string', 'example' => 'avatar_39f8e0bc005e4f309379701645f4****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AIAgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\",\\n \\"InstanceId\\": \\"39f8e0bc005e4f309379701645f4****\\",\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"Token\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"UserId\\": \\"user123\\",\\n \\"AvatarUserId\\": \\"avatar_39f8e0bc005e4f309379701645f4****\\"\\n}","type":"json"}]', 'title' => 'Generate an AI Agent Call Instance ', 'description' => 'This API creates an agent instance using the specified AI agent ID (AIAgentId). You can use the information in the response to join the corresponding channel and start a session with the agent.'."\n" ."\n" .'>'."\n" ."\n" .'Ensure that the specified AI agent ID is valid and configure optional parameters as needed.'."\n" ."\n" .'>', 'changeSet' => [ ['createdAt' => '2025-05-29T07:43:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-27T07:13:06.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-01-23T09:26:49.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-20T02:59:05.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateAIAgentCall'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:GenerateAIAgentCall', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GenerateKMSDataKey' => [ 'summary' => 'Generates a random Key Management Service (KMS) data key used for HTTP Live Streaming (HLS) encryption and transcoding of videos.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'DataKey' => [ 'description' => 'The information about the data key.', 'type' => 'object', 'properties' => [ 'KeyId' => ['description' => 'The ID of the customer master key (CMK). The ID must be globally unique.', 'type' => 'string', 'example' => '7906979c-8e06-46a2-be2d-68e3ccbc****'."\n", 'title' => ''], 'Plaintext' => ['description' => 'The Base64-encoded plaintext of the data key.', 'type' => 'string', 'example' => 'QmFzZTY0IGVuY29kZWQgcGxhaW50****'."\n", 'title' => ''], 'CiphertextBlob' => ['description' => 'The ciphertext of the encrypted data key. This parameter is used as CipherText when you create a transcoding job.', 'type' => 'string', 'example' => ' '."\n" .'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"DataKey\\": {\\n \\"KeyId\\": \\"7906979c-8e06-46a2-be2d-68e3ccbc****\\\\n\\",\\n \\"Plaintext\\": \\"QmFzZTY0IGVuY29kZWQgcGxhaW50****\\\\n\\",\\n \\"CiphertextBlob\\": \\"\\\\t\\\\nODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****\\"\\n }\\n}","type":"json"}]', 'title' => 'GenerateKMSDataKey', 'description' => '## Prerequisites'."\n" ."\n" .'You must [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?spm=a2c63.p38356.0.0.583760760aj80E) to create a custom KMS key before you can call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateKMSDataKey'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GenerateKMSDataKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GenerateMessageChatToken' => [ 'summary' => 'Generates the token required for interactive messaging.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236523', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI agent.', 'type' => 'string', 'required' => true, 'example' => '19de81b3b3d94abda22******', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the user to sign in. It can be up to 64 characters in length and can contain only letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'example' => 'YOURUSERID', 'title' => ''], ], [ 'name' => 'Role', 'in' => 'query', 'schema' => ['description' => 'The role. A value of admin indicates that the user can perform management operations. This parameter is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => ['description' => 'The validity period. Unit: seconds. Default value: 3600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'req_1234567890abcdef'], 'Token' => ['description' => 'The generated token.', 'type' => 'string', 'example' => 'acet**********', 'title' => ''], 'AppId' => ['description' => 'The AppID of the user.', 'type' => 'string', 'example' => '***********', 'title' => ''], 'UserId' => ['description' => 'The ID of the user for joining the channel.', 'type' => 'string', 'example' => 'YOURUSERID', 'title' => ''], 'Nonce' => ['description' => 'The nonce used to generate the token.', 'type' => 'string', 'example' => 'AK-***********', 'title' => ''], 'Role' => ['description' => 'The role used to generate the token.', 'type' => 'string', 'example' => 'admin', 'title' => ''], 'AppSign' => ['description' => 'The application signature.', 'type' => 'string', 'example' => 'H4sIAAAAAAAE******************', 'title' => ''], 'TimeStamp' => ['description' => 'The expiration time. Unit: seconds. Expiration time = Current time + Validity period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"req_1234567890abcdef\\",\\n \\"Token\\": \\"acet**********\\",\\n \\"AppId\\": \\"***********\\",\\n \\"UserId\\": \\"YOURUSERID\\",\\n \\"Nonce\\": \\"AK-***********\\",\\n \\"Role\\": \\"admin\\",\\n \\"AppSign\\": \\"H4sIAAAAAAAE******************\\",\\n \\"TimeStamp\\": 1700000000\\n}","type":"json"}]', 'title' => 'GenerateMessageChatToken', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:GenerateMessageChatToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetAIAgentConcurrency' => [ 'summary' => 'Retrieves the current number of active concurrent calls for a specified AI agent. This is a lightweight query operation that returns only the number of currently active instances. It does not return instance details or historical peak values.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236523', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI agent.', 'type' => 'string', 'required' => true, 'example' => '*******3b3d94abda22******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'ActiveCount' => ['description' => 'The number of active concurrent calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '39', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAIAgentConcurrency', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:GetAIAgentConcurrency', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"ActiveCount\\": 39\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetAIWorkflowTask' => [ 'summary' => 'Retrieves the details of a workflow task.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'required' => false, 'example' => '********-266c-4bb8-b20c-6faa********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'WorkflowTask' => [ 'description' => 'The information about the workflow task.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'example' => '********-67fd-43aa-9cc1-3e7f********', 'title' => ''], 'Status' => [ 'description' => 'The task state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- running'."\n" ."\n" .'- stopped'."\n" ."\n" .'- failed'."\n" ."\n" .'- partial-succeeded'."\n" ."\n" .'- succeeded', 'enumValueTitles' => ['running' => '', 'stopped' => '', 'failed' => '', 'partial-succeeded' => '', 'succeeded' => ''], 'type' => 'string', 'example' => 'succeeded', 'title' => '', ], 'Inputs' => ['description' => 'The input parameters of the workflow task.', 'type' => 'string', 'example' => '{\\"source_language_id\\":\\"en\\",\\"live_id\\":123,\\"live_url\\":{\\"url\\":\\"rtmp://test.com.cn/video/638d9088fe4f15ce\\"}}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2025-07-28T02:17:26Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2025-08-19T02:28:22Z', 'title' => ''], 'Workflow' => [ 'description' => 'The workflow template information.', 'type' => 'object', 'properties' => [ 'WorkflowId' => ['description' => 'The ID of the workflow template.', 'type' => 'string', 'example' => '****3f44-f1f6-477e-9364-c5e6c49e****', 'title' => ''], 'Name' => ['description' => 'The name of the workflow template.', 'type' => 'string', 'example' => 'RealtimeTranslation', 'title' => ''], 'Status' => ['description' => 'Workflow template status. Valid values:'."\n" ."\n" .'- Draft'."\n" ."\n" .'- Published'."\n" ."\n" .'- Editing', 'type' => 'string', 'example' => 'Draft', 'title' => ''], 'Type' => ['description' => 'The scenario type of the template.', 'type' => 'string', 'example' => 'Live', 'title' => ''], 'CreateTime' => ['description' => 'The time when the template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2025-08-20T01:35:04Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2025-08-20T01:35:04Z', 'title' => ''], 'Version' => ['description' => 'The template version.', 'type' => 'string', 'example' => '****ec0a-e3b9-40b1-abf2-6549d00e****', 'title' => ''], 'Graph' => ['description' => 'The workflow\'s topological structure.', 'type' => 'string', 'example' => '{'."\n" .'"nodes":[...],'."\n" .'"edges":[...]'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'NodeResults' => ['description' => 'The results of the workflow nodes. The structure of this JSON varies based on the workflow\'s configuration.', 'type' => 'string', 'example' => '{...}', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', 'title' => ''], 'Outputs' => ['description' => 'The node output.', 'type' => 'string', 'example' => '{'."\n" .'"result":"test"'."\n" .'}', 'title' => ''], 'Version' => ['description' => 'The version of the workflow template that was executed.', 'type' => 'string', 'example' => '****ec0a-e3b9-40b1-abf2-6549d00e****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"WorkflowTask\\": {\\n \\"TaskId\\": \\"********-67fd-43aa-9cc1-3e7f********\\",\\n \\"Status\\": \\"succeeded\\",\\n \\"Inputs\\": \\"{\\\\\\\\\\\\\\"source_language_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"live_id\\\\\\\\\\\\\\":123,\\\\\\\\\\\\\\"live_url\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rtmp://test.com.cn/video/638d9088fe4f15ce\\\\\\\\\\\\\\"}}\\",\\n \\"CreateTime\\": \\"2025-07-28T02:17:26Z\\",\\n \\"FinishTime\\": \\"2025-08-19T02:28:22Z\\",\\n \\"Workflow\\": {\\n \\"WorkflowId\\": \\"****3f44-f1f6-477e-9364-c5e6c49e****\\",\\n \\"Name\\": \\"RealtimeTranslation\\",\\n \\"Status\\": \\"Draft\\",\\n \\"Type\\": \\"Live\\",\\n \\"CreateTime\\": \\"2025-08-20T01:35:04Z\\",\\n \\"ModifiedTime\\": \\"2025-08-20T01:35:04Z\\",\\n \\"Version\\": \\"****ec0a-e3b9-40b1-abf2-6549d00e****\\",\\n \\"Graph\\": \\"{\\\\n\\\\\\"nodes\\\\\\":[...],\\\\n\\\\\\"edges\\\\\\":[...]\\\\n}\\"\\n },\\n \\"NodeResults\\": \\"{...}\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\",\\n \\"Outputs\\": \\"{\\\\n\\\\\\"result\\\\\\":\\\\\\"test\\\\\\"\\\\n}\\",\\n \\"Version\\": \\"****ec0a-e3b9-40b1-abf2-6549d00e****\\"\\n }\\n}","type":"json"}]', 'title' => 'GetAIWorkflowTask', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetAIWorkflowTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetAdInsertion' => [ 'summary' => 'Obtains details of an ad insertion configuration.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238117', 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the ad insertion configuration that you want to query.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_ad'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Config' => [ 'description' => 'The ad insertion configuration.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'title' => '', 'example' => '2024-06-13T08:26:09Z '], 'LastModified' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'title' => '', 'example' => '2024-06-13T08:26:09Z '], 'Name' => ['description' => 'The name of the configuration.', 'type' => 'string', 'title' => '', 'example' => 'my_ad'], 'ContentUrlPrefix' => ['description' => 'The prefix of the source URL.', 'type' => 'string', 'title' => '', 'example' => 'https://source.com/'."\n"], 'AdsUrl' => ['description' => 'The URL of the ad decision server (ADS).', 'type' => 'string', 'title' => '', 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'], 'ConfigAliases' => ['description' => 'The aliases for dynamic variable replacement.', 'type' => 'string', 'title' => '', 'example' => '{'."\n" .' "player_params.p1": {'."\n" .' "1": "abc"'."\n" .' }'."\n" .'}'], 'PersonalizationThreshold' => ['description' => 'The personalization threshold.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'SlateAdUrl' => ['description' => 'The URL of the slate ad.', 'type' => 'string', 'title' => '', 'example' => 'http://storage.com/slate1.mp4'], 'CdnConfig' => [ 'title' => '', 'description' => 'The CDN configurations.', 'type' => 'object', 'properties' => [ 'ContentSegmentUrlPrefix' => ['description' => 'The CDN prefix for accessing content segments.', 'type' => 'string', 'title' => '', 'example' => 'http://cdn.com/'], 'AdSegmentUrlPrefix' => ['description' => 'The CDN prefix for accessing ad segments.', 'type' => 'string', 'title' => '', 'example' => 'http://cdn.com/'], ], 'example' => '', ], 'AdMarkerPassthrough' => ['description' => 'Indicates whether ad marker passthrough is enabled.', 'type' => 'string', 'title' => '', 'example' => 'ON'], 'ManifestEndpointConfig' => [ 'title' => '', 'description' => 'The playback endpoint prefix for accessing manifests.', 'type' => 'object', 'properties' => [ 'HlsPrefix' => ['description' => 'The playback endpoint prefix for accessing HLS manifests.', 'type' => 'string', 'title' => '', 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'], 'DashPrefix' => ['description' => 'DASH manifest playback endpoint prefix', 'type' => 'string', 'title' => '', 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\\\t\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\\\t\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\\\n\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\",\\n \\"ConfigAliases\\": \\"{\\\\n \\\\\\"player_params.p1\\\\\\": {\\\\n \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\"\\\\n }\\\\n}\\",\\n \\"PersonalizationThreshold\\": 5,\\n \\"SlateAdUrl\\": \\"http://storage.com/slate1.mp4\\",\\n \\"CdnConfig\\": {\\n \\"ContentSegmentUrlPrefix\\": \\"http://cdn.com/\\",\\n \\"AdSegmentUrlPrefix\\": \\"http://cdn.com/\\"\\n },\\n \\"AdMarkerPassthrough\\": \\"ON\\",\\n \\"ManifestEndpointConfig\\": {\\n \\"HlsPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\",\\n \\"DashPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\"\\n }\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'GetAdInsertion', 'changeSet' => [ ['createdAt' => '2025-05-29T03:34:26.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAdInsertion'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetAdInsertion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetAiRtcAuthCodeList' => [ 'summary' => 'Retrieves a list of Real-time Conversational AI authentication codes and their status for a specified batch.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'LicenseItemId', 'in' => 'query', 'schema' => ['description' => 'The ID of the batch.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '17712***', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status of the authorization code. Valid values:'."\n" ."\n" .'- `1`: Activated'."\n" ."\n" .'- `2`: Inactive', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The type of license. Valid values:'."\n" ."\n" .'- `1`: Audio call'."\n" ."\n" .'- `2`: Vision call', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NeedTotalCount', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to include the total count of records in the response. Defaults to `true`.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'ApiResponse\\', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1***', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'AuthCodeList' => [ 'description' => 'An array of AiRtcAuthCodeDTO objects, each representing an authorization code.', 'type' => 'array', 'items' => ['description' => 'An authorization code.', '$ref' => '#/components/schemas/AiRtcAuthCodeDTO', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"AuthCodeList\\": [\\n {\\n \\"Status\\": 1,\\n \\"Type\\": 1,\\n \\"AuthCode\\": \\"iU1IeJech7***\\",\\n \\"ActivatedTime\\": \\"2024-01-01 06:57:43\\",\\n \\"DeviceId\\": \\"device-***\\",\\n \\"CreationTime\\": \\"2023-12-23T13:33:49Z\\",\\n \\"License\\": \\"a659a06659a***\\",\\n \\"ModificationTime\\": \\"2023-12-23T13:33:49Z\\",\\n \\"LicenseItemId\\": \\"11096067***\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n}","type":"json"}]', 'title' => 'GetAiRtcAuthCodeList', 'description' => '## [](#)Usage notes'."\n" ."\n" .'- This API retrieves a list of authorization codes for a specific batch ID. You can filter the results by status and type.'."\n" ."\n" .'- Pagination is supported via the `PageNo` and `PageSize` parameters.'."\n" ."\n" .'- By default, the `NeedTotalCount` parameter is set to `true`, indicating that the response includes the total count of matching records.'."\n" ."\n" .'- `LicenseItemId` is a required parameter that specifies the batch to query.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiRtcAuthCodeList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetAiRtcAuthCodeList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetAiRtcLicenseInfoList' => [ 'summary' => 'Retrieves details for AI Real-Time Communication license batches that match specified filter criteria.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'LicenseItemId', 'in' => 'query', 'schema' => ['description' => 'The License Item ID.', 'type' => 'string', 'required' => false, 'example' => '17712***', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the license batch. Valid values:'."\n" ."\n" .'- `1`: Normal'."\n" ."\n" .'- `2`: Expired', 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => '', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The license type. Valid values:'."\n" ."\n" .'- `1`: voice call'."\n" ."\n" .'- `2`: visual understanding', 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NeedTotalCount', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the total count. Default value: `true`.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'ApiResponse\\'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1***', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => 'httpStatusCode', 'title' => ''], 'LicenseInfoList' => [ 'description' => 'The list of license batch details.', 'type' => 'array', 'items' => ['description' => 'The details of a license batch.', '$ref' => '#/components/schemas/AiRtcLicenseInfoDTO', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'GetAiRtcLicenseInfoList', 'description' => '## Description'."\n" ."\n" .'- Retrieve AI Real-Time Communication license batches based on filter criteria such as License Item ID, Status, and Type.'."\n" ."\n" .'- The `NeedTotalCount` parameter defaults to `true`. When set to true, the response includes the total count of matching entries. To exclude the total count, set this parameter to `false`.'."\n" ."\n" .'- If you do not specify any filter criteria, the operation returns the details for all license batches by default.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiRtcLicenseInfoList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetAiRtcLicenseInfoList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 0,\\n \\"LicenseInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2020-12-23T13:33:49Z\\",\\n \\"ModificationTime\\": \\"2020-12-23T13:33:49Z\\",\\n \\"Type\\": 1,\\n \\"LicenseItemId\\": \\"17712***\\",\\n \\"Status\\": 1,\\n \\"ValidDays\\": 365,\\n \\"ExpiredOn\\": \\"2021-12-23T13:33:49Z\\",\\n \\"BeginOn\\": \\"2020-12-23T13:33:49Z\\",\\n \\"LicenseCount\\": 10000,\\n \\"AvailableCapacity\\": 10000000,\\n \\"InstanceId\\": \\"ice_CoverAILicense_public_cn***\\",\\n \\"ContractNo\\": \\"258396267390***\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetAvatar' => [ 'summary' => 'Queries the information about a trained digital human.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AvatarId', 'in' => 'query', 'schema' => ['description' => '- The ID of the digital human.', 'type' => 'string', 'required' => true, 'example' => 'Avatar-XXXX', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Avatar' => [ 'description' => 'The information about the digital human.', 'type' => 'object', 'properties' => [ 'AvatarId' => ['description' => 'The ID of the digital human.', 'type' => 'string', 'example' => 'Avatar-XXXX', 'title' => ''], 'AvatarName' => ['description' => 'The name of the digital human.', 'type' => 'string', 'example' => 'Decimal', 'title' => ''], 'AvatarDescription' => ['description' => 'The description of the digital human.', 'type' => 'string', 'example' => 'This is a digital human used for a specific scenario.', 'title' => ''], 'AvatarType' => ['description' => 'The type of the digital human.', 'type' => 'string', 'example' => '2DAvatar', 'title' => ''], 'Thumbnail' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', 'title' => ''], 'Portrait' => ['description' => 'The media asset ID of the portrait image.', 'type' => 'string', 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], 'Transparent' => ['description' => 'Indicates whether the digital human supports alpha channels.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Width' => ['description' => 'The width of the digital human image in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], 'Height' => ['description' => 'The height of the digital human image in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"Avatar\\": {\\n \\"AvatarId\\": \\"Avatar-XXXX\\",\\n \\"AvatarName\\": \\"Decimal\\",\\n \\"AvatarDescription\\": \\"This is a digital human used for a specific scenario.\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Thumbnail\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png\\",\\n \\"Portrait\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Transparent\\": true,\\n \\"Width\\": 1080,\\n \\"Height\\": 1920\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetAvatar', 'changeSet' => [ ['createdAt' => '2023-09-13T09:15:05.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAvatar'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetAvatar', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetAvatarTrainingJob' => [ 'summary' => 'Queries the information about a digital human training job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Data' => [ 'description' => 'The data returned if the request was successful.', 'type' => 'object', 'properties' => [ 'AvatarTrainingJob' => [ 'description' => 'The information about the digital human training job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'example' => '****55d86f7f4587943ce7734d6b****', 'title' => ''], 'AvatarId' => ['description' => 'The ID of the digital human.', 'type' => 'string', 'example' => 'Avatar-XXXX', 'title' => ''], 'AvatarName' => ['description' => 'The name of the digital human.', 'type' => 'string', 'example' => 'Decimal', 'title' => ''], 'AvatarDescription' => ['description' => 'The description of the digital human.', 'type' => 'string', 'example' => 'This is a digital human used for a specific scenario.', 'title' => ''], 'AvatarType' => ['description' => 'The type of the digital human.', 'type' => 'string', 'example' => '2DAvatar', 'title' => ''], 'Status' => ['description' => '- The state of the digital human training job.'."\n" ."\n" .'- Valid values: Init, Queuing, Training, Success, and Fail.', 'type' => 'string', 'example' => 'Success'."\n", 'title' => ''], 'Message' => ['description' => 'The status description.', 'type' => 'string', 'example' => 'Training succeeded', 'title' => ''], 'Thumbnail' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', 'title' => ''], 'Portrait' => ['description' => 'The media asset ID of the portrait image.', 'type' => 'string', 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], 'Video' => ['description' => 'The ID of the video used for training.', 'type' => 'string', 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], 'Transparent' => ['description' => 'Indicates whether the input video supports alpha channels.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'FirstTrainingTime' => ['description' => '- The time when the first training was initiated.'."\n" ."\n" .'- The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:40Z', 'title' => ''], 'LastTrainingTime' => ['description' => '- The time when the last training was initiated.'."\n" ."\n" .'- The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:40Z', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"AvatarTrainingJob\\": {\\n \\"JobId\\": \\"****55d86f7f4587943ce7734d6b****\\",\\n \\"AvatarId\\": \\"Avatar-XXXX\\",\\n \\"AvatarName\\": \\"Decimal\\",\\n \\"AvatarDescription\\": \\"This is a digital human used for a specific scenario.\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Status\\": \\"Success\\\\n\\",\\n \\"Message\\": \\"Training succeeded\\",\\n \\"Thumbnail\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png\\",\\n \\"Portrait\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Video\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Transparent\\": true,\\n \\"FirstTrainingTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"LastTrainingTime\\": \\"2020-12-23T13:33:40Z\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetAvatarTrainingJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetAvatarTrainingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetBatchMediaProducingJob' => [ 'summary' => 'Obtain detailed information about batch Intelligent One-Click Video Editing jobs, including the input parameters, job status, and the IDs and URLs of the generated media assets. This API supports querying job data from the past year only.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207313', 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the quick video production job.', 'type' => 'string', 'required' => false, 'example' => '****b4549d46c88681030f6e****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'], 'EditingBatchJob' => [ 'description' => 'The information about the quick video production job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****b6b2750d4308892ac3330238****', 'title' => ''], 'InputConfig' => ['description' => 'The input configurations. For more information, see [InputConfig](~~2692547#2faed1559549n~~).', 'type' => 'string', 'example' => '{'."\n" .' "MediaGroupArray": [{'."\n" .' "GroupName": "MediaGroup1",'."\n" .' "MediaArray": ['."\n" .' "****9d46c886b45481030f6e****",'."\n" .' "****6c886b4549d481030f6e****" ]'."\n" .' }, {'."\n" .' "GroupName": "MediaGroup2",'."\n" .' "MediaArray": ['."\n" .' "****d46c886810b454930f6e****",'."\n" .' "****4549d886810b46c30f6e****" ]'."\n" .' }],'."\n" .' "TitleArray": ['."\n" .' "回龙观盒马鲜生开业啦",'."\n" .' "盒马鲜生开业啦" ],'."\n" .' "SpeechTextArray": ['."\n" .' "附近的商场新开了一家盒马鲜生，今天是第一天开业"'."\n" .' "商场里的人不少，零食、酒水都比较便宜大家也快来看看呀" ]'."\n" .'}', 'title' => ''], 'EditingConfig' => ['description' => 'The editing configurations. For more information, see [EditingConfig](~~2692547#1be9bba03b7qu~~).', 'type' => 'string', 'example' => '{'."\n" .' "MediaConfig": {'."\n" .' "Volume": 0'."\n" .' },'."\n" .' "SpeechConfig": {'."\n" .' "Volume": 1'."\n" .' },'."\n" .' "BackgroundMusicConfig": {'."\n" .' "Volume": 0.3'."\n" .' }'."\n" .'}', 'title' => ''], 'OutputConfig' => ['description' => 'The output configurations. For more information, see [OutputConfig](~~2692547#447b928fcbuoa~~).', 'type' => 'string', 'example' => '{'."\n" .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" .' "Count": 20,'."\n" .' "MaxDuration": 15,'."\n" .' "Width": 1080,'."\n" .' "Height": 1920,'."\n" .' "Video": {"Crf": 27}'."\n" .'}', 'title' => ''], 'Status' => ['description' => 'The job state. Valid values:'."\n" ."\n" .'Init: The job is initialized.'."\n" ."\n" .'Processing: The job is in progress.'."\n" ."\n" .'Finished: The job is complete.', 'type' => 'string', 'example' => 'Finished', 'title' => ''], 'UserData' => ['description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~357745~~).', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', 'title' => ''], 'Extend' => ['description' => 'The extended information. This parameter contains the following fields:'."\n" ."\n" .'ErrorCode: the error code of the main job.'."\n" ."\n" .'ErrorMessage: the error message of the main job.', 'type' => 'string', 'example' => '{'."\n" .' "ErrorCode": "InvalidMaterial.NotFound",'."\n" .' "ErrorMessage": "The specified clips id not found:[\\"****30d0b5e871eebb2ff7f6c75a****\\"]"'."\n" .'}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-06-13T08:47:07Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.'."\n" ."\n" .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-06-13T08:57:07Z'."\n", 'title' => ''], 'CompleteTime' => ['description' => 'The time when the job was complete.'."\n" ."\n" .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-06-13T08:57:07Z'."\n", 'title' => ''], 'JobType' => ['description' => 'Task Type:'."\n" ."\n" .'- Script (Script-based automated video editing)'."\n" ."\n" .'- Smart\\_Mix (Intelligent text-to-media matching for video editing)'."\n" ."\n" .'- Sports\\_Highlights (Sporting event highlights compilation)'."\n" ."\n" .'- Screen\\_Media\\_Highlights (High-energy multi-media mashup editing)'."\n" ."\n" .'- Smart\\_Mix\\_Media\\_Select (Intelligent matching – Material selection)'."\n" ."\n" .'- Smart\\_Mix\\_Timeline\\_Organize (Intelligent matching – Timeline orchestration)'."\n" ."\n" .'- Screen\\_Media\\_Highlights\\_Media\\_Select (High-energy mashup – Material selection)'."\n" ."\n" .'- Screen\\_Media\\_Highlights\\_Timeline\\_Organize (High-energy mashup – Timeline orchestration)'."\n" ."\n" .'- Scene\\_Batch\\_Editing (Batch synthesis across multiple timelines)', 'type' => 'string', 'example' => 'Script', 'title' => ''], 'SubJobList' => [ 'description' => 'The quick video production subjobs.', 'type' => 'array', 'items' => [ 'description' => 'The information about the quick video production subjob.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the output media asset.', 'type' => 'string', 'example' => '****1470b11171ee9d19e7e6c66a****', 'title' => ''], 'JobId' => ['description' => 'The subjob ID.', 'type' => 'string', 'example' => '****8e81933d44e3ae69e2f81485****', 'title' => ''], 'MediaURL' => ['description' => 'The URL of the output file.', 'type' => 'string', 'example' => 'http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4', 'title' => ''], 'Status' => ['description' => 'The subjob state. Valid values:'."\n" ."\n" .'Init: The subjob is initialized.'."\n" ."\n" .'Processing: The subjob is in progress.'."\n" ."\n" .'Success: The subjob is successful.'."\n" ."\n" .'Failed: The subjob failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ErrorCode' => ['description' => 'The error code that is returned if the subjob failed. This parameter is not returned if the subjob is successful.', 'type' => 'string', 'example' => 'InvalidMaterial.NotFound', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message that is returned if the subjob failed. This parameter is not returned if the subjob is successful.', 'type' => 'string', 'example' => 'The specified clips id not found:["****30d0b5e871eebb2ff7f6c75a****"]', 'title' => ''], 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'example' => '****7cc47fe04eaa81bd853acb6a****', 'title' => ''], 'Duration' => ['description' => 'The duration of the output video, in seconds (s).', 'type' => 'number', 'format' => 'float', 'example' => '24.5', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ExtendInput' => ['description' => 'Additional input.'."\n" ."\n" .'- When JobType is Smart\\_Mix\\_Timeline\\_Organize or Screen\\_Media\\_Highlights\\_Timeline\\_Organize, the additional input is the material selection result.'."\n" ."\n" .'- When JobType is Scene\\_Batch\\_Editing, the additional input is a list of video editing project IDs.', 'type' => 'string', 'example' => '["****7cc47fe04eaa81bd853acb6a****", "****04eaa7cc47fe81bd853acb6a****"]', 'title' => ''], 'ExtendOutput' => ['description' => 'Additional outputs.'."\n" ."\n" .'- When JobType is Smart\\_Mix\\_Media\\_Select or Screen\\_Media\\_Highlights\\_Media\\_Select, material selection results are additionally returned.', 'type' => 'string', 'example' => '{'."\n" .'"textMatchMediaOutputList": [{'."\n" .'"textMatchMediaSentenceOutputList": [{'."\n" .'"duration": 3.366667,'."\n" .'"matchClipList": [{'."\n" .'"clipId": "null-2",'."\n" .'"endTime": 11.16,'."\n" .'"mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" .'"score": -0.253,'."\n" .'"startTime": 8.04'."\n" .'}],'."\n" .'"text": "A new Freshippo store just opened at the nearby mall.",'."\n" .'"textId": "0"'."\n" .'},'."\n" .'{'."\n" .'"duration": 1.566667,'."\n" .'"matchClipList": [{'."\n" .'"clipId": "null-1",'."\n" .'"endTime": 1.54,'."\n" .'"mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" .'"score": -0.2326,'."\n" .'"startTime": 0'."\n" .'}],'."\n" .'"text": "today Yesfirst day of opening",'."\n" .'"textId": "0"'."\n" .'}'."\n" .']'."\n" .'}]'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"EditingBatchJob\\": {\\n \\"JobId\\": \\"****b6b2750d4308892ac3330238****\\",\\n \\"InputConfig\\": \\"{\\\\n \\\\\\"MediaGroupArray\\\\\\": [{\\\\n \\\\\\"GroupName\\\\\\": \\\\\\"MediaGroup1\\\\\\",\\\\n \\\\\\"MediaArray\\\\\\": [\\\\n \\\\\\"****9d46c886b45481030f6e****\\\\\\",\\\\n \\\\\\"****6c886b4549d481030f6e****\\\\\\" ]\\\\n }, {\\\\n \\\\\\"GroupName\\\\\\": \\\\\\"MediaGroup2\\\\\\",\\\\n \\\\\\"MediaArray\\\\\\": [\\\\n \\\\\\"****d46c886810b454930f6e****\\\\\\",\\\\n \\\\\\"****4549d886810b46c30f6e****\\\\\\" ]\\\\n }],\\\\n \\\\\\"TitleArray\\\\\\": [\\\\n \\\\\\"回龙观盒马鲜生开业啦\\\\\\",\\\\n \\\\\\"盒马鲜生开业啦\\\\\\" ],\\\\n \\\\\\"SpeechTextArray\\\\\\": [\\\\n \\\\\\"附近的商场新开了一家盒马鲜生，今天是第一天开业\\\\\\"\\\\n \\\\\\"商场里的人不少，零食、酒水都比较便宜大家也快来看看呀\\\\\\" ]\\\\n}\\",\\n \\"EditingConfig\\": \\"{\\\\n \\\\\\"MediaConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0\\\\n },\\\\n \\\\\\"SpeechConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 1\\\\n },\\\\n \\\\\\"BackgroundMusicConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0.3\\\\n }\\\\n}\\",\\n \\"OutputConfig\\": \\"{\\\\n \\\\\\"MediaURL\\\\\\": \\\\\\"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\\\\\\",\\\\n \\\\\\"Count\\\\\\": 20,\\\\n \\\\\\"MaxDuration\\\\\\": 15,\\\\n \\\\\\"Width\\\\\\": 1080,\\\\n \\\\\\"Height\\\\\\": 1920,\\\\n \\\\\\"Video\\\\\\": {\\\\\\"Crf\\\\\\": 27}\\\\n}\\",\\n \\"Status\\": \\"Finished\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\",\\n \\"Extend\\": \\"{\\\\n\\\\t\\\\\\"ErrorCode\\\\\\": \\\\\\"InvalidMaterial.NotFound\\\\\\",\\\\n\\\\t\\\\\\"ErrorMessage\\\\\\": \\\\\\"The specified clips id not found:[\\\\\\\\\\\\\\"****30d0b5e871eebb2ff7f6c75a****\\\\\\\\\\\\\\"]\\\\\\"\\\\n}\\",\\n \\"CreateTime\\": \\"2024-06-13T08:47:07Z\\",\\n \\"ModifiedTime\\": \\"2024-06-13T08:57:07Z\\\\n\\",\\n \\"CompleteTime\\": \\"2024-06-13T08:57:07Z\\\\n\\",\\n \\"JobType\\": \\"Script\\",\\n \\"SubJobList\\": [\\n {\\n \\"MediaId\\": \\"****1470b11171ee9d19e7e6c66a****\\",\\n \\"JobId\\": \\"****8e81933d44e3ae69e2f81485****\\",\\n \\"MediaURL\\": \\"http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4\\",\\n \\"Status\\": \\"Success\\",\\n \\"ErrorCode\\": \\"InvalidMaterial.NotFound\\",\\n \\"ErrorMessage\\": \\"The specified clips id not found:[\\\\\\"****30d0b5e871eebb2ff7f6c75a****\\\\\\"]\\",\\n \\"ProjectId\\": \\"****7cc47fe04eaa81bd853acb6a****\\",\\n \\"Duration\\": 24.5\\n }\\n ],\\n \\"ExtendInput\\": \\"[\\\\\\"****7cc47fe04eaa81bd853acb6a****\\\\\\", \\\\\\"****04eaa7cc47fe81bd853acb6a****\\\\\\"]\\",\\n \\"ExtendOutput\\": \\"{\\\\n\\\\\\"textMatchMediaOutputList\\\\\\": [{\\\\n\\\\\\"textMatchMediaSentenceOutputList\\\\\\": [{\\\\n\\\\\\"duration\\\\\\": 3.366667,\\\\n\\\\\\"matchClipList\\\\\\": [{\\\\n\\\\\\"clipId\\\\\\": \\\\\\"null-2\\\\\\",\\\\n\\\\\\"endTime\\\\\\": 11.16,\\\\n\\\\\\"mediaId\\\\\\": \\\\\\"****a0900f5071efbf1ce7e6c66a****\\\\\\",\\\\n\\\\\\"score\\\\\\": -0.253,\\\\n\\\\\\"startTime\\\\\\": 8.04\\\\n}],\\\\n\\\\\\"text\\\\\\": \\\\\\"A new Freshippo store just opened at the nearby mall.\\\\\\",\\\\n\\\\\\"textId\\\\\\": \\\\\\"0\\\\\\"\\\\n},\\\\n{\\\\n\\\\\\"duration\\\\\\": 1.566667,\\\\n\\\\\\"matchClipList\\\\\\": [{\\\\n\\\\\\"clipId\\\\\\": \\\\\\"null-1\\\\\\",\\\\n\\\\\\"endTime\\\\\\": 1.54,\\\\n\\\\\\"mediaId\\\\\\": \\\\\\"****a0900f5071efbf1ce7e6c66a****\\\\\\",\\\\n\\\\\\"score\\\\\\": -0.2326,\\\\n\\\\\\"startTime\\\\\\": 0\\\\n}],\\\\n\\\\\\"text\\\\\\": \\\\\\"today Yesfirst day of opening\\\\\\",\\\\n\\\\\\"textId\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\\\n]\\\\n}]\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain batch Intelligent One-Click Video Editing job information', 'changeSet' => [ ['createdAt' => '2025-09-18T09:03:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-04-21T02:54:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-07-22T10:09:55.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-07-03T11:43:11.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-28T02:09:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBatchMediaProducingJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetBatchMediaProducingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetCategories' => [ 'summary' => 'Queries the information about a category and its subcategories.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'CateId', 'in' => 'query', 'schema' => ['description' => 'The category ID. You can use one of the following methods to obtain the ID:'."\n" ."\n" .'- Log on to the [Intelligent Media Services (IMS) console](https://ims.console.aliyun.com) and choose **Media Asset Management** > **Category Management** to view the category ID.'."\n" ."\n" .'- View the value of CateId returned by the AddCategory operation that you called to create a category.'."\n" ."\n" .'- View the value of CateId returned by the GetCategories operation that you called to query a category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '33', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting rule of results. Valid values:'."\n" ."\n" .'\\- CreationTime:Desc (default): The results are sorted in reverse chronological order based on the creation time.'."\n" ."\n" .'\\- CreationTime:Asc: The results are sorted in chronological order based on the creation time.', 'type' => 'string', 'required' => false, 'example' => 'CreationTime:Desc', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The type of the category. Valid values: default and material. A value of default indicates audio, video, and image files. This is the default value. A value of material indicates short video materials.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SubTotal' => ['description' => 'The total number of subcategories.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'Category' => [ 'description' => 'The information about the category.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the category. Valid values:'."\n" ."\n" .'- **default**: audio, video, and image files. This is the default value.'."\n" ."\n" .'- **material**: short video materials.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'CateName' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'First-level category', 'title' => ''], 'ParentId' => ['description' => 'The ID of the parent category.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '46', 'title' => ''], 'Level' => ['description' => 'The level of the category. A value of **0** indicates a level-1 category, a value of **1** indicates a level-2 category, and a value of **2** indicates a level-3 category.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'SubCategories' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Category' => [ 'description' => 'The subcategories in the category.', 'type' => 'array', 'items' => [ 'description' => 'The subcategory in the category.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the category. Valid values:'."\n" ."\n" .'- **default**: audio, video, and image files. This is the default value.'."\n" ."\n" .'- **material**: short video materials.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'CateName' => ['description' => 'The category name.'."\n" ."\n" .'- The value can be up to 64 bytes in length.'."\n" ."\n" .'- The value is encoded in UTF-8.', 'type' => 'string', 'example' => 'Second-level subcategory', 'title' => ''], 'ParentId' => ['description' => 'The ID of the parent category.', 'type' => 'integer', 'format' => 'int64', 'example' => '46', 'title' => ''], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '129', 'title' => ''], 'SubTotal' => ['description' => 'The total number of subcategories.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Level' => ['description' => 'The level of the category. A value of **0** indicates a level-1 category, a value of **1** indicates a level-2 category, and a value of **2** indicates a level-3 category.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => [], 'title' => 'GetCategories', 'description' => 'Query the information about a category and its subcategories based on the category ID and category type.', 'changeSet' => [ ['createdAt' => '2022-07-15T06:48:03.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCategories'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetCategories', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubTotal\\": 100,\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"CateName\\": \\"First-level category\\",\\n \\"ParentId\\": -1,\\n \\"CateId\\": 46,\\n \\"Level\\": 0\\n },\\n \\"SubCategories\\": {\\n \\"Category\\": [\\n {\\n \\"Type\\": \\"default\\",\\n \\"CateName\\": \\"Second-level subcategory\\",\\n \\"ParentId\\": 46,\\n \\"CateId\\": 129,\\n \\"SubTotal\\": 100,\\n \\"Level\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetChannel' => [ 'summary' => 'Gets information about a channel in MediaWeaver.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Channel' => ['description' => 'The channel information.', '$ref' => '#/components/schemas/ChannelAssemblyChannel', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"MySource\\",\\n \\"FillerSourceLocationName\\": \\"MySourceLocation\\",\\n \\"GmtCreate\\": \\"2024-01-15T03:44:16Z\\\\n\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"ChannelTier\\": \\"basic\\",\\n \\"AccessToken\\": \\"xxxxx\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"2024-09-01T10:09Z\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::channel/myChannel\\\\n\\",\\n \\"PlaybackMode\\": \\"loop\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"index1\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"Format\\": \\"hls\\",\\n \\"PlaybackUrl\\": \\"https://xxxxx.com/xxx.m3u8\\\\n\\",\\n \\"ManifestSettings\\": \\"{\\\\\\"WindowDuration\\\\\\": 60,\\\\\\"AdMarkType\\\\\\":\\\\\\"Daterange\\\\\\"}\\\\n\\",\\n \\"SourceGroupName\\": \\"group1\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', 'title' => 'GetChannel', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetContentAnalyzeConfig' => [ 'summary' => 'Retrieves the configuration for Intelligent Content Analysis.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '31FEC819-2344-5771-9366-9172DB0D26C9'], 'ContentAnalyzeConfig' => [ 'description' => 'The configuration for Intelligent Content Analysis.', 'type' => 'object', 'properties' => [ 'Auto' => ['description' => 'Specifies if Intelligent Content Analysis starts automatically after a Media Asset is registered.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- `true`: Enabled.'."\n" ."\n" .'- `false`: Disabled. (default)', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SaveType' => ['description' => 'The repository type for saving analysis results. This parameter is valid only when `Auto` is set to `true`. The default is an empty string.'."\n" ."\n" .'- `TEXT`: Label'."\n" ."\n" .'- `FACE`: Face'."\n" ."\n" .'- `DNA`: Image DNA'."\n" ."\n" .'You can specify multiple values, separated by commas (,). If this parameter is left empty, the analysis results are not saved to any search repository and cannot be used for content search.', 'type' => 'string', 'example' => 'TEXT,FACE', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the Intelligent Content Analysis template. Each template includes the following AI capabilities:'."\n" ."\n" .'- `S00000101-100040`: Text Recognition'."\n" ."\n" .'- `S00000101-100060`: Video Classification and Face Recognition'."\n" ."\n" .'- `S00000101-100070`: Text Recognition, Video Classification, and Face Recognition', 'type' => 'string', 'example' => 'S00000101-100070', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31FEC819-2344-5771-9366-9172DB0D26C9\\",\\n \\"ContentAnalyzeConfig\\": {\\n \\"Auto\\": true,\\n \\"SaveType\\": \\"TEXT,FACE\\",\\n \\"TemplateId\\": \\"S00000101-100070\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain Intelligent Content Analysis Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContentAnalyzeConfig'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetContentAnalyzeConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetCustomTemplate' => [ 'summary' => 'Gets details of a custom media processing template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceEO4QPO'], ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom template.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The ID of the template type. This parameter is required if you omit `TemplateId` to get a default template.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Subtype', 'in' => 'query', 'schema' => ['description' => 'The template subtype.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'CustomTemplate' => [ 'title' => '', 'description' => 'The template details.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Test screenshot template', 'title' => ''], 'Type' => ['description' => 'The ID of the template type.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'TypeName' => ['description' => 'The name of the template type.', 'type' => 'string', 'example' => 'SnapshotTemplate', 'title' => ''], 'Subtype' => ['description' => 'The ID of the template subtype.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SubtypeName' => ['description' => 'The name of the template subtype.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Status' => ['description' => 'The status of the template.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the template is a default template.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TemplateConfig' => ['description' => 'The template configuration, in a JSON string.', 'type' => 'string', 'title' => '', 'example' => '{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}'], 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2022-01-01T10:00:00Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2022-01-01T11:00:00Z'."\n", 'title' => ''], 'FrontendHint' => [ 'type' => 'object', 'properties' => [ 'TranscodeTemplateHint' => [ 'type' => 'object', 'properties' => [ 'BitrateControlType' => ['description' => 'The bitrate control type.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'description' => 'Hint for transcoding templates.', 'title' => '', 'example' => '', ], ], 'description' => 'Reserved for frontend display.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'GetCustomTemplate', 'description' => 'This operation gets the details of a custom template by its ID or the details of a default template. If you provide a `TemplateId`, the operation ignores other parameters and returns the details for that template. If you omit `TemplateId`, you must specify the `Type` parameter to get the corresponding default template.'."\n" ."\n" .'Template type (`Type`):'."\n" ."\n" .'1. 1: transcoding template'."\n" ."\n" .'2. 2: snapshot template'."\n" ."\n" .'3. 3: Animated GIF template'."\n" ."\n" .'4. 4: Image watermark template'."\n" ."\n" .'5. 5: Text watermark template'."\n" ."\n" .'6. 6: Subtitle template'."\n" ."\n" .'7. 7: AI content moderation template'."\n" ."\n" .'8. 8: AI smart cover template'."\n" ."\n" .'9. 9: AI smart erase template'."\n" ."\n" .'Transcoding template subtype (`Subtype`):'."\n" ."\n" .'1. 1: Normal (Normal)'."\n" ."\n" .'2. 2: Audio transcoding (AudioTranscode)'."\n" ."\n" .'3. 3: remuxing (Remux)'."\n" ."\n" .'4. 4: Narrowband HD 1.0 (NarrowBandV1)'."\n" ."\n" .'5. 5: Narrowband HD 2.0 (NarrowBandV2)'."\n" ."\n" .'Snapshot template subtype (`Subtype`):'."\n" ."\n" .'1. 1: Static screenshot (Normal)'."\n" ."\n" .'2. 2: sprite (Sprite)'."\n" ."\n" .'3. 3: WebVTT screenshot (WebVtt)'."\n" ."\n" .'AI content moderation template subtype (`Subtype`):'."\n" ."\n" .'1. 1: Video moderation (Video)'."\n" ."\n" .'2. 2: Audio moderation (Audio)'."\n" ."\n" .'3. 3: Image moderation (Image)'."\n" ."\n" .'AI smart erase template subtype (`Subtype`):'."\n" ."\n" .'1. 1: Logo removal (VideoDelogo)'."\n" ."\n" .'2. 2: Subtitle removal (VideoDetext)', 'changeSet' => [ ['createdAt' => '2024-10-24T00:59:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-18T03:29:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-11T09:38:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetCustomTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"CustomTemplate\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateName\\": \\"Test screenshot template\\",\\n \\"Type\\": 2,\\n \\"TypeName\\": \\"SnapshotTemplate\\",\\n \\"Subtype\\": 1,\\n \\"SubtypeName\\": \\"Normal\\",\\n \\"Status\\": \\"Normal\\",\\n \\"IsDefault\\": true,\\n \\"TemplateConfig\\": \\"{\\\\\\"Type\\\\\\":\\\\\\"Normal\\\\\\",\\\\\\"FrameType\\\\\\":\\\\\\"normal\\\\\\",\\\\\\"Time\\\\\\":0,\\\\\\"Count\\\\\\":10}\\",\\n \\"CreateTime\\": \\"2022-01-01T10:00:00Z\\",\\n \\"ModifiedTime\\": \\"2022-01-01T11:00:00Z\\\\n\\",\\n \\"FrontendHint\\": {\\n \\"TranscodeTemplateHint\\": {\\n \\"BitrateControlType\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetCustomizedVoice' => [ 'summary' => 'Queries the information about a personalized human voice.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'VoiceId', 'in' => 'query', 'schema' => ['description' => 'The voice ID.', 'type' => 'string', 'required' => false, 'example' => 'xiaozhuan', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'CustomizedVoice' => [ 'description' => 'The personalized human voice.', 'type' => 'object', 'properties' => [ 'VoiceId' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'xiaozhuan', 'title' => ''], 'VoiceName' => ['description' => 'The voice name.', 'type' => 'string', 'example' => 'Basic', 'title' => ''], 'VoiceDesc' => ['description' => 'The voice description.', 'type' => 'string', 'example' => '这是一个个性化人声', 'title' => ''], 'Gender' => ['description' => 'The gender. Valid values:'."\n" ."\n" .'- female'."\n" ."\n" .'- male', 'type' => 'string', 'example' => 'female', 'title' => ''], 'Scenario' => ['description' => 'The demonstration scenario.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- **story**'."\n" ."\n" .'- **interaction**'."\n" ."\n" .'- **navigation**', 'type' => 'string', 'example' => 'interaction', 'title' => ''], 'DemoAudioMediaId' => ['description' => 'The media asset ID of the sample audio file.', 'type' => 'string', 'example' => '****42d3c312402982be65975f5b****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"CustomizedVoice\\": {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"VoiceName\\": \\"Basic\\",\\n \\"VoiceDesc\\": \\"这是一个个性化人声\\",\\n \\"Gender\\": \\"female\\",\\n \\"Scenario\\": \\"interaction\\",\\n \\"DemoAudioMediaId\\": \\"****42d3c312402982be65975f5b****\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetCustomizedVoice', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomizedVoice'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:GetCustomizedVoice', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetCustomizedVoiceJob' => [ 'summary' => 'Queries the information about a human voice cloning job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the human voice cloning job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'Data' => [ 'description' => 'The data returned if the request was successful.', 'type' => 'object', 'properties' => [ 'CustomizedVoiceJob' => [ 'description' => 'The information about the human voice cloning job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the human voice cloning job.', 'type' => 'string', 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], 'VoiceId' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'xiaozhuan', 'title' => ''], 'Status' => ['description' => 'The job state. Valid values:'."\n" ."\n" .'- Initialization'."\n" ."\n" .'- AudioDetecting'."\n" ."\n" .'- PreTraining'."\n" ."\n" .'- Training'."\n" ."\n" .'- Success'."\n" ."\n" .'- Fail', 'type' => 'string', 'example' => 'Fail', 'title' => ''], 'Message' => ['description' => 'The status description.', 'type' => 'string', 'example' => 'Training failed', 'title' => ''], 'Type' => ['description' => 'The type of the human voice cloning job. Valid values:'."\n" ."\n" .'- Basic'."\n" ."\n" .'- Standard', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'VoiceName' => ['description' => 'The voice name.', 'type' => 'string', 'example' => 'Basic', 'title' => ''], 'VoiceDesc' => ['description' => 'The voice description.', 'type' => 'string', 'example' => '这是一个专属人声', 'title' => ''], 'Scenario' => ['description' => 'The scenario. Valid values:'."\n" ."\n" .'- story'."\n" ."\n" .'- interaction'."\n" ."\n" .'- navigation', 'type' => 'string', 'example' => 'story', 'title' => ''], 'Gender' => ['description' => 'The gender. Valid values:'."\n" ."\n" .'- female'."\n" ."\n" .'- male', 'type' => 'string', 'example' => 'female', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-06-07T02:27:08Z', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"CustomizedVoiceJob\\": {\\n \\"JobId\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"Status\\": \\"Fail\\",\\n \\"Message\\": \\"Training failed\\",\\n \\"Type\\": \\"Standard\\",\\n \\"VoiceName\\": \\"Basic\\",\\n \\"VoiceDesc\\": \\"这是一个专属人声\\",\\n \\"Scenario\\": \\"story\\",\\n \\"Gender\\": \\"female\\",\\n \\"CreateTime\\": \\"2023-06-07T02:27:08Z\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetCustomizedVoiceJob', 'changeSet' => [ ['createdAt' => '2023-11-21T07:13:55.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomizedVoiceJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetCustomizedVoiceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetDefaultStorageLocation' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'StorageType' => ['description' => 'Storage class', 'type' => 'string', 'title' => '', 'example' => 'user_oss_bucket'], 'Bucket' => ['description' => 'OSS bucket name', 'type' => 'string', 'title' => '', 'example' => 'oss-test-bucket'], 'Path' => ['description' => 'Path', 'type' => 'string', 'title' => '', 'example' => 'ice/dir'], 'Status' => ['description' => 'Bucket status:'."\n" ."\n" .'- Normal: The bucket is in normal status.'."\n" ."\n" .'- notExist: The bucket does not exist.', 'type' => 'string', 'title' => '', 'example' => 'normal'], ], 'example' => '', ], ], ], 'title' => 'Obtain Default Storage Location', 'summary' => 'This topic describes the API request parameters and sample for obtaining the default storage configuration.', 'changeSet' => [ ['createdAt' => '2021-05-25T03:33:13.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultStorageLocation'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetDefaultStorageLocation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"StorageType\\": \\"user_oss_bucket\\",\\n \\"Bucket\\": \\"oss-test-bucket\\",\\n \\"Path\\": \\"ice/dir\\",\\n \\"Status\\": \\"normal\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetDemonstrationForCustomizedVoiceJob' => [ 'summary' => 'Queries the text to be read and sample audio for training a personalized human voice.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Scenario', 'in' => 'query', 'schema' => [ 'description' => 'The demonstration scenario.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- **story**'."\n" ."\n" .'- **interaction**'."\n" ."\n" .'- **navigation**', 'type' => 'string', 'required' => true, 'enum' => ['story', 'interaction', 'navigation'], 'example' => 'story', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'DemonstrationList' => [ 'description' => 'A list of 20 text entries to be read and the corresponding sample audio.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DemoAudio' => ['description' => 'The URL of the sample audio.'."\n" ."\n" .'- The value is an Object Storage Service (OSS) URL.'."\n" ."\n" .' \\*\\*'."\n" ."\n" .' **Note**: The URL expires in 12 hours.', 'type' => 'string', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/1.wav', 'title' => ''], 'Text' => ['description' => 'The text content to be read.', 'type' => 'string', 'example' => 'No, he thought for a moment, I cannot say this to the king, that would be lying.', 'title' => ''], 'AudioId' => ['description' => 'The sequence number of the text, which corresponds to the AduioRecordId parameter to be passed during audio check.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DemonstrationList\\": [\\n {\\n \\"DemoAudio\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/1.wav\\",\\n \\"Text\\": \\"No, he thought for a moment, I cannot say this to the king, that would be lying.\\",\\n \\"AudioId\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'GetDemonstrationForCustomizedVoiceJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDemonstrationForCustomizedVoiceJob'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:GetDemonstrationForCustomizedVoiceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetDynamicImageJob' => [ 'summary' => 'Queries the information about an image animation job.', 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******36-3C1E-4417-BDB2-1E034F******', 'title' => ''], 'DynamicImageJob' => [ 'title' => '', 'description' => 'The information about the snapshot job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****'."\n", 'title' => ''], 'TriggerSource' => [ 'description' => 'The request trigger source.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Console'."\n" ."\n" .'- Workflow'."\n" ."\n" .'- API', 'enumValueTitles' => ['Console' => '', 'Workflow' => '', 'API' => 'API'], 'type' => 'string', 'example' => 'API', 'title' => '', ], 'Name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'SampleJob', 'title' => ''], 'Input' => [ 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'2. Media: a media asset.', 'enumValueTitles' => ['Media' => '', 'OSS' => ''], 'type' => 'string', 'example' => 'OSS', 'title' => '', ], 'Media' => ['description' => 'The input file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats:'."\n" ."\n" .'1. OSS://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object'."\n" ."\n" .'In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS.', 'type' => 'string', 'example' => 'oss://test-bucket/sample-input.mp4', 'title' => ''], 'OssFile' => [ 'title' => '', 'description' => 'The three key elements of OSS.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'test-bucket', 'title' => ''], 'Location' => ['description' => 'The OSS location.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Object' => ['description' => 'The OSS object.', 'type' => 'string', 'example' => 'sample-input.mp4', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'The output of the job.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the input file. Valid values: OSS: an OSS object. Media: a media asset.', 'enumValueTitles' => ['Media' => '', 'OSS' => ''], 'type' => 'string', 'example' => 'Media', 'title' => '', ], 'Media' => ['description' => 'The input file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats:'."\n" ."\n" .'1. OSS://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], 'OssFile' => [ 'title' => '', 'description' => 'The three key elements of OSS.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'sample-bucket', 'title' => ''], 'Location' => ['description' => 'The OSS location.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Object' => ['description' => 'The OSS object.', 'type' => 'string', 'example' => 'path/to/object', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'OutputUrl' => ['description' => 'The URL of the output animated image.', 'type' => 'string', 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif', 'title' => ''], 'TemplateConfig' => ['description' => 'The animation template configuration.', 'type' => 'string', 'example' => '{"Format":"gif","Fps":5,"Height":1080,"Width":1920}', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], 'Status' => [ 'description' => 'The state of the job.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Init: The job is submitted.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Fail: The job failed.', 'enumValueTitles' => ['Init' => '', 'Success' => '', 'Fail' => ''], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'Code' => ['description' => 'Error codes', 'type' => 'string', 'example' => 'ResourceNotFound', 'title' => ''], 'Message' => ['description' => 'The error message that is returned.', 'type' => 'string', 'example' => 'The specified resource for "CustomTemplate" could not be found.', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"sampleParam": "sampleValue"}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\",\\n \\"DynamicImageJob\\": {\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\\\n\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"SampleJob\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://test-bucket/sample-input.mp4\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"sample-input.mp4\\"\\n }\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"Media\\",\\n \\"Media\\": \\"****d80e4e4044975745c14b****\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"sample-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"path/to/object\\"\\n }\\n },\\n \\"OutputUrl\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Format\\\\\\":\\\\\\"gif\\\\\\",\\\\\\"Fps\\\\\\":5,\\\\\\"Height\\\\\\":1080,\\\\\\"Width\\\\\\":1920}\\",\\n \\"TemplateId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"PipelineId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource for \\\\\\"CustomTemplate\\\\\\" could not be found.\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"UserData\\": \\"{\\\\\\"sampleParam\\\\\\": \\\\\\"sampleValue\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n}","type":"json"}]', 'title' => 'GetDynamicImageJob', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDynamicImageJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetDynamicImageJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetEditingProject' => [ 'summary' => 'Queries the information about an online editing project.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'PrivateKey' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****fb2101bf24b2754cb318787dc****'], ], [ 'name' => 'RequestSource', 'in' => 'query', 'schema' => ['description' => 'The ID of the request source. Valid values:'."\n" ."\n" .'\\- OpenAPI (default): Timeline conversion is not performed.'."\n" ."\n" .'\\- WebSDK: If you specify this value, the project timeline is automatically converted into the frontend style, and the materials in the timeline are associated with the project to enable preview by using frontend web SDKs.', 'type' => 'string', 'required' => false, 'example' => 'WebSDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'Project' => [ 'description' => 'The information about the online editing project.', 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'title' => '', 'example' => '****fb2101bf24b2754cb318787dc****'], 'Title' => ['description' => 'The title of the online editing project.', 'type' => 'string', 'title' => '', 'example' => 'Sample title'], 'Timeline' => ['description' => 'The timeline of the online editing project.', 'type' => 'string', 'title' => '', 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]}'], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => '****96e8864746a0b6f3****'], 'ClipsParam' => ['description' => 'The material parameter corresponding to the template, in the JSON format. If TemplateId is specified, ClipsParam must also be specified. For more information, see [Create and use a regular template](https://help.aliyun.com/document_detail/328557.html) and [Create and use an advanced template](https://help.aliyun.com/document_detail/291418.html).', 'type' => 'string', 'title' => '', 'example' => 'See the template user guide.'], 'Description' => ['description' => 'The description of the online editing project.', 'type' => 'string', 'title' => '', 'example' => 'Example description'], 'CoverURL' => ['description' => 'The thumbnail URL of the online editing project.', 'type' => 'string', 'title' => '', 'example' => 'http://aaa.bbb/your-cover.jpg'], 'CreateTime' => ['description' => 'The time when the online editing project was created.', 'type' => 'string', 'title' => '', 'example' => '2020-12-20T12:00:00Z'], 'ModifiedTime' => ['description' => 'The time when the online editing project was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-12-20T13:00:00Z'], 'Duration' => ['description' => 'The total duration of the online editing project.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '24.120000'], 'Status' => ['description' => 'The status of the online editing project. Valid values:'."\n" ."\n" .'\\- Draft'."\n" ."\n" .'\\- Editing'."\n" ."\n" .'\\- Producing'."\n" ."\n" .'\\- Produced'."\n" ."\n" .'\\- ProduceFailed'."\n" ."\n" .'\\- Deleted', 'type' => 'string', 'title' => '', 'example' => 'Editing'], 'CreateSource' => ['description' => 'The method for creating the online editing project. Valid values:'."\n" ."\n" .'\\- OpenAPI'."\n" ."\n" .'\\- AliyunConsole'."\n" ."\n" .'\\- WebSDK'."\n" ."\n" .'\\- LiveEditingOpenAPI'."\n" ."\n" .'\\- LiveEditingConsole', 'type' => 'string', 'title' => '', 'example' => 'OpenAPI'], 'TemplateType' => ['description' => 'The template type of the online editing project. Valid values:'."\n" ."\n" .'\\- Timeline'."\n" ."\n" .'\\- VETemplate', 'type' => 'string', 'title' => '', 'example' => 'Timeline'], 'ModifiedSource' => ['description' => 'The method for editing the online editing project. Valid values:'."\n" ."\n" .'\\- OpenAPI'."\n" ."\n" .'\\- AliyunConsole'."\n" ."\n" .'\\- WebSDK'."\n" ."\n" .'\\- LiveEditingOpenAPI'."\n" ."\n" .'\\- LiveEditingConsole', 'type' => 'string', 'title' => '', 'example' => 'OpenAPI'], 'ProjectType' => ['description' => 'The type of the editing project. Default value: EditingProject. Valid values:'."\n" ."\n" .'\\- EditingProject: a regular editing project.'."\n" ."\n" .'\\- LiveEditingProject: a live stream editing project.', 'type' => 'string', 'example' => 'EditingProject', 'title' => ''], 'BusinessConfig' => ['description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.', 'type' => 'string', 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', 'title' => ''], 'BusinessStatus' => ['description' => 'The business status of the project. This parameter can be ignored for general editing projects. Valid values:'."\n" ."\n" .'Reserving'."\n" ."\n" .'ReservationCanceled'."\n" ."\n" .'BroadCasting'."\n" ."\n" .'LoadingFailed'."\n" ."\n" .'LiveFinished', 'type' => 'string', 'example' => 'Reserving', 'title' => ''], 'TimelineConvertStatus' => ['description' => 'The project conversion status. Conversion of an API-style timeline into a frontend-style timeline is an asynchronous process and takes effect only if RequestSource:WebSDK is specified.'."\n" ."\n" .'\\- Unconverted'."\n" ."\n" .'\\- Converting'."\n" ."\n" .'\\- Converted'."\n" ."\n" .'\\- ConvertFailed', 'type' => 'string', 'example' => 'Converted', 'title' => ''], 'TimelineConvertErrorMessage' => ['description' => 'The error message returned if the project conversion failed. The error message displays the detailed information about the failure, and is returned only if the value of TimelineConvertStatus is ConvertFailed.', 'type' => 'string', 'example' => 'The StorageLocation must be in the same division(apiRegion) as ICE service access point.', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], ], ], 'staticInfo' => [], 'title' => 'GetEditingProject', 'changeSet' => [ ['createdAt' => '2022-12-05T04:40:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEditingProject'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetEditingProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Project\\": {\\n \\"ProjectId\\": \\"****fb2101bf24b2754cb318787dc****\\",\\n \\"Title\\": \\"Sample title\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****9b4d7cf14dc7b83b0e801cbe****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****9b4d7cf14dc7b83b0e801cbe****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****1656bca4474999c961a6d2a2****\\\\\\"}]}]}\\",\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"ClipsParam\\": \\"See the template user guide.\\",\\n \\"Description\\": \\"Example description\\",\\n \\"CoverURL\\": \\"http://aaa.bbb/your-cover.jpg\\",\\n \\"CreateTime\\": \\"2020-12-20T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2020-12-20T13:00:00Z\\",\\n \\"Duration\\": 24.12,\\n \\"Status\\": \\"Editing\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"ProjectType\\": \\"EditingProject\\",\\n \\"BusinessConfig\\": \\"{ \\\\\\"OutputMediaConfig\\\\\\" : { \\\\\\"StorageLocation\\\\\\": \\\\\\"test-bucket.oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Path\\\\\\": \\\\\\"test-path\\\\\\" }, \\\\\\"OutputMediaTarget\\\\\\": \\\\\\"oss-object\\\\\\", \\\\\\"ReservationTime\\\\\\": \\\\\\"2021-06-21T08:05:00Z\\\\\\" }\\",\\n \\"BusinessStatus\\": \\"Reserving\\",\\n \\"TimelineConvertStatus\\": \\"Converted\\",\\n \\"TimelineConvertErrorMessage\\": \\"The StorageLocation must be in the same division(apiRegion) as ICE service access point.\\"\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetEditingProjectMaterials' => [ 'summary' => 'Retrieve all media assets bound to the current editing project.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'PrivateKey' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['description' => 'ID of the online editing project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '*****fb2101cb318*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '******89-C21D-4B78-AE24-3788B8******'], 'ProjectId' => ['description' => 'ID of the project.', 'type' => 'string', 'example' => '*****67ae06542b9b93e0d1c387*****', 'title' => ''], 'MediaInfos' => [ 'title' => '', 'description' => 'Collection of matching media assets.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => '*****64623a94eca8516569c8fe*****'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'Basic information about the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'ID of the media asset.', 'type' => 'string', 'example' => '*****64623a94eca8516569c8f*****'], 'InputURL' => ['description' => 'URL of the media asset in the source system.', 'type' => 'string', 'title' => '', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4'], 'MediaType' => ['description' => 'Media type of the asset.', 'type' => 'string', 'title' => '', 'example' => 'video'], 'BusinessType' => ['description' => 'Business type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'general'], 'Source' => ['description' => 'Source of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'Title of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'file.mp4'], 'Description' => ['description' => 'Description of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'sample_description'], 'Category' => ['description' => 'Category of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'video'], 'MediaTags' => ['description' => 'Tags associated with the media asset.', 'type' => 'string', 'example' => 'tag1', 'title' => ''], 'CoverURL' => ['description' => 'URL of the thumbnail image.', 'type' => 'string', 'title' => '', 'example' => 'http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature'], 'UserData' => ['description' => 'User-defined data.', 'type' => 'string', 'title' => '', 'example' => 'userData'], 'Snapshots' => ['description' => 'Thumbnail images.', 'type' => 'string', 'title' => '', 'example' => 'null'], 'Status' => ['description' => 'Status of the resource.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'TranscodeStatus' => [ 'description' => 'Status of the transcoding task.', 'enumValueTitles' => ['TranscodeSuccess' => 'Transcoding completed', 'TranscodeFailed' => 'Transcoding failed', 'Init' => 'Initializing', 'Transcoding' => 'Transcoding in progress'], 'type' => 'string', 'title' => '', 'example' => 'Init', ], 'CreateTime' => ['description' => 'Time when the media asset was created.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:08Z'], 'ModifiedTime' => ['description' => 'Time when the media asset was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:08Z'], 'DeletedTime' => ['description' => 'Time when the media asset was deleted.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:08Z'], 'SpriteImages' => ['description' => 'Sprite image.', 'type' => 'string', 'title' => '', 'example' => 'null'], ], 'example' => '', ], 'FileInfoList' => [ 'title' => '', 'description' => 'File information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'Basic file information, such as duration and size.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'Name of the file.', 'type' => 'string', 'title' => '', 'example' => 'example.mp4'], 'FileStatus' => ['description' => 'Status of the file.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'Type of the file.', 'type' => 'string', 'title' => '', 'example' => 'source_file'], 'FileSize' => ['description' => 'Size of the file, in bytes.', 'type' => 'string', 'title' => '', 'example' => '30611502'], 'FileUrl' => ['description' => 'OSS URL of the file.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['description' => 'Region where the file is stored.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'FormatName' => ['description' => 'Container format.', 'type' => 'string', 'title' => '', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2'], 'Duration' => ['description' => 'Duration of the file.', 'type' => 'string', 'title' => '', 'example' => '216.206667'], 'Bitrate' => ['description' => 'Bitrate of the file.', 'type' => 'string', 'title' => '', 'example' => '1132.68'], 'Width' => ['description' => 'Width of the video.', 'type' => 'string', 'title' => '', 'example' => '960'], 'Height' => ['description' => 'Height of the video.', 'type' => 'string', 'title' => '', 'example' => '540'], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'LiveMaterials' => [ 'description' => 'Media assets associated with live streams.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AppName' => ['description' => 'Name of the live streaming application.', 'type' => 'string', 'example' => 'testrecord', 'title' => ''], 'StreamName' => ['description' => 'Name of the live stream.', 'type' => 'string', 'example' => 'testrecord', 'title' => ''], 'DomainName' => ['description' => 'Streaming domain name for live streaming.', 'type' => 'string', 'example' => 'test.alivecdn.com', 'title' => ''], 'LiveUrl' => ['description' => 'Streaming URL for the live stream.', 'type' => 'string', 'example' => 'rtmp://test.alivecdn.com/testrecord/teststream', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ProjectMaterials' => [ 'description' => 'Media assets associated with the editing project. After a live stream ends, it is linked to a standard editing project.', 'type' => 'array', 'items' => ['description' => 'ID of the standard editing project associated with the live editing project.', 'type' => 'string', 'example' => '*****c38767ae06542b9b93e0d1*****', 'title' => ''], 'example' => '*****9b145c5cafc2e057304fcd*****', 'title' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], ], 404 => [ ['errorCode' => 'ProjectNotFound', 'errorMessage' => 'The specified project not found', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******89-C21D-4B78-AE24-3788B8******\\",\\n \\"ProjectId\\": \\"*****67ae06542b9b93e0d1c387*****\\",\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"*****64623a94eca8516569c8fe*****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"*****64623a94eca8516569c8f*****\\",\\n \\"InputURL\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"file.mp4\\",\\n \\"Description\\": \\"sample_description\\",\\n \\"Category\\": \\"video\\",\\n \\"MediaTags\\": \\"tag1\\",\\n \\"CoverURL\\": \\"http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"null\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"SpriteImages\\": \\"null\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"216.206667\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"LiveMaterials\\": [\\n {\\n \\"AppName\\": \\"testrecord\\",\\n \\"StreamName\\": \\"testrecord\\",\\n \\"DomainName\\": \\"test.alivecdn.com\\",\\n \\"LiveUrl\\": \\"rtmp://test.alivecdn.com/testrecord/teststream\\"\\n }\\n ],\\n \\"ProjectMaterials\\": [\\n \\"*****c38767ae06542b9b93e0d1*****\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetEditingProjectMaterials', 'changeSet' => [ ['createdAt' => '2021-11-26T03:21:26.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-04-07T10:59:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEditingProjectMaterials'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetEditingProjectMaterials', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetEventCallback' => [ 'summary' => 'Queries event callback configurations.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'CallbackType' => [ 'description' => 'The callback method. Valid values:'."\n" ."\n" .'- **HTTP**'."\n" ."\n" .'- **MNS**', 'enumValueTitles' => ['MNS' => 'MNS', 'HTTP' => 'HTTP'], 'type' => 'string', 'example' => 'HTTP', 'title' => '', ], 'CallbackQueueName' => ['description' => 'The name of the Simple Message Queue (SMQ) queue to which callback messages are sent.', 'type' => 'string', 'example' => 'ice-callback-queue', 'title' => ''], 'CallbackURL' => ['description' => 'The callback URL to which event notifications are sent.', 'type' => 'string', 'example' => 'http://xxx.yyy/callback', 'title' => ''], 'EventTypeList' => ['description' => 'The type of the callback event. Multiple values are separated with commas (,). For more information about callback event types, see [Event notification content](~~610204~~).', 'type' => 'string', 'example' => 'ProduceMediaComplete,TranscodeComplete', 'title' => ''], 'AuthSwitch' => [ 'description' => 'Specifies whether callback authentication is enabled. This parameter is returned only for **HTTP** callbacks. Valid values:'."\n" ."\n" .'- **on**'."\n" ."\n" .'- **off**', 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', 'example' => 'on', 'title' => '', ], 'AuthKey' => ['description' => 'The authentication key. This parameter is returned only for HTTP callbacks.', 'type' => 'string', 'example' => 'TestKey001', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'GetEventCallback', 'changeSet' => [ ['createdAt' => '2021-06-25T14:18:28.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEventCallback'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetEventCallback', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"CallbackType\\": \\"HTTP\\",\\n \\"CallbackQueueName\\": \\"ice-callback-queue\\",\\n \\"CallbackURL\\": \\"http://xxx.yyy/callback\\",\\n \\"EventTypeList\\": \\"ProduceMediaComplete,TranscodeComplete\\",\\n \\"AuthSwitch\\": \\"on\\",\\n \\"AuthKey\\": \\"TestKey001\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetHotwordLibrary' => [ 'summary' => 'Queries the information about a specified hotword library based on the ID.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'HotwordLibraryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the hotword library.', 'type' => 'string', 'required' => true, 'example' => '****96e8864746a0b6f3****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '****12e8864746a0a398****'], 'HotwordLibraryId' => ['description' => 'The ID of the hotword library.', 'type' => 'string', 'example' => '****05512043f49f697f7425****', 'title' => ''], 'Name' => ['description' => 'The name of the hotword library.', 'type' => 'string', 'example' => 'Hotword library name', 'title' => ''], 'Description' => ['description' => 'The description of the hotword library.', 'type' => 'string', 'example' => '热词库描述', 'title' => ''], 'Hotwords' => [ 'title' => '', 'description' => 'The hotword list.', 'type' => 'array', 'items' => ['description' => 'The hotword data.', '$ref' => '#/components/schemas/Hotword', 'title' => '', 'example' => ''], 'example' => '', ], 'UsageScenario' => ['description' => 'The usage scenario of the hotword library.', 'type' => 'string', 'example' => 'ASR', 'title' => ''], 'CreationTime' => ['description' => 'The time when the hotword library was created.', 'type' => 'string', 'example' => '2020-12-23T13:33:49Z', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****12e8864746a0a398****\\",\\n \\"HotwordLibraryId\\": \\"****05512043f49f697f7425****\\",\\n \\"Name\\": \\"Hotword library name\\",\\n \\"Description\\": \\"热词库描述\\",\\n \\"Hotwords\\": [\\n {\\n \\"TranspositionResultList\\": [\\n {\\n \\"TranslatedText\\": \\"你好\\",\\n \\"TargetLanguage\\": \\"zh\\"\\n }\\n ],\\n \\"Language\\": \\"en\\",\\n \\"Text\\": \\"hello\\",\\n \\"Weight\\": 2\\n }\\n ],\\n \\"UsageScenario\\": \\"ASR\\",\\n \\"CreationTime\\": \\"2020-12-23T13:33:49Z\\"\\n}","type":"json"}]', 'title' => 'GetHotwordLibrary', 'description' => '##'."\n" ."\n" .'Retrieve details of a specified hotword library based on the ID, including the library name, description, and content and attributes of all hotwords in it.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetHotwordLibrary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetIpcDeviceInfo' => [ 'summary' => 'Obtain IPC device information.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => false, 'example' => 'd123', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start Time. UTC time in the format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2017-01-11T12:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End Time. UTC time in the format yyyy-MM-ddTHH:mm:ssZ. The difference between EndTime and StartTime must not exceed 180 days.', 'type' => 'string', 'required' => false, 'example' => '2017-02-11T12:00:00Z', 'title' => ''], ], [ 'name' => 'Capability', 'in' => 'query', 'schema' => ['description' => 'Capability. Default value is understand. Valid values:'."\n" ."\n" .'- understand: understanding'."\n" ."\n" .'- understand-reid: understanding with reid'."\n" ."\n" .'- search: search', 'type' => 'string', 'required' => false, 'example' => 'understand', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'Page number for paging. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, which specifies the number of entries displayed per page. Default value is 10. Maximum value is 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'DeviceInfos' => [ 'description' => 'List of device identity information.', 'type' => 'array', 'items' => [ 'description' => 'List of device identity information.', 'type' => 'object', 'properties' => [ 'DeviceId' => ['description' => 'Device ID.', 'type' => 'string', 'example' => 'd123', 'title' => ''], 'Capability' => ['description' => 'Capability. Valid values:'."\n" ."\n" .'- understand: understanding'."\n" ."\n" .'- understand-reid: understanding with reid'."\n" ."\n" .'- search: search', 'type' => 'string', 'example' => 'understand', 'title' => ''], 'ExpireTime' => ['description' => 'Expiration Time. UTC time in the format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2017-02-11T12:00:00Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '78', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain IPC device information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetIpcDeviceInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"DeviceInfos\\": [\\n {\\n \\"DeviceId\\": \\"d123\\",\\n \\"Capability\\": \\"understand\\",\\n \\"ExpireTime\\": \\"2017-02-11T12:00:00Z\\"\\n }\\n ],\\n \\"Total\\": 78\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetLiveEditingIndexFile' => [ 'summary' => 'Queries the index file of a live stream. The index file is used to preview an editing project in the console.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice6HV5HL'], ], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'query', 'schema' => ['description' => 'The application name of the live stream.', 'type' => 'string', 'required' => false, 'example' => 'testrecord', 'title' => ''], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => ['description' => 'The domain name of the live stream.', 'type' => 'string', 'required' => false, 'example' => 'test.alivecdn.com', 'title' => ''], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => ['description' => 'The name of the live stream.', 'type' => 'string', 'required' => false, 'example' => 'teststream', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the live stream editing project.', 'type' => 'string', 'required' => false, 'example' => '*****cb6307a4edea614d8b3f3c*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94'], 'IndexFile' => ['description' => 'The URL of the index file.', 'type' => 'string', 'example' => 'https://bucket.oss-cn-shanghai.aliyuncs.com/test/live1.m3u8?<鉴权>&x-oss-process=hls/sign', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'GetLiveEditingIndexFile', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveEditingIndexFile'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveEditingIndexFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"IndexFile\\": \\"https://bucket.oss-cn-shanghai.aliyuncs.com/test/live1.m3u8?<鉴权>&x-oss-process=hls/sign\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetLiveEditingJob' => [ 'summary' => 'Queries the information about a live editing job. The requested information includes the state, timeline, and template of the job, the ID and URL of the output file, and the configurations of the job. Query only live editing jobs created within the past year.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice6HV5HL'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the live editing job.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****', 'title' => ''], 'LiveEditingJob' => [ 'title' => '', 'description' => 'The information about the live editing job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the live editing job.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], 'ProjectId' => ['description' => 'The ID of the live editing project.', 'type' => 'string', 'example' => '****fddd7748b58bf1d47e95****', 'title' => ''], 'Status' => ['description' => 'The state of the live editing job. Valid values: Init, Queuing, Processing, Success, and Failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Clips' => ['description' => 'The clips.', 'type' => 'string', 'example' => '[{\\"StartTime\\": \\" 2021-06-21T08:01:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:03:00Z\\" }]', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"key": "value\'}', 'title' => ''], 'CreationTime' => ['description' => 'The time when the live editing job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:40Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the live editing job was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:49Z', 'title' => ''], 'CompleteTime' => ['description' => 'The time when the live editing job was completed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:52Z', 'title' => ''], 'MediaId' => ['description' => 'The media asset ID of the output file.', 'type' => 'string', 'example' => '****0cc6ba49eab379332c5b****', 'title' => ''], 'MediaURL' => ['description' => 'The URL of the output file.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4', 'title' => ''], 'Code' => ['description' => 'The response code. Note: Pay attention to this parameter if the job failed.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], 'Message' => ['description' => 'The returned message. Note: Pay attention to this parameter if the job failed.', 'type' => 'string', 'example' => 'The specific parameter LiveStreamConfig is not valid.', 'title' => ''], 'LiveStreamConfig' => [ 'title' => '', 'description' => 'The live editing configurations.', 'type' => 'object', 'properties' => [ 'AppName' => ['description' => 'The name of the application to which the live stream belongs.', 'type' => 'string', 'example' => 'app', 'title' => ''], 'DomainName' => ['description' => 'The domain name of the live stream.', 'type' => 'string', 'example' => 'domain.com', 'title' => ''], 'StreamName' => ['description' => 'The name of the live stream.', 'type' => 'string', 'example' => 'streamName', 'title' => ''], ], 'example' => '', ], 'MediaProduceConfig' => [ 'title' => '', 'description' => 'The production configurations.', 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'The editing mode. Default value: Accurate.', 'type' => 'string', 'example' => 'Accurate', 'title' => ''], ], 'example' => '', ], 'OutputMediaConfig' => [ 'title' => '', 'description' => 'The storage configurations of the output file.', 'type' => 'object', 'properties' => [ 'MediaURL' => ['description' => 'The URL of the output file.', 'type' => 'string', 'example' => 'https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4', 'title' => ''], 'StorageLocation' => ['description' => 'If OutputMediaTarget is set to vod-media, this parameter indicates the storage location of the media asset in ApsaraVideo VOD. The storage location is the path of the file in ApsaraVideo VOD, excluding the prefix http\\://. Example: outin-xxxxxx.oss-cn-shanghai.aliyuncs.com.', 'type' => 'string', 'example' => 'outin-xxxxxx.oss-cn-shanghai.aliyuncs.com', 'title' => ''], 'FileName' => ['description' => 'If OutputMediaTarget is set to vod-media, this parameter indicates the file name of the output file. The value contains the file name extension but not the path.', 'type' => 'string', 'example' => 'test.mp4', 'title' => ''], 'Width' => ['description' => 'The width of the output file. You can leave this parameter empty. The default value is the maximum width of the input materials.', 'type' => 'integer', 'format' => 'int32', 'example' => '640', 'title' => ''], 'Height' => ['description' => 'The height of the output file. You can leave this parameter empty. The default value is the maximum height of the input materials.', 'type' => 'integer', 'format' => 'int32', 'example' => '480', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the output file. Unit: Kbit/s. You can leave this parameter empty. The default value is the maximum bitrate of the input materials.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'VodTemplateGroupId' => ['description' => 'The ID of the VOD transcoding template group. If VOD transcoding is not required, set the value to VOD\\_NO\\_TRANSCODE.', 'type' => 'string', 'example' => 'VOD_NO_TRANSCODE', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'GetLiveEditingJob', 'changeSet' => [ ['createdAt' => '2021-12-21T08:24:09.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-08-13T14:04:54.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveEditingJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveEditingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"LiveEditingJob\\": {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"Status\\": \\"Success\\",\\n \\"Clips\\": \\"[{\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\": \\\\\\\\\\\\\\" 2021-06-21T08:01:00Z\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"EndTime\\\\\\\\\\\\\\": \\\\\\\\\\\\\\" 2021-06-21T08:03:00Z\\\\\\\\\\\\\\" }]\\",\\n \\"UserData\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\'}\\",\\n \\"CreationTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"ModifiedTime\\": \\"2020-12-23T13:33:49Z\\",\\n \\"CompleteTime\\": \\"2020-12-23T13:33:52Z\\",\\n \\"MediaId\\": \\"****0cc6ba49eab379332c5b****\\",\\n \\"MediaURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"The specific parameter LiveStreamConfig is not valid.\\",\\n \\"LiveStreamConfig\\": {\\n \\"AppName\\": \\"app\\",\\n \\"DomainName\\": \\"domain.com\\",\\n \\"StreamName\\": \\"streamName\\"\\n },\\n \\"MediaProduceConfig\\": {\\n \\"Mode\\": \\"Accurate\\"\\n },\\n \\"OutputMediaConfig\\": {\\n \\"MediaURL\\": \\"https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4\\",\\n \\"StorageLocation\\": \\"outin-xxxxxx.oss-cn-shanghai.aliyuncs.com\\",\\n \\"FileName\\": \\"test.mp4\\",\\n \\"Width\\": 640,\\n \\"Height\\": 480,\\n \\"Bitrate\\": 1000,\\n \\"VodTemplateGroupId\\": \\"VOD_NO_TRANSCODE\\"\\n }\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetLivePackageChannel' => [ 'summary' => 'Gets details about a live package channel.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239699', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageChannel' => [ 'description' => 'Details of the live package channel.', 'type' => 'object', 'properties' => [ 'ChannelName' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'ch4'], 'CreateTime' => ['description' => 'The time when the channel was created.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The channel description.', 'type' => 'string', 'example' => 'Test channel', 'title' => ''], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'channel-group-1'], 'IngestEndpoints' => [ 'description' => 'The ingest endpoints.', 'type' => 'array', 'items' => [ 'description' => 'The information about the ingest endpoint.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The ingest endpoint ID.', 'type' => 'string', 'example' => 'ingest1', 'title' => ''], 'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => '2F9e******b569c8', 'title' => ''], 'Url' => ['description' => 'The ingest endpoint URL.', 'type' => 'string', 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest'."\n", 'title' => ''], 'Username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'us12******das', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LastModified' => ['description' => 'The time when the endpoint was last modified.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Protocol' => ['description' => 'The ingest protocol. Only HLS is supported.', 'type' => 'string', 'title' => '', 'example' => 'HLS'], 'SegmentCount' => ['description' => 'The number of M3U8 segments.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], 'SegmentDuration' => ['description' => 'The segment duration.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'RequestId-12345678', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"ch4\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"Test channel\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"ingest1\\",\\n \\"Password\\": \\"2F9e******b569c8\\",\\n \\"Url\\": \\"http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\\\n\\",\\n \\"Username\\": \\"us12******das\\"\\n }\\n ],\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n },\\n \\"RequestId\\": \\"RequestId-12345678\\"\\n}","type":"json"}]', 'title' => 'GetLivePackageChannel', 'description' => '## [](#)Usage notes'."\n" ."\n" .'This API operation allows you to query the details of a live package channel, including the creation time, description, ingest endpoint, protocol, number of segments, and segment duration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetLivePackageChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLivePackageChannelGroup' => [ 'summary' => 'Gets details about a live package channel group by name.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238116', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageChannelGroup' => [ 'description' => 'Details of the channel group.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the channel group was created. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The channel group description.', 'type' => 'string', 'title' => '', 'example' => 'Updated description of the channel group.'], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'channel-group-1'], 'LastModified' => ['description' => 'The time when the channel group was last modified. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'OriginDomain' => ['description' => 'The origin domain.', 'type' => 'string', 'title' => '', 'example' => 'example.com'], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroup\\": {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"Updated description of the channel group.\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"OriginDomain\\": \\"example.com\\"\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', 'title' => 'GetLivePackageChannelGroup', 'description' => '## [](#)Usage notes'."\n" ."\n" .'Gets details about a specific channel group, including its name, description, origin domain, and creation and last modification timestamps.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetLivePackageChannelGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLivePackageOriginEndpoint' => [ 'summary' => 'Query the real-time stream packaging origin configuration details of a specified channel.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239770', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ 'name' => 'EndpointName', 'in' => 'query', 'schema' => ['description' => 'The endpoint name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'endpoint-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageOriginEndpoint' => [ 'description' => 'The information about the origin endpoints.', 'type' => 'object', 'properties' => [ 'AuthorizationCode' => ['description' => 'The authorization code.', 'type' => 'string', 'title' => '', 'example' => 'Abc123Def456'], 'ChannelName' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'channel-1'], 'CreateTime' => ['description' => 'The time when the endpoint was created.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The endpoint description.', 'type' => 'string', 'example' => 'This is an origin endpoint.', 'title' => ''], 'EndpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'title' => '', 'example' => 'endpoint-1'], 'EndpointUrl' => ['description' => 'The endpoint URL.', 'type' => 'string', 'title' => '', 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest'], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'channel-group-1'], 'IpBlacklist' => ['description' => 'The IP address blacklist.', 'type' => 'string', 'title' => '', 'example' => '10.21.222.1/32'], 'IpWhitelist' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'title' => '', 'example' => '192.168.1.0/24,10.0.0.1/24'], 'LastModified' => ['description' => 'The time when the endpoint was last modified.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'ManifestName' => ['description' => 'The playlist name.', 'type' => 'string', 'title' => '', 'example' => 'manifest'], 'Protocol' => ['description' => 'The distribution protocol.', 'type' => 'string', 'title' => '', 'example' => 'HLS'], 'TimeshiftVision' => ['description' => 'The number of days that time-shifted content is available.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'LivePackagingConfig' => ['description' => 'Live packaging configuration', '$ref' => '#/components/schemas/LivePackagingConfig', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"This is an origin endpoint.\\",\\n \\"EndpointName\\": \\"endpoint-1\\",\\n \\"EndpointUrl\\": \\"https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IpBlacklist\\": \\"10.21.222.1/32\\",\\n \\"IpWhitelist\\": \\"192.168.1.0/24,10.0.0.1/24\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"TimeshiftVision\\": 5,\\n \\"LivePackagingConfig\\": {\\n \\"LiveManifestConfigs\\": [\\n {\\n \\"SegmentCount\\": 3,\\n \\"AdMarkers\\": \\"NONE\\",\\n \\"MinVideoBitrate\\": 1000000,\\n \\"MinBufferTime\\": 8,\\n \\"PresentationDelay\\": 12,\\n \\"StreamOrder\\": \\"ORIGINAL\\",\\n \\"MaxVideoBitrate\\": 8000000,\\n \\"DateTimeInterval\\": 5,\\n \\"SegmentTemplateFormat\\": \\"NUMBER_TIMELINE\\",\\n \\"MinUpdatePeriod\\": 8,\\n \\"ManifestDuration\\": 60\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"9a04f079-9840-4286-ab92-e65be0885f95\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"live-axb1-9dd2fa123\\",\\n \\"EncryptionMethod\\": \\"SAMPLE_AES\\",\\n \\"IV\\": \\"00000000000000000000000000000000\\",\\n \\"Url\\": \\"https://exampledrm.com/path?arg1=xxx\\"\\n },\\n \\"SegmentDuration\\": 6\\n }\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', 'title' => 'Obtain real-time packaging origin endpoint ', 'description' => '## Request Description', 'changeSet' => [ ['createdAt' => '2025-05-29T03:09:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetLivePackageOriginEndpoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLiveRecordJob' => [ 'summary' => 'Queries the information about a live stream recording job.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the recording job.', 'type' => 'string', 'required' => true, 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RecordJob' => [ 'title' => '', 'description' => 'The details of the recording job.', 'type' => 'object', 'properties' => [ 'NotifyUrl' => ['description' => 'The callback URL.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'https://example.com/imsnotify'], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'format' => 'iso8601', 'title' => '', 'example' => '2022-07-20T02:48:58Z'], 'StreamInput' => [ 'description' => 'The URL of the live stream.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the live stream. The value can only be rtmp.', 'enumValueTitles' => ['rtmp' => 'rtmp'], 'type' => 'string', 'example' => 'rtmp', 'title' => '', ], 'Url' => ['description' => 'The URL of the live stream.', 'type' => 'string', 'example' => 'rtmp://example.com/app/stream', 'title' => ''], ], 'deprecated' => false, 'title' => '', 'example' => '', ], 'RecordOutput' => [ 'description' => 'The storage address of the recording.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the storage address.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- vod'."\n" ."\n" .'- oss', 'enumValueTitles' => ['vod' => 'vod', 'oss' => 'oss'], 'type' => 'string', 'example' => 'oss', 'title' => '', ], 'Bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'imsbucket1', 'title' => ''], 'Endpoint' => ['description' => 'The endpoint of the storage service.', 'type' => 'string', 'example' => 'oss-cn-shanghai.aliyuncs.com', 'title' => ''], ], 'deprecated' => false, 'title' => '', 'example' => '', ], 'TemplateId' => ['description' => 'The ID of the recording template.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66'], 'TemplateName' => ['description' => 'The name of the recording template.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'test template'], 'Name' => ['description' => 'The name of the recording job.', 'type' => 'string', 'example' => 'Live event recording task 1', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => ''], 'JobId' => ['description' => 'The ID of the recording job.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66'], 'Status' => [ 'description' => 'The state of the recording job.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- paused: The job is paused.'."\n" ."\n" .'- initial: The job is not started.'."\n" ."\n" .'- started: The job is in progress.', 'enumValueTitles' => ['paused' => 'paused', 'initial' => 'initial', 'started' => 'started'], 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'paused', ], ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B57A046C-CE33-5FBB-B57A-D2B89ACF6907', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecordJob\\": {\\n \\"NotifyUrl\\": \\"https://example.com/imsnotify\\",\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\",\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"Url\\": \\"rtmp://example.com/app/stream\\"\\n },\\n \\"RecordOutput\\": {\\n \\"Type\\": \\"oss\\",\\n \\"Bucket\\": \\"imsbucket1\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\"\\n },\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"TemplateName\\": \\"test template\\",\\n \\"Name\\": \\"Live event recording task 1\\",\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\",\\n \\"Status\\": \\"paused\\"\\n },\\n \\"RequestId\\": \\"B57A046C-CE33-5FBB-B57A-D2B89ACF6907\\"\\n}","type":"json"}]', 'title' => 'GetLiveRecordJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRecordJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveRecordJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLiveRecordTemplate' => [ 'summary' => 'Queries the information about a live stream recording template or a snapshot of the template.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the recording job. You can specify the JobId parameter to retrieve the snapshot of the template used by the job.', 'type' => 'string', 'required' => false, 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RecordTemplate' => [ 'title' => '', 'description' => 'The recording template.', 'type' => 'object', 'properties' => [ 'RecordFormatList' => [ 'title' => '', 'description' => 'The list of recording formats.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The recording format.', 'type' => 'object', 'properties' => [ 'Format' => [ 'description' => 'The output file format.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'enum' => ['m3u8', 'mp4', 'flv'], 'title' => '', 'example' => 'm3u8', ], 'OssObjectPrefix' => ['description' => 'The name of the recording file that is stored in Object Storage Service (OSS).', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'record/{JobId}/{Sequence}{EscapedStartTime}{EscapedEndTime}'], 'SliceOssObjectPrefix' => ['description' => 'The name of the TS segment.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}'], 'CycleDuration' => ['description' => 'The duration of the recording cycle. Unit: seconds. If you do not specify this parameter, the default value 6 hours is used.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '7200', 'title' => ''], 'SliceDuration' => ['description' => 'The duration of a single segment. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], 'deprecated' => false, 'example' => '', ], 'deprecated' => false, 'example' => '', ], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'format' => 'iso8601', 'title' => '', 'example' => '2022-07-20T03:26:36Z'], 'LastModified' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'format' => 'iso8601', 'title' => '', 'example' => '2022-07-20T03:26:36Z'], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66'], 'Name' => ['description' => 'The template name.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'test template'], 'Type' => [ 'description' => 'The type of the template.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- system'."\n" ."\n" .'- custom', 'enumValueTitles' => ['system' => 'system', 'custom' => 'custom'], 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'custom', ], ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C892855F-95DF-50D6-A28C-279ABDB76810', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecordTemplate\\": {\\n \\"RecordFormatList\\": [\\n {\\n \\"Format\\": \\"m3u8\\",\\n \\"OssObjectPrefix\\": \\"record/{JobId}/{Sequence}{EscapedStartTime}{EscapedEndTime}\\",\\n \\"SliceOssObjectPrefix\\": \\"record/{JobId}/{UnixTimestamp}_{Sequence}\\",\\n \\"CycleDuration\\": 7200,\\n \\"SliceDuration\\": 30\\n }\\n ],\\n \\"CreateTime\\": \\"2022-07-20T03:26:36Z\\",\\n \\"LastModified\\": \\"2022-07-20T03:26:36Z\\",\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"Name\\": \\"test template\\",\\n \\"Type\\": \\"custom\\"\\n },\\n \\"RequestId\\": \\"C892855F-95DF-50D6-A28C-279ABDB76810\\"\\n}","type":"json"}]', 'title' => 'GetLiveRecordTemplate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRecordTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveRecordTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLiveSnapshotJob' => [ 'summary' => 'Queries the information a live stream snapshot job.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'Screenshot task 1', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => '****a046-263c-3560-978a-fb287666****'], 'TemplateName' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''], 'Status' => [ 'description' => 'The state of the job.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- init: The job is not started.'."\n" ."\n" .'- paused: The job is paused.'."\n" ."\n" .'- started: The job is in progress.', 'enumValueTitles' => ['init' => '', 'paused' => '', 'started' => ''], 'type' => 'string', 'title' => '', 'example' => 'started', ], 'StreamInput' => [ 'title' => '', 'description' => 'The input information.', 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'The URL of the input stream.', 'type' => 'string', 'title' => '', 'example' => 'rtmp://www.aliyun.com/stream'], 'Type' => [ 'description' => 'The type of the input stream. The value can only be rtmp.', 'enumValueTitles' => ['rtmp' => 'rtmp'], 'type' => 'string', 'title' => '', 'example' => 'rtmp', ], ], 'example' => '', ], 'SnapshotOutput' => [ 'title' => '', 'description' => 'The output information.', 'type' => 'object', 'properties' => [ 'StorageType' => [ 'description' => 'The storage type. The value can only be oss.', 'enumValueTitles' => ['oss' => 'oss'], 'type' => 'string', 'title' => '', 'example' => 'oss', ], 'Endpoint' => ['description' => 'The output endpoint. If the storage type is set to oss, the Object Storage Service (OSS) domain name is returned.', 'type' => 'string', 'title' => '', 'example' => 'oss-cn-shanghai.aliyuncs.com'], 'Bucket' => ['description' => 'The bucket of the output endpoint. If the storage type is set to oss, the OSS bucket is returned.', 'type' => 'string', 'title' => '', 'example' => 'testbucket'], ], 'example' => '', ], 'OverwriteFormat' => ['description' => 'The naming format of the snapshot captured in overwrite mode.', 'type' => 'string', 'title' => '', 'example' => 'snapshot/{JobId}.jpg'], 'SequenceFormat' => ['description' => 'The naming format of the snapshot captured in time series mode.', 'type' => 'string', 'title' => '', 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg'], 'TimeInterval' => ['description' => 'The interval between two adjacent snapshots.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'CallbackUrl' => ['description' => 'The snapshot callback URL.', 'type' => 'string', 'title' => '', 'example' => 'http://www.aliyun.com/snapshot/callback'], 'LastModified' => ['description' => 'The time when the file was last modified.', 'type' => 'string', 'title' => '', 'example' => '2022-02-02T22:22:22Z'], 'CreateTime' => ['description' => 'The time when the file was created.', 'type' => 'string', 'title' => '', 'example' => '2022-02-02T22:22:22Z'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], [ ['errorCode' => 'JobNotFound', 'errorMessage' => 'No such job.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"JobName\\": \\"Screenshot task 1\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"Status\\": \\"started\\",\\n \\"StreamInput\\": {\\n \\"Url\\": \\"rtmp://www.aliyun.com/stream\\",\\n \\"Type\\": \\"rtmp\\"\\n },\\n \\"SnapshotOutput\\": {\\n \\"StorageType\\": \\"oss\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"Bucket\\": \\"testbucket\\"\\n },\\n \\"OverwriteFormat\\": \\"snapshot/{JobId}.jpg\\",\\n \\"SequenceFormat\\": \\"snapshot/{JobId}/{UnixTimestamp}.jpg\\",\\n \\"TimeInterval\\": 5,\\n \\"CallbackUrl\\": \\"http://www.aliyun.com/snapshot/callback\\",\\n \\"LastModified\\": \\"2022-02-02T22:22:22Z\\",\\n \\"CreateTime\\": \\"2022-02-02T22:22:22Z\\"\\n}","type":"json"}]', 'title' => 'GetLiveSnapshotJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveSnapshotJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveSnapshotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLiveSnapshotTemplate' => [ 'summary' => 'Queries the information about a live stream snapshot template.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''], 'Type' => [ 'description' => 'The type of the template.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- system'."\n" ."\n" .'- custom', 'enumValueTitles' => ['system' => '', 'custom' => ''], 'type' => 'string', 'title' => '', 'example' => 'custom', ], 'OverwriteFormat' => ['description' => 'The naming format of the snapshot captured in overwrite mode.', 'type' => 'string', 'title' => '', 'example' => 'snapshot/{JobId}.jpg'], 'SequenceFormat' => ['description' => 'The naming format of the snapshot captured in time series mode.', 'type' => 'string', 'title' => '', 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg'], 'TimeInterval' => ['description' => 'The interval between two adjacent snapshots.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'LastModified' => ['description' => 'The time when the template was created.', 'type' => 'string', 'title' => '', 'example' => '2022-02-02T22:22:22Z'], 'CreateTime' => ['description' => 'The time when the configuration was modified.', 'type' => 'string', 'title' => '', 'example' => '2022-02-02T22:22:22Z'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], [ ['errorCode' => 'TemplateNotFound', 'errorMessage' => 'No such template.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"Type\\": \\"custom\\",\\n \\"OverwriteFormat\\": \\"snapshot/{JobId}.jpg\\",\\n \\"SequenceFormat\\": \\"snapshot/{JobId}/{UnixTimestamp}.jpg\\",\\n \\"TimeInterval\\": 5,\\n \\"LastModified\\": \\"2022-02-02T22:22:22Z\\",\\n \\"CreateTime\\": \\"2022-02-02T22:22:22Z\\"\\n}","type":"json"}]', 'title' => 'GetLiveSnapshotTemplate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveSnapshotTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveSnapshotTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLiveTranscodeJob' => [ 'summary' => 'Queries the information about a live stream transcoding job.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the transcoding job.', 'type' => 'string', 'required' => true, 'enum' => [], 'title' => '', 'example' => '****20b48fb04483915d4f2cd8ac****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'Job' => [ 'description' => 'The information about the transcoding job.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the transcoding job.', 'type' => 'string', 'example' => 'task1', 'title' => ''], 'JobId' => ['description' => 'The ID of the transcoding job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'TemplateType' => ['description' => 'The type of the template.', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'b6491d5b3e514b7d895d14b5453ea119', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'basic', 'title' => ''], 'StartMode' => ['description' => 'The start mode of the job.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Status' => ['description' => 'The state of the job.'."\n" ."\n" .'- 0: The job is not started.'."\n" ."\n" .'- 1: The job is in progress.'."\n" ."\n" .'- 2: The job is stopped.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'StreamInput' => [ 'description' => 'The information about the input stream.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input stream.', 'type' => 'string', 'example' => 'rtmp', 'title' => ''], 'InputUrl' => ['description' => 'The URL of the input stream.', 'type' => 'string', 'example' => 'rtmp://mydomain/app/stream1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'OutputStream' => [ 'description' => 'The information about the output stream.', 'type' => 'object', 'properties' => [ 'StreamInfos' => [ 'description' => 'The information about the output stream.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output stream protocol. Only the RTMP protocol is supported.', 'type' => 'string', 'example' => 'rtmp', 'title' => ''], 'OutputUrl' => ['description' => 'The URL of the output stream.', 'type' => 'string', 'example' => 'rtmp://mydomain/app/mytranscode1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-20T02:48:58Z', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Forbidden', 'errorMessage' => '%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Job\\": {\\n \\"Name\\": \\"task1\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateType\\": \\"normal\\",\\n \\"TemplateId\\": \\"b6491d5b3e514b7d895d14b5453ea119\\",\\n \\"TemplateName\\": \\"basic\\",\\n \\"StartMode\\": 0,\\n \\"Status\\": 1,\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"InputUrl\\": \\"rtmp://mydomain/app/stream1\\"\\n },\\n \\"OutputStream\\": {\\n \\"StreamInfos\\": [\\n {\\n \\"Type\\": \\"rtmp\\",\\n \\"OutputUrl\\": \\"rtmp://mydomain/app/mytranscode1\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n}","type":"json"}]', 'title' => 'GetLiveTranscodeJob', 'changeSet' => [ ['createdAt' => '2022-08-24T03:10:25.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveTranscodeJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveTranscodeJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetLiveTranscodeTemplate' => [ 'summary' => 'Queries the information a live stream transcoding template.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '****a046-263c-3560-978a-fb287666****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'TemplateContent' => [ 'description' => 'The content of the template.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => 'my-template', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'bcfa57950bc649b2abfb476ecd36ea4f', 'title' => ''], 'Type' => ['description' => 'The type of the template.', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Category' => ['description' => 'The category of the template. Valid values:'."\n" ."\n" .'- system'."\n" ."\n" .'- customized', 'type' => 'string', 'example' => 'customized', 'title' => ''], 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2022-07-25T06:15:14Z', 'title' => ''], 'TemplateConfig' => [ 'description' => 'The configuration of the template.', 'type' => 'object', 'properties' => [ 'VideoParams' => [ 'description' => 'The video parameters.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'The encoding type.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Height' => ['description' => 'The height of the output video.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Width' => ['description' => 'The width of the output video.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the output video.', 'type' => 'string', 'example' => '30', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the output video.', 'type' => 'string', 'example' => '2500', 'title' => ''], 'Gop' => ['description' => 'The group of pictures (GOP) of the output video.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Profile' => ['description' => 'The encoding profile.', 'type' => 'string', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AudioParams' => [ 'description' => 'The audio parameters.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'The audio codec.', 'type' => 'string', 'example' => 'AAC', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the output audio.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Samplerate' => ['description' => 'The audio sampling rate.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Profile' => ['description' => 'The audio codec profile.', 'type' => 'string', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParam', 'errorMessage' => '%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TemplateContent\\": {\\n \\"Name\\": \\"my-template\\",\\n \\"TemplateId\\": \\"bcfa57950bc649b2abfb476ecd36ea4f\\",\\n \\"Type\\": \\"normal\\",\\n \\"Category\\": \\"customized\\",\\n \\"CreateTime\\": \\"2022-07-25T06:15:14Z\\",\\n \\"TemplateConfig\\": {\\n \\"VideoParams\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"2500\\",\\n \\"Gop\\": \\"1000\\",\\n \\"Profile\\": \\"2\\"\\n },\\n \\"AudioParams\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Bitrate\\": \\"1000\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"Profile\\": \\"1\\"\\n }\\n }\\n }\\n}","type":"json"}]', 'title' => 'GetLiveTranscodeTemplate', 'changeSet' => [ ['createdAt' => '2022-08-23T11:40:01.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveTranscodeTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetLiveTranscodeTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaConnectAvailableRegion' => [ 'summary' => 'Retrieves all regions where MediaConnect is available.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '41CB9D4C-4650-5723-BA89-D6824F706ACB'], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Content' => [ 'description' => 'The rsponse body.', 'type' => 'object', 'properties' => [ 'RegionList' => [ 'description' => 'The supported regions.', 'type' => 'array', 'items' => ['description' => 'The region name.', 'type' => 'string', 'example' => '[\'cn-shanghai\', \'cn-qingdao\']', 'title' => ''], 'title' => '', 'example' => '', ], 'DefaultRegion' => ['description' => 'The default region. You can ignore the parameter.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41CB9D4C-4650-5723-BA89-D6824F706ACB\\",\\n \\"RetCode\\": 0,\\n \\"Description\\": \\"OK\\",\\n \\"Content\\": {\\n \\"RegionList\\": [\\n \\"[\'cn-shanghai\', \'cn-qingdao\']\\"\\n ],\\n \\"DefaultRegion\\": \\"cn-shanghai\\"\\n }\\n}","type":"json"}]', 'title' => 'GetMediaConnectAvailableRegion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:GetMediaConnectAvailableRegion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaConnectFlow' => [ 'summary' => 'Retrieves the details of a MediaConnect Flow instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MediaConnect Flow instance.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'The ID of the MediaConnect Flow instance.', 'type' => 'string', 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], 'FlowName' => ['description' => 'The name of the MediaConnect Flow instance.', 'type' => 'string', 'example' => 'AliTestFlow', 'title' => ''], 'FlowStatus' => ['description' => 'The status of the MediaConnect Flow instance.', 'type' => 'string', 'example' => 'online', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the MediaConnect Flow instance.', 'type' => 'string', 'example' => '2024-07-18T01:29:24Z', 'title' => ''], 'StartTime' => ['description' => 'The start time of the MediaConnect Flow instance.', 'type' => 'string', 'example' => '2024-07-18T01:39:24Z', 'title' => ''], 'FlowFailover' => ['description' => 'Indicates whether Input Failover is enabled for the flow. Valid values: `yes` and `no`.', 'type' => 'string', 'example' => 'yes', 'title' => ''], 'FlowRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The description of the API call.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Retcode' => ['description' => 'The return code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'FB503AEF-118E-1516-89E2-7B227EA1AC20', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"FlowId\\": \\"34900dc6-90ec-4968-af3c-fcd87f231a5f\\",\\n \\"FlowName\\": \\"AliTestFlow\\",\\n \\"FlowStatus\\": \\"online\\",\\n \\"CreateTime\\": \\"2024-07-18T01:29:24Z\\",\\n \\"StartTime\\": \\"2024-07-18T01:39:24Z\\",\\n \\"FlowFailover\\": \\"yes\\",\\n \\"FlowRegion\\": \\"\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"Retcode\\": 0,\\n \\"RequestId\\": \\"FB503AEF-118E-1516-89E2-7B227EA1AC20\\"\\n}","type":"json"}]', 'title' => 'Get MediaConnect Flow Instance Information', 'description' => '- This operation returns an error if the specified `FlowId` does not exist.'."\n" ."\n" .'- The `StartTime` in the response is valid only when the flow status is `online`.', 'changeSet' => [ ['createdAt' => '2025-08-07T03:33:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-04-24T06:29:31.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-01-23T06:18:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:GetMediaConnectFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetMediaConnectFlowAllOutputName' => [ 'summary' => 'Retrieves the names of all outputs for a MediaConnect flow.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => true, 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'Description' => ['title' => '', 'description' => 'The call description.', 'type' => 'string', 'example' => 'OK'], 'Content' => [ 'description' => 'The response body, as an array of strings.', 'type' => 'array', 'items' => ['description' => 'The name of an output.', 'type' => 'string', 'example' => '[\'output1\',\'output2\']', 'title' => ''], 'title' => '', 'example' => '', ], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '559E9828-245D-5CBA-9C7A-4E01453F091F', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"Content\\": [\\n \\"[\'output1\',\'output2\']\\"\\n ],\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"559E9828-245D-5CBA-9C7A-4E01453F091F\\"\\n}","type":"json"}]', 'title' => 'GetMediaConnectFlowAllOutputName', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:GetMediaConnectFlowAllOutputName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaConnectFlowInput' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Flow instance.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ 'name' => 'WithInternalVip', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response content.', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'InputName' => ['description' => 'The input name.', 'type' => 'string', 'example' => 'AliTestInput', 'title' => ''], 'InputProtocol' => [ 'description' => 'The input type.', 'enumValueTitles' => ['RTMP-PUSH' => 'RTMP-PUSH', 'SRT-Caller' => 'SRT-Caller', 'RTMP-PULL' => 'RTMP-PULL', 'SRT-Listener' => 'SRT-Listener', 'Flow' => 'Flow'], 'type' => 'string', 'example' => 'RTMP-PUSH', 'title' => '', ], 'MaxBitrate' => ['description' => 'The input bitrate, in bps.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000000', 'title' => ''], 'Cidrs' => ['description' => 'The IP address whitelist in CIDR format. Separate multiple IP address segments with commas.', 'type' => 'string', 'example' => '10.211.0.0/17', 'title' => ''], 'InputUrl' => ['description' => 'The input URL.', 'type' => 'string', 'example' => 'rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be', 'title' => ''], 'SrtLatency' => ['description' => 'The SRT latency in milliseconds (ms). This parameter is required only when the input type is SRT-Listener or SRT-Caller.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'SrtPassphrase' => ['description' => 'The SRT encryption key. This parameter is required only when the input type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'example' => 'FICUBPX4Q77DYHRF', 'title' => ''], 'SrtPbkeyLen' => [ 'description' => 'The SRT encryption key length. This parameter is required only when the input type is SRT-Listener or SRT-Caller.', 'enumValueTitles' => ['0', 16 => '16', 24 => '24', 32 => '32'], 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => '', ], 'PairOutputName' => ['description' => 'The output name of the peer Flow. This parameter is required only when the input type is Flow.', 'type' => 'string', 'example' => 'AliTestOutput', 'title' => ''], 'PairFlowId' => ['description' => 'The ID of the peer Flow instance. This parameter is required only if the output type is Flow.', 'type' => 'string', 'example' => '05c3adf4-aa0e-421d-a991-48ceae3e642e', 'title' => ''], 'CreateTime' => ['description' => 'The time when the input was created.', 'type' => 'string', 'example' => '2024-07-18T01:29:24Z', 'title' => ''], 'BackupInputName' => ['description' => 'The name of the backup input.', 'type' => 'string', 'title' => '', 'example' => ''], 'BackupCidrs' => ['description' => 'The IP address whitelist for the backup input.', 'type' => 'string', 'title' => '', 'example' => ''], 'BackupInputUrl' => ['description' => 'The URL of the backup input.', 'type' => 'string', 'title' => '', 'example' => ''], 'BackupSrtLatency' => ['description' => 'The SRT latency for the backup input.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'BackupSrtPassphrase' => ['description' => 'The SRT encryption key for the backup input.', 'type' => 'string', 'title' => '', 'example' => ''], 'BackupSrtPbkeyLen' => ['description' => 'The SRT encryption key length for the backup input.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'BackupCreateTime' => ['description' => 'The time when the backup input was created.', 'type' => 'string', 'title' => '', 'example' => ''], 'BackupMaxBitrate' => ['description' => 'The bitrate of the backup input.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'InputStatus' => ['description' => 'The input status. It indicates whether the primary stream is being pushed.', 'type' => 'string', 'title' => '', 'example' => ''], 'BackupInputStatus' => ['description' => 'The status of the backup input. It indicates whether the backup stream is being pushed.', 'type' => 'string', 'title' => '', 'example' => ''], 'InnerInputUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'BackupInnerInputUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The description of the API call.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The error code returned. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D4C231DF-103A-55FF-8D09-E699552457DE', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Get MediaConnect Flow Instance Input Information', 'summary' => 'Retrieves the input information of a MediaConnect instance.', 'description' => '- If the specified Flow instance ID does not exist, the API returns an error.', 'changeSet' => [ ['createdAt' => '2025-04-24T06:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:GetMediaConnectFlowInput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"InputName\\": \\"AliTestInput\\",\\n \\"InputProtocol\\": \\"RTMP-PUSH\\",\\n \\"MaxBitrate\\": 2000000,\\n \\"Cidrs\\": \\"10.211.0.0/17\\",\\n \\"InputUrl\\": \\"rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be\\",\\n \\"SrtLatency\\": 1000,\\n \\"SrtPassphrase\\": \\"FICUBPX4Q77DYHRF\\",\\n \\"SrtPbkeyLen\\": 32,\\n \\"PairOutputName\\": \\"AliTestOutput\\",\\n \\"PairFlowId\\": \\"05c3adf4-aa0e-421d-a991-48ceae3e642e\\",\\n \\"CreateTime\\": \\"2024-07-18T01:29:24Z\\",\\n \\"BackupInputName\\": \\"\\",\\n \\"BackupCidrs\\": \\"\\",\\n \\"BackupInputUrl\\": \\"\\",\\n \\"BackupSrtLatency\\": 0,\\n \\"BackupSrtPassphrase\\": \\"\\",\\n \\"BackupSrtPbkeyLen\\": 0,\\n \\"BackupCreateTime\\": \\"\\",\\n \\"BackupMaxBitrate\\": 0,\\n \\"InputStatus\\": \\"\\",\\n \\"BackupInputStatus\\": \\"\\",\\n \\"InnerInputUrl\\": \\"\\",\\n \\"BackupInnerInputUrl\\": \\"\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"D4C231DF-103A-55FF-8D09-E699552457DE\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetMediaConnectFlowOutput' => [ 'summary' => 'Retrieve detailed information of a specific output based on outputName', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', 'title' => ''], ], [ 'name' => 'OutputName', 'in' => 'query', 'schema' => ['description' => 'The name of the output that you want to query.', 'type' => 'string', 'required' => true, 'example' => 'AliTestOutput', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response content.', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'OutputName' => ['description' => 'The output name.', 'type' => 'string', 'example' => 'AliTestInput', 'title' => ''], 'OutputProtocol' => [ 'description' => 'The output type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- RTMP-PUSH'."\n" ."\n" .'- SRT-Caller'."\n" ."\n" .'- RTMP-PULL'."\n" ."\n" .'- SRT-Listener'."\n" ."\n" .'- Flow', 'enumValueTitles' => ['RTMP-PUSH' => 'RTMP-PUSH', 'SRT-Caller' => 'SRT-Caller', 'RTMP-PULL' => 'RTMP-PULL', 'SRT-Listener' => 'SRT-Listener', 'Flow' => 'Flow'], 'type' => 'string', 'example' => 'SRT-PULL', 'title' => '', ], 'Cidrs' => ['description' => 'The IP address whitelist in CIDR format. CIDR blocks are separated with commas (,).', 'type' => 'string', 'example' => '10.211.0.0/17', 'title' => ''], 'OutputUrl' => ['description' => 'The output URL.', 'type' => 'string', 'example' => 'srt://1.2.3.4:1025', 'title' => ''], 'SrtLatency' => ['description' => 'The latency for the SRT stream. Unit: milliseconds. This parameter is returned when the source type is SRT-Listener or SRT-Caller.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'SrtPassphrase' => ['description' => 'The SRT key. This parameter is returned when the source type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'example' => 'FICUBPX4Q77DYHRF', 'title' => ''], 'SrtPbkeyLen' => [ 'description' => 'The encryption key length. This parameter is returned when the source type is SRT-Listener or SRT-Caller.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- 0'."\n" ."\n" .'- 16'."\n" ."\n" .'- 24'."\n" ."\n" .'- 32', 'enumValueTitles' => ['0', 16 => '16', 24 => '24', 32 => '32'], 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => '', ], 'PairFlowId' => ['description' => 'The ID of the destination flow. This parameter is returned when the output type is Flow.', 'type' => 'string', 'example' => '805fbdd0-575e-4146-b35d-ec7f63937b20', 'title' => ''], 'PairInputName' => ['description' => 'The source name of the destination flow. This parameter is returned when the output type is Flow.', 'type' => 'string', 'example' => 'AliTestInput', 'title' => ''], 'PlayerLimit' => ['description' => 'The maximum number of viewers.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'CreateTime' => ['description' => 'The time when the flow was created.', 'type' => 'string', 'example' => '2024-07-18T01:29:24Z', 'title' => ''], 'Forbid' => ['description' => 'Indicates whether the output is disabled. Valid values: yes or no.', 'type' => 'string', 'example' => 'no', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0DB23DCE-0D69-598B-AA7C-7268D55E2F89', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"OutputName\\": \\"AliTestInput\\",\\n \\"OutputProtocol\\": \\"SRT-PULL\\",\\n \\"Cidrs\\": \\"10.211.0.0/17\\",\\n \\"OutputUrl\\": \\"srt://1.2.3.4:1025\\",\\n \\"SrtLatency\\": 1000,\\n \\"SrtPassphrase\\": \\"FICUBPX4Q77DYHRF\\",\\n \\"SrtPbkeyLen\\": 32,\\n \\"PairFlowId\\": \\"805fbdd0-575e-4146-b35d-ec7f63937b20\\",\\n \\"PairInputName\\": \\"AliTestInput\\",\\n \\"PlayerLimit\\": 5,\\n \\"CreateTime\\": \\"2024-07-18T01:29:24Z\\",\\n \\"Forbid\\": \\"no\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"0DB23DCE-0D69-598B-AA7C-7268D55E2F89\\"\\n}","type":"json"}]', 'title' => 'Get MediaConnect Flow Instance\'s Output Information', 'description' => '- When the provided Flow instance ID does not exist, the interface will return an error.', 'changeSet' => [ ['createdAt' => '2025-04-24T06:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:GetMediaConnectFlowOutput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaConvertJob' => [ 'summary' => 'MediaConvert task details', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceEO4QPO'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media transcoding job.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402'], 'Job' => [ 'title' => '', 'description' => 'The media transcoding job.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the job creation request.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'ClientToken' => ['description' => 'The idempotency parameter for the job creation request.', 'type' => 'string', 'title' => '', 'example' => '780018cb-55ba-466d-8acc-946c0c319a0e '], 'JobId' => ['description' => 'The job ID. This is a 32-character string.', 'type' => 'string', 'title' => '', 'example' => '******4579b5e748b99a27f6d6******'], 'Config' => [ 'title' => '', 'description' => 'The job configuration.', 'type' => 'object', 'properties' => [ 'Inputs' => [ 'title' => '', 'description' => 'The job inputs.', 'type' => 'array', 'items' => ['description' => 'A job input.', '$ref' => '#/components/schemas/MediaConvertInput', 'title' => '', 'example' => ''], 'example' => '', ], 'Outputs' => [ 'title' => '', 'description' => 'The job output configurations.', 'type' => 'array', 'items' => ['description' => 'A job output configuration.', '$ref' => '#/components/schemas/MediaConvertOutput', 'title' => '', 'example' => ''], 'example' => '', ], 'OutputGroups' => [ 'title' => '', 'description' => 'The job output group configurations.', 'type' => 'array', 'items' => ['description' => 'A job output group configuration.', '$ref' => '#/components/schemas/MediaConvertOutputGroup', 'title' => '', 'example' => ''], 'example' => '', ], 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job-1-20241205-102045', 'title' => ''], ], 'example' => '', ], 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'title' => '', 'example' => '83500cb2a3b94fabb0956e38d64bd16d'], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'title' => '', 'example' => '{"videoId":"ddd333"}'], 'Code' => ['description' => 'The error code if the job fails.', 'type' => 'string', 'title' => '', 'example' => 'InvalidParameter.ResourceContentBad'], 'Message' => ['description' => 'The error message detailing the failure.', 'type' => 'string', 'title' => '', 'example' => 'The resource operated InputFile is bad'], 'State' => ['description' => 'The job state. Valid values:'."\n" ."\n" .'- Inited: The job is initialized.'."\n" ."\n" .'- Running: The job is in progress.'."\n" ."\n" .'- Complete: The job finished successfully.'."\n" ."\n" .'- Error: The job failed.'."\n" ."\n" .'- Cancelled: The job was cancelled.', 'type' => 'string', 'title' => '', 'example' => 'Complete'], 'OutputDetails' => [ 'title' => '', 'description' => 'The execution results of the outputs specified in the job configuration.', 'type' => 'array', 'items' => ['description' => 'The details of an output.', '$ref' => '#/components/schemas/MediaConvertOutputDetail', 'title' => '', 'example' => ''], 'example' => '', ], 'OutputGroupDetails' => [ 'title' => '', 'description' => 'The execution results of the output groups specified in the job configuration.', 'type' => 'array', 'items' => ['description' => 'The details of an output group.', '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', 'title' => '', 'example' => ''], 'example' => '', ], 'Percent' => ['description' => 'The completion percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).', 'type' => 'string', 'example' => '2024-12-07T13:01:07Z'."\n", 'title' => ''], 'FinishTime' => ['description' => 'The time when the job finished, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).', 'type' => 'string', 'example' => '2024-12-07T13:01:07Z'."\n", 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402\\",\\n \\"Job\\": {\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"ClientToken\\": \\"780018cb-55ba-466d-8acc-946c0c319a0e \\",\\n \\"JobId\\": \\"******4579b5e748b99a27f6d6******\\",\\n \\"Config\\": {\\n \\"Inputs\\": [\\n {\\n \\"Name\\": \\"InputVideo\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://bucket.loction.aliyuncs.com/path/to/video.mp4\\"\\n }\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"output-video\\",\\n \\"OutputFile\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://bucket.loction.aliyuncs.com/path/to/video.mp4\\"\\n },\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"Priority\\": 6,\\n \\"Features\\": \\"{}\\",\\n \\"OverrideParams\\": \\"{}\\"\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"Name\\": \\"hls-group\\",\\n \\"GroupConfig\\": {\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Type\\": \\"Hls\\",\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://bucket.loction.aliyuncs.com/path/to/video.mp4\\"\\n }\\n },\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"group-output\\",\\n \\"OutputFileName\\": \\"720p.mp4\\",\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\\\n\\",\\n \\"Priority\\": 6,\\n \\"Features\\": \\"{}\\",\\n \\"OverrideParams\\": \\"{}\\"\\n }\\n ]\\n }\\n ],\\n \\"JobName\\": \\"job-1-20241205-102045\\"\\n },\\n \\"PipelineId\\": \\"83500cb2a3b94fabb0956e38d64bd16d\\",\\n \\"UserData\\": \\"{\\\\\\"videoId\\\\\\":\\\\\\"ddd333\\\\\\"}\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"State\\": \\"Complete\\",\\n \\"OutputDetails\\": [\\n {\\n \\"Name\\": \\"720P-mp4\\",\\n \\"TaskId\\": \\"******4215e042b3966ca5441e******\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\\\n\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\\\n\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\\\n\\",\\n \\"Url\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"9066406c306771f0bfa35107e0c90102\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"cn\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n }\\n },\\n \\"CreateTime\\": \\"2024-12-07T06:06:58Z\\",\\n \\"FinishTime\\": \\"2024-12-07T13:01:07Z\\"\\n }\\n ],\\n \\"OutputGroupDetails\\": [\\n {\\n \\"Name\\": \\"hls-group\\",\\n \\"TaskId\\": \\"******22dad741d086a50325f9******\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated \\\\\\"InputFile\\\\\\" is bad\\",\\n \\"Status\\": \\"Success\\",\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"720P-mp4\\",\\n \\"TaskId\\": \\"******4215e042b3966ca5441e******\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\\\n\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\\\n\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\\\n\\",\\n \\"Url\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"9066406c306771f0bfa35107e0c90102\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"cn\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n }\\n },\\n \\"CreateTime\\": \\"2024-12-07T06:06:58Z\\",\\n \\"FinishTime\\": \\"2024-12-07T13:01:07Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2025-03-21T01:48:41Z\\",\\n \\"FinishTime\\": \\"2025-03-21T01:48:41Z\\\\n\\"\\n }\\n ],\\n \\"Percent\\": 0,\\n \\"CreateTime\\": \\"2024-12-07T13:01:07Z\\\\n\\",\\n \\"FinishTime\\": \\"2024-12-07T13:01:07Z\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'Query an ApsaraVideo Media Processing job ', 'changeSet' => [ ['createdAt' => '2025-06-17T11:25:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetMediaConvertJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaInfo' => [ 'summary' => 'Retrieves media asset information using an Intelligent Media Services (IMS) `mediaId` or an `InputURL`.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '6890', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset in Intelligent Media Services (IMS). If you omit this parameter, you must specify `InputURL`.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'InputURL', 'in' => 'query', 'schema' => ['description' => 'The address of the media asset to query. You must first register the media asset in the IMS media library and bind it to a `mediaId`.'."\n" ."\n" .'- Object Storage Service (OSS) URL. Two formats are supported:'."\n" ."\n" .'`http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4`'."\n" ."\n" .'`oss://example-bucket/example.mp4`. When you use this format, the OSS region defaults to the service endpoint region.', 'type' => 'string', 'required' => false, 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', 'title' => ''], ], [ 'name' => 'OutputType', 'in' => 'query', 'schema' => ['description' => 'The type of URL to return for the media asset file.'."\n" ."\n" .'- `oss`: Returns the OSS URL. This is the default value.'."\n" ."\n" .'- `cdn`: Returns the Content Delivery Network (CDN) URL. A CDN URL is returned only if the media asset was imported from Video on Demand (VOD) and has a CDN domain name configured in VOD.', 'type' => 'string', 'required' => false, 'example' => 'cdn', 'title' => ''], ], [ 'name' => 'ReturnDetailedInfo', 'in' => 'query', 'schema' => ['description' => 'Whether to return detailed information for specific media asset fields. The only supported field is `AiRoughData.StandardSmartTagJob`, which specifies how the result of a tag analysis task is returned.'."\n" ."\n" .'- `false`: The task result is returned as a URL. This is the default value.'."\n" ."\n" .'- `true`: The task result is returned as a string.', 'type' => 'string', 'required' => false, 'example' => '{"AiRoughData.StandardSmartTagJob": false} ', 'title' => ''], ], [ 'name' => 'AuthTimeout', 'in' => 'query', 'schema' => ['description' => 'The validity period of the signed URL, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2FDE2411-DB8D-4A9A-875B-275798F14A5E'], 'MediaInfo' => [ 'description' => 'Information about the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'title' => '', 'example' => '****20b48fb04483915d4f2cd8ac****'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'Basic information about the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The media asset ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****'], 'InputURL' => ['description' => 'The media asset URL.', 'type' => 'string', 'title' => '', 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], 'MediaType' => ['description' => 'The media asset type.', 'type' => 'string', 'title' => '', 'example' => 'video'], 'BusinessType' => ['description' => 'The business type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'general'], 'Source' => ['description' => 'The source of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'The title of the media asset.', 'type' => 'string', 'example' => 'Title', 'title' => ''], 'Description' => ['description' => 'The description of the media asset.', 'type' => 'string', 'example' => 'Description', 'title' => ''], 'Category' => ['description' => 'The category of the media asset.', 'type' => 'string', 'example' => 'Category', 'title' => ''], 'MediaTags' => ['description' => 'A comma-separated list of tags for the media asset.', 'type' => 'string', 'example' => 'tag1', 'title' => ''], 'CoverURL' => ['description' => 'The cover image URL.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'UserData' => ['description' => 'Custom user data.', 'type' => 'string', 'title' => '', 'example' => 'userDataTest'], 'Snapshots' => ['description' => 'A list of snapshot URLs.', 'type' => 'string', 'title' => '', 'example' => '['."\n" .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",'."\n" .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=",'."\n" .'  "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token="'."\n" .']'], 'Status' => ['description' => 'The status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'CreateTime' => ['description' => 'The time when the media asset was created. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:08Z'], 'ModifiedTime' => ['description' => 'The time when the media asset was last modified. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:10Z'], 'DeletedTime' => ['description' => 'The time when the media asset was deleted. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:15Z'], 'SpriteImages' => ['description' => 'The details of the generated sprite images.', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3048', 'title' => ''], 'Biz' => ['description' => 'The business associated with the media asset.', 'type' => 'string', 'example' => 'ICE', 'title' => ''], 'UploadSource' => ['description' => 'The upload source of the media asset.', 'type' => 'string', 'example' => 'general', 'title' => ''], 'CateName' => ['description' => 'The name of the category.', 'type' => 'string', 'example' => 'cateName', 'title' => ''], 'ReferenceId' => ['description' => 'A custom, user-unique ID. It must be 6 to 64 characters long and can only contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'example' => '123-1234', 'title' => ''], ], 'example' => '', ], 'FileInfoList' => [ 'title' => '', 'description' => 'A list of file information objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'The basic information about the file, such as the duration and size.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'title' => '', 'example' => 'example.mp4'], 'FileStatus' => ['description' => 'The status of the file.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'The type of the file.', 'type' => 'string', 'title' => '', 'example' => 'source_file'], 'FileSize' => ['description' => 'The file size in bytes.', 'type' => 'string', 'title' => '', 'example' => '30611502'], 'FileUrl' => ['description' => 'The file\'s OSS URL.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['description' => 'The Region where the file is stored.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'FormatName' => ['description' => 'The container format.', 'type' => 'string', 'title' => '', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2'], 'Duration' => ['description' => 'The file duration in seconds.', 'type' => 'string', 'title' => '', 'example' => '216.206667'], 'Bitrate' => ['description' => 'The file bitrate in kbit/s.', 'type' => 'string', 'title' => '', 'example' => '1132.68'], 'Width' => ['description' => 'The video width in pixels.', 'type' => 'string', 'title' => '', 'example' => '960'], 'Height' => ['description' => 'The video height in pixels.', 'type' => 'string', 'title' => '', 'example' => '540'], 'CreateTime' => ['description' => 'The time when the file was created. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.', 'type' => 'string', 'example' => '2020-12-26T04:11:08Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the file was last modified. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], ], 'example' => '', ], 'AudioStreamInfoList' => [ 'title' => '', 'description' => 'A list of audio stream information. A media asset may contain multiple audio streams.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The index of the audio stream.', 'type' => 'string', 'title' => '', 'example' => '1'], 'CodecName' => ['description' => 'The short name of the codec.', 'type' => 'string', 'title' => '', 'example' => 'aac'], 'CodecLongName' => ['description' => 'The full name of the codec.', 'type' => 'string', 'title' => '', 'example' => 'AAC (Advanced Audio Coding)'], 'CodecTimeBase' => ['description' => 'The time base of the codec.', 'type' => 'string', 'title' => '', 'example' => '1/24000'], 'CodecTagString' => ['description' => 'The tag string of the codec.', 'type' => 'string', 'title' => '', 'example' => 'mp4a'], 'CodecTag' => ['description' => 'The tag of the codec.', 'type' => 'string', 'title' => '', 'example' => '0x6134706d'], 'Profile' => ['description' => 'The encoding profile.', 'type' => 'string', 'title' => '', 'example' => 'High'], 'SampleFmt' => ['description' => 'The sample format.', 'type' => 'string', 'title' => '', 'example' => 'fltp'], 'SampleRate' => ['description' => 'The sample rate, in Hz.', 'type' => 'string', 'title' => '', 'example' => '44100'], 'Channels' => ['description' => 'The number of audio channels.', 'type' => 'string', 'title' => '', 'example' => '2'], 'ChannelLayout' => ['description' => 'The channel layout.', 'type' => 'string', 'title' => '', 'example' => 'stereo'], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'title' => '', 'example' => '1/44100'], 'StartTime' => ['description' => 'The start time, in seconds.', 'type' => 'string', 'title' => '', 'example' => '0.000000'], 'Duration' => ['description' => 'The duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '16.200998'], 'Bitrate' => ['description' => 'The bitrate, in kbit/s.', 'type' => 'string', 'title' => '', 'example' => '127.794'], 'Fps' => ['description' => 'The audio frame rate.', 'type' => 'string', 'title' => '', 'example' => '8'], 'NumFrames' => ['description' => 'The total number of audio frames.', 'type' => 'string', 'title' => '', 'example' => '10'], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'title' => '', 'example' => 'und'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoStreamInfoList' => [ 'title' => '', 'description' => 'A list of video stream information. A media asset may contain multiple video streams.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The index of the video stream.', 'type' => 'string', 'title' => '', 'example' => '0'], 'CodecName' => ['description' => 'The short name of the codec.', 'type' => 'string', 'title' => '', 'example' => 'h264'], 'CodecLongName' => ['description' => 'The full name of the codec.', 'type' => 'string', 'title' => '', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10'], 'Profile' => ['description' => 'The encoding profile.', 'type' => 'string', 'title' => '', 'example' => 'High'], 'CodecTimeBase' => ['description' => 'The time base of the codec.', 'type' => 'string', 'title' => '', 'example' => '1/48'], 'CodecTagString' => ['description' => 'The tag string of the codec.', 'type' => 'string', 'title' => '', 'example' => '[0][0][0][0]'], 'CodecTag' => ['description' => 'The tag of the codec.', 'type' => 'string', 'title' => '', 'example' => '0x0000'], 'Width' => ['description' => 'The video width in pixels.', 'type' => 'string', 'title' => '', 'example' => '960'], 'Height' => ['description' => 'The video height in pixels.', 'type' => 'string', 'title' => '', 'example' => '540'], 'HasBFrames' => ['description' => 'Specifies whether B-frames exist.', 'type' => 'string', 'title' => '', 'example' => '2'], 'Sar' => ['description' => 'The sample aspect ratio (SAR).', 'type' => 'string', 'title' => '', 'example' => '0:1'], 'Dar' => ['description' => 'The display aspect ratio (DAR).', 'type' => 'string', 'title' => '', 'example' => '0:1'], 'PixFmt' => ['description' => 'The pixel format.', 'type' => 'string', 'title' => '', 'example' => 'yuv420p'], 'Level' => ['description' => 'The encoding level.', 'type' => 'string', 'title' => '', 'example' => '30'], 'Fps' => ['description' => 'The video frame rate.', 'type' => 'string', 'title' => '', 'example' => '24.0'], 'AvgFPS' => ['description' => 'The average frame rate.', 'type' => 'string', 'title' => '', 'example' => '24.0'], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'title' => '', 'example' => '1/12288'], 'StartTime' => ['description' => 'The start time, in seconds.', 'type' => 'string', 'title' => '', 'example' => '0.081706'], 'Duration' => ['description' => 'The duration, in seconds.', 'type' => 'string', 'title' => '', 'example' => '216.206706'], 'Bitrate' => ['description' => 'The bitrate, in kbit/s.', 'type' => 'string', 'title' => '', 'example' => '1001.594'], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'title' => '', 'example' => '5184'], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'title' => '', 'example' => 'und'], 'Rotate' => ['description' => 'The rotation angle of the video.', 'type' => 'string', 'title' => '', 'example' => '0'], 'Nb_frames' => ['description' => 'The total number of video frames.', 'type' => 'string', 'title' => '', 'example' => '5184'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'SubtitleStreamInfoList' => [ 'title' => '', 'description' => 'A list of subtitle stream information. A media asset may contain multiple subtitle streams.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The index of the subtitle stream.', 'type' => 'string', 'title' => '', 'example' => '1'], 'CodecName' => ['description' => 'The short name of the codec.', 'type' => 'string', 'title' => '', 'example' => 'srt'], 'CodecLongName' => ['description' => 'The full name of the codec.', 'type' => 'string', 'title' => '', 'example' => 'SubRip Text'], 'CodecTimeBase' => ['description' => 'The time base of the codec.', 'type' => 'string', 'title' => '', 'example' => '29.97'], 'CodecTagString' => ['description' => 'The tag string of the codec.', 'type' => 'string', 'title' => '', 'example' => 'unicode'], 'CodecTag' => ['description' => 'The tag of the codec.', 'type' => 'string', 'title' => '', 'example' => 'unicode'], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'title' => '', 'example' => '30'], 'StartTime' => ['description' => 'The start time, in seconds.', 'type' => 'string', 'title' => '', 'example' => '0'], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'title' => '', 'example' => '1'], 'Lang' => ['description' => 'The language.', 'type' => 'string', 'title' => '', 'example' => 'und'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'AiRoughData' => [ 'description' => 'The raw data from the AI analysis.', 'type' => 'object', 'properties' => [ 'Result' => ['description' => 'The raw AI analysis result.', 'type' => 'string', 'example' => 'https://sample-bucket.cn-shanghai.aliyuncs.com/result.json', 'title' => ''], 'Status' => ['description' => 'The status of the AI analysis:'."\n" ."\n" .'- Analyzing: The analysis is in progress.'."\n" ."\n" .'- AnalyzeSuccess: The analysis is successful.'."\n" ."\n" .'- AnalyzeFailed: The analysis failed.'."\n" ."\n" .'- Saving: The data is being saved.'."\n" ."\n" .'- SaveSuccess: The data is saved.'."\n" ."\n" .'- SaveFailed: The data failed to save.'."\n" ."\n" .'- Deleting: The data is being deleted.'."\n" ."\n" .'- DeleteSuccess: The data is deleted.'."\n" ."\n" .'- DeleteFailed: The data failed to delete.', 'type' => 'string', 'example' => 'Analyzing', 'title' => ''], 'SaveType' => ['description' => 'The save type. Specifies whether to save the results to the search index after the AI analysis is complete. Valid values:'."\n" ."\n" .'- TEXT: The text index.', 'type' => 'string', 'example' => 'TEXT', 'title' => ''], 'AiCategory' => ['description' => 'The AI category. Valid values:'."\n" ."\n" .'- Lifestyle'."\n" ."\n" .'- Appearance'."\n" ."\n" .'- Pets'."\n" ."\n" .'- News'."\n" ."\n" .'- Advertisement'."\n" ."\n" .'- Environment'."\n" ."\n" .'- Automobile', 'type' => 'string', 'example' => '生活', 'title' => ''], 'AiJobId' => ['description' => 'The AI job ID.', 'type' => 'string', 'example' => '****483915d4f2cd8ac20b48fb04****', 'title' => ''], 'StandardSmartTagJob' => [ 'description' => 'The tag job.', 'type' => 'object', 'properties' => [ 'AiJobId' => ['description' => 'The AI job ID.', 'type' => 'string', 'example' => '****483915d4f2cd8ac20b48fb04****', 'title' => ''], 'Status' => ['description' => 'The AI analysis status:'."\n" ."\n" .'- **Analyzing**: The analysis is in progress.'."\n" ."\n" .'- **AnalyzeSuccess**: The analysis is successful.'."\n" ."\n" .'- **AnalyzeFailed**: The analysis failed.', 'type' => 'string', 'example' => 'Analyzing', 'title' => ''], 'ResultUrl' => ['description' => 'The tag result URL.', 'type' => 'string', 'example' => 'http://xx.oss-cn-shanghai.aliyuncs.com/result2.txt', 'title' => ''], 'Results' => [ 'description' => 'A list of tag recognition results.', 'type' => 'array', 'items' => [ 'description' => 'Tag recognition result', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The detailed analysis result is a JSON string. For the data structure of each Type, see [Result parameter description](~~478787#api-detail-40~~).', 'type' => 'string', 'example' => '{"autoChapters": [...]}', 'title' => ''], 'Type' => ['description' => 'The tag identification type. Valid values:'."\n" ."\n" .'- NLP: The result from Natural Language Processing (NLP).'."\n" ."\n" .'- TextLabel: A text tag.'."\n" ."\n" .'- VideoLabel: A video tag.'."\n" ."\n" .'- ASR: The raw result from Automatic Speech Recognition (ASR).'."\n" ."\n" .'- OCR: The raw result from Optical Character Recognition (OCR).', 'type' => 'string', 'example' => 'NLP', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FDE2411-DB8D-4A9A-875B-275798F14A5E\\",\\n \\"MediaInfo\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"Title\\",\\n \\"Description\\": \\"Description\\",\\n \\"Category\\": \\"Category\\",\\n \\"MediaTags\\": \\"tag1\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"UserData\\": \\"userDataTest\\",\\n \\"Snapshots\\": \\"[\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\\\\\",\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=\\\\\\",\\\\n  \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=\\\\\\"\\\\n]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:15Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"CateId\\": 3048,\\n \\"Biz\\": \\"ICE\\",\\n \\"UploadSource\\": \\"general\\",\\n \\"CateName\\": \\"cateName\\",\\n \\"ReferenceId\\": \\"123-1234\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"216.206667\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/24000\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"Profile\\": \\"High\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/44100\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Duration\\": \\"16.200998\\",\\n \\"Bitrate\\": \\"127.794\\",\\n \\"Fps\\": \\"8\\",\\n \\"NumFrames\\": \\"10\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1/48\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Sar\\": \\"0:1\\",\\n \\"Dar\\": \\"0:1\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"30\\",\\n \\"Fps\\": \\"24.0\\",\\n \\"AvgFPS\\": \\"24.0\\",\\n \\"Timebase\\": \\"1/12288\\",\\n \\"StartTime\\": \\"0.081706\\",\\n \\"Duration\\": \\"216.206706\\",\\n \\"Bitrate\\": \\"1001.594\\",\\n \\"NumFrames\\": \\"5184\\",\\n \\"Lang\\": \\"und\\",\\n \\"Rotate\\": \\"0\\",\\n \\"Nb_frames\\": \\"5184\\"\\n }\\n ],\\n \\"SubtitleStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"srt\\",\\n \\"CodecLongName\\": \\"SubRip Text\\",\\n \\"CodecTimeBase\\": \\"29.97\\",\\n \\"CodecTagString\\": \\"unicode\\",\\n \\"CodecTag\\": \\"unicode\\",\\n \\"Timebase\\": \\"30\\",\\n \\"StartTime\\": \\"0\\",\\n \\"Duration\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n ],\\n \\"AiRoughData\\": {\\n \\"Result\\": \\"https://sample-bucket.cn-shanghai.aliyuncs.com/result.json\\",\\n \\"Status\\": \\"Analyzing\\",\\n \\"SaveType\\": \\"TEXT\\",\\n \\"AiCategory\\": \\"生活\\",\\n \\"AiJobId\\": \\"****483915d4f2cd8ac20b48fb04****\\",\\n \\"StandardSmartTagJob\\": {\\n \\"AiJobId\\": \\"****483915d4f2cd8ac20b48fb04****\\",\\n \\"Status\\": \\"Analyzing\\",\\n \\"ResultUrl\\": \\"http://xx.oss-cn-shanghai.aliyuncs.com/result2.txt\\",\\n \\"Results\\": [\\n {\\n \\"Data\\": \\"{\\\\\\"autoChapters\\\\\\": [...]}\\",\\n \\"Type\\": \\"NLP\\"\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', 'title' => 'GetMediaInfo', 'description' => '`MediaId` takes precedence. If `MediaId` is empty, `InputURL` must not be null.', 'changeSet' => [ ['createdAt' => '2025-07-02T09:50:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-06-04T02:24:35.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-04-24T02:22:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-12-02T09:41:09.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-29T09:16:10.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-15T06:33:31.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-01T03:57:51.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-14T07:52:52.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-25T06:45:51.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-05-25T03:33:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-03-31T06:11:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaInfo'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetMediaInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetMediaInfoJob' => [ 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82dfa8e8', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], 'MediaInfoJob' => [ 'title' => '', 'description' => 'MediaInfoJobDTO', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job-name', 'title' => ''], 'TriggerSource' => ['description' => 'The source of the job. Valid values: API, WorkFlow, and Console.', 'type' => 'string', 'example' => 'API', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82dfa8e8', 'title' => ''], 'Input' => [ 'title' => '', 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" .'- OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media object. If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported. If Type is set to Media, the ID of a media asset is returned.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], 'Async' => ['description' => 'Indicates whether asynchronous processing was performed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => 'user-data', 'title' => ''], 'ScheduleConfig' => [ 'title' => '', 'description' => 'The scheduling information.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => ''], 'Priority' => ['description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'example' => '', ], 'Status' => ['description' => 'The state of the job. Valid values: Init (the job is submitted), Success (the job is successful), and Fail (the job failed).', 'type' => 'string', 'example' => 'Init', 'title' => ''], 'SubmitResultJson' => ['description' => 'The job submission information.', 'type' => 'object', 'title' => '', 'example' => ''], 'MediaInfoProperty' => [ 'title' => '', 'description' => 'The details of the media information.', 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'The basic file information.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'e520090207114cc7a392d44f0b211574'], 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'file.m3u8', 'title' => ''], 'FileStatus' => ['description' => 'The state of the file.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'example' => 'source_file', 'title' => ''], 'FileSize' => ['description' => 'The file size.', 'type' => 'string', 'example' => '31737', 'title' => ''], 'FileUrl' => ['description' => 'The URL of the file.', 'type' => 'string', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', 'title' => ''], 'Region' => ['description' => 'The region in which the file resides.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'FormatName' => ['description' => 'The name of the video format.', 'type' => 'string', 'example' => 'hls,applehttp', 'title' => ''], 'Duration' => ['description' => 'The duration of the video. Unit: seconds.', 'type' => 'string', 'example' => '403.039999', 'title' => ''], 'Bitrate' => ['description' => 'The video bitrate.', 'type' => 'string', 'example' => '888.563', 'title' => ''], 'Width' => ['description' => 'The width of the output video.', 'type' => 'string', 'example' => '848', 'title' => ''], 'Height' => ['description' => 'The height of the output video.', 'type' => 'string', 'example' => '478', 'title' => ''], ], 'example' => '', ], 'AudioStreamInfoList' => [ 'title' => '', 'description' => 'The information about the audio stream.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The sequence number of the stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CodecName' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'CodecLongName' => ['description' => 'The name of the encoding format.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'CodecTimeBase' => ['description' => 'The time base of the encoder.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'CodecTagString' => ['description' => 'The name of the encoder tag.', 'type' => 'string', 'example' => '[15][0][0][0]', 'title' => ''], 'CodecTag' => ['description' => 'The encoder tag.', 'type' => 'string', 'example' => '0x000f', 'title' => ''], 'SampleFmt' => ['description' => 'The sample format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'SampleRate' => ['description' => 'The sampling rate. Unit: Hz.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'ChannelLayout' => ['description' => 'The sound channel layout.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], 'StartTime' => ['description' => 'The start time of the stream.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], 'Duration' => ['description' => 'The duration of the stream. Unit: seconds.', 'type' => 'string', 'example' => '403.039989', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '0.f', 'title' => ''], 'Lang' => ['description' => 'The language of the stream.', 'type' => 'string', 'example' => 'us', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoStreamInfoList' => [ 'title' => '', 'description' => 'The information about the video stream.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The sequence number of the stream.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Codec_name' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => 'h264', 'title' => ''], 'Codec_long_name' => ['description' => 'The name of the encoding format.', 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'title' => ''], 'Profile' => ['description' => 'The encoder profile.', 'type' => 'string', 'example' => 'High', 'title' => ''], 'Codec_time_base' => ['description' => 'The time base of the encoder.', 'type' => 'string', 'example' => '1/50', 'title' => ''], 'Codec_tag_string' => ['description' => 'The tag string of the encoding format.', 'type' => 'string', 'example' => '[27][0][0][0]', 'title' => ''], 'Codec_tag' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => '0x001b', 'title' => ''], 'Width' => ['description' => 'The width of the output video.', 'type' => 'string', 'example' => '848', 'title' => ''], 'Height' => ['description' => 'The height of the output video.', 'type' => 'string', 'example' => '478', 'title' => ''], 'Has_b_frames' => ['description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). Valid values:'."\n" ."\n" .'- 0: The stream contains no B-frames.'."\n" ."\n" .'- 1: The stream contains one B-frame.'."\n" ."\n" .'- 2: The stream contains multiple consecutive B-frames.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Sar' => ['description' => 'The aspect ratio of the area from which the sampling points are collected.', 'type' => 'string', 'example' => '478:477', 'title' => ''], 'Dar' => ['description' => 'The display aspect ratio.', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'PixFmt' => ['description' => 'The pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Level' => ['description' => 'The codec level.', 'type' => 'string', 'example' => '31', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Avg_fps' => ['description' => 'The average frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Time_base' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], 'Start_time' => ['description' => 'The start time of the stream.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], 'Duration' => ['description' => 'The duration of the file.', 'type' => 'string', 'example' => '403.039989', 'title' => ''], 'Bit_rate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '888.563', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '10040', 'title' => ''], 'Lang' => ['description' => 'The language of the stream.', 'type' => 'string', 'example' => 'zh', 'title' => ''], 'Rotate' => ['description' => 'The rotation angle of the video image.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'SubmitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', 'title' => ''], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"MediaInfoJob\\": {\\n \\"Name\\": \\"job-name\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82dfa8e8\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"Async\\": true,\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"SubmitResultJson\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"e520090207114cc7a392d44f0b211574\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"us\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"zh\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168\\"\\n }\\n}","type":"json"}]', 'title' => 'GetMediaInfoJob', 'summary' => 'Queries the information about a media information analysis job.', 'changeSet' => [ ['createdAt' => '2022-07-20T06:51:54.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-19T09:22:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-19T08:08:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaInfoJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetMediaInfoJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaLiveChannel' => [ 'summary' => 'Queries a MediaLive channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'ChannelId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Channel' => [ 'title' => '', 'description' => 'The channel information.', 'type' => 'object', 'properties' => [ 'ChannelId' => ['description' => 'The ID of the channel.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], 'Name' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'mych'], 'State' => ['description' => 'The state of the channel. Valid values: IDLE, STARTING, RUNNING, RECOVERING, and STOPPING.', 'type' => 'string', 'title' => '', 'example' => 'IDLE'], 'InputAttachments' => [ 'title' => '', 'description' => 'The inputs associated with the channel.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InputId' => ['description' => 'The ID of the associated input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], 'InputName' => ['description' => 'The name of the input.', 'type' => 'string', 'title' => '', 'example' => 'myinput'], 'LanguageName' => ['description' => 'The language name.', 'type' => 'string', 'title' => '', 'example' => 'eng'], 'AudioSelectors' => [ 'title' => '', 'description' => 'The audio selectors.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the audio selector.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myselector'], 'AudioLanguageSelection' => [ 'title' => '', 'description' => 'The audio language selection.', 'type' => 'object', 'properties' => [ 'LanguageCode' => ['description' => 'A three-letter ISO 639-2 language code from within an audio source.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eng'], ], 'example' => '', ], 'AudioPidSelection' => [ 'title' => '', 'description' => 'The audio PID selection.', 'type' => 'object', 'properties' => [ 'Pid' => ['title' => '', 'description' => 'A PID from within a source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], 'example' => '', ], 'AudioTrackSelection' => [ 'title' => '', 'description' => 'The audio track selection.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TrackId' => ['description' => 'The track ID from within a source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'OutputGroups' => [ 'title' => '', 'description' => 'The output groups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the output group.', 'type' => 'string', 'title' => '', 'example' => 'group1'], 'Type' => ['description' => 'The output group type.', 'type' => 'string', 'title' => '', 'example' => 'MediaPackage'], 'Outputs' => [ 'title' => '', 'description' => 'The outputs in the output group.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the output.', 'type' => 'string', 'title' => '', 'example' => 'output1'], 'MediaType' => ['description' => 'The media type of the output.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], 'MediaPackageOutputSetting' => [ 'title' => '', 'description' => 'The settings of the output delivered to MediaPackage.', 'type' => 'object', 'properties' => [ 'NameModifier' => ['description' => 'The manifest name modifier. The child manifests include this modifier in their M3U8 file names.', 'type' => 'string', 'title' => '', 'example' => '480p'], 'AudioGroupId' => ['description' => 'The manifest audio group ID.', 'type' => 'string', 'title' => '', 'example' => 'audiogroup'], ], 'example' => '', ], 'VideoSettingName' => ['description' => 'The name of the referenced VideoSettings.', 'type' => 'string', 'title' => '', 'example' => 'myVideo1'], 'AudioSettingNames' => [ 'title' => '', 'description' => 'The referenced AudioSettings.', 'type' => 'array', 'items' => ['description' => 'The name of the referenced AudioSettings.', 'type' => 'string', 'example' => 'myAudio1', 'title' => ''], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'MediaPackageGroupSetting' => [ 'title' => '', 'description' => 'The MediaPackage destination.', 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => 'GroupName in MediaPackage.', 'type' => 'string', 'title' => '', 'example' => 'myPackageGroup'], 'ChannelName' => ['description' => 'ChannelName in MediaPackage.', 'type' => 'string', 'title' => '', 'example' => 'myPackageChannel'], ], 'example' => '', ], 'MonitorUrl' => ['description' => 'The URL for monitoring the output group. The parameter is returned only when the output gourp type is MediaPackage.', 'type' => 'string', 'title' => '', 'example' => 'rtmp://xxx'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'AudioSettings' => [ 'title' => '', 'description' => 'The audio settings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the audio settings.', 'type' => 'string', 'title' => '', 'example' => 'zhuanfengzhuang'], 'AudioSelectorName' => ['description' => 'The name of the audio selector.', 'type' => 'string', 'title' => '', 'example' => 'myselector'], 'LanguageCode' => ['description' => 'A three-letter ISO 639-2 language code.', 'type' => 'string', 'title' => '', 'example' => 'eng'], 'LanguageName' => ['description' => 'The name of the language.', 'type' => 'string', 'title' => '', 'example' => 'English'], 'AudioCodec' => ['description' => 'The audio codec.', 'type' => 'string', 'title' => '', 'example' => 'aac'], 'AudioCodecSetting' => [ 'title' => '', 'description' => 'The audio encoding settings.', 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The audio codec profile.', 'type' => 'string', 'title' => '', 'example' => 'AAC-LOW'], 'Bitrate' => ['description' => 'The audio bitrate. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200000'], 'SampleRate' => ['description' => 'The audio sample rate. Unit: Hz.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '44100'], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoSettings' => [ 'title' => '', 'description' => 'The video settings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the video settings.', 'type' => 'string', 'title' => '', 'example' => 'video1'], 'Width' => ['description' => 'The width of the video in pixels.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1280'], 'Height' => ['description' => 'The height of the video in pixels.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '720'], 'VideoCodec' => ['description' => 'The video codec.', 'type' => 'string', 'title' => '', 'example' => 'H264'], 'VideoCodecSetting' => [ 'title' => '', 'description' => 'The video encoding settings.', 'type' => 'object', 'properties' => [ 'Rate' => [ 'title' => '', 'description' => 'The video encoding rate.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'The video bitrate. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2500000'], 'RateControlMode' => ['description' => 'The bitrate control mode.', 'type' => 'string', 'title' => '', 'example' => 'ABR'], 'MaxBitrate' => ['description' => 'The maximum bitrate. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '6000000'], 'BufferSize' => ['description' => 'The video buffer size. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '6000000'], ], 'example' => '', ], 'Framerate' => [ 'title' => '', 'description' => 'The frame rate.', 'type' => 'object', 'properties' => [ 'FramerateControl' => ['description' => 'The frame rate mode.', 'type' => 'string', 'title' => '', 'example' => 'SPECIFIED'], 'FramerateNumerator' => ['description' => 'The numerator of the fixed frame rate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '25'], 'FramerateDenominator' => ['description' => 'The denominator of the fixed frame rate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'example' => '', ], 'Gop' => [ 'title' => '', 'description' => 'The GOP setting.', 'type' => 'object', 'properties' => [ 'GopSizeUnits' => ['description' => 'The GOP size unit.', 'type' => 'string', 'title' => '', 'example' => 'FRAMES'], 'GopSize' => ['description' => 'The GOP size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '90'], 'BframesNum' => ['description' => 'The number of B frames.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], ], 'example' => '', ], 'CodecDetail' => [ 'title' => '', 'description' => 'The video encoding settings.', 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The H.264 profile.', 'type' => 'string', 'title' => '', 'example' => 'MAIN'], 'Level' => ['description' => 'The video encoding level. It is not supported yet.', 'type' => 'string', 'title' => '', 'example' => 'H264_LEVEL_AUTO'], ], 'example' => '', ], ], 'example' => '', ], 'VideoCodecType' => ['description' => 'The video transcoding method. Valid values: NORMAL (regular transcoding) and NBHD (Narrowband HD™ transcoding).', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'The time when the channel was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2024-12-03T06:56:42Z'], 'LastStartTime' => ['description' => 'The time when the channel was last started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. If the channel has never been started since it was created, an empty string is returned.', 'type' => 'string', 'title' => '', 'example' => '2024-12-03T06:56:42Z'], 'LastStopTime' => ['description' => 'The time when the channel was last stopped. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. If the channel has never stopped since it was created, an empty string is returned.', 'type' => 'string', 'title' => '', 'example' => '2024-12-03T06:56:42Z'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Channel\\": {\\n \\"ChannelId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mych\\",\\n \\"State\\": \\"IDLE\\",\\n \\"InputAttachments\\": [\\n {\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"InputName\\": \\"myinput\\",\\n \\"LanguageName\\": \\"eng\\",\\n \\"AudioSelectors\\": [\\n {\\n \\"Name\\": \\"myselector\\",\\n \\"AudioLanguageSelection\\": {\\n \\"LanguageCode\\": \\"eng\\"\\n },\\n \\"AudioPidSelection\\": {\\n \\"Pid\\": 123\\n },\\n \\"AudioTrackSelection\\": [\\n {\\n \\"TrackId\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"Name\\": \\"group1\\",\\n \\"Type\\": \\"MediaPackage\\",\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"output1\\",\\n \\"MediaType\\": 0,\\n \\"MediaPackageOutputSetting\\": {\\n \\"NameModifier\\": \\"480p\\",\\n \\"AudioGroupId\\": \\"audiogroup\\"\\n },\\n \\"VideoSettingName\\": \\"myVideo1\\",\\n \\"AudioSettingNames\\": [\\n \\"myAudio1\\"\\n ]\\n }\\n ],\\n \\"MediaPackageGroupSetting\\": {\\n \\"GroupName\\": \\"myPackageGroup\\",\\n \\"ChannelName\\": \\"myPackageChannel\\"\\n },\\n \\"MonitorUrl\\": \\"rtmp://xxx\\"\\n }\\n ],\\n \\"AudioSettings\\": [\\n {\\n \\"Name\\": \\"zhuanfengzhuang\\",\\n \\"AudioSelectorName\\": \\"myselector\\",\\n \\"LanguageCode\\": \\"eng\\",\\n \\"LanguageName\\": \\"English\\",\\n \\"AudioCodec\\": \\"aac\\",\\n \\"AudioCodecSetting\\": {\\n \\"Profile\\": \\"AAC-LOW\\",\\n \\"Bitrate\\": 200000,\\n \\"SampleRate\\": 44100\\n }\\n }\\n ],\\n \\"VideoSettings\\": [\\n {\\n \\"Name\\": \\"video1\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"H264\\",\\n \\"VideoCodecSetting\\": {\\n \\"Rate\\": {\\n \\"Bitrate\\": 2500000,\\n \\"RateControlMode\\": \\"ABR\\",\\n \\"MaxBitrate\\": 6000000,\\n \\"BufferSize\\": 6000000\\n },\\n \\"Framerate\\": {\\n \\"FramerateControl\\": \\"SPECIFIED\\",\\n \\"FramerateNumerator\\": 25,\\n \\"FramerateDenominator\\": 1\\n },\\n \\"Gop\\": {\\n \\"GopSizeUnits\\": \\"FRAMES\\",\\n \\"GopSize\\": 90,\\n \\"BframesNum\\": 3\\n },\\n \\"CodecDetail\\": {\\n \\"Profile\\": \\"MAIN\\",\\n \\"Level\\": \\"H264_LEVEL_AUTO\\"\\n }\\n },\\n \\"VideoCodecType\\": \\"NORMAL\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStartTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStopTime\\": \\"2024-12-03T06:56:42Z\\"\\n }\\n}","type":"json"}]', 'title' => 'GetMediaLiveChannel', 'description' => '## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [ ['createdAt' => '2025-05-14T07:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaLiveChannel'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetMediaLiveChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaLiveInput' => [ 'summary' => 'Query the details of a media live input.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'InputId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Input' => [ 'title' => '', 'description' => 'The input information.', 'type' => 'object', 'properties' => [ 'InputId' => ['description' => 'The ID of the input.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], 'Name' => ['description' => 'The name of the input.', 'type' => 'string', 'title' => '', 'example' => 'myinput'], 'Type' => ['description' => 'The input type.', 'type' => 'string', 'title' => '', 'example' => 'RTMP_PUSH'], 'InputInfos' => [ 'title' => '', 'description' => 'The input configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DestHost' => ['description' => 'The endpoint that the stream is pushed to. This parameter is returned for PUSH inputs.', 'type' => 'string', 'title' => '', 'example' => 'rtmp://domain/app/stream'], 'StreamName' => ['description' => 'The name of the pushed stream. This parameter is returned for PUSH inputs.', 'type' => 'string', 'title' => '', 'example' => 'mystream'], 'SourceUrl' => ['description' => 'The source URL where the stream is pulled from. This parameter is returned for PULL inputs.', 'type' => 'string', 'title' => '', 'example' => 'rtmp://domain/app/stream'], 'MonitorUrl' => ['description' => 'The URL for input monitoring.', 'type' => 'string', 'example' => 'rtmp://domain/app/stream_for_monitor', 'title' => ''], 'FlowId' => ['description' => 'The ID of the flow from MediaConnect.', 'type' => 'string', 'example' => '******81-9693-40dc-bbab-db5e49******', 'title' => ''], 'FlowOutputName' => ['description' => 'The output name of the MediaConnect flow.', 'type' => 'string', 'example' => 'myFlowOutputName', 'title' => ''], 'SrtMaxBitrate' => ['description' => 'Maximum bitrate of the SRT stream, in bps.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000000', 'title' => ''], 'SrtLatency' => ['description' => 'Latency of the SRT stream, in ms.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'SrtPassphrase' => ['description' => 'SRT encryption configuration: the password for the SRT stream.', 'type' => 'string', 'example' => 'srtencryption', 'title' => ''], 'SrtPbKeyLen' => ['description' => 'SRT encryption configuration: key length for the SRT stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'The time when the input was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-12-03T06:56:42Z', 'title' => ''], 'ChannelIds' => [ 'description' => 'The IDs of the channels associated with the input.', 'type' => 'array', 'items' => ['description' => 'The ID of the channel.', 'type' => 'string', 'example' => 'SEGK5KA6KYKAWQQH', 'title' => ''], 'title' => '', 'example' => '', ], 'SecurityGroupIds' => [ 'title' => '', 'description' => 'The IDs of the security groups associated with the input.', 'type' => 'array', 'items' => ['description' => 'The ID of the security group.', 'type' => 'string', 'example' => 'SEGK5KA6KYKAWQQH', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Input\\": {\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"myinput\\",\\n \\"Type\\": \\"RTMP_PUSH\\",\\n \\"InputInfos\\": [\\n {\\n \\"DestHost\\": \\"rtmp://domain/app/stream\\",\\n \\"StreamName\\": \\"mystream\\",\\n \\"SourceUrl\\": \\"rtmp://domain/app/stream\\",\\n \\"MonitorUrl\\": \\"rtmp://domain/app/stream_for_monitor\\",\\n \\"FlowId\\": \\"******81-9693-40dc-bbab-db5e49******\\",\\n \\"FlowOutputName\\": \\"myFlowOutputName\\",\\n \\"SrtMaxBitrate\\": 3000000,\\n \\"SrtLatency\\": 1000,\\n \\"SrtPassphrase\\": \\"srtencryption\\",\\n \\"SrtPbKeyLen\\": 16\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"ChannelIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Query media live input details', 'description' => '- Query the details of a media live input.'."\n" ."\n" .'## Queries per second (QPS) limit'."\n" ."\n" .'The queries per second (QPS) limit for this API is 50 requests per second per user. If this limit is exceeded, API calls will be subject to rate limiting, which may impact your business. Please invoke the API appropriately.', 'changeSet' => [ ['createdAt' => '2025-08-07T07:13:03.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-02-27T07:59:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaLiveInput'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetMediaLiveInput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaLiveInputSecurityGroup' => [ 'summary' => 'Gets details about a security group in MediaLive.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'SecurityGroupId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'SecurityGroup' => [ 'description' => 'The security group information.', 'type' => 'object', 'properties' => [ 'SecurityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'example' => 'SEGK5KA6KYKAWQQH', 'title' => ''], 'Name' => ['description' => 'The name of the security group.', 'type' => 'string', 'example' => 'mysg', 'title' => ''], 'WhitelistRules' => [ 'description' => 'The security group rules.', 'type' => 'array', 'items' => ['description' => 'The security group rule.', 'type' => 'string', 'example' => '10.1.1.0/24', 'title' => ''], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the security group was created. It follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-06-13T08:31:56Z', 'title' => ''], 'InputIds' => [ 'description' => 'The IDs of the inputs associated with the security group.', 'type' => 'array', 'items' => ['description' => 'The input ID.', 'type' => 'string', 'example' => 'SEGK5KA6KYKAWQQH', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"SecurityGroup\\": {\\n \\"SecurityGroupId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mysg\\",\\n \\"WhitelistRules\\": [\\n \\"10.1.1.0/24\\"\\n ],\\n \\"CreateTime\\": \\"2024-06-13T08:31:56Z\\",\\n \\"InputIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'GetMediaLiveInputSecurityGroup', 'description' => '## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaLiveInputSecurityGroup'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetMediaLiveInputSecurityGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaMarks' => [ 'summary' => 'Queries the information about marks based on mark IDs.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'MediaMarkIds', 'in' => 'query', 'schema' => ['description' => 'The mark ID. You can specify multiple mark IDs separated with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****'], 'MediaMarks' => ['title' => '', 'description' => 'The queried marks.'."\n" ."\n" .'- The value is in the JSONArray format.', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "MarkStartTime": "12.1",'."\n" .' "MarkEndTime": "12.2",'."\n" .' "MarkTag": "tag-1",'."\n" .' "MarkContent": "content-1",'."\n" .' "MarkStatus": "a"'."\n" .' },'."\n" .' {'."\n" .' "MarkStartTime": "12.3",'."\n" .' "MarkEndTime": "12.4",'."\n" .' "MarkTag": "tag-2",'."\n" .' "MarkContent": "content-2",'."\n" .' "MarkStatus": "online"'."\n" .' }'."\n" .']'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"MediaMarks\\": \\"[\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.1\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.2\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-1\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-1\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"a\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.3\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.4\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-2\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-2\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"online\\\\\\"\\\\n }\\\\n]\\"\\n}","type":"json"}]', 'title' => 'GetMediaMarks', 'responseParamsDescription' => '## MediaMark'."\n" ."\n" .'| Field | Type | Required | Description |'."\n" .'| ------------- | ------ | -------- | --------------------------------------- |'."\n" .'| MarkId | String | No | The mark ID. |'."\n" .'| MarkStartTime | Float | No | The start time of the mark. |'."\n" .'| MarkEndTime | Float | No | The end time of the mark. |'."\n" .'| MarkTag | String | No | The custom tag for easy classification. |'."\n" .'| MarkContent | String | No | The mark content. |'."\n" .'| MarkStatus | String | No | The mark status. |', 'changeSet' => [ ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaMarks'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetMediaMarks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetMediaProducingJob' => [ 'summary' => 'Retrieves details for an editing and composition job, such as its task status, timeline, template, and data.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media production job.', 'type' => 'string', 'required' => false, 'example' => '****cdb3e74639973036bc84****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****83B7-7F87-4792-BFE9-63CD2137****'], 'MediaProducingJob' => [ 'description' => 'The details of the media producing job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => '****fddd7748b58bf1d47e95****', 'title' => ''], 'MediaId' => ['description' => 'The ID of the output media asset.', 'type' => 'string', 'example' => '****0cc6ba49eab379332c5b****', 'title' => ''], 'MediaURL' => ['description' => 'The URL of the output media file.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4', 'title' => ''], 'Timeline' => ['description' => 'The timeline of the media producing job.', 'type' => 'string', 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the template used for the job.', 'type' => 'string', 'example' => '****6e76134d739cc3e85d3e****', 'title' => ''], 'ClipsParam' => ['description' => 'The clip parameters of the template used for the job.', 'type' => 'string', 'example' => '{"VideoArray":["****05512043f49f697f7425****","****05512043f49f697f7425****","****05512043f49f697f7425****"]}', 'title' => ''], 'Duration' => ['description' => 'The duration of the output media. >This parameter is returned only if the job is successful and the output is an audio or video file.>', 'type' => 'number', 'format' => 'float', 'example' => '30.500000', 'title' => ''], 'CreateTime' => ['description' => 'The time in UTC when the media producing job was created, formatted as `YYYY-MM-DD\'T\'hh:mm:ss\'Z\'`.', 'type' => 'string', 'example' => '2020-12-23T13:33:40Z', 'title' => ''], 'CompleteTime' => ['description' => 'The time in UTC when the media producing job was completed, formatted as `YYYY-MM-DD\'T\'hh:mm:ss\'Z\'`.', 'type' => 'string', 'example' => '2020-12-23T13:33:52Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time in UTC when the media producing job was last modified, formatted as `YYYY-MM-DD\'T\'hh:mm:ss\'Z\'`.', 'type' => 'string', 'example' => '2020-12-23T13:33:49Z', 'title' => ''], 'Status' => ['description' => 'The status of the media producing job. Valid values:'."\n" ."\n" .'- `Init` (Initialized)'."\n" ."\n" .'- `Queuing` (In queue)'."\n" ."\n" .'- `Processing` (In progress)'."\n" ."\n" .'- `Success` (Successful)'."\n" ."\n" .'- `Failed` (Failed)', 'type' => 'string', 'example' => 'Failed', 'title' => ''], 'Code' => ['description' => 'The error code of the media producing job. >This parameter is returned only if the job fails.>', 'type' => 'string', 'example' => 'ExceededMaximumValue', 'title' => ''], 'Message' => ['description' => 'The error message of the media producing job.'."\n" ."\n" .'>'."\n" ."\n" .'This parameter is returned only if the job fails.'."\n" ."\n" .'>', 'type' => 'string', 'example' => 'The specified "Width_Height" has exceeded maximum value.', 'title' => ''], 'VodMediaId' => ['description' => 'The ID of the media asset in VOD (Video on Demand). This ID is returned if the job\'s output is stored in VOD.', 'type' => 'string', 'example' => '****332c5b0cc6ba49eab379****', 'title' => ''], 'UserData' => ['description' => 'The user data, in JSON format.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}', 'title' => ''], 'SubJobMaterials' => ['description' => 'If the job is a subtask of a batch smart one-click video creation task, this parameter contains the subtask\'s materials, such as the title and speech script.', 'type' => 'string', 'example' => '{"Title": "标题", "SpeechText": "批量智能一键成片口播文案"}', 'title' => ''], 'Progress' => ['description' => 'The progress of the job. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], ], 404 => [ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job not found', 'description' => ''], ], ], 'title' => 'GetMediaProducingJob', 'description' => '### Limitations'."\n" ."\n" .'This API can only retrieve editing job data from the past year.', 'changeSet' => [ ['createdAt' => '2024-11-25T02:21:40.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-26T06:16:09.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-03T01:14:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-25T03:57:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaProducingJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetMediaProducingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"MediaProducingJob\\": {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"MediaId\\": \\"****0cc6ba49eab379332c5b****\\",\\n \\"MediaURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"}]}]}\\",\\n \\"TemplateId\\": \\"****6e76134d739cc3e85d3e****\\",\\n \\"ClipsParam\\": \\"{\\\\\\"VideoArray\\\\\\":[\\\\\\"****05512043f49f697f7425****\\\\\\",\\\\\\"****05512043f49f697f7425****\\\\\\",\\\\\\"****05512043f49f697f7425****\\\\\\"]}\\",\\n \\"Duration\\": 30.5,\\n \\"CreateTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"CompleteTime\\": \\"2020-12-23T13:33:52Z\\",\\n \\"ModifiedTime\\": \\"2020-12-23T13:33:49Z\\",\\n \\"Status\\": \\"Failed\\",\\n \\"Code\\": \\"ExceededMaximumValue\\",\\n \\"Message\\": \\"The specified \\\\\\"Width_Height\\\\\\" has exceeded maximum value.\\",\\n \\"VodMediaId\\": \\"****332c5b0cc6ba49eab379****\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\",\\\\\\"Key\\\\\\":\\\\\\"Valuexxx\\\\\\"}\\",\\n \\"SubJobMaterials\\": \\"{\\\\\\"Title\\\\\\": \\\\\\"标题\\\\\\", \\\\\\"SpeechText\\\\\\": \\\\\\"批量智能一键成片口播文案\\\\\\"}\\",\\n \\"Progress\\": 0\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetPackageJob' => [ 'summary' => 'Queries the information about a packaging job.', 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID. You can obtain the job ID from the response parameters of the [SubmitPackageJob](~~461964~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ab4802364a2e49208c99efab82df****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], 'PackageJob' => [ 'title' => '', 'description' => 'The information about the packaging job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82df****', 'title' => ''], 'TriggerSource' => ['description' => 'The source of the job. Valid values:'."\n" ."\n" .'- API'."\n" ."\n" .'- WorkFlow'."\n" ."\n" .'- Console', 'type' => 'string', 'example' => 'API', 'title' => ''], 'Name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'job-name', 'title' => ''], 'Inputs' => [ 'description' => 'The input of the job.', 'type' => 'array', 'items' => [ 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Input' => [ 'title' => '', 'description' => 'The information about the input stream file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" .'- OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media object.'."\n" ."\n" .'- If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported.'."\n" ."\n" .'- If Type is set to Media, the ID of a media asset is returned.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'The output of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" .'- OSS: an OSS object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media object.'."\n" ."\n" .'- If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported.'."\n" ."\n" .'- If Type is set to Media, the ID of a media asset is returned.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.m3u8', 'title' => ''], ], 'title' => '', 'example' => '', ], 'OutputUrl' => ['description' => 'The URL of the output file.', 'type' => 'string', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/output.m3u8', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => '36f3fee40aa047c0b067d0fb85ed****', 'title' => ''], 'Priority' => ['description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Status' => ['description' => 'The state of the job.', 'type' => 'string', 'example' => 'Init', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job fails.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], 'Message' => ['description' => 'The error message that is returned.', 'type' => 'string', 'example' => 'Resource content bad.', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the job was submitted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-09-08T11:34:05Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-09-08T11:44:05Z', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"param": "value"}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-09-08T11:34:05Z'."\n", 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-09-08T11:44:05Z'."\n", 'title' => ''], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"PackageJob\\": {\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82df****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"job-name\\",\\n \\"Inputs\\": [\\n {\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n ],\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.m3u8\\"\\n },\\n \\"OutputUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/output.m3u8\\",\\n \\"PipelineId\\": \\"36f3fee40aa047c0b067d0fb85ed****\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Init\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"Resource content bad.\\",\\n \\"SubmitTime\\": \\"2022-09-08T11:34:05Z\\",\\n \\"FinishTime\\": \\"2022-09-08T11:44:05Z\\",\\n \\"UserData\\": \\"{\\\\\\"param\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-09-08T11:34:05Z\\\\n\\",\\n \\"ModifiedTime\\": \\"2022-09-08T11:44:05Z\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'GetPackageJob', 'changeSet' => [ ['createdAt' => '2022-09-20T10:02:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPackageJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetPackageJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetPipeline' => [ 'summary' => 'Queries the information about an ApsaraVideo Media Processing (MPS) queue.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Pipeline' => [ 'title' => '', 'description' => 'The information about the MPS queue.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Name' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'example' => 'test-pipeline', 'title' => ''], 'Speed' => [ 'description' => 'The type of the MPS queue.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Standard: standard MPS queue.'."\n" ."\n" .'- Boost: MPS queue with transcoding speed boosted.'."\n" ."\n" .'- NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0.', 'enumValueTitles' => ['Speed' => '', 'Boost' => '', 'NarrowBandHDV2' => ''], 'type' => 'string', 'example' => 'Standard', 'title' => '', ], 'Priority' => ['description' => 'The priority of the MPS queue. Valid values: 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Status' => [ 'description' => 'The state of the MPS queue.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Active'."\n" ."\n" .'- Paused', 'enumValueTitles' => ['Active' => '', 'Paused' => ''], 'type' => 'string', 'example' => 'Active', 'title' => '', ], 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Pipeline\\": {\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"test-pipeline\\",\\n \\"Speed\\": \\"Standard\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Active\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\"\\n }\\n}","type":"json"}]', 'title' => 'GetPipeline', 'changeSet' => [ ['createdAt' => '2022-07-18T03:28:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipeline'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetPipeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetPlayInfo' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFUMQ35'], ], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The media asset ID.'."\n" ."\n" .'> Specify at least one of MediaId and InputURL.', 'type' => 'string', 'required' => false, 'example' => '86434e152b7d4f20be480574439fe***', 'title' => ''], ], [ 'name' => 'InputURL', 'in' => 'query', 'schema' => ['description' => 'The InputURL used to register the media asset. For more information, see [RegisterMediaInfo](~~441152~~).'."\n" ."\n" .'> Specify at least one of MediaId and InputURL.', 'type' => 'string', 'required' => false, 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4  or  vod://****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'AuthTimeout', 'in' => 'query', 'schema' => ['description' => 'The validity period of the playback URL, in seconds. The value defaults to 3600, which is also the minimum.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaBase' => [ 'description' => 'The basic information about the media asset.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the media asset was created.', 'type' => 'string', 'example' => '2021-09-22T10:07:31+08:00', 'title' => ''], 'Status' => ['description' => 'The status of the media asset. Valid values:'."\n" ."\n" .'- `Init`: The source file is not ready.'."\n" ."\n" .'- `Preparing`: The source file is being prepared. This process may involve uploading or compositing.'."\n" ."\n" .'- `PrepareFail`: Preparation of the source file failed. For example, the system failed to retrieve the source file metadata.'."\n" ."\n" .'- `Normal`: The source file is ready.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'example' => '2eea77a61c7b4ddd95bec34a6f65b***', 'title' => ''], 'CoverURL' => ['description' => 'The cover URL.', 'type' => 'string', 'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/cover/281c64d6-b5fb-4c57-97cd-84da56a8b151_large_cover_url.jpg', 'title' => ''], 'Title' => ['description' => 'The title.', 'type' => 'string', 'example' => 'testTitle', 'title' => ''], 'MediaType' => ['description' => 'The type of the media file. Valid values:'."\n" ."\n" .'`video`: A video file. `audio`: An audio-only file.', 'type' => 'string', 'example' => 'video', 'title' => ''], 'MediaTags' => ['description' => 'The tags.'."\n" ."\n" .'- You can add up to 16 tags.'."\n" ."\n" .'- Separate multiple tags with commas (,).'."\n" ."\n" .'- The maximum length of a tag is 32 bytes.'."\n" ."\n" .'- Tags must be UTF-8 encoded.', 'type' => 'string', 'example' => 'test,ccc', 'title' => ''], 'CateId' => ['description' => 'The category ID. You can obtain the category ID in one of the following ways:'."\n" ."\n" .'- Log on to the [IMS console](https://ims.console.aliyun.com) and choose **media asset management** > **category management** to view the category ID.'."\n" ."\n" .'- The create category operation returns the category ID in the `CateId` parameter.'."\n" ."\n" .'- The get category operation returns the category ID in the `CateId` parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '4220', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'desc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PlayInfoList' => [ 'description' => 'A list of audio or video playback streams.', 'type' => 'array', 'items' => [ 'description' => 'The details of an audio or video stream.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The creation time. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-05-10T02:28:49Z', 'title' => ''], 'Status' => ['description' => 'The media stream status. Valid values:'."\n" ."\n" .'- **Normal**: The stream is available.'."\n" ."\n" .'- **Invisible**: The stream is not visible.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'NarrowBandType' => ['description' => 'The Narrowband HD type. Valid values:'."\n" ."\n" .'- **0**: regular.'."\n" ."\n" .'- **1.0**: Narrowband HD 1.0.'."\n" ."\n" .'- **2.0**: Narrowband HD 2.0.'."\n" ."\n" .'This parameter applies only if a definition is configured in the built-in transcoding template for Narrowband HD 1.0. For more information, see [Configure transcoding templates - Definition](~~52839~~).', 'type' => 'string', 'example' => '0', 'title' => ''], 'Height' => ['description' => 'The height of the media stream in pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate of the media stream in Kbit/s.', 'type' => 'string', 'example' => '20', 'title' => ''], 'ModificationTime' => ['description' => 'The last modification time. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-05-13T11:39:41.714+08:00', 'title' => ''], 'WatermarkId' => ['description' => 'The ID of the watermark that is associated with the media stream.', 'type' => 'string', 'example' => '5bed88672b1e2520ead228935ed51***', 'title' => ''], 'Encrypt' => ['description' => 'Indicates whether the media stream is encrypted. Valid values:'."\n" ."\n" .'- **0**: No.'."\n" ."\n" .'- **1**: Yes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'Definition' => ['description' => 'The definition of the video stream. Valid values:'."\n" ."\n" .'- **FD**: fluent'."\n" ."\n" .'- **LD**: standard definition'."\n" ."\n" .'- **SD**: high definition'."\n" ."\n" .'- **HD**: ultra-high definition'."\n" ."\n" .'- **OD**: original'."\n" ."\n" .'- **2K**'."\n" ."\n" .'- **4K**'."\n" ."\n" .'- **SQ**: standard-quality audio'."\n" ."\n" .'- **HQ**: high-quality audio'."\n" ."\n" .'- **AUTO**: adaptive bitrate', 'type' => 'string', 'example' => 'HD', 'title' => ''], 'EncryptType' => ['description' => 'The encryption type of the media stream. Valid values:'."\n" ."\n" .'- **AliyunVoDEncryption**: Alibaba Cloud VoD Encryption.'."\n" ."\n" .'- **HLSEncryption**: HLS standard encryption.'."\n" ."\n" .'> If a stream is encrypted with **AliyunVoDEncryption**, you can play it only with the Alibaba Cloud Player SDK.', 'type' => 'string', 'example' => 'AliyunVoDEncryption', 'title' => ''], 'StreamType' => ['description' => 'The type of the media stream. The value is **video** for video streams or **audio** for audio-only streams.', 'type' => 'string', 'example' => 'video', 'title' => ''], 'Size' => ['description' => 'The size of the media stream in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '418112', 'title' => ''], 'Width' => ['description' => 'The width of the media stream in pixels.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], 'Fps' => ['description' => 'The frame rate of the media stream in frames per second.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Duration' => ['description' => 'The duration of the media stream in seconds.', 'type' => 'string', 'example' => '9.0464', 'title' => ''], 'PlayURL' => ['description' => 'The playback URL of the video stream.', 'type' => 'string', 'example' => 'https://***.aliyuncdn.com/sv/756bee1-17f980f0945/756bee1-17f980f0945.mp4', 'title' => ''], 'Format' => ['description' => 'The format of the media stream.'."\n" ."\n" .'- For video streams, valid values are **mp4** and **m3u8**.'."\n" ."\n" .'- For audio-only streams, the value is **mp3**.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], 'HDRType' => ['description' => 'The High Dynamic Range (HDR) type of the media stream. Valid values:'."\n" ."\n" .'- HDR'."\n" ."\n" .'- HDR10'."\n" ."\n" .'- HLG'."\n" ."\n" .'- DolbyVision'."\n" ."\n" .'- HDRVivid'."\n" ."\n" .'- SDR+', 'type' => 'string', 'title' => '', 'example' => 'HDR'], 'BitDepth' => ['description' => 'The color bit depth.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '8'], 'FileURL' => ['description' => 'The OSS file URL.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/43a68ee9-181809b6aba/43a68ee9-181809b6aba.mpeg', 'title' => ''], 'TransTemplateType' => ['description' => 'The type of the transcoding template. Valid values:'."\n" ."\n" .'- `Normal`: regular transcoding'."\n" ."\n" .'- `AudioTranscode`: audio transcoding'."\n" ."\n" .'- `Remux`: remuxing'."\n" ."\n" .'- `NarrowBandV1`: Narrowband HD 1.0'."\n" ."\n" .'- `NarrowBandV2`: Narrowband HD 2.0'."\n" ."\n" .'- `UHD`: audio and video enhancement (ultra-high definition)', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'StreamTags' => ['description' => 'The stream tags, which are used to identify the transcoding type.', 'type' => 'string', 'example' => '"{\\"ims.audioServiceType\\": \\"AudioEnhancement\\"}"', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '36c9d38e70bf43ed9f7f8f48d6356***', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'GetPlayInfo', 'summary' => 'This API retrieves the playback URL for a media file (video or audio) using a given audio/video ID. Use this URL for audio/video playback after integrating the Alibaba Cloud Player SDK (for URL-based playback) or a third-party player.', 'changeSet' => [ ['createdAt' => '2025-07-02T09:50:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-25T02:04:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-29T11:14:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-15T07:26:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-13T06:53:38.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPlayInfo'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetPlayInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaBase\\": {\\n \\"CreationTime\\": \\"2021-09-22T10:07:31+08:00\\",\\n \\"Status\\": \\"Normal\\",\\n \\"MediaId\\": \\"2eea77a61c7b4ddd95bec34a6f65b***\\",\\n \\"CoverURL\\": \\"https://***.oss-cn-shanghai.aliyuncs.com/cover/281c64d6-b5fb-4c57-97cd-84da56a8b151_large_cover_url.jpg\\",\\n \\"Title\\": \\"testTitle\\",\\n \\"MediaType\\": \\"video\\",\\n \\"MediaTags\\": \\"test,ccc\\",\\n \\"CateId\\": 4220,\\n \\"Description\\": \\"desc\\"\\n },\\n \\"PlayInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2022-05-10T02:28:49Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"NarrowBandType\\": \\"0\\",\\n \\"Height\\": 1080,\\n \\"Bitrate\\": \\"20\\",\\n \\"ModificationTime\\": \\"2022-05-13T11:39:41.714+08:00\\",\\n \\"WatermarkId\\": \\"5bed88672b1e2520ead228935ed51***\\",\\n \\"Encrypt\\": 0,\\n \\"Definition\\": \\"HD\\",\\n \\"EncryptType\\": \\"AliyunVoDEncryption\\",\\n \\"StreamType\\": \\"video\\",\\n \\"Size\\": 418112,\\n \\"Width\\": 1024,\\n \\"Fps\\": \\"25\\",\\n \\"Duration\\": \\"9.0464\\",\\n \\"PlayURL\\": \\"https://***.aliyuncdn.com/sv/756bee1-17f980f0945/756bee1-17f980f0945.mp4\\",\\n \\"Format\\": \\"mp4\\",\\n \\"HDRType\\": \\"HDR\\",\\n \\"BitDepth\\": 8,\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/43a68ee9-181809b6aba/43a68ee9-181809b6aba.mpeg\\",\\n \\"TransTemplateType\\": \\"Normal\\",\\n \\"StreamTags\\": \\"\\\\\\"{\\\\\\\\\\\\\\"ims.audioServiceType\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"AudioEnhancement\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"JobId\\": \\"36c9d38e70bf43ed9f7f8f48d6356***\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetProgram' => [ 'summary' => 'Queries a program.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProgramName', 'in' => 'query', 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => true, 'example' => 'program1', 'title' => ''], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Program' => ['description' => 'The information about the program.', '$ref' => '#/components/schemas/ChannelAssemblyProgram', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"2024-04-02T00:58:19Z\\\\n\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"{\\\\\\"segmentationEventID\\\\\\":0,\\\\\\"segmentationUPIDType\\\\\\":14,\\\\\\"segmentationUPID\\\\\\":\\\\\\"upid\\\\\\",\\\\\\"segmentationTypeID\\\\\\":48,\\\\\\"segmentNumber\\\\\\":0,\\\\\\"segmentsExpected\\\\\\":0,\\\\\\"subSegmentNumber\\\\\\":1,\\\\\\"subSegmentsExpected\\\\\\":0}\\\\n\\",\\n \\"OffsetMillis\\": 1000,\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\",\\n \\"SpliceInsertSettings\\": \\"{\\\\\\"AvailNumber\\\\\\":0,\\\\\\"AvailExpected\\\\\\":0,\\\\\\"SpliceEventID\\\\\\":1,\\\\\\"UniqueProgramID\\\\\\":0}\\\\n\\",\\n \\"SourceName\\": \\"MyAdSource\\",\\n \\"ProgramName\\": \\"program_name\\\\n\\",\\n \\"MessageType\\": \\"SPLICE_INSERT\\"\\n }\\n ],\\n \\"SourceType\\": \\"vodSource\\",\\n \\"Transition\\": \\"{\\\\\\"Type\\\\\\": \\\\\\"RELATIVE\\\\\\", \\\\\\"RelativePosition\\\\\\": \\\\\\"AFTER_PROGRAM\\\\\\", \\\\\\"RelativeProgram\\\\\\": \\\\\\"program2\\\\\\"}\\\\n\\",\\n \\"GmtModified\\": \\"2024-04-02T00:58:19Z\\\\n\\",\\n \\"SourceName\\": \\"MySource\\",\\n \\"ClipRange\\": \\"{StartOffsetMillis: 213123, EndOffsetMillis: 213134}\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::program/myChannel/MyProgram\\\\n\\",\\n \\"ProgramName\\": \\"program1\\"\\n }\\n}","type":"json"}]', 'title' => 'GetProgram', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetProgram', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetProjectExportJob' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the project export task.', 'type' => 'string', 'required' => true, 'example' => '****cdb3e74639973036bc84****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****'], 'ProjectExportJob' => [ 'description' => 'The project export task.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the project export task.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****'."\n", 'title' => ''], 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'example' => '****fddd7748b58bf1d47e95****'."\n", 'title' => ''], 'ExportType' => ['description' => 'The type of the project export. Valid values:'."\n" .'- **BaseTimeline**: timeline.'."\n" .'- **AdobePremierePro**: Adobe Premiere Pro project.', 'type' => 'string', 'example' => 'BaseTimeline', 'title' => ''], 'Status' => ['description' => 'The status of the project export task. Valid values:'."\n" .'- **Init**: initial state.'."\n" .'- **Processing**: processing.'."\n" .'- **Success**: succeeded.'."\n" .'- **Failed**: failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Code' => ['description' => 'The error code of the project export task.'."\n" .'>Check this field when the task fails.>', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], 'Message' => ['description' => 'The error message of the project export task.'."\n" ."\n" .'>Check this field when the task fails.>', 'type' => 'string', 'example' => 'The specified parameter is not valid.', 'title' => ''], 'ExportResult' => [ 'description' => 'The export result.', 'type' => 'object', 'properties' => [ 'Timeline' => ['description' => 'The online editing timeline. This field is returned when the export type is BaseTimeline. For more information about the structure, see [Timeline configuration](~~198823~~).', 'type' => 'string', 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"Type":"Video","MediaId":"****4d7cf14dc7b83b0e801c****","MediaURL":"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4","TimelineIn":0.0,"TimelineOut":5.0,"In":0.0,"Out":5.0,"Speed":1.0,"Duration":5.0,"VirginDuration":13.334,"Height":1.0,"Width":1.0,"X":0.0,"Y":0.0}]}]}', 'title' => ''], 'ProjectUrl' => ['description' => 'The file URL of the exported project, which is typically an authenticated OSS URL. This field is returned when the export type is AdobePremierePro.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example_prefix/exported_project_1e8c39a502c3436c84f88290cd713bf3.zip?Expires=1750331685&....', 'title' => ''], 'AudioUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'SrtList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Tag' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'SrtUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'The custom settings in JSON format.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query a project export task', 'summary' => 'Queries the information about a project export task.', 'changeSet' => [ ['createdAt' => '2025-07-02T09:50:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:GetProjectExportJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"ProjectExportJob\\": {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\\\n\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\\\n\\",\\n \\"ExportType\\": \\"BaseTimeline\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"The specified parameter is not valid.\\",\\n \\"ExportResult\\": {\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"Type\\\\\\":\\\\\\"Video\\\\\\",\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\",\\\\\\"MediaURL\\\\\\":\\\\\\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4\\\\\\",\\\\\\"TimelineIn\\\\\\":0.0,\\\\\\"TimelineOut\\\\\\":5.0,\\\\\\"In\\\\\\":0.0,\\\\\\"Out\\\\\\":5.0,\\\\\\"Speed\\\\\\":1.0,\\\\\\"Duration\\\\\\":5.0,\\\\\\"VirginDuration\\\\\\":13.334,\\\\\\"Height\\\\\\":1.0,\\\\\\"Width\\\\\\":1.0,\\\\\\"X\\\\\\":0.0,\\\\\\"Y\\\\\\":0.0}]}]}\\",\\n \\"ProjectUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example_prefix/exported_project_1e8c39a502c3436c84f88290cd713bf3.zip?Expires=1750331685&....\\",\\n \\"AudioUrl\\": \\"\\",\\n \\"SrtList\\": [\\n {\\n \\"Tag\\": \\"\\",\\n \\"SrtUrl\\": \\"\\"\\n }\\n ]\\n },\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\",\\\\\\"Key\\\\\\":\\\\\\"Valuexxx\\\\\\"}\\"\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetPublicMediaInfo' => [ 'summary' => 'Obtain and return media asset information based on the mediaId of an ICE public copyright media asset. The URL returned by the API is a preview or audition address for the copyright media asset. The official material will be used during synthesis.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '104901', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'IMS media asset ID', 'type' => 'string', 'required' => false, 'example' => 'icepublic-****14e501538aeef0a3140176f6****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'RequestId', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaInfo' => [ 'description' => 'Media asset information', 'properties' => [ 'MediaId' => ['description' => 'Media asset ID', 'type' => 'string', 'title' => '', 'example' => 'icepublic-****14e501538aeef0a3140176f6****'], 'MediaBasicInfo' => [ 'description' => 'BasicInfo', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'MediaId', 'type' => 'string', 'example' => 'icepublic-****14e501538aeef0a3140176f6****'], 'MediaType' => ['description' => 'media asset Type', 'type' => 'string', 'title' => '', 'example' => 'video'], 'BusinessType' => ['description' => 'Media asset business type', 'type' => 'string', 'title' => '', 'example' => 'general'], 'Source' => ['description' => 'Source', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'title', 'type' => 'string', 'title' => '', 'example' => 'title'], 'Description' => ['description' => 'Content description', 'type' => 'string', 'title' => '', 'example' => 'description'], 'Category' => ['description' => 'categorization', 'type' => 'string', 'title' => '', 'example' => 'category'], 'MediaTags' => ['description' => 'label', 'type' => 'string', 'example' => 'tag1', 'title' => ''], 'CoverURL' => ['description' => 'thumbnail URL', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'UserData' => ['description' => 'User Data', 'type' => 'string', 'title' => '', 'example' => '{"key":"value"}'], 'Status' => ['description' => 'Resource status', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'CreateTime' => ['description' => 'Media asset creation time', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:08Z'], 'ModifiedTime' => ['description' => 'Updated At', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:10Z'], 'DeletedTime' => ['description' => 'Media asset deletion time', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T04:11:15Z'], 'SpriteImages' => ['description' => 'sprite', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], ], 'title' => '', 'type' => 'object', 'example' => '', ], 'DynamicMetaData' => [ 'description' => 'Public media asset dynamic metadata', 'properties' => [ 'Type' => ['description' => 'Type. Valid values:'."\n" ."\n" .'- "ai": AI data processed from raw AI results'."\n" ."\n" .'- "user-defined": User-defined metadata'."\n" ."\n" .'- "system": System-provided', 'type' => 'string', 'title' => '', 'example' => 'system'], 'Data' => ['description' => 'Metadata in JSON format', 'type' => 'string', 'title' => '', 'example' => '{"AuditionUrl": "http://example-bucket.cdn.domain.com/example.mp4", "AuditionCount": 3}'], ], 'title' => '', 'type' => 'object', 'example' => '', ], 'FileInfoList' => [ 'description' => 'FileInfos', 'items' => [ 'properties' => [ 'FileBasicInfo' => [ 'description' => 'Basic file information, including duration and size.', 'properties' => [ 'FileName' => ['description' => 'File name', 'type' => 'string', 'title' => '', 'example' => 'example.mp4'], 'FileStatus' => ['description' => 'File status', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'File type', 'type' => 'string', 'title' => '', 'example' => 'source_file'], 'FileSize' => ['description' => 'File Size (bytes)', 'type' => 'string', 'title' => '', 'example' => '27007'], 'FileUrl' => ['description' => 'Preview or sample playback URL for the copyrighted media asset.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.cdn.domain.com/example.mp4'], 'Region' => ['description' => 'File storage area', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'FormatName' => ['description' => 'Container format', 'type' => 'string', 'title' => '', 'example' => 'mp4'], 'Duration' => ['description' => 'Duration', 'type' => 'string', 'title' => '', 'example' => '16.2'], 'Bitrate' => ['description' => 'Bitrate', 'type' => 'string', 'title' => '', 'example' => '192.0'], 'Width' => ['description' => 'Width', 'type' => 'string', 'title' => '', 'example' => '0'], 'Height' => ['description' => 'Height', 'type' => 'string', 'title' => '', 'example' => '0'], ], 'title' => '', 'type' => 'object', 'example' => '', ], 'AudioStreamInfoList' => [ 'description' => 'Audio stream information. A media asset may contain multiple audio streams.', 'items' => [ 'properties' => [ 'Index' => ['description' => 'Audio stream ordinal number', 'type' => 'string', 'title' => '', 'example' => '1'], 'CodecName' => ['description' => 'short name of the encoding format', 'type' => 'string', 'title' => '', 'example' => 'aac'], 'CodecLongName' => ['description' => 'Long name of the encoding format', 'type' => 'string', 'title' => '', 'example' => 'AAC (Advanced Audio Coding)'], 'CodecTimeBase' => ['description' => 'Codec time base', 'type' => 'string', 'title' => '', 'example' => '1/44100'], 'CodecTagString' => ['description' => 'Encoding format tag text', 'type' => 'string', 'title' => '', 'example' => 'mp4a'], 'CodecTag' => ['description' => 'Encoding format tag', 'type' => 'string', 'title' => '', 'example' => '0x6134706d'], 'Profile' => ['description' => 'codec profile', 'type' => 'string', 'title' => '', 'example' => 'High'], 'SampleFmt' => ['description' => 'Sampling format', 'type' => 'string', 'title' => '', 'example' => 'fltp'], 'SampleRate' => ['description' => 'Sample rate', 'type' => 'string', 'title' => '', 'example' => '44100'], 'Channels' => ['description' => 'the number of sound channels', 'type' => 'string', 'title' => '', 'example' => '2'], 'ChannelLayout' => ['description' => 'Sound channel output layout', 'type' => 'string', 'title' => '', 'example' => 'stereo'], 'Timebase' => ['description' => 'Timebase', 'type' => 'string', 'title' => '', 'example' => '1/44100'], 'StartTime' => ['description' => 'Start time', 'type' => 'string', 'title' => '', 'example' => '0.000000'], 'Duration' => ['description' => 'Duration', 'type' => 'string', 'title' => '', 'example' => '16.2'], 'Bitrate' => ['description' => 'bitrate', 'type' => 'string', 'title' => '', 'example' => '192.0'], 'Fps' => ['description' => 'Audio frame rate', 'type' => 'string', 'title' => '', 'example' => '10'], 'NumFrames' => ['description' => 'Total number of frames', 'type' => 'string', 'title' => '', 'example' => '162'], 'Lang' => ['description' => 'Language', 'type' => 'string', 'title' => '', 'example' => 'und'], ], 'type' => 'object', 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'type' => 'array', 'example' => '', ], 'VideoStreamInfoList' => [ 'description' => 'Video stream information; a media asset may contain multiple video streams.', 'items' => [ 'properties' => [ 'Index' => ['description' => 'Video stream ordinal number', 'type' => 'string', 'title' => '', 'example' => '0'], 'CodecName' => ['description' => 'Encoding format short name', 'type' => 'string', 'title' => '', 'example' => 'h264'], 'CodecLongName' => ['description' => 'Long name of the encoding format', 'type' => 'string', 'title' => '', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10'], 'Profile' => ['description' => 'codec profile', 'type' => 'string', 'title' => '', 'example' => 'High'], 'CodecTimeBase' => ['description' => 'Codec time base', 'type' => 'string', 'title' => '', 'example' => '1/48'], 'CodecTagString' => ['description' => 'Encoding format mark text', 'type' => 'string', 'title' => '', 'example' => '[0][0][0][0]'], 'CodecTag' => ['description' => 'Encoding format tag', 'type' => 'string', 'title' => '', 'example' => '0x0000'], 'Width' => ['description' => 'Width', 'type' => 'string', 'title' => '', 'example' => '960'], 'Height' => ['description' => 'Height', 'type' => 'string', 'title' => '', 'example' => '540'], 'HasBFrames' => ['description' => 'Whether B-frames are present', 'type' => 'string', 'title' => '', 'example' => '2'], 'Sar' => ['description' => 'Sample Aspect Ratio (SAR)', 'type' => 'string', 'title' => '', 'example' => '0:1'], 'Dar' => ['description' => 'Encoded display aspect ratio', 'type' => 'string', 'title' => '', 'example' => '0:1'], 'PixFmt' => ['description' => 'Pixel format', 'type' => 'string', 'title' => '', 'example' => 'yuv420p'], 'Level' => ['description' => 'Encoding Level', 'type' => 'string', 'title' => '', 'example' => '30'], 'Fps' => ['description' => 'video frame rate', 'type' => 'string', 'title' => '', 'example' => '24.0'], 'AvgFPS' => ['description' => 'average frame rate', 'type' => 'string', 'title' => '', 'example' => '24.0'], 'Timebase' => ['description' => 'time base', 'type' => 'string', 'title' => '', 'example' => '1/12288'], 'StartTime' => ['description' => 'start time', 'type' => 'string', 'title' => '', 'example' => '0.081706'], 'Duration' => ['description' => 'Duration', 'type' => 'string', 'title' => '', 'example' => '216.206706'], 'Bitrate' => ['description' => 'bitrate', 'type' => 'string', 'title' => '', 'example' => '1001.594'], 'NumFrames' => ['description' => 'Total number of frames', 'type' => 'string', 'title' => '', 'example' => '5184'], 'Lang' => ['description' => 'Language', 'type' => 'string', 'title' => '', 'example' => 'und'], 'Rotate' => ['description' => 'rotate', 'type' => 'string', 'title' => '', 'example' => '0'], 'Nb_frames' => ['description' => 'total number of frames', 'type' => 'string', 'title' => '', 'example' => '5184'], ], 'type' => 'object', 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'type' => 'array', 'example' => '', ], 'SubtitleStreamInfoList' => [ 'description' => 'Caption stream information. A media asset may have multiple caption streams.', 'items' => [ 'properties' => [ 'Index' => ['description' => 'Caption stream ordinal number', 'type' => 'string', 'title' => '', 'example' => '1'], 'CodecName' => ['description' => 'Brief name of encoding format', 'type' => 'string', 'title' => '', 'example' => 'srt'], 'CodecLongName' => ['description' => 'Long name of encoding format', 'type' => 'string', 'title' => '', 'example' => 'SubRip Text'], 'CodecTimeBase' => ['description' => 'Codec time base', 'type' => 'string', 'title' => '', 'example' => '29.97'], 'CodecTagString' => ['description' => 'Encoding format mark text', 'type' => 'string', 'title' => '', 'example' => 'unicode'], 'CodecTag' => ['description' => 'Encoding format tag', 'type' => 'string', 'title' => '', 'example' => 'unicode'], 'Timebase' => ['description' => 'Time base', 'type' => 'string', 'title' => '', 'example' => '30'], 'StartTime' => ['description' => 'Start time', 'type' => 'string', 'title' => '', 'example' => '0'], 'Duration' => ['description' => 'Duration', 'type' => 'string', 'title' => '', 'example' => '1'], 'Lang' => ['description' => 'Language', 'type' => 'string', 'title' => '', 'example' => 'und'], ], 'type' => 'object', 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'type' => 'array', 'example' => '', ], ], 'type' => 'object', 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'type' => 'array', 'example' => '', ], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], 'title' => '', 'type' => 'object', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaInfo\\": {\\n \\"MediaId\\": \\"icepublic-****14e501538aeef0a3140176f6****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"icepublic-****14e501538aeef0a3140176f6****\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"category\\",\\n \\"MediaTags\\": \\"tag1\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"UserData\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:15Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\"\\n },\\n \\"DynamicMetaData\\": {\\n \\"Type\\": \\"system\\",\\n \\"Data\\": \\"{\\\\\\"AuditionUrl\\\\\\": \\\\\\"http://example-bucket.cdn.domain.com/example.mp4\\\\\\", \\\\\\"AuditionCount\\\\\\": 3}\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"27007\\",\\n \\"FileUrl\\": \\"http://example-bucket.cdn.domain.com/example.mp4\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mp4\\",\\n \\"Duration\\": \\"16.2\\",\\n \\"Bitrate\\": \\"192.0\\",\\n \\"Width\\": \\"0\\",\\n \\"Height\\": \\"0\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"Profile\\": \\"High\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/44100\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Duration\\": \\"16.2\\",\\n \\"Bitrate\\": \\"192.0\\",\\n \\"Fps\\": \\"10\\",\\n \\"NumFrames\\": \\"162\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1/48\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Sar\\": \\"0:1\\",\\n \\"Dar\\": \\"0:1\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"30\\",\\n \\"Fps\\": \\"24.0\\",\\n \\"AvgFPS\\": \\"24.0\\",\\n \\"Timebase\\": \\"1/12288\\",\\n \\"StartTime\\": \\"0.081706\\",\\n \\"Duration\\": \\"216.206706\\",\\n \\"Bitrate\\": \\"1001.594\\",\\n \\"NumFrames\\": \\"5184\\",\\n \\"Lang\\": \\"und\\",\\n \\"Rotate\\": \\"0\\",\\n \\"Nb_frames\\": \\"5184\\"\\n }\\n ],\\n \\"SubtitleStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"srt\\",\\n \\"CodecLongName\\": \\"SubRip Text\\",\\n \\"CodecTimeBase\\": \\"29.97\\",\\n \\"CodecTagString\\": \\"unicode\\",\\n \\"CodecTag\\": \\"unicode\\",\\n \\"Timebase\\": \\"30\\",\\n \\"StartTime\\": \\"0\\",\\n \\"Duration\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Obtain public copyright media assets ', 'changeSet' => [ ['createdAt' => '2021-11-25T06:45:51.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'GetSmartHandleJob' => [ 'summary' => 'Retrieves the information and execution result for a smart task by task ID. This API only supports querying editing tasks from the past year.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Output' => ['description' => 'The output of the job.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'JobResult' => [ 'description' => 'The job result.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'AiResult' => ['description' => 'The AI result.', 'type' => 'string', 'example' => '拆条或智能标签信息', 'title' => ''], 'Usage' => ['description' => 'The token usage. This parameter is returned only for keyword expansion jobs.', 'type' => 'string', 'example' => '{"total_tokens":100}', 'title' => ''], 'MediaUrl' => ['description' => 'The URL of the output media file generated by the smart job.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'State' => [ 'description' => 'The state of the job.', 'enumValueTitles' => ['Finished' => 'The job is complete.', 'Failed' => 'The job failed.', 'Executing' => 'The job is running.', 'Created' => 'The job is created.'], 'type' => 'string', 'example' => 'Finished', 'title' => '', ], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => '{"user":"data"}', 'title' => ''], 'SmartJobInfo' => [ 'title' => '', 'description' => 'The smart job information.', 'type' => 'object', 'properties' => [ 'Title' => ['description' => 'The job title.', 'type' => 'string', 'example' => 'Test title', 'title' => ''], 'Description' => ['description' => 'The job description.', 'type' => 'string', 'example' => 'Test description', 'title' => ''], 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1974526429******', 'title' => ''], 'InputConfig' => [ 'title' => '', 'description' => 'The input configuration.', 'type' => 'object', 'properties' => [ 'InputFile' => ['description' => 'The Object Storage Service (OSS) URL of the input file or the media ID.', 'type' => 'string', 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or ******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], 'OutputConfig' => [ 'title' => '', 'description' => 'The output configuration.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'test-bucket', 'title' => ''], 'Object' => ['description' => 'The OSS object.', 'type' => 'string', 'example' => 'test-object', 'title' => ''], ], 'example' => '', ], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'JobType' => ['description' => 'The job type.', 'type' => 'string', 'example' => 'ASR', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['description' => 'The error code. This parameter is returned only if the job fails.', 'type' => 'string', 'example' => 'SpeechTranslationNoValidVocal', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message. This parameter is returned only if the job fails.', 'type' => 'string', 'example' => 'The speech translation job failed due to lack of valid vocal voice data.', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'GetSmartHandleJob', 'responseParamsDescription' => 'The result format varies depending on the type of smart job. The following examples show the response bodies for different smart jobs.'."\n" ."\n" .'## ASR smart captioning'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" .' "JobId": "******042d5e4db6866f6289d1******",'."\n" .' "State": "Finished",'."\n" .' "SmartJobInfo": {'."\n" .' "JobType": "ASR",'."\n" .' "ModifiedTime": "2022-01-21T06:15:08Z",'."\n" .' "CreateTime": "2022-01-21T06:15:02Z",'."\n" .' "Title": "default_title_2022-01-21T06:15:02Z",'."\n" .' "InputConfig": {'."\n" .' "JobParameters": "{\\"duration\\":\\"00:30:00\\",\\"start_time\\":\\"00:00:00\\",\\"request_params\\":\\"&enable_word_level_result=true\\"}",'."\n" .' "InputFile": "oss://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4"'."\n" .' }'."\n" .' },'."\n" .' "JobResult": {'."\n" .' "AiResult": "[{\\"content\\":\\"Speaking of which, he\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"is now incredibly popular.\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"Tickets are often very expensive,\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"but they sell out instantly upon release.\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"He also participates in various crosstalk variety shows to comment on new performers and has already...\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'## Text-to-speech'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" .' "JobId": "******042d5e4db6866f6289d1******",'."\n" .' "State": "Finished",'."\n" .' "SmartJobInfo": {'."\n" .' "Title": "default_title_2022-01-21T06:15:07Z",'."\n" .' "JobType": "TextToSpeech",'."\n" .' "CreateTime": "2022-01-21T06:15:07Z",'."\n" .' "ModifiedTime": "2022-01-21T06:15:07Z",'."\n" .' "InputConfig": {'."\n" .' "InputFile": "Speaking of which, he is now incredibly popular. Tickets are often very expensive, but they sell out instantly upon release. He also participates in various crosstalk variety shows to comment on new performers and has already..."'."\n" .' },'."\n" .' "EditingConfig": "{\\"format\\":\\"MP3\\",\\"pitch_rate\\":0,\\"sample_rate\\":16000,\\"speech_rate\\":0,\\"voice\\":\\"Siqi\\",\\"volume\\":50}",'."\n" .' "OutputConfig": {'."\n" .' "Bucket": "your-bucket",'."\n" .' "Object": "your-audio"'."\n" .' }'."\n" .' },'."\n" .' "JobResult": {'."\n" .' "MediaId": "******bf47c94e82b3b2014361******",'."\n" .' "AiResult": "[{\\"content\\":\\"Speaking of which, he\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"is now incredibly popular.\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"Tickets are often very expensive,\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"but they sell out instantly upon release.\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"He also participates in various crosstalk variety shows to comment on new performers and has already...\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'## Text generation'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId":"******AC-5A01-1116-87A4-BF86F2******",'."\n" .' "UserData":"{\\"NotifyAddress\\":\\"https://****\\"}",'."\n" .' "JobResult":{'."\n" .' "AiResult":"[\\"Try the cakes from our new store, made with pure, real cream for a rich, silky-smooth texture. Every bite is a sweet surprise that lets your taste buds dance with freshness and purity!\\",\\"Explore a new world of desserts. Our new store\'s cakes feature premium real cream, offering a low-sugar, non-cloying flavor with rich layers. Each cake tells a sweet story of craftsmanship, waiting for you to discover.\\",\\"For those who appreciate the finer things in life: our new cake shop uses carefully selected real cream with no artificial additives. Enjoy the pure, fragrant aroma and a light, fluffy texture. Every bite is a celebration of the good life.\\"]",'."\n" .' "Usage": "{\\"total_tokens\\":200}"'."\n" .' },'."\n" .' "State":"Finished",'."\n" .' "JobId":"******8c784f461db57c99c9d9******",'."\n" .' "SmartJobInfo":{'."\n" .' "JobType":"TextGenerate",'."\n" .' "ModifiedTime":"2024-01-17T08:46:17Z",'."\n" .' "CreateTime":"2024-01-17T08:46:17Z",'."\n" .' "Title":"default_title_2024-01-17T08:46:17Z",'."\n" .' "EditingConfig":"{\\"Type\\":\\"MarketingCopy\\",\\"GenerateConfig\\":\\"{\\\\\\"keywords\\\\\\":\\\\\\"new cake shop, real cream\\\\\\",\\\\\\"textLength\\\\\\":100,\\\\\\"targetCount\\\\\\":3}\\"}"'."\n" .' }'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2025-07-07T08:53:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-12-19T10:37:41.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-27T11:52:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-01T06:55:25.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSmartHandleJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetSmartHandleJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Output\\": \\"{}\\",\\n \\"JobResult\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"AiResult\\": \\"拆条或智能标签信息\\",\\n \\"Usage\\": \\"{\\\\\\"total_tokens\\\\\\":100}\\",\\n \\"MediaUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\"\\n },\\n \\"State\\": \\"Finished\\",\\n \\"UserData\\": \\"{\\\\\\"user\\\\\\":\\\\\\"data\\\\\\"}\\",\\n \\"SmartJobInfo\\": {\\n \\"Title\\": \\"Test title\\",\\n \\"Description\\": \\"Test description\\",\\n \\"UserId\\": \\"1974526429******\\",\\n \\"InputConfig\\": {\\n \\"InputFile\\": \\"oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or ******11-DB8D-4A9A-875B-275798******\\"\\n },\\n \\"OutputConfig\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Object\\": \\"test-object\\"\\n },\\n \\"CreateTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"JobType\\": \\"ASR\\"\\n },\\n \\"ErrorCode\\": \\"SpeechTranslationNoValidVocal\\",\\n \\"ErrorMessage\\": \\"The speech translation job failed due to lack of valid vocal voice data.\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetSnapshotJob' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice5MI8QL'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'required' => true, 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'SnapshotJob' => [ 'title' => '', 'description' => 'The information about the snapshot job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], 'TriggerSource' => [ 'description' => 'The request trigger source.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Console'."\n" ."\n" .'- Workflow'."\n" ."\n" .'- API', 'enumValueTitles' => ['Console' => '', 'Workflow' => '', 'API' => 'API'], 'type' => 'string', 'example' => 'API', 'title' => '', ], 'Name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'Test task', 'title' => ''], 'Type' => [ 'description' => 'Snapshot types'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- WebVtt'."\n" ."\n" .'- Sprite'."\n" ."\n" .'- Normal', 'enumValueTitles' => ['WebVtt' => '', 'Sprite' => '', 'Normal' => ''], 'type' => 'string', 'example' => 'Sprite', 'title' => '', ], 'Input' => [ 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'2. Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The input file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats:'."\n" ."\n" .'1. oss\\://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS.', 'type' => 'string', 'example' => 'oss://test-bucket/object.mp4', 'title' => ''], 'OssFile' => [ 'title' => '', 'description' => 'The three key elements of OSS.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'test-bucket', 'title' => ''], 'Location' => ['description' => 'The OSS location.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Object' => ['description' => 'The OSS object.', 'type' => 'string', 'example' => 'object.mp4', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'The output of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid values:'."\n" ."\n" .'1. OSS: an OSS object.'."\n" ."\n" .'2. Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The output file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats:'."\n" ."\n" .'1. oss\\://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object'."\n" ."\n" .'In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS. If multiple static snapshots were captured, the object must contain the "{Count}" placeholder. In the case of a sprite, the object must contain the "{TileCount}" placeholder. The suffix of the WebVTT snapshot objects must be ".vtt".', 'type' => 'string', 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg', 'title' => ''], 'OssFile' => [ 'title' => '', 'description' => 'The three key elements of OSS.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'test-bucket', 'title' => ''], 'Location' => ['description' => 'The OSS location.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Object' => ['description' => 'The OSS object.', 'type' => 'string', 'example' => 'output-{Count}.jpg', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Count' => ['description' => 'The number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'Async' => ['description' => 'Indicates whether the snapshots were captured in asynchronous mode. Default value: true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], 'TemplateConfig' => ['description' => 'The snapshot template configuration.', 'type' => 'string', 'example' => '{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], 'Status' => [ 'description' => 'The state of the job.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Init: The job is submitted.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Fail: The job failed.', 'enumValueTitles' => ['Init' => '', 'Success' => '', 'Fail' => ''], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'Code' => ['description' => 'Error codes', 'type' => 'string', 'example' => 'ResourceNotFound', 'title' => ''], 'Message' => ['description' => 'The error message that is returned.', 'type' => 'string', 'example' => 'The specified resource for "Pipeline" could not be found.', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], 'UserData' => ['description' => 'The user-defined parameters.', 'type' => 'string', 'example' => '{"test parameter": "test value"}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'GetSnapshotJob', 'summary' => 'Queries the information about a snapshot job.', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSnapshotJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetSnapshotJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SnapshotJob\\": {\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"Test task\\",\\n \\"Type\\": \\"Sprite\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://test-bucket/object.mp4\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"object.mp4\\"\\n }\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"output-{Count}.jpg\\"\\n }\\n },\\n \\"Count\\": 8,\\n \\"Async\\": true,\\n \\"TemplateId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Type\\\\\\":\\\\\\"Normal\\\\\\",\\\\\\"FrameType\\\\\\":\\\\\\"normal\\\\\\",\\\\\\"Time\\\\\\":0,\\\\\\"Count\\\\\\":10}\\",\\n \\"PipelineId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource for \\\\\\"Pipeline\\\\\\" could not be found.\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"UserData\\": \\"{\\\\\\"test parameter\\\\\\": \\\\\\"test value\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetSnapshotUrls' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 30. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => 'The order that you use to sort the query results. Valid values: Asc and Desc.'."\n" ."\n" .'- Asc'."\n" ."\n" .'- Desc', 'enumValueTitles' => ['Asc' => '', 'Desc' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Asc', ], ], [ 'name' => 'Timeout', 'in' => 'query', 'schema' => ['description' => 'The authentication timeout period. Unit: seconds Default value: 3600. Maximum value: 129600 (36 hours).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '3600'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Total' => ['description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], 'SnapshotUrls' => [ 'title' => '', 'description' => 'The list of snapshot URLs.', 'type' => 'array', 'items' => ['description' => 'The URL of the snapshot.', 'type' => 'string', 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput-00001.jpg', 'title' => ''], 'example' => '', ], 'WebVTTUrl' => ['description' => 'The URL of the WebVTT file.', 'type' => 'string', 'title' => '', 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput.vtt'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'GetSnapshotUrls', 'summary' => 'Queries the accessible URLs of the output images of a snapshot job.', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSnapshotUrls'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetSnapshotUrls', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Total\\": 30,\\n \\"SnapshotUrls\\": [\\n \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput-00001.jpg\\"\\n ],\\n \\"WebVTTUrl\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput.vtt\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetSource' => [ 'summary' => 'Queries a source.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The source type. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ 'name' => 'SourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MyVodSource', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Source' => ['description' => 'The source information.', '$ref' => '#/components/schemas/ChannelAssemblySource', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"2022-10-20T07:15:51Z\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\\\n\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"vodSource\\",\\n \\"GmtModified\\": \\"2024-11-07T10:12:01Z\\\\n\\",\\n \\"SourceName\\": \\"MyVodSource\\\\n\\",\\n \\"HttpPackageConfigurations\\": \\"[{\\\\n\\\\t\\\\\\"sourceGroupName\\\\\\": \\\\\\"mySourceGroup-1\\\\\\",\\\\n\\\\t\\\\\\"relativePath\\\\\\": \\\\\\"group1/hls.m3u8\\\\\\",\\\\n\\\\t\\\\\\"packageType\\\\\\": \\\\\\"hls\\\\\\"\\\\n}]\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::vodSource/mySourceLocation/mySource\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'GetSource', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetSourceLocation' => [ 'summary' => 'Queries a source location.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'SourceLocation' => ['description' => 'The source location information.', '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"2024-03-29T02:03:17Z\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\\\n\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"2024-03-29T02:03:17Z\\\\n\\",\\n \\"SegmentDeliveryConfigurations\\": \\"http://segmentdelivery.com\\\\n\\",\\n \\"BaseUrl\\": \\"http://xxxx.com\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::sourcelocation/MySourceLocation\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'GetSourceLocation', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetSourceLocation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetStorageList' => [ 'summary' => 'Obtains storage configurations.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app-****', 'title' => ''], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => 'The storage type.', 'type' => 'string', 'required' => false, 'example' => 'vod_oss_bucket', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The OSS storage status.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******73-8B78-5D86-A50C-49B96C******'], 'StorageInfoList' => [ 'description' => 'The storage configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'app-****', 'title' => ''], 'StorageLocation' => ['description' => 'The bucket.', 'type' => 'string', 'example' => 'your-bucket', 'title' => ''], 'Path' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'your-path/', 'title' => ''], 'StorageType' => ['description' => 'The storage type.', 'type' => 'string', 'example' => 'vod_oss_bucket', 'title' => ''], 'Status' => ['description' => 'The OSS storage status.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'DefaultStorage' => ['description' => 'Indicates whether it is the default storage location.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EditingTempFileStorage' => ['description' => 'Indicates whether temporary files created during editing processes are stored in this location.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CreationTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'example' => '2024-06-06T01:55:07Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'example' => '2024-06-06T03:07:07Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******73-8B78-5D86-A50C-49B96C******\\",\\n \\"StorageInfoList\\": [\\n {\\n \\"AppId\\": \\"app-****\\",\\n \\"StorageLocation\\": \\"your-bucket\\",\\n \\"Path\\": \\"your-path/\\",\\n \\"StorageType\\": \\"vod_oss_bucket\\",\\n \\"Status\\": \\"Normal\\",\\n \\"DefaultStorage\\": true,\\n \\"EditingTempFileStorage\\": false,\\n \\"CreationTime\\": \\"2024-06-06T01:55:07Z\\",\\n \\"ModifiedTime\\": \\"2024-06-06T03:07:07Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetStorageList', 'changeSet' => [ ['createdAt' => '2022-07-12T10:54:57.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStorageList'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetStorageList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetStreamTagList' => [ 'summary' => 'Retrieves tags of a live stream media asset.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the query time range, based on the tagging timestamp. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2025-04-23T02:26:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the query time range, based on the tagging timestamp. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2017-12-22T08:00:00Z', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order for the results. Valid values:'."\n" ."\n" .'- StartTime:Desc (default): Sort by creation time in descending order.'."\n" ."\n" .'- StartTime:Asc: Sort by creation time in ascending order.', 'type' => 'string', 'required' => false, 'example' => 'StartTime:Asc', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => '****73f33c91-d59383e8280b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'NextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '****73f33c91-d59383e8280b****', 'title' => ''], 'Total' => ['description' => 'The total number of entries that are returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '163', 'title' => ''], 'StreamTagList' => [ 'description' => 'The tag information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The start time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-26T16:00:00Z', 'title' => ''], 'EndTime' => ['description' => 'The end time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2025-02-25T02:24:00Z', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"result":"xxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"NextToken\\": \\"****73f33c91-d59383e8280b****\\",\\n \\"Total\\": 163,\\n \\"StreamTagList\\": [\\n {\\n \\"StartTime\\": \\"2025-04-26T16:00:00Z\\",\\n \\"EndTime\\": \\"2025-02-25T02:24:00Z\\",\\n \\"UserData\\": \\"{\\\\\\"result\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetStreamTagList', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:GetStreamTagList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetSystemTemplate' => [ 'summary' => 'Queries the information about a system template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'S00000001-100060'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'SystemTemplate' => [ 'title' => '', 'description' => 'The template information.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'S00000001-100060', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'M3U8-2K', 'title' => ''], 'Type' => ['description' => 'The type ID of the template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TypeName' => ['description' => 'The type name of the template.', 'type' => 'string', 'example' => 'TranscodeTemplate', 'title' => ''], 'Subtype' => ['description' => 'The subtype ID of the template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SubtypeName' => ['description' => 'The subtype name of the template.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Status' => ['description' => 'The template state.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'TemplateConfig' => ['description' => 'The template parameters.', 'type' => 'string', 'title' => '', 'example' => '{"Container":{"Format":"m3u8"},"TransConfig":{"TransMode":"onepass"},"Video":{"Codec":"H.264","Maxrate":8000,"Preset":"medium","PixFmt":"yuv420p","Width":2048,"Bitrate":3500},"Audio":{"Codec":"aac","Bitrate":160,"Samplerate":44100,"Channels":2}}'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SystemTemplate\\": {\\n \\"TemplateId\\": \\"S00000001-100060\\",\\n \\"TemplateName\\": \\"M3U8-2K\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": 1,\\n \\"SubtypeName\\": \\"Normal\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"m3u8\\\\\\"},\\\\\\"TransConfig\\\\\\":{\\\\\\"TransMode\\\\\\":\\\\\\"onepass\\\\\\"},\\\\\\"Video\\\\\\":{\\\\\\"Codec\\\\\\":\\\\\\"H.264\\\\\\",\\\\\\"Maxrate\\\\\\":8000,\\\\\\"Preset\\\\\\":\\\\\\"medium\\\\\\",\\\\\\"PixFmt\\\\\\":\\\\\\"yuv420p\\\\\\",\\\\\\"Width\\\\\\":2048,\\\\\\"Bitrate\\\\\\":3500},\\\\\\"Audio\\\\\\":{\\\\\\"Codec\\\\\\":\\\\\\"aac\\\\\\",\\\\\\"Bitrate\\\\\\":160,\\\\\\"Samplerate\\\\\\":44100,\\\\\\"Channels\\\\\\":2}}\\"\\n }\\n}","type":"json"}]', 'title' => 'GetSystemTemplate', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSystemTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetSystemTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetTemplate' => [ 'summary' => 'Queries the information about a template based on the template ID. Query the information about an advanced template if the template is in the Available state.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], [ 'name' => 'RelatedMediaidFlag', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the information about the associated materials. Default value: 0. Valid values: 0 and 1. A value of 1 specifies that the information about the associated materials is returned. This parameter is valid only for regular templates.', 'type' => 'string', 'example' => '0', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Template' => [ 'description' => 'The template information.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Name' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Video watermark template', 'title' => ''], 'Type' => ['description' => 'The template type. Valid values:'."\n" ."\n" .'- Timeline'."\n" ."\n" .'- VETemplate', 'type' => 'string', 'example' => 'Timeline', 'title' => ''], 'Config' => ['description' => 'The template configurations.'."\n" ."\n" .'- For more information about the configurations of a regular template, see [Config object of a regular template](~~456193~~).'."\n" ."\n" .'- For more information about the configurations of an advanced template, see [Create and use advanced templates](~~445389~~).', 'type' => 'string', 'example' => 'See Timeline template configuration details.', 'title' => ''], 'PreviewMedia' => ['description' => 'The preview media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Status' => ['description' => 'The template state. Valid values:'."\n" ."\n" .'- Available'."\n" ."\n" .'- Created'."\n" ."\n" .'- Uploading'."\n" ."\n" .'- Processing'."\n" ."\n" .'- UploadFailed'."\n" ."\n" .'- ProcessFailed', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'CreateSource' => ['description' => 'The source from which the template was created. Valid values:'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- OpenAPI'."\n" ."\n" .'- WebSDK', 'type' => 'string', 'example' => 'OpenAPI', 'title' => ''], 'ModifiedSource' => ['description' => 'The source from which the template was modified. Valid values:'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- OpenAPI'."\n" ."\n" .'- WebSDK', 'type' => 'string', 'example' => 'OpenAPI', 'title' => ''], 'PreviewMediaStatus' => ['description' => 'The state of the preview media asset. Valid values:'."\n" ."\n" .'- Init: the initial state, which indicates that the source file is not ready.'."\n" ."\n" .'- Preparing: The source file is being prepared. For example, the file is being uploaded or edited.'."\n" ."\n" .'- PrepareFail: The source file failed to be prepared. For example, the information about the source file failed to be obtained.'."\n" ."\n" .'- Normal: The source file is ready.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'CreationTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'CoverURL' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', 'title' => ''], 'ClipsParam' => ['description' => 'The clip parameters for submitting a video production job. You can replace mediaId and text with real values to submit a job. References:'."\n" ."\n" .'- [Create and use a regular template](~~445399~~)'."\n" ."\n" .'- [Create and use advanced templates](~~445389~~)', 'type' => 'string', 'example' => '{"Media1":"mediaId","Text1":"text"}', 'title' => ''], 'RelatedMediaids' => ['description' => 'The IDs of the materials associated with the template for use by the regular template editor.', 'type' => 'string', 'example' => '{"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Template\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"Video watermark template\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"See Timeline template configuration details.\\",\\n \\"PreviewMedia\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Status\\": \\"Available\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"PreviewMediaStatus\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg\\",\\n \\"ClipsParam\\": \\"{\\\\\\"Media1\\\\\\":\\\\\\"mediaId\\\\\\",\\\\\\"Text1\\\\\\":\\\\\\"text\\\\\\"}\\",\\n \\"RelatedMediaids\\": \\"{\\\\\\"video\\\\\\":[\\\\\\"******c04f1d4a06996144cc1a******\\\\\\"],\\\\\\"audio\\\\\\":[\\\\\\"******c04f1d4a06996144cc1a******\\\\\\"],\\\\\\"image\\\\\\":[\\\\\\"******c04f1d4a06996144cc1a******\\\\\\"]}\\"\\n }\\n}","type":"json"}]', 'title' => 'GetTemplate', 'description' => 'A template is an encapsulation of the timeline of a media editing and production job. You can define a common timeline as a template. When you have the same requirements, you need to only specify key parameters and materials to produce videos.'."\n" ."\n" .'- For more information about how to use a regular template, see [Create and use a regular template](~~445399~~).'."\n" ."\n" .'- For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).', 'changeSet' => [ ['createdAt' => '2021-04-23T09:25:12.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetTemplateMaterials' => [ 'summary' => 'Queries the URLs of materials associated with an advanced template for use by the advanced template editor. The URLs expire in 30 minutes. FileList is an array of materials that you want to query. If you do not specify this parameter, the URLs of all materials are returned. A maximum of 400 URLs can be returned.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'FileList', 'in' => 'query', 'schema' => ['description' => 'The materials that you want to query.', 'type' => 'string', 'example' => '["music.mp3","config.json","assets/1.jpg"]', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MaterialUrls' => ['description' => 'The URLs of the associated materials.', 'type' => 'string', 'example' => '{"music.mp3":"https://bucket.oss-cn-shanghai.aliyuncs.com/music.mp3?sign=xxx","config.json":"https://bucket.oss-cn-shanghai.aliyuncs.com/config.json?sign=xxx","assets/1.jpg":"https://bucket.oss-cn-shanghai.aliyuncs.com/assets/1.jpg?sign=xxx"}', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MaterialUrls\\": \\"{\\\\\\"music.mp3\\\\\\":\\\\\\"https://bucket.oss-cn-shanghai.aliyuncs.com/music.mp3?sign=xxx\\\\\\",\\\\\\"config.json\\\\\\":\\\\\\"https://bucket.oss-cn-shanghai.aliyuncs.com/config.json?sign=xxx\\\\\\",\\\\\\"assets/1.jpg\\\\\\":\\\\\\"https://bucket.oss-cn-shanghai.aliyuncs.com/assets/1.jpg?sign=xxx\\\\\\"}\\"\\n}","type":"json"}]', 'title' => 'GetTemplateMaterials', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetTemplateMaterials', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetTemplateParams' => [ 'summary' => 'Obtain the replaceable material parameter information of a template, including the parameter name, default material value, and material thumbnail. Currently, only advanced templates are supported.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceDXIJ4D'], ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****'], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '******419c8741c1b4325f035b******', 'title' => ''], 'ParamList' => [ 'description' => 'The queried parameters.', 'type' => 'array', 'items' => [ 'description' => 'The template parameters.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'video1', 'title' => ''], 'Type' => [ 'description' => 'The material type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Video'."\n" ."\n" .'- Text'."\n" ."\n" .'- Image', 'enumValueTitles' => ['Video' => '', 'Text' => '', 'Image' => ''], 'type' => 'string', 'example' => 'Image', 'title' => '', ], 'CoverUrl' => ['description' => 'The thumbnail URL of the original material.', 'type' => 'string', 'example' => 'https://ice-materials-***.alicdn.com/***/********20221****.jpg', 'title' => ''], 'MediaUrl' => ['description' => 'The URL of the original material.', 'type' => 'string', 'example' => 'https://ice-materials-***.alicdn.com/***/********2022111618012453120c2a81*******.mp4', 'title' => ''], 'Content' => ['description' => 'The original subtitle content.', 'type' => 'string', 'example' => 'Subtitle test', 'title' => ''], 'X' => ['description' => 'The horizontal distance of the original material relative to the top-left corner of the video, in absolute pixel values. This value is returned only for standard templates created in the console.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'Y' => ['description' => 'The vertical distance of the original material relative to the top-left corner of the video, in absolute pixel values. This value is returned only for standard templates created in the console.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'Width' => ['description' => 'The width of the original material in the output video, in absolute pixel values. This value is returned only for standard templates created in the console.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], 'Height' => ['description' => 'The height of the original material in the output video, in absolute pixel values. This value is returned only for standard templates created in the console.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], 'TimelineIn' => ['description' => 'In-point of the original material segment relative to the timeline, in seconds. This value is returned only for standard templates created in the console.', 'type' => 'number', 'format' => 'float', 'example' => '5.5', 'title' => ''], 'TimelineOut' => ['description' => 'Out-point of the original material segment relative to the timeline, in seconds. This value is returned only for standard templates created in the console.', 'type' => 'number', 'format' => 'float', 'example' => '8.5', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain template parameter information', 'changeSet' => [ ['createdAt' => '2025-12-04T16:20:10.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplateParams'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetTemplateParams', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"TemplateId\\": \\"******419c8741c1b4325f035b******\\",\\n \\"ParamList\\": [\\n {\\n \\"Key\\": \\"video1\\",\\n \\"Type\\": \\"Image\\",\\n \\"CoverUrl\\": \\"https://ice-materials-***.alicdn.com/***/********20221****.jpg\\",\\n \\"MediaUrl\\": \\"https://ice-materials-***.alicdn.com/***/********2022111618012453120c2a81*******.mp4\\",\\n \\"Content\\": \\"Subtitle test\\",\\n \\"X\\": 100,\\n \\"Y\\": 100,\\n \\"Width\\": 300,\\n \\"Height\\": 300,\\n \\"TimelineIn\\": 5.5,\\n \\"TimelineOut\\": 8.5\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetTranscodeJob' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ParentJobId', 'in' => 'query', 'schema' => ['description' => 'Job ID', 'type' => 'string', 'docRequired' => true, 'example' => 'ab4802364a2e49208c99efab82dfa8e8', 'title' => '', 'required' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9EDC30DC-0050-5459-B788-F761B2BE359B', 'title' => ''], 'TranscodeParentJob' => [ 'title' => '', 'description' => 'TranscodeParentJobWithSubJobDTO', 'type' => 'object', 'properties' => [ 'TranscodeJobList' => [ 'title' => '', 'description' => 'List of sub-jobs.', 'type' => 'array', 'items' => [ 'description' => 'Sub-job.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'Job creation time.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'Name' => ['description' => 'Job name.', 'type' => 'string', 'example' => 'transcode-job', 'title' => ''], 'ParentJobId' => ['description' => 'Parent job ID.', 'type' => 'string', 'example' => '8b2198504dd340b7b3c9842a74fc9baa', 'title' => ''], 'JobId' => ['description' => 'Sub-job ID.', 'type' => 'string', 'example' => '7d6a7e0d4db2457a8d45ff5d43e1bf0a', 'title' => ''], 'JobIndex' => ['description' => 'Index of the sub-job within the entire job.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'InputGroup' => [ 'title' => '', 'description' => 'Job input group. A single input represents a transcoding job. Multiple inputs represent an audio-video merging job.', 'type' => 'array', 'items' => [ 'description' => 'Job input.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], 'InputUrl' => ['description' => 'Media stream URL. Specify this parameter only when transcoding a media stream.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ProcessConfig' => [ 'title' => '', 'description' => 'Transcoding processing configuration.', 'type' => 'object', 'properties' => [ 'Transcode' => [ 'title' => '', 'description' => 'Transcoding configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Video' => [ 'title' => '', 'description' => 'Video settings.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'Encoding format.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Profile' => ['description' => 'Encoding profile.'."\n" .'Supported values: baseline, main, high.'."\n" ."\n" .'- baseline: for mobile devices.'."\n" ."\n" .'- main: for standard-resolution devices.'."\n" ."\n" .'- high: for high-resolution devices.'."\n" ."\n" .'Default value: high.', 'type' => 'string', 'example' => 'Main', 'title' => ''], 'Bitrate' => ['description' => 'Video average bitrate.'."\n" ."\n" .'- Valid range: \\[10, 50000].'."\n" ."\n" .'- Unit: Kbps.', 'type' => 'string', 'example' => '3000', 'title' => ''], 'Crf' => ['description' => 'Bitrate-quality control factor.'."\n" ."\n" .'- Valid range: \\[0, 51].'."\n" ."\n" .'- Default value: 23 for H.264, 26 for H.265.'."\n" ."\n" .'If Crf is set, the Bitrate setting is ignored.', 'type' => 'string', 'example' => '23', 'title' => ''], 'Width' => ['description' => 'Width.'."\n" ."\n" .'- Valid range: \\[128, 4096].'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'Default value: original video width.', 'type' => 'string', 'example' => '1920', 'title' => ''], 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Valid range: \\[128, 4096].'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'Default value: original video height.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'Fps' => ['description' => 'Frame rate.'."\n" ."\n" .'- Valid range: (0, 60].'."\n" .' If the input file frame rate exceeds 60, use 60.'."\n" ."\n" .'- Default value: input file frame rate.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Gop' => ['description' => 'Maximum number of frames between keyframes.'."\n" ."\n" .'- Valid range: \\[1, 1080000].'."\n" ."\n" .'- Default value: 250.', 'type' => 'string', 'example' => '250', 'title' => ''], 'Preset' => ['description' => 'Video encoder preset. This parameter is supported only for H.264.'."\n" .'Supported values: veryfast, fast, medium, slow, slower.'."\n" .'Default value: medium.'."\n" ."\n" .'Default value: medium.', 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'Scan mode.'."\n" .'Supported values: interlaced, progressive.', 'type' => 'string', 'example' => 'progressive', 'title' => ''], 'PixFmt' => ['description' => 'Video color format.'."\n" .'Valid values: yuv420p, yuvj420p, and other standard color formats.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Remove' => ['description' => 'Whether to remove the video.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Crop' => ['description' => 'Video cropping. Two methods are supported:'."\n" ."\n" .'- Automatically detect and crop black bars by setting this parameter to "border".'."\n" ."\n" .'- Custom cropping in the format: width:height:left:top.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Pad' => ['description' => 'Add black bars to the video in the format: width:height:left:top.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'LongShortMode' => ['description' => 'Whether to enable automatic rotation (long-short edge mode).', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Bufsize' => ['description' => 'Buffer size:'."\n" ."\n" .'- Valid range: \\[1000, 128000].'."\n" ."\n" .'- Default value: 6000.'."\n" ."\n" .'- Unit: Kb.', 'type' => 'string', 'example' => '6000', 'title' => ''], 'Maxrate' => ['description' => 'Peak video bitrate:'."\n" ."\n" .'- Valid range: \\[10, 50000].'."\n" ."\n" .'- Unit: Kbps.', 'type' => 'string', 'example' => '9000', 'title' => ''], 'AbrMax' => ['description' => 'Maximum ABR bitrate (valid only for narrow-high 1):'."\n" ."\n" .'- Valid range: \\[10, 50000].'."\n" ."\n" .'- Unit: Kbps.', 'type' => 'string', 'example' => '6000', 'title' => ''], ], 'example' => '', ], 'Audio' => [ 'title' => '', 'description' => 'Audio settings.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'Audio codec format: AAC, MP3, VORBIS, FLAC.'."\n" .'Default value: AAC'."\n" ."\n" .'Default value: AAC.', 'type' => 'string', 'example' => 'AAC', 'title' => ''], 'Profile' => ['description' => 'Audio encoding preset.'."\n" .'When Codec is AAC, valid values are aac\\_low, aac\\_he, aac\\_he\\_v2, aac\\_ld, aac\\_eld.', 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Samplerate' => ['description' => 'Sample rate.'."\n" ."\n" .'- Supported values: 22050, 32000, 44100, 48000, 96000,'."\n" ."\n" .'- Unit: Hz', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Bitrate' => ['description' => 'Audio bitrate of the output file.'."\n" ."\n" .'- Valid range: \\[8, 1000]'."\n" ."\n" .'- Unit: Kbps'."\n" ."\n" .'- Default value: 128', 'type' => 'string', 'example' => '128', 'title' => ''], 'Channels' => ['description' => 'Number of sound channels.'."\n" .'Default value: 2', 'type' => 'string', 'example' => '2', 'title' => ''], 'Remove' => ['description' => 'Whether to remove the audio stream.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Volume' => [ 'title' => '', 'description' => 'Volume control.', 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'Volume adjustment method.', 'type' => 'string', 'example' => 'auto', 'title' => ''], 'IntegratedLoudnessTarget' => ['description' => 'Target volume.', 'type' => 'string', 'example' => '-6', 'title' => ''], 'TruePeak' => ['description' => 'Peak volume.', 'type' => 'string', 'example' => '-1', 'title' => ''], 'LoudnessRangeTarget' => ['description' => 'Volume range.', 'type' => 'string', 'example' => '8', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'Container' => [ 'title' => '', 'description' => 'Container format settings.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'Container format.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'example' => '', ], 'MuxConfig' => [ 'title' => '', 'description' => 'Muxing settings.', 'type' => 'object', 'properties' => [ 'Segment' => [ 'title' => '', 'description' => 'Segmentation settings.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'Segment length.', 'type' => 'string', 'example' => '10', 'title' => ''], 'ForceSegTime' => ['description' => 'Forced segmentation time points.', 'type' => 'string', 'example' => '2,3', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'TransConfig' => [ 'description' => 'Conditional transcoding parameters.', 'type' => 'object', 'properties' => [ 'TransMode' => ['description' => 'Video transcoding mode. Valid values:'."\n" ."\n" .'- onepass: generally used for ABR. Faster encoding than twopass.'."\n" ."\n" .'- twopass: generally used for VBR. Slower encoding than onepass.'."\n" ."\n" .'- CBR: constant bitrate mode.'."\n" ."\n" .'Default value: onepass.', 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Whether to check video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. IsCheckResoFail takes precedence.'."\n" ."\n" .'- true: Check. If the input video resolution (width or height) is smaller than the output setting, transcode using the input video resolution.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Whether to check video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. This parameter takes precedence.'."\n" ."\n" .'- true: Check. If the input video resolution (width or height) is smaller than the output setting, return a transcoding failure.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Whether to check video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. IsCheckVideoBitrateFail takes precedence.'."\n" ."\n" .'- true: Check. If the input video bitrate is lower than the output setting, transcode using the input video bitrate.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Whether to check video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. This parameter takes precedence.'."\n" ."\n" .'- true: Check. If the input video bitrate is lower than the output setting, return a transcoding failure.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckAudioBitrate' => ['description' => 'Whether to check audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. IsCheckAudioBitrateFail takes precedence.'."\n" ."\n" .'- true: Check. If the input audio bitrate is lower than the output setting, transcode using the input audio bitrate.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value:'."\n" ."\n" .'- If this parameter is empty and the codec differs from the input source: false.'."\n" ."\n" .'- If this parameter is empty and the codec matches the input source: true.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Whether to check audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. This parameter takes precedence.'."\n" ."\n" .'- true: Check. If the input audio bitrate is lower than the output setting, return a transcoding failure.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'AdjDarMethod' => ['description' => 'Resolution adjustment method. This parameter takes effect only when both Width and Height are specified. It can be used together with LongShortMode.'."\n" ."\n" .'Valid values: rescale, crop, pad, none.'."\n" ."\n" .'Default value: none.'."\n" ."\n" .'Example: See how to set resolution.', 'type' => 'string', 'example' => 'none', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Tags' => [ 'type' => 'object', 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'ImageWatermarks' => [ 'title' => '', 'description' => 'Image watermark configuration.', 'type' => 'array', 'items' => [ 'description' => 'Image watermark configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'Width.', 'type' => 'string', 'example' => '32', 'title' => ''], 'Height' => ['description' => 'The height of the image watermark.', 'type' => 'string', 'example' => '32', 'title' => ''], 'Dx' => ['description' => 'Watermark position, x.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Dy' => ['description' => 'Watermark position, y.', 'type' => 'string', 'example' => '10', 'title' => ''], 'ReferPos' => ['description' => 'Reference position: TopLeft, TopRight, BottomLeft, BottomRight.
'."\n" .'Default value: TopLeft.
', 'type' => 'string', 'example' => 'TopLeft', 'title' => ''], 'Timeline' => [ 'title' => '', 'description' => 'Display time settings.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'Start time.', 'type' => 'string', 'example' => '00:00:05', 'title' => ''], 'Duration' => ['description' => 'Display duration in seconds or "ToEND".', 'type' => 'string', 'example' => 'ToEND', 'title' => ''], ], 'example' => '', ], 'File' => [ 'title' => '', 'description' => 'Watermark image file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TextWatermarks' => [ 'title' => '', 'description' => 'Text watermark configuration.', 'type' => 'array', 'items' => [ 'description' => 'Text watermark configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Watermark text. Do not Base64 encode. The string must be UTF-8 encoded.', 'type' => 'string', 'example' => 'Test watermark', 'title' => ''], 'FontName' => ['description' => 'Font.', 'type' => 'string', 'example' => 'SimSun', 'title' => ''], 'FontColor' => ['description' => 'Color.', 'type' => 'string', 'example' => '#006400', 'title' => ''], 'FontAlpha' => ['description' => 'Transparency.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'Top' => ['description' => 'Watermark position, distance from the top.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Left' => ['description' => 'Watermark position, distance from the left.', 'type' => 'string', 'example' => '10', 'title' => ''], 'FontSize' => ['description' => 'Font size.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], 'BorderWidth' => ['description' => 'Border width.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'BorderColor' => ['description' => 'Border color.', 'type' => 'string', 'example' => '#006400', 'title' => ''], 'Adaptive' => ['description' => 'Adjust font size based on output video size. Valid values: true / false. Default: false.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Subtitles' => [ 'title' => '', 'description' => 'Subtitle embedding configuration.', 'type' => 'array', 'items' => [ 'description' => 'Subtitle embedding configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'Subtitle file format.', 'type' => 'string', 'example' => 'vtt', 'title' => ''], 'CharEnc' => ['description' => 'File encoding format.', 'type' => 'string', 'example' => 'UTF-8', 'title' => ''], 'File' => [ 'title' => '', 'description' => 'Subtitle file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Encryption' => [ 'title' => '', 'description' => 'Encryption configuration.', 'type' => 'object', 'properties' => [ 'EncryptType' => ['description' => 'Encryption type.', 'type' => 'string', 'example' => 'PrivateEncryption', 'title' => ''], 'CipherText' => ['description' => 'Ciphertext of the encryption key for standard encryption.', 'type' => 'string', 'example' => 'MTYi00NDU0LTg5O****', 'title' => ''], 'DecryptKeyUri' => ['description' => 'Decryption service endpoint for standard encryption.', 'type' => 'string', 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', 'title' => ''], 'KeyServiceType' => ['description' => 'Key service type. Only KMS and Base64 are supported.', 'type' => 'string', 'example' => 'KMS', 'title' => ''], ], 'example' => '', ], 'CombineConfigs' => [ 'title' => '', 'description' => 'Multi-input merging configuration', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AudioIndex' => ['description' => 'Audio stream index', 'type' => 'string', 'required' => true, 'example' => '0 or exclude', 'title' => ''], 'VideoIndex' => ['description' => 'Video stream index', 'type' => 'string', 'required' => true, 'example' => '0 or exclude', 'title' => ''], 'Start' => ['description' => 'Start time of the input stream. Default: 0', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], 'Duration' => ['description' => 'Duration of the input stream. Default: video duration.', 'type' => 'number', 'format' => 'double', 'example' => '20.0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'IsInheritTags' => ['description' => 'Whether to inherit tags from the input stream.'."\n" .'This parameter does not take effect if the input is not a media asset.'."\n" .'Default value: false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], 'Output' => [ 'title' => '', 'description' => 'Output media configuration.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], 'OutputUrl' => ['description' => 'Transcoded stream URL. Specify this parameter only when outputting to a media stream.', 'type' => 'string', 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4'."\n", 'title' => ''], ], 'example' => '', ], 'UserData' => ['description' => 'User data.', 'type' => 'string', 'example' => 'user-data', 'title' => ''], 'ScheduleConfig' => [ 'title' => '', 'description' => 'Job scheduling information.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'Pipeline ID.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => ''], 'Priority' => ['description' => 'Job priority. Higher numbers indicate higher priority. Valid range: 1–10.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'example' => '', ], 'Status' => ['description' => 'Transcoding job status'."\n" ."\n" .'- Init: Submitted.'."\n" ."\n" .'- Processing: Transcoding.'."\n" ."\n" .'- Success: Transcoding succeeded.'."\n" ."\n" .'- Fail: Transcoding failed.'."\n" ."\n" .'- Deleted: Deleted.', 'type' => 'string', 'example' => 'Init', 'title' => ''], 'OutFileMeta' => [ 'title' => '', 'description' => 'Generated video media information.', 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'Basic file information.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'Media asset ID.', 'type' => 'string', 'title' => '', 'example' => '486c2890096871edba6f81848c016303'], 'FileName' => ['description' => 'File name.', 'type' => 'string', 'example' => 'file.m3u8', 'title' => ''], 'FileStatus' => ['description' => 'File status.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'FileType' => ['description' => 'File type. Valid values: source\\_file, transcode\\_file', 'type' => 'string', 'example' => 'source_file', 'title' => ''], 'FileSize' => ['description' => 'File size. Unit: Byte.', 'type' => 'string', 'example' => '31737', 'title' => ''], 'FileUrl' => ['description' => 'File URL.', 'type' => 'string', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', 'title' => ''], 'Region' => ['description' => 'File region.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'FormatName' => ['description' => 'Video format name.', 'type' => 'string', 'example' => 'hls,applehttp', 'title' => ''], 'Duration' => ['description' => 'Video duration (unit: seconds).', 'type' => 'string', 'example' => '403.039999', 'title' => ''], 'Bitrate' => ['description' => 'Video bitrate.', 'type' => 'string', 'example' => '888.563', 'title' => ''], 'Width' => ['description' => 'Width.', 'type' => 'string', 'example' => '848', 'title' => ''], 'Height' => ['description' => 'Height.', 'type' => 'string', 'example' => '478', 'title' => ''], ], 'example' => '', ], 'AudioStreamInfoList' => [ 'title' => '', 'description' => 'Audio stream information.', 'type' => 'array', 'items' => [ 'description' => 'Audio stream information.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Stream index.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CodecName' => ['description' => 'Encoding format.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'CodecLongName' => ['description' => 'Encoding format name.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'CodecTimeBase' => ['description' => 'Codec time base.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'CodecTagString' => ['description' => 'Codec tag name.', 'type' => 'string', 'example' => '[15][0][0][0]', 'title' => ''], 'CodecTag' => ['description' => 'Codec tag.', 'type' => 'string', 'example' => '0x000f', 'title' => ''], 'SampleFmt' => ['description' => 'Sample format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'SampleRate' => ['description' => 'Sample rate (unit: Hz).', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Channels' => ['description' => 'Number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'ChannelLayout' => ['description' => 'Channel layout.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], 'Timebase' => ['description' => 'Time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], 'Duration' => ['description' => 'Duration (unit: seconds).', 'type' => 'string', 'example' => '403.039989', 'title' => ''], 'Bitrate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '0.f', 'title' => ''], 'Lang' => ['description' => 'Language.', 'type' => 'string', 'example' => 'cn', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoStreamInfoList' => [ 'title' => '', 'description' => 'Video stream information.', 'type' => 'array', 'items' => [ 'description' => 'Video stream information.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Stream index.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Codec_name' => ['description' => 'Encoding format.', 'type' => 'string', 'example' => 'h264', 'title' => ''], 'Codec_long_name' => ['description' => 'Encoding format name.', 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'title' => ''], 'Profile' => ['description' => 'Encoder preset.', 'type' => 'string', 'example' => 'High', 'title' => ''], 'Codec_time_base' => ['description' => 'Codec time base.', 'type' => 'string', 'example' => '1/50', 'title' => ''], 'Codec_tag_string' => ['description' => 'Codec tag string.', 'type' => 'string', 'example' => '[27][0][0][0]', 'title' => ''], 'Codec_tag' => ['description' => 'Codec tag.', 'type' => 'string', 'example' => '0x001b', 'title' => ''], 'Width' => ['description' => 'Width.', 'type' => 'string', 'example' => '848', 'title' => ''], 'Height' => ['description' => 'Height.', 'type' => 'string', 'example' => '478', 'title' => ''], 'Has_b_frames' => ['description' => 'Whether B-frames exist.'."\n" .'Valid values:'."\n" ."\n" .'- 0: No B-frames,'."\n" ."\n" .'- 1: One B-frame,'."\n" ."\n" .'- 2: Multiple consecutive B-frames.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Sar' => ['description' => 'Sample aspect ratio.', 'type' => 'string', 'example' => '478:477', 'title' => ''], 'Dar' => ['description' => 'Display aspect ratio.', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'PixFmt' => ['description' => 'Color storage format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Level' => ['description' => 'Encoding level.', 'type' => 'string', 'example' => '31', 'title' => ''], 'Fps' => ['description' => 'Frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Avg_fps' => ['description' => 'Average frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Time_base' => ['description' => 'Time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], 'Start_time' => ['description' => 'Start time.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], 'Duration' => ['description' => 'Duration (unit: seconds).', 'type' => 'string', 'example' => '403.039989', 'title' => ''], 'Bit_rate' => ['description' => 'Bitrate.', 'type' => 'string', 'example' => '888.563', 'title' => ''], 'NumFrames' => ['description' => 'Total number of frames.', 'type' => 'string', 'example' => '10040', 'title' => ''], 'Lang' => ['description' => 'Language.', 'type' => 'string', 'example' => 'cn', 'title' => ''], 'Rotate' => ['description' => 'Video rotation angle.'."\n" .'Valid values: 0, 90, 180, 270.'."\n" .'Default value: 0', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'SubmitResultJson' => ['description' => 'Job submission result.', 'type' => 'object', 'example' => '{}', 'title' => ''], 'SubmitTime' => ['description' => 'Job submission time.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'FinishTime' => ['description' => 'Job completion time.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'RequestId' => ['description' => 'Request ID at job submission.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'Job creation time. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'Name' => ['description' => 'Job name.', 'type' => 'string', 'example' => 'transcode-job', 'title' => ''], 'RequestId' => ['description' => 'Request ID at job submission.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], 'ParentJobId' => ['description' => 'Parent job ID.', 'type' => 'string', 'example' => '8b2198504dd340b7b3c9842a74fc9baa', 'title' => ''], 'JobCount' => ['description' => 'Number of sub-jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Status' => ['description' => 'Job status.'."\n" ."\n" .'- Success: All sub-jobs completed successfully.'."\n" ."\n" .'- Fail: All sub-jobs failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'TriggerSource' => ['description' => 'Job source.'."\n" ."\n" .'- API: API'."\n" ."\n" .'- WorkFlow: Workflow'."\n" ."\n" .'- Console: Console', 'type' => 'string', 'example' => 'API', 'title' => ''], 'Percent' => ['description' => 'Job completion percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'SubmitTime' => ['description' => 'Job submission time. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'FinishTime' => ['description' => 'Job completion time. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'InputGroup' => [ 'title' => '', 'description' => 'Job input group. A single input represents a transcoding job. Multiple inputs represent an audio-video merging job.', 'type' => 'array', 'items' => [ 'description' => 'Job input.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'OutputGroup' => [ 'title' => '', 'description' => 'Job output group.', 'type' => 'array', 'items' => [ 'description' => 'Job output.', 'type' => 'object', 'properties' => [ 'Output' => [ 'title' => '', 'description' => 'Output media configuration.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], 'OutputUrl' => ['description' => 'Output stream URL.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4'."\n", 'title' => ''], ], 'example' => '', ], 'ProcessConfig' => [ 'title' => '', 'description' => 'Job processing configuration.', 'type' => 'object', 'properties' => [ 'Transcode' => [ 'title' => '', 'description' => 'Transcoding configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Video' => [ 'title' => '', 'description' => 'Video settings.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'Encoding format.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Profile' => ['description' => 'Encoding profile.'."\n" .'Supported values: baseline, main, high.'."\n" ."\n" .'- baseline: for mobile devices.'."\n" ."\n" .'- main: for standard-resolution devices.'."\n" ."\n" .'- high: for high-resolution devices.'."\n" ."\n" .'Default value: high.', 'type' => 'string', 'example' => 'Main', 'title' => ''], 'Bitrate' => ['description' => 'Video average bitrate.'."\n" ."\n" .'- Valid range: \\[10, 50000].'."\n" ."\n" .'- Unit: Kbps.', 'type' => 'string', 'example' => '3000', 'title' => ''], 'Crf' => ['description' => 'Bitrate-quality control factor.'."\n" ."\n" .'- Valid range: \\[0, 51].'."\n" ."\n" .'- Default value: 23 for H.264, 26 for H.265.'."\n" ."\n" .'- If Crf is set, the Bitrate setting is ignored.', 'type' => 'string', 'example' => '23', 'title' => ''], 'Width' => ['description' => 'Width.'."\n" ."\n" .'- Valid range: \\[128, 4096].'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'- Default value: original video width.', 'type' => 'string', 'example' => '1920', 'title' => ''], 'Height' => ['description' => 'Height.'."\n" ."\n" .'- Valid range: \\[128, 4096].'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'- Default value: original video height.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'Fps' => ['description' => 'Frame rate.'."\n" ."\n" .'- Valid range: (0, 60].'."\n" ."\n" .'- If the input file frame rate exceeds 60, use 60.'."\n" ."\n" .'- Default value: input file frame rate.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Gop' => ['description' => 'Maximum number of frames between keyframes.'."\n" ."\n" .'- Valid range: \\[1, 1080000].'."\n" ."\n" .'- Default value: 250.', 'type' => 'string', 'example' => '250', 'title' => ''], 'Preset' => ['description' => 'Video encoder preset. This parameter is supported only for H.264.'."\n" .'Supported values: veryfast, fast, medium, slow, slower.'."\n" .'Default value: medium.', 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'Scan mode.'."\n" .'Supported values: interlaced, progressive.', 'type' => 'string', 'example' => 'progressive', 'title' => ''], 'PixFmt' => ['description' => 'Video color format.'."\n" .'Valid values: yuv420p, yuvj420p, and other standard color formats.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Remove' => ['description' => 'Whether to remove the video.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Crop' => ['description' => 'Video cropping.'."\n" .'Two methods are supported.'."\n" .'Automatically detect and crop black bars by setting this parameter to "border".'."\n" .'Custom cropping in the format: width:height:left:top.'."\n" .'Example: 1280:800:0:140', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Pad' => ['description' => 'Black bar padding parameters'."\n" ."\n" .'- Format: width:height:left:top.'."\n" ."\n" .'- Example: 1280:800:0:140', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'LongShortMode' => ['description' => 'Whether to enable automatic rotation (long-short edge mode).', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Bufsize' => ['description' => 'Buffer size'."\n" ."\n" .'- Valid range: \\[1000, 128000]'."\n" ."\n" .'- Default value: 6000'."\n" ."\n" .'- Unit: Kb', 'type' => 'string', 'example' => '6000', 'title' => ''], 'Maxrate' => ['description' => 'Peak video bitrate'."\n" ."\n" .'- Valid range: \\[10, 50000]'."\n" ."\n" .'- Unit: Kbps.', 'type' => 'string', 'example' => '9000', 'title' => ''], 'AbrMax' => ['description' => 'Maximum ABR bitrate (valid only for narrow-high 1)'."\n" ."\n" .'- Valid range: \\[10, 50000],'."\n" ."\n" .'- Unit: Kbps.', 'type' => 'string', 'example' => '6000', 'title' => ''], ], 'example' => '', ], 'Audio' => [ 'title' => '', 'description' => 'Audio settings.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'Audio codec format: AAC, MP3, VORBIS, FLAC.'."\n" .'Default value: AAC', 'type' => 'string', 'example' => 'AAC', 'title' => ''], 'Profile' => ['description' => 'Audio encoding preset.'."\n" .'When Codec is AAC, valid values are aac\\_low, aac\\_he, aac\\_he\\_v2, aac\\_ld, aac\\_eld.', 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Samplerate' => ['description' => 'Sample rate.'."\n" ."\n" .'- Default value: 44100'."\n" ."\n" .'- Supported values: 22050, 32000, 44100, 48000, 96000,'."\n" ."\n" .'- Unit: Hz', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Bitrate' => ['description' => 'Audio bitrate of the output file.'."\n" ."\n" .'- Valid range: \\[8, 1000]'."\n" ."\n" .'- Unit: Kbps'."\n" ."\n" .'- Default value: 128', 'type' => 'string', 'example' => '128', 'title' => ''], 'Channels' => ['description' => 'Number of sound channels.'."\n" .'Default value: 2', 'type' => 'string', 'example' => '2', 'title' => ''], 'Remove' => ['description' => 'Whether to remove the audio stream.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Volume' => [ 'title' => '', 'description' => 'Volume control.', 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'Volume adjustment method.', 'type' => 'string', 'example' => 'auto', 'title' => ''], 'IntegratedLoudnessTarget' => ['description' => 'Target volume.', 'type' => 'string', 'example' => '-6', 'title' => ''], 'TruePeak' => ['description' => 'Peak volume.', 'type' => 'string', 'example' => '-1', 'title' => ''], 'LoudnessRangeTarget' => ['description' => 'Volume range.', 'type' => 'string', 'example' => '8', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'Container' => [ 'title' => '', 'description' => 'Container format settings.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'Container format.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'example' => '', ], 'MuxConfig' => [ 'title' => '', 'description' => 'Muxing settings.', 'type' => 'object', 'properties' => [ 'Segment' => [ 'title' => '', 'description' => 'Segmentation settings.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'Segment length.', 'type' => 'string', 'example' => '10', 'title' => ''], 'ForceSegTime' => ['description' => 'Forced segmentation time points.', 'type' => 'string', 'example' => '2,3', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'TransConfig' => [ 'description' => 'Conditional transcoding parameters.', 'type' => 'object', 'properties' => [ 'TransMode' => ['description' => 'Video transcoding mode. Valid values:'."\n" ."\n" .'- onepass: generally used for ABR. Faster encoding than twopass.'."\n" ."\n" .'- twopass: generally used for VBR. Slower encoding than onepass.'."\n" ."\n" .'- CBR: constant bitrate mode.'."\n" ."\n" .'Default value: onepass.', 'type' => 'string', 'example' => 'onepass', 'title' => ''], 'IsCheckReso' => ['description' => 'Whether to check video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. IsCheckResoFail takes precedence.'."\n" ."\n" .'- true: Check. If the input video resolution (width or height) is smaller than the output setting, transcode using the input video resolution.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckResoFail' => ['description' => 'Whether to check video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. This parameter takes precedence.'."\n" ."\n" .'- true: Check. If the input video resolution (width or height) is smaller than the output setting, return a transcoding failure.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckVideoBitrate' => ['description' => 'Whether to check video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. IsCheckVideoBitrateFail takes precedence.'."\n" ."\n" .'- true: Check. If the input video bitrate is lower than the output setting, transcode using the input video bitrate.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckVideoBitrateFail' => ['description' => 'Whether to check video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. This parameter takes precedence.'."\n" ."\n" .'- true: Check. If the input video bitrate is lower than the output setting, return a transcoding failure.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckAudioBitrate' => ['description' => 'Whether to check audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. IsCheckAudioBitrateFail takes precedence.'."\n" ."\n" .'- true: Check. If the input audio bitrate is lower than the output setting, transcode using the input audio bitrate.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value:'."\n" ."\n" .'- If this parameter is empty and the codec differs from the input source: false.'."\n" ."\n" .'- If this parameter is empty and the codec matches the input source: true.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsCheckAudioBitrateFail' => ['description' => 'Whether to check audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. This parameter takes precedence.'."\n" ."\n" .'- true: Check. If the input audio bitrate is lower than the output setting, return a transcoding failure.'."\n" ."\n" .'- false: Do not check.'."\n" ."\n" .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'AdjDarMethod' => ['description' => 'Resolution adjustment method. This parameter takes effect only when both Width and Height are specified. It can be used together with LongShortMode.'."\n" ."\n" .'Valid values: rescale, crop, pad, none.'."\n" ."\n" .'Default value: none.', 'type' => 'string', 'example' => 'none', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'ImageWatermarks' => [ 'title' => '', 'description' => 'Image watermark configuration.', 'type' => 'array', 'items' => [ 'description' => 'Image watermark configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'Width.', 'type' => 'string', 'example' => '32', 'title' => ''], 'Height' => ['description' => 'Height.', 'type' => 'string', 'example' => '32', 'title' => ''], 'Dx' => ['description' => 'Watermark position, x.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Dy' => ['description' => 'Watermark position, y.', 'type' => 'string', 'example' => '10', 'title' => ''], 'ReferPos' => ['description' => 'Reference position: TopLeft, TopRight, BottomLeft, BottomRight. Default: TopLeft.', 'type' => 'string', 'example' => 'TopLeft', 'title' => ''], 'Timeline' => [ 'title' => '', 'description' => 'Display time settings.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'Start time.', 'type' => 'string', 'example' => '00:00:05', 'title' => ''], 'Duration' => ['description' => 'Display duration in seconds or "ToEND".', 'type' => 'string', 'example' => 'ToEND', 'title' => ''], ], 'example' => '', ], 'File' => [ 'title' => '', 'description' => 'Watermark image file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TextWatermarks' => [ 'title' => '', 'description' => 'Text watermark configuration.', 'type' => 'array', 'items' => [ 'description' => 'Text watermark configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Watermark text. Do not Base64 encode. The string must be UTF-8 encoded.', 'type' => 'string', 'example' => 'test watermark', 'title' => ''], 'FontName' => ['description' => 'Font.', 'type' => 'string', 'example' => 'SimSun', 'title' => ''], 'FontColor' => ['description' => 'Color.', 'type' => 'string', 'example' => '#006400', 'title' => ''], 'FontAlpha' => ['description' => 'Transparency.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'Top' => ['description' => 'Watermark position, distance from the top.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Left' => ['description' => 'Watermark position, distance from the left.', 'type' => 'string', 'example' => '10', 'title' => ''], 'FontSize' => ['description' => 'Font size.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], 'BorderWidth' => ['description' => 'Border width.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'BorderColor' => ['description' => 'Border color.', 'type' => 'string', 'example' => '#006400', 'title' => ''], 'Adaptive' => ['description' => 'Adjust font size based on output video size. Valid values: true / false. Default: false.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Subtitles' => [ 'title' => '', 'description' => 'Subtitle embedding configuration.', 'type' => 'array', 'items' => [ 'description' => 'Subtitle embedding configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'Override parameters. If specified, these parameters override the corresponding template parameters.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'Subtitle file format.', 'type' => 'string', 'example' => 'vtt', 'title' => ''], 'CharEnc' => ['description' => 'File encoding format.', 'type' => 'string', 'example' => 'UTF-8', 'title' => ''], 'File' => [ 'title' => '', 'description' => 'Subtitle file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Media object type.'."\n" .'Valid values:'."\n" ."\n" .'- OSS: OSS file.'."\n" ."\n" .'- Media: Media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Media value:'."\n" ."\n" .'- If Type is OSS, this field is a URL that supports OSS and HTTP protocols.'."\n" ."\n" .'- If Type is Media, this field is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Encryption' => [ 'title' => '', 'description' => 'Encryption configuration.', 'type' => 'object', 'properties' => [ 'EncryptType' => ['description' => 'Encryption type.', 'type' => 'string', 'example' => 'PrivateEncryption', 'title' => ''], 'CipherText' => ['description' => 'Ciphertext of the encryption key for standard encryption.', 'type' => 'string', 'example' => 'MTYi00NDU0LTg5O****', 'title' => ''], 'DecryptKeyUri' => ['description' => 'Decryption service endpoint for standard encryption.', 'type' => 'string', 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', 'title' => ''], 'KeyServiceType' => ['description' => 'Key service type. Only KMS and Base64 are supported.', 'type' => 'string', 'example' => 'KMS', 'title' => ''], ], 'example' => '', ], 'CombineConfigs' => [ 'title' => '', 'description' => 'Multi-input merging configuration', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AudioIndex' => ['description' => 'Audio stream index', 'type' => 'string', 'required' => true, 'example' => '0 or exclude', 'title' => ''], 'VideoIndex' => ['description' => 'Video stream index', 'type' => 'string', 'required' => true, 'example' => '0 or exclude', 'title' => ''], 'Start' => ['description' => 'Start time of the input stream. Default: 0', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], 'Duration' => ['description' => 'Duration of the input stream. Default: video duration.', 'type' => 'number', 'format' => 'double', 'example' => '20.0', 'title' => ''], ], 'description' => 'Multi-input merging configuration', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'UserData' => ['description' => 'User data.', 'type' => 'string', 'example' => 'user-data', 'title' => ''], 'ScheduleConfig' => [ 'title' => '', 'description' => 'Job scheduling configuration.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'Pipeline ID.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => ''], 'Priority' => ['description' => 'Job priority. Higher numbers indicate higher priority. Valid range: 1–10.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9EDC30DC-0050-5459-B788-F761B2BE359B\\",\\n \\"TranscodeParentJob\\": {\\n \\"TranscodeJobList\\": [\\n {\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc9baa\\",\\n \\"JobId\\": \\"7d6a7e0d4db2457a8d45ff5d43e1bf0a\\",\\n \\"JobIndex\\": 0,\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"InputUrl\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n ],\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"none\\"\\n },\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"Test watermark\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\",\\n \\"KeyServiceType\\": \\"KMS\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 or exclude\\",\\n \\"VideoIndex\\": \\"0 or exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ],\\n \\"IsInheritTags\\": true\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"OutputUrl\\": \\"oss://bucket/path/to/{MediaId}/{JobId}.mp4\\\\n\\"\\n },\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"OutFileMeta\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"486c2890096871edba6f81848c016303\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"cn\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitResultJson\\": {},\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc9baa\\",\\n \\"JobCount\\": 1,\\n \\"Status\\": \\"Success\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Percent\\": 0,\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n ],\\n \\"OutputGroup\\": [\\n {\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"OutputUrl\\": \\"oss://bucket/path/to/video.mp4\\\\n\\"\\n },\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"none\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"test watermark\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\",\\n \\"KeyServiceType\\": \\"KMS\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 or exclude\\",\\n \\"VideoIndex\\": \\"0 or exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ]\\n }\\n }\\n ],\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n }\\n }\\n}","type":"json"}]', 'title' => 'GetTranscodeJob', 'summary' => 'Queries the details of a single transcoding job.', 'description' => ''."\n" ."\n" .'This API is deprecated. Call [GetMediaConvertJob – Query media transcoding jobs](~~2867675~~) instead.'."\n" ."\n" .'', 'changeSet' => [ ['createdAt' => '2023-06-06T03:31:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-18T06:21:49.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-15T10:04:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-09-20T09:39:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-20T08:45:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-19T09:22:38.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-19T08:08:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTranscodeJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetTranscodeJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetUrlUploadInfos' => [ 'summary' => 'Queries the information about URL-based upload jobs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the upload jobs. You can specify one or more job IDs. You can obtain the job IDs from the response parameter JobId of the [UploadMediaByURL](~~86311~~) operation.'."\n" ."\n" .'- You can specify a maximum of 10 job IDs.'."\n" ."\n" .'- Separate the job IDs with commas (,).'."\n" ."\n" .'> You must specify either JobIds or UploadURLs. If you specify both parameters, only the value of JobIds takes effect.', 'type' => 'string', 'required' => false, 'example' => 'df2ac80b481346daa1db6a7c40edc7f8', 'title' => ''], ], [ 'name' => 'UploadURLs', 'in' => 'query', 'schema' => ['description' => 'The upload URLs of the source files. You can specify a maximum of 10 URLs. Separate the URLs with commas (,).'."\n" ."\n" .'>'."\n" ."\n" .'- The URLs must be encoded.'."\n" ."\n" .'- If a media file is uploaded multiple times, we recommend that you specify the URL of the media file only once in this parameter.'."\n" ."\n" .'- You must specify either JobIds or UploadURLs. If you specify both parameters, only the value of JobIds takes effect.', 'type' => 'string', 'required' => false, 'example' => 'https://media.w3.org/2010/05/sintel/trailer.mp4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'NonExists' => [ 'description' => 'The job IDs or upload URLs that do not exist.', 'type' => 'array', 'items' => ['description' => 'The job ID or upload URL that does not exist.'."\n" ."\n" .'Job IDs are returned for this parameter if you have specified JobIds in the request, and upload URLs are returned if you have specified UploadURLs in the request.', 'type' => 'string', 'example' => '[\'e3e71ae8e4a46e4893d8cadce50c3bd0\']', 'title' => ''], 'title' => '', 'example' => '', ], 'URLUploadInfoList' => [ 'description' => 'The details about URL-based upload jobs.', 'type' => 'array', 'items' => [ 'description' => 'The information about the URL-based upload job. For more information, see the "URLUploadInfo: the information about a URL-based upload job" section of the "Basic data types" topic.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the upload job was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-11-07T10:03:37Z', 'title' => ''], 'Status' => ['description' => 'The status of the upload job. For more information about the valid values of the parameter, see the "Status: the status of a URL-based upload job" section of the [Basic data types](~~52839~~) topic.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned if the upload job failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the upload job failed.', 'type' => 'string', 'example' => '200', 'title' => ''], 'CompleteTime' => ['description' => 'The time when the upload job was complete. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-11-26 21:47:37', 'title' => ''], 'JobId' => ['description' => 'The ID of the upload job.', 'type' => 'string', 'example' => '3829500c0fef429fa4ec1680b122d***', 'title' => ''], 'UserData' => ['description' => 'The user data. The value is a JSON string.', 'type' => 'string', 'example' => '{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}', 'title' => ''], 'UploadURL' => ['description' => 'The upload URL of the source file.'."\n" ."\n" .'> A maximum of 100 URLs can be returned.', 'type' => 'string', 'example' => 'http://****.mp4', 'title' => ''], 'MediaId' => ['description' => 'The ID of the uploaded media file.', 'type' => 'string', 'example' => '5014ca70f08171ecbf940764a0fd6***', 'title' => ''], 'FileSize' => ['description' => 'The file size. Unit: bytes.', 'type' => 'string', 'example' => '64610', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'GetUrlUploadInfos', 'description' => 'Query the information, including the upload status, user data, creation time, and completion time, about URL-based upload jobs based on the returned job IDs or the URLs used during the upload.'."\n" ."\n" .'If an upload job fails, you can view the error code and error message. If an upload job is successful, you can obtain the video ID.', 'changeSet' => [ ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUrlUploadInfos'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetUrlUploadInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"NonExists\\": [\\n \\"[\'e3e71ae8e4a46e4893d8cadce50c3bd0\']\\"\\n ],\\n \\"URLUploadInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2021-11-07T10:03:37Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"CompleteTime\\": \\"2021-11-26 21:47:37\\",\\n \\"JobId\\": \\"3829500c0fef429fa4ec1680b122d***\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":\\\\\\"{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"}\\\\\\", \\\\\\"Extend\\\\\\":\\\\\\"{\\\\\\"localId\\\\\\":\\\\\\"***\\\\\\", \\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}\\\\\\"}\\",\\n \\"UploadURL\\": \\"http://****.mp4\\",\\n \\"MediaId\\": \\"5014ca70f08171ecbf940764a0fd6***\\",\\n \\"FileSize\\": \\"64610\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetVideoList' => [ 'summary' => 'Gets information about video and audio files.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'CateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '781111', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the video. You can specify multiple video statuses and separate them with commas (,).'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- PrepareFail: The file is abnormal.'."\n" ."\n" .'- UploadFail: The video failed to be uploaded.'."\n" ."\n" .'- UploadSucc: The video is uploaded.'."\n" ."\n" .'- Transcoding: The video is being transcoded.'."\n" ."\n" .'- TranscodeFail: The video failed to be transcoded.'."\n" ."\n" .'- ProduceFail: The video failed to be produced.'."\n" ."\n" .'- Normal: The video is normal.'."\n" ."\n" .'- Uploading: The video is being uploaded.'."\n" ."\n" .'- Preparing: The file is being generated.'."\n" ."\n" .'- Blocked: The video is blocked.'."\n" ."\n" .'- checking: The video is being reviewed.', 'enumValueTitles' => [ 'PrepareFail' => '', 'UploadFail' => '', 'UploadSucc' => '', 'Transcoding' => '', 'TranscodeFail' => '', 'ProduceFail' => '', 'Normal' => '', 'Uploading' => '', 'Preparing' => '', 'Blocked' => '', 'Checking' => '', ], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Uploading,Normal', ], ], [ 'name' => 'StartTime', '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.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2017-01-11T12:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2017-01-11T12:59:00Z'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting method of the results. Valid values:'."\n" ."\n" .'- CreationTime:Desc (default): sorts results in reverse chronological order.'."\n" ."\n" .'- CreationTime:Asc: sorts results in chronological order.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CreationTime:Asc'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Total' => ['description' => 'The total number of audio and video files that meet the conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '163', 'title' => ''], 'MediaList' => [ 'description' => 'The information about the audio and video files.', 'type' => 'array', 'items' => [ 'description' => 'The information about the audio or video file.', 'type' => 'object', 'properties' => [ 'StorageLocation' => ['description' => 'The storage address.', 'type' => 'string', 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', 'title' => ''], 'Status' => [ 'description' => 'The status of the video.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- PrepareFail: The file is abnormal.'."\n" ."\n" .'- UploadFail: The video failed to be uploaded.'."\n" ."\n" .'- UploadSucc: The video is uploaded.'."\n" ."\n" .'- Transcoding: The video is being transcoded.'."\n" ."\n" .'- TranscodeFail: The video failed to be transcoded.'."\n" ."\n" .'- ProduceFail: The video failed to be produced.'."\n" ."\n" .'- Normal: The video is normal.'."\n" ."\n" .'- Uploading: The video is being uploaded.'."\n" ."\n" .'- Preparing: The file is being generated.'."\n" ."\n" .'- Blocked: The video is blocked.'."\n" ."\n" .'- checking: The video is being reviewed.', 'enumValueTitles' => [ 'PrepareFail' => '', 'UploadFail' => '', 'UploadSucc' => '', 'Transcoding' => '', 'TranscodeFail' => '', 'ProduceFail' => '', 'Normal' => '', 'Uploading' => '', 'Preparing' => '', 'Blocked' => '', 'Checking' => '', ], 'type' => 'string', 'example' => 'Normal', 'title' => '', ], 'CreationTime' => ['description' => 'The time when the audio or video file was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2017-11-14T09:15:50Z', 'title' => ''], 'CateId' => ['description' => 'The ID of the category.', 'type' => 'integer', 'format' => 'int64', 'example' => '3679', 'title' => ''], 'MediaId' => ['description' => 'The ID of the audio or video file.', 'type' => 'string', 'example' => '1c6ce34007d571ed94667630a6bc****', 'title' => ''], 'Tags' => ['description' => 'The tags of the audio or video file.', 'type' => 'string', 'example' => 'Tag 1, Tag 2', 'title' => ''], 'ModificationTime' => ['description' => 'The time when the audio or video file was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2017-11-14T09:16:50Z', 'title' => ''], 'CateName' => ['description' => 'The name of the category.', 'type' => 'string', 'example' => 'Category1', 'title' => ''], 'Description' => ['description' => 'The description of the audio or video file.', 'type' => 'string', 'example' => 'Alibaba Cloud VOD video description', 'title' => ''], 'AppId' => ['description' => 'The ID of the application. Default value: app-1000000.', 'type' => 'string', 'example' => 'app-1000000', 'title' => ''], 'Size' => ['description' => 'The size of the source file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10897890', 'title' => ''], 'CoverUrl' => ['description' => 'The URL of the thumbnail.', 'type' => 'string', 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', 'title' => ''], 'Duration' => ['description' => 'The duration. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '135.6', 'title' => ''], 'Title' => ['description' => 'The title of the audio or video file.', 'type' => 'string', 'example' => 'The best music player ever', 'title' => ''], 'Snapshots' => [ 'description' => 'The array of video snapshot URLs.', 'type' => 'array', 'items' => ['description' => 'The URL of the video snapshot.', 'type' => 'string', 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Total\\": 163,\\n \\"MediaList\\": [\\n {\\n \\"StorageLocation\\": \\"out-****.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\",\\n \\"CateId\\": 3679,\\n \\"MediaId\\": \\"1c6ce34007d571ed94667630a6bc****\\",\\n \\"Tags\\": \\"Tag 1, Tag 2\\",\\n \\"ModificationTime\\": \\"2017-11-14T09:16:50Z\\",\\n \\"CateName\\": \\"Category1\\",\\n \\"Description\\": \\"Alibaba Cloud VOD video description\\",\\n \\"AppId\\": \\"app-1000000\\",\\n \\"Size\\": 10897890,\\n \\"CoverUrl\\": \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\",\\n \\"Duration\\": 135.6,\\n \\"Title\\": \\"The best music player ever\\",\\n \\"Snapshots\\": [\\n \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetVideoList', 'description' => 'Get information about up to the first 5,000 audio and video files based on the filter condition, such as the status or category ID of the file. We recommend that you set the StartTime and EndTime parameters to narrow down the time range and perform multiple queries to obtain data.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVideoList'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:GetVideoList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetVodPackagingAsset' => [ 'summary' => 'Queries a VOD packaging asset.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'AssetName', 'in' => 'query', 'schema' => ['description' => 'The name of the VOD packaging asset.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '30min_movie'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The result of asset query.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0622C702-41BE-467E-AF2E-883D4517962E'], 'Asset' => [ 'title' => '', 'description' => 'The information about the asset.', 'type' => 'object', 'properties' => [ 'AssetName' => ['description' => 'The name of the asset.', 'type' => 'string', 'title' => '', 'example' => '30min_movie'], 'GroupName' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'example' => 'vod_hls'], 'Input' => [ 'title' => '', 'description' => 'The asset input configurations.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The input type. Only Object Storage Service (OSS) is supported.', 'type' => 'string', 'title' => '', 'example' => 'OSS'], 'Media' => ['description' => 'The URL of the media file. Only M3U8 files stored in OSS are supported.', 'type' => 'string', 'title' => '', 'example' => 'OSS://***test-bucket***/***video/input.m3u8'], ], 'example' => '', ], 'CreateTime' => ['description' => 'The time when the asset was created. It follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2024-11-21T06:45:32Z'], 'EgressEndpoints' => [ 'title' => '', 'description' => 'The egress endpoints, each corresponding to a packaging configuration.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The egress endpoint.', 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'The playback URL. If the asset fails to be packaged, no playback URL is returned.', 'type' => 'string', 'title' => '', 'example' => 'https://y92kpc.**/v1/sy9gtc0w00i0bw2q33q2a4y71oydkofm/cvtcqv3lvrftd68k7f5avfjznvv0tje4/o3cfzi6c3qxo18ascgvnz7974qy3c02o/index.m3u8'], 'Status' => ['description' => 'The asset status. Valid values:'."\n" ."\n" .'- Queuing: The asset is waiting for packaging.'."\n" ."\n" .'- Playable: The asset is packaged and playable.'."\n" ."\n" .'- Failed: The asset fails to be packaged.', 'type' => 'string', 'title' => '', 'example' => 'Playable'], 'ConfigurationName' => ['description' => 'The name of the packaging configuration.', 'type' => 'string', 'title' => '', 'example' => 'hls_3s'], ], 'example' => '', ], 'example' => '', ], 'ContentId' => ['description' => 'The content ID in the DRM system. The maximum length is 256 characters. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'example' => 'movie'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"Asset\\": {\\n \\"AssetName\\": \\"30min_movie\\",\\n \\"GroupName\\": \\"vod_hls\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"OSS://***test-bucket***/***video/input.m3u8\\"\\n },\\n \\"CreateTime\\": \\"2024-11-21T06:45:32Z\\",\\n \\"EgressEndpoints\\": [\\n {\\n \\"Url\\": \\"https://y92kpc.**/v1/sy9gtc0w00i0bw2q33q2a4y71oydkofm/cvtcqv3lvrftd68k7f5avfjznvv0tje4/o3cfzi6c3qxo18ascgvnz7974qy3c02o/index.m3u8\\",\\n \\"Status\\": \\"Playable\\",\\n \\"ConfigurationName\\": \\"hls_3s\\"\\n }\\n ],\\n \\"ContentId\\": \\"movie\\"\\n }\\n}","type":"json"}]', 'title' => 'GetVodPackagingAsset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetVodPackagingAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetVodPackagingConfiguration' => [ 'summary' => 'Queries a packaging configuration.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'ConfigurationName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hls_3s'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The query result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'PackagingConfiguration' => ['description' => 'The information about the packaging configuration.', '$ref' => '#/components/schemas/VodPackagingConfiguration', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PackagingConfiguration\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ConfigurationName\\": \\"\\",\\n \\"Protocol\\": \\"\\",\\n \\"PackageConfig\\": {\\n \\"ManifestName\\": \\"\\",\\n \\"StreamSelection\\": {\\n \\"MinVideoBitsPerSecond\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitsPerSecond\\": 0\\n },\\n \\"DrmProvider\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n }\\n}","type":"json"}]', 'title' => 'GetVodPackagingConfiguration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetVodPackagingConfiguration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetVodPackagingGroup' => [ 'summary' => 'Queries a VOD packaging group.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group. The name must be unique and can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The query result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'], 'PackagingGroup' => ['description' => 'The information about the packaging group.', '$ref' => '#/components/schemas/VodPackagingGroup', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"PackagingGroup\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DomainName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ApproximateAssetCount\\": 0,\\n \\"ConfigurationCount\\": 0\\n }\\n}","type":"json"}]', 'title' => 'GetVodPackagingGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetVodPackagingGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetWorkflowTask' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'required' => false, 'example' => '******4215e042b3966ca5441e******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******0C-7870-15FE-B96F-8880BB******'], 'WorkflowTask' => [ 'description' => 'The information about the workflow task.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'example' => '******4215e042b3966ca5441e******', 'title' => ''], 'Status' => [ 'description' => 'The task state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Init: The task is being initialized.'."\n" ."\n" .'- Failed: The task failed.'."\n" ."\n" .'- Canceled: The task is canceled.'."\n" ."\n" .'- Processing: The task is in progress.'."\n" ."\n" .'- Succeed: The task is successful.', 'enumValueTitles' => ['Init' => '', 'Failed' => '', 'Canceled' => '', 'Processing' => '', 'Succeed' => ''], 'type' => 'string', 'example' => 'Succeed', 'title' => '', ], 'TaskInput' => ['description' => 'The input of the workflow task.', 'type' => 'string', 'example' => '{'."\n" .' "Type": "Media",'."\n" .' "Media": "******30706071edbfe290b488******"'."\n" .'}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-01-04T02:05:17Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-01-04T02:06:19Z', 'title' => ''], 'Workflow' => [ 'description' => 'The workflow Information.', 'type' => 'object', 'properties' => [ 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => '******63dca94c609de02ac0d1******', 'title' => ''], 'Name' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'Super-resolution transcoding workflow', 'title' => ''], 'Status' => [ 'description' => 'The workflow state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Active'."\n" ."\n" .'- Inactive', 'enumValueTitles' => ['Active' => '', 'Inactive' => ''], 'type' => 'string', 'example' => 'Active', 'title' => '', ], 'Type' => [ 'description' => 'The workflow type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Customize: custom workflow.'."\n" ."\n" .'- System: system workflow.'."\n" ."\n" .'- Common: user-created workflow.', 'enumValueTitles' => ['Customize' => '', 'System' => '', 'Common' => ''], 'type' => 'string', 'example' => 'Common', 'title' => '', ], 'CreateTime' => ['description' => 'The time when the workflow was created.', 'type' => 'string', 'example' => '2022-11-27T10:02:12Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the workflow was last modified.', 'type' => 'string', 'example' => '2022-11-29T02:06:19Z'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'ActivityResults' => ['description' => 'The results for all nodes of the workflow task.', 'type' => 'string', 'example' => 'Json格式，内容根据工作流配置有变化。', 'title' => ''], 'UserData' => ['description' => 'The user-defined field that was specified when the workflow task was submitted.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'GetWorkflowTask', 'summary' => 'Queries the information about a workflow task by task ID, including the workflow ID and the status and result of the task. You can query only the workflow task data of the last year.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkflowTask'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetWorkflowTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******0C-7870-15FE-B96F-8880BB******\\",\\n \\"WorkflowTask\\": {\\n \\"TaskId\\": \\"******4215e042b3966ca5441e******\\",\\n \\"Status\\": \\"Succeed\\",\\n \\"TaskInput\\": \\"{\\\\n \\\\\\"Type\\\\\\": \\\\\\"Media\\\\\\",\\\\n \\\\\\"Media\\\\\\": \\\\\\"******30706071edbfe290b488******\\\\\\"\\\\n}\\",\\n \\"CreateTime\\": \\"2023-01-04T02:05:17Z\\",\\n \\"FinishTime\\": \\"2023-01-04T02:06:19Z\\",\\n \\"Workflow\\": {\\n \\"WorkflowId\\": \\"******63dca94c609de02ac0d1******\\",\\n \\"Name\\": \\"Super-resolution transcoding workflow\\",\\n \\"Status\\": \\"Active\\",\\n \\"Type\\": \\"Common\\",\\n \\"CreateTime\\": \\"2022-11-27T10:02:12Z\\",\\n \\"ModifiedTime\\": \\"2022-11-29T02:06:19Z\\\\n\\"\\n },\\n \\"ActivityResults\\": \\"Json格式，内容根据工作流配置有变化。\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\"\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetYikeAIAppJob' => [ 'summary' => 'Retrieves the details of a Yike AI App job.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], 'AppId' => ['description' => 'The Yike AI App ID.', 'type' => 'string', 'example' => 'app-****', 'title' => ''], 'AppParams' => ['description' => 'The input parameters for the Yike AI App, provided as a JSON string.', 'type' => 'string', 'example' => '{\\"LoadImage.1.TargetImage\\":\\"MediaId1\\"}', 'title' => ''], 'Status' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'- `Created`: The job is created.'."\n" ."\n" .'- `Queuing`: The job is queued for processing.'."\n" ."\n" .'- `Executing`: The job is running.'."\n" ."\n" .'- `Finished`: The job completed successfully.'."\n" ."\n" .'- `Failed`: The job failed.', 'type' => 'string', 'example' => 'Created', 'title' => ''], 'ProductionId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****'."\n", 'title' => ''], 'FolderId' => ['description' => 'The folder ID.', 'type' => 'string', 'example' => 'folder-u3ilwhoc36ux9a****', 'title' => ''], 'ExecutionStartTime' => ['description' => 'The UTC time when the job started, in `yyyy-MM-ddTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2026-02-06T18:53:34.001+08:00', 'title' => ''], 'ExecutionFinishTime' => ['description' => 'The UTC time when the job finished, in `yyyy-MM-ddTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2026-02-06T18:53:18.809+08:00', 'title' => ''], 'Result' => [ 'description' => 'The job results.', 'type' => 'object', 'properties' => [ 'ImageResult' => [ 'description' => 'The image results.', 'type' => 'array', 'items' => [ 'description' => 'A single image result.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'example' => '1a7852b032c371f0b64fe6f6c74b****', 'title' => ''], 'OutputUrl' => ['description' => 'The OSS URL of the output file.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.png', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'VideoResult' => [ 'description' => 'The video results.', 'type' => 'array', 'items' => [ 'description' => 'A single video result.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'example' => '1a7852b032c371f0b64fe6f6c74b****', 'title' => ''], 'OutputUrl' => ['description' => 'The OSS URL of the output file.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AudioResult' => [ 'description' => 'The audio results.', 'type' => 'array', 'items' => [ 'description' => 'A single audio result.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'example' => '1a7852b032c371f0b64fe6f6c74b****', 'title' => ''], 'OutputUrl' => ['description' => 'The OSS URL of the output file.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain Job Result Details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetYikeAIAppJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"AppParams\\": \\"{\\\\\\\\\\\\\\"LoadImage.1.TargetImage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MediaId1\\\\\\\\\\\\\\"}\\",\\n \\"Status\\": \\"Created\\",\\n \\"ProductionId\\": \\"****cdb3e74639973036bc84****\\\\n\\",\\n \\"FolderId\\": \\"folder-u3ilwhoc36ux9a****\\",\\n \\"ExecutionStartTime\\": \\"2026-02-06T18:53:34.001+08:00\\",\\n \\"ExecutionFinishTime\\": \\"2026-02-06T18:53:18.809+08:00\\",\\n \\"Result\\": {\\n \\"ImageResult\\": [\\n {\\n \\"MediaId\\": \\"1a7852b032c371f0b64fe6f6c74b****\\",\\n \\"OutputUrl\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.png\\"\\n }\\n ],\\n \\"VideoResult\\": [\\n {\\n \\"MediaId\\": \\"1a7852b032c371f0b64fe6f6c74b****\\",\\n \\"OutputUrl\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4\\"\\n }\\n ],\\n \\"AudioResult\\": [\\n {\\n \\"MediaId\\": \\"1a7852b032c371f0b64fe6f6c74b****\\",\\n \\"OutputUrl\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp3\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetYikeAssetMediaInfo' => [ 'summary' => 'Gets media asset information.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '6890', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The media asset ID.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaInfo' => [ 'description' => 'The media asset information.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The media asset ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****'], 'MediaBasicInfo' => [ 'description' => 'The basic information about the media asset.', 'title' => '', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The media asset ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****'], 'InputURL' => ['title' => '', 'description' => 'The source URL of the media asset.', 'type' => 'string', 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], 'MediaType' => ['title' => '', 'description' => 'The media type.', 'type' => 'string', 'example' => 'video'], 'BusinessType' => ['title' => '', 'description' => 'The business type.', 'type' => 'string', 'example' => 'general'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => 'oss'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => 'v6l82k_176822379****.jpeg'], 'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'description'], 'Category' => ['title' => '', 'description' => 'The category.', 'type' => 'string', 'example' => 'category'], 'MediaTags' => ['title' => '', 'description' => 'The media tags.', 'type' => 'string', 'example' => 'tag1'], 'CoverURL' => ['title' => '', 'description' => 'The cover URL.', 'type' => 'string', 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg'], 'UserData' => ['title' => '', 'description' => 'The user data.', 'type' => 'string', 'example' => 'UserData'], 'Snapshots' => ['title' => '', 'description' => 'The snapshot information.', 'type' => 'string', 'example' => '[]'], 'Status' => ['title' => '', 'description' => 'The asset\'s status.', 'type' => 'string', 'example' => 'Normal'], 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2020-12-26T04:11:08Z'], 'ModifiedTime' => ['title' => '', 'description' => 'The last modification time.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z'], 'DeletedTime' => ['title' => '', 'description' => 'The deletion time.', 'type' => 'string', 'example' => '2020-12-26T04:11:15Z'], 'SpriteImages' => ['title' => '', 'description' => 'The sprite images.', 'type' => 'string', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3048', 'title' => ''], 'Biz' => ['description' => 'The associated business.', 'type' => 'string', 'example' => 'AiSaas', 'title' => ''], 'UploadSource' => ['description' => 'The upload source.', 'type' => 'string', 'example' => 'general', 'title' => ''], 'CateName' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'cateName', 'title' => ''], 'ReferenceId' => ['description' => 'A custom ID. It must be 6 to 64 characters long and can contain only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (\\_). This ID must be unique per user.', 'type' => 'string', 'example' => '123-1234', 'title' => ''], 'ThumbURL240P' => ['description' => 'The thumbnail with a height of 240 pixels.', 'type' => 'string', 'example' => 'ThumbURL240P', 'title' => ''], 'ThumbURLWebp' => ['description' => 'The WebP-encoded thumbnail.', 'type' => 'string', 'example' => 'ThumbURLWebp', 'title' => ''], ], 'example' => '', ], 'FileInfoList' => [ 'description' => 'The file information.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The file information.', 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'description' => 'Basic file information, such as duration and size.', 'title' => '', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => 'example.mp4'], 'FileStatus' => ['title' => '', 'description' => 'The file status.', 'type' => 'string', 'example' => 'Normal'], 'FileType' => ['title' => '', 'description' => 'The file type.', 'type' => 'string', 'example' => 'source_file'], 'FileSize' => ['title' => '', 'description' => 'The file size, in bytes.', 'type' => 'string', 'example' => '27007'], 'FileUrl' => ['title' => '', 'description' => 'The OSS URL of the file.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['title' => '', 'description' => 'The file\'s storage region.', 'type' => 'string', 'example' => 'cn-shanghai'], 'FormatName' => ['title' => '', 'description' => 'The container format.', 'type' => 'string', 'example' => 'mp4'], 'Duration' => ['title' => '', 'description' => 'The duration.', 'type' => 'string', 'example' => '16.2'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate.', 'type' => 'string', 'example' => '20'], 'Width' => ['title' => '', 'description' => 'The width.', 'type' => 'string', 'example' => '960'], 'Height' => ['title' => '', 'description' => 'The height.', 'type' => 'string', 'example' => '540'], 'CreateTime' => ['description' => 'The file\'s creation time.', 'type' => 'string', 'example' => '2020-12-26T04:11:08Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The file\'s last modification time.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], ], 'example' => '', ], 'AudioStreamInfoList' => [ 'description' => 'An array of audio stream objects. A media asset can contain multiple audio streams.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An audio stream object.', 'type' => 'object', 'properties' => [ 'Index' => ['title' => '', 'description' => 'The audio stream\'s index.', 'type' => 'string', 'example' => '1'], 'CodecName' => ['title' => '', 'description' => 'The codec\'s short name.', 'type' => 'string', 'example' => 'aac'], 'CodecLongName' => ['title' => '', 'description' => 'The codec\'s long name.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)'], 'CodecTimeBase' => ['title' => '', 'description' => 'The codec\'s time base.', 'type' => 'string', 'example' => '1/44100'], 'CodecTagString' => ['title' => '', 'description' => 'The codec tag string.', 'type' => 'string', 'example' => 'mp4a'], 'CodecTag' => ['title' => '', 'description' => 'The codec tag.', 'type' => 'string', 'example' => '0x6134706d'], 'Profile' => ['title' => '', 'description' => 'The profile.', 'type' => 'string', 'example' => 'High'], 'SampleFmt' => ['title' => '', 'description' => 'The sample format.', 'type' => 'string', 'example' => 'fltp'], 'SampleRate' => ['title' => '', 'description' => 'The sample rate.', 'type' => 'string', 'example' => '44100'], 'Channels' => ['title' => '', 'description' => 'The number of channels.', 'type' => 'string', 'example' => '2'], 'ChannelLayout' => ['title' => '', 'description' => 'The channel layout.', 'type' => 'string', 'example' => 'stereo'], 'Timebase' => ['title' => '', 'description' => 'The time base.', 'type' => 'string', 'example' => '1/44100'], 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2026-02-04T02:13:00Z'], 'Duration' => ['title' => '', 'description' => 'The duration.', 'type' => 'string', 'example' => '16.2'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate.', 'type' => 'string', 'example' => '192.0'], 'Fps' => ['title' => '', 'description' => 'The audio frame rate.', 'type' => 'string', 'example' => '10'], 'NumFrames' => ['title' => '', 'description' => 'The total number of frames.', 'type' => 'string', 'example' => '10'], 'Lang' => ['title' => '', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoStreamInfoList' => [ 'description' => 'An array of video stream objects. A media asset can contain multiple video streams.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A video stream object.', 'type' => 'object', 'properties' => [ 'Index' => ['title' => '', 'description' => 'The video stream\'s index.', 'type' => 'string', 'example' => '0'], 'CodecName' => ['title' => '', 'description' => 'The codec\'s short name.', 'type' => 'string', 'example' => 'h264'], 'CodecLongName' => ['title' => '', 'description' => 'The codec\'s long name.', 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10'], 'Profile' => ['title' => '', 'description' => 'The profile.', 'type' => 'string', 'example' => 'High'], 'CodecTimeBase' => ['title' => '', 'description' => 'The codec\'s time base.', 'type' => 'string', 'example' => '1/48'], 'CodecTagString' => ['title' => '', 'description' => 'The codec tag string.', 'type' => 'string', 'example' => '[0][0][0][0]'], 'CodecTag' => ['title' => '', 'description' => 'The codec tag.', 'type' => 'string', 'example' => '0x0000'], 'Width' => ['title' => '', 'description' => 'The width.', 'type' => 'string', 'example' => '960'], 'Height' => ['title' => '', 'description' => 'The height.', 'type' => 'string', 'example' => '540'], 'HasBFrames' => ['title' => '', 'description' => 'Indicates whether the video stream contains B-frames.', 'type' => 'string', 'example' => '2'], 'Sar' => ['title' => '', 'description' => 'The sample aspect ratio (SAR).', 'type' => 'string', 'example' => '0:1'], 'Dar' => ['title' => '', 'description' => 'The display aspect ratio (DAR).', 'type' => 'string', 'example' => '0:1'], 'PixFmt' => ['title' => '', 'description' => 'The pixel format.', 'type' => 'string', 'example' => 'yuv420p'], 'Level' => ['title' => '', 'description' => 'The encoding level.', 'type' => 'string', 'example' => '30'], 'Fps' => ['title' => '', 'description' => 'The video frame rate.', 'type' => 'string', 'example' => '24.0'], 'AvgFPS' => ['title' => '', 'description' => 'The average frame rate.', 'type' => 'string', 'example' => '24.0'], 'Timebase' => ['title' => '', 'description' => 'The time base.', 'type' => 'string', 'example' => '1/12288'], 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '0.081706'], 'Duration' => ['title' => '', 'description' => 'The duration.', 'type' => 'string', 'example' => '216.206706'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate.', 'type' => 'string', 'example' => '20'], 'NumFrames' => ['title' => '', 'description' => 'The total number of frames.', 'type' => 'string', 'example' => '5184'], 'Lang' => ['title' => '', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], 'Rotate' => ['title' => '', 'description' => 'The rotation angle.', 'type' => 'string', 'example' => '0'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SubtitleStreamInfoList' => [ 'description' => 'An array of subtitle stream objects. A media asset can contain multiple subtitle streams.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A subtitle stream object.', 'type' => 'object', 'properties' => [ 'Index' => ['title' => '', 'description' => 'The subtitle stream\'s index.', 'type' => 'string', 'example' => '1'], 'CodecName' => ['title' => '', 'description' => 'The codec\'s short name.', 'type' => 'string', 'example' => 'srt'], 'CodecLongName' => ['title' => '', 'description' => 'The codec\'s long name.', 'type' => 'string', 'example' => 'SubRip Text'], 'CodecTimeBase' => ['title' => '', 'description' => 'The codec\'s time base.', 'type' => 'string', 'example' => '29.97'], 'CodecTagString' => ['title' => '', 'description' => 'The codec tag string.', 'type' => 'string', 'example' => 'unicode'], 'CodecTag' => ['title' => '', 'description' => 'The codec tag.', 'type' => 'string', 'example' => 'unicode'], 'Timebase' => ['title' => '', 'description' => 'The time base.', 'type' => 'string', 'example' => '30'], 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2025-03-07T01:30Z'], 'Duration' => ['title' => '', 'description' => 'The duration.', 'type' => 'string', 'example' => '1'], 'Lang' => ['title' => '', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'BizData' => [ 'description' => 'Custom business data.', 'type' => 'object', 'properties' => [ 'FolderId' => ['description' => 'The folder ID.', 'type' => 'string', 'example' => 'fd-CBMEJaa2fA', 'title' => ''], 'ProductionId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'ID', 'title' => ''], 'AuditBlockedLabel' => ['description' => 'The audit label.', 'type' => 'string', 'example' => 'Label', 'title' => ''], 'AuditStatus' => ['description' => '审核状态。', 'type' => 'string', 'example' => 'Status', 'title' => ''], 'MediaAssetType' => ['description' => '媒资类型。', 'type' => 'string', 'example' => 'Type', 'title' => ''], 'MediaAssetSubType' => ['description' => '媒资子类型。', 'type' => 'string', 'example' => 'SubType', 'title' => ''], 'SourceType' => ['description' => '源类型。', 'type' => 'string', 'example' => 'MainBody', 'title' => ''], 'SourceId' => ['description' => '源 ID。', 'type' => 'string', 'example' => 'f4a26390f02371f0a1f4e6e7c758****', 'title' => ''], 'SourceName' => ['description' => '源名称。', 'type' => 'string', 'example' => 'SourceName', 'title' => ''], 'IsFavorite' => ['description' => '是否最喜爱的。', 'type' => 'string', 'example' => '1', 'title' => ''], 'IsLogicalDeleted' => ['description' => '是否被删除。', 'type' => 'string', 'example' => '1', 'title' => ''], 'CreationJobId' => ['description' => '创建任务 ID。', 'type' => 'string', 'example' => 'ID', 'title' => ''], 'Prompt' => ['description' => '提示词。', 'type' => 'string', 'example' => '请为上述内容生成一段摘要，字数必须限制在70字以内包含标点符号', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Obtain media asset information details ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetYikeAssetMediaInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaInfo\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"v6l82k_176822379****.jpeg\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"category\\",\\n \\"MediaTags\\": \\"tag1\\",\\n \\"CoverURL\\": \\"https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg\\",\\n \\"UserData\\": \\"UserData\\",\\n \\"Snapshots\\": \\"[]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:15Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"CateId\\": 3048,\\n \\"Biz\\": \\"AiSaas\\",\\n \\"UploadSource\\": \\"general\\",\\n \\"CateName\\": \\"cateName\\",\\n \\"ReferenceId\\": \\"123-1234\\",\\n \\"ThumbURL240P\\": \\"ThumbURL240P\\",\\n \\"ThumbURLWebp\\": \\"ThumbURLWebp\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"27007\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mp4\\",\\n \\"Duration\\": \\"16.2\\",\\n \\"Bitrate\\": \\"20\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"Profile\\": \\"High\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/44100\\",\\n \\"StartTime\\": \\"2026-02-04T02:13:00Z\\",\\n \\"Duration\\": \\"16.2\\",\\n \\"Bitrate\\": \\"192.0\\",\\n \\"Fps\\": \\"10\\",\\n \\"NumFrames\\": \\"10\\",\\n \\"Lang\\": \\"zh\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1/48\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Sar\\": \\"0:1\\",\\n \\"Dar\\": \\"0:1\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"30\\",\\n \\"Fps\\": \\"24.0\\",\\n \\"AvgFPS\\": \\"24.0\\",\\n \\"Timebase\\": \\"1/12288\\",\\n \\"StartTime\\": \\"0.081706\\",\\n \\"Duration\\": \\"216.206706\\",\\n \\"Bitrate\\": \\"20\\",\\n \\"NumFrames\\": \\"5184\\",\\n \\"Lang\\": \\"zh\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ],\\n \\"SubtitleStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"srt\\",\\n \\"CodecLongName\\": \\"SubRip Text\\",\\n \\"CodecTimeBase\\": \\"29.97\\",\\n \\"CodecTagString\\": \\"unicode\\",\\n \\"CodecTag\\": \\"unicode\\",\\n \\"Timebase\\": \\"30\\",\\n \\"StartTime\\": \\"2025-03-07T01:30Z\\",\\n \\"Duration\\": \\"1\\",\\n \\"Lang\\": \\"zh\\"\\n }\\n ]\\n }\\n ],\\n \\"BizData\\": {\\n \\"FolderId\\": \\"fd-CBMEJaa2fA\\",\\n \\"ProductionId\\": \\"ID\\",\\n \\"AuditBlockedLabel\\": \\"Label\\",\\n \\"AuditStatus\\": \\"Status\\",\\n \\"MediaAssetType\\": \\"Type\\",\\n \\"MediaAssetSubType\\": \\"SubType\\",\\n \\"SourceType\\": \\"MainBody\\",\\n \\"SourceId\\": \\"f4a26390f02371f0a1f4e6e7c758****\\",\\n \\"SourceName\\": \\"SourceName\\",\\n \\"IsFavorite\\": \\"1\\",\\n \\"IsLogicalDeleted\\": \\"1\\",\\n \\"CreationJobId\\": \\"ID\\",\\n \\"Prompt\\": \\"请为上述内容生成一段摘要，字数必须限制在70字以内包含标点符号\\"\\n }\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetYikeStoryboardJob' => [ 'summary' => 'Retrieves the details of a Yike storyboard job.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The storyboard job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'JobId' => ['title' => '', 'description' => 'The storyboard job ID. You can obtain this ID from the response parameters of the [SubmitStoryboardJob](~~461964~~) operation.', 'type' => 'string', 'example' => '****a046-263c-3560-978a-fb287782****'], 'JobParams' => [ 'description' => 'A JSON object that contains the parameters for the job. The structure of this object varies based on the AI algorithm.', 'title' => '', 'type' => 'object', 'properties' => [ 'FileURL' => ['title' => '', 'description' => 'The OSS URL of the file.', 'type' => 'string', 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/test.mp4'], 'ShotPromptMode' => ['title' => '', 'description' => 'The shot generation mode.', 'type' => 'string', 'example' => 'multi'], 'SourceType' => ['title' => '', 'description' => 'The source type.', 'type' => 'string', 'example' => 'Novel'], 'ModelParams' => ['title' => '', 'description' => 'The model parameters.', 'type' => 'string', 'example' => '{'."\n" .' "AudioEnable": false'."\n" .'}'], 'ShotSplitMode' => ['title' => '', 'description' => 'The shot splitting mode.', 'type' => 'string', 'example' => 'firstPersonNarration'], 'NarrationVoiceId' => ['title' => '', 'description' => 'The narration voice.', 'type' => 'string', 'example' => 'sys_YoungGracefulWoman'], 'VideoModel' => ['title' => '', 'description' => 'The video model.', 'type' => 'string', 'example' => 'wan2.6-r2v-flash'], 'StyleId' => ['title' => '', 'description' => 'The style ID.', 'type' => 'string', 'example' => 'RealisticPhotography'], 'Resolution' => ['title' => '', 'description' => 'The resolution of the generated video.', 'type' => 'string', 'example' => '1K'], 'Title' => ['title' => '', 'description' => 'The job title.'."\n" ."\n" .'\\- Maximum length: 128 bytes.'."\n" ."\n" .'\\- UTF-8 encoding.', 'type' => 'string', 'example' => 'test-title'], 'AspectRatio' => ['title' => '', 'description' => 'The aspect ratio of the video.', 'type' => 'string', 'example' => '16:9'], ], 'example' => '', ], 'JobStatus' => ['title' => '', 'description' => 'The job status. Valid values:'."\n" ."\n" .'- **Succeeded**: The job completed successfully.'."\n" ."\n" .'- **Failed**: The job failed to complete.'."\n" ."\n" .'- **Running**: The job is in progress.', 'type' => 'string', 'example' => 'Succeeded'], 'JobResult' => [ 'description' => 'The job result.', 'title' => '', 'type' => 'object', 'properties' => [ 'OutputUrl' => ['title' => '', 'description' => 'The downloadable OSS URL.', 'type' => 'string', 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/test.mp4'], 'SuccessStoryboardList' => ['title' => '', 'description' => 'A list of IDs for successful storyboards.', 'type' => 'string', 'example' => '[\\"st_2118280473\\"]'], 'ExceptionStoryboardIds' => ['title' => '', 'description' => 'A list of IDs for storyboards that encountered an exception.', 'type' => 'string', 'example' => '[\\"st_2053348871\\"]'], 'FailureShotList' => ['title' => '', 'description' => 'A list of shots that failed to generate.', 'type' => 'string', 'example' => '[{\\"errorCode\\":\\"NoMediaData\\",\\"storyboardId\\":\\"st_2118280473\\",\\"shotId\\":\\"54\\"}]'], 'SuccessStoryboardIds' => ['description' => 'A comma-separated list of successful storyboard IDs.', 'type' => 'string', 'example' => 'st_2118280473, st_2118280471', 'title' => ''], 'StoryboardInfoList' => ['description' => 'Detailed information about each storyboard in the job.', 'type' => 'string', 'example' => '[{\\"storyboardId\\":\\"st_1541525214\\",\\"title\\":\\"test_1\\",\\"status\\":\\"Produced\\",\\"subStatus\\":\\"ProduceSucc\\"},{\\"storyboardId\\":\\"st_1633435355\\",\\"title\\":\\"test_2\\",\\"status\\":\\"Produced\\",\\"subStatus\\":\\"ProduceSucc\\"}]', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query storyboard generation Job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetYikeStoryboardJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"JobParams\\": {\\n \\"FileURL\\": \\"https://test.oss-cn-shanghai.aliyuncs.com/test.mp4\\",\\n \\"ShotPromptMode\\": \\"multi\\",\\n \\"SourceType\\": \\"Novel\\",\\n \\"ModelParams\\": \\"{\\\\n \\\\\\"AudioEnable\\\\\\": false\\\\n}\\",\\n \\"ShotSplitMode\\": \\"firstPersonNarration\\",\\n \\"NarrationVoiceId\\": \\"sys_YoungGracefulWoman\\",\\n \\"VideoModel\\": \\"wan2.6-r2v-flash\\",\\n \\"StyleId\\": \\"RealisticPhotography\\",\\n \\"Resolution\\": \\"1K\\",\\n \\"Title\\": \\"test-title\\",\\n \\"AspectRatio\\": \\"16:9\\"\\n },\\n \\"JobStatus\\": \\"Succeeded\\",\\n \\"JobResult\\": {\\n \\"OutputUrl\\": \\"https://test.oss-cn-shanghai.aliyuncs.com/test.mp4\\",\\n \\"SuccessStoryboardList\\": \\"[\\\\\\\\\\\\\\"st_2118280473\\\\\\\\\\\\\\"]\\",\\n \\"ExceptionStoryboardIds\\": \\"[\\\\\\\\\\\\\\"st_2053348871\\\\\\\\\\\\\\"]\\",\\n \\"FailureShotList\\": \\"[{\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NoMediaData\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"storyboardId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"st_2118280473\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"shotId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"54\\\\\\\\\\\\\\"}]\\",\\n \\"SuccessStoryboardIds\\": \\"st_2118280473, st_2118280471\\",\\n \\"StoryboardInfoList\\": \\"[{\\\\\\\\\\\\\\"storyboardId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"st_1541525214\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test_1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Produced\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ProduceSucc\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"storyboardId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"st_1633435355\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test_2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Produced\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ProduceSucc\\\\\\\\\\\\\\"}]\\"\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetYikeUser' => [ 'summary' => 'Gets information about a Yike sub-account.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'UserName', 'in' => 'query', 'schema' => ['description' => 'The user name of the sub-account.', 'type' => 'string', 'required' => false, 'maxLength' => 50, 'pattern' => '^[^\';<>=|\\(\\)]+$', 'example' => 'test.xxx@xxx.yikeai', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'UserInfo' => [ 'type' => 'object', 'properties' => [ 'YikeUserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'id', 'title' => ''], 'UserName' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'Nickname' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'example' => 'nick', 'title' => ''], 'WorkspaceId' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'spaceId', 'title' => ''], ], 'description' => 'The user information.', 'title' => '', 'example' => '', ], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'title' => 'GetYikeUser', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetYikeUser', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"UserInfo\\": {\\n \\"YikeUserId\\": \\"id\\",\\n \\"UserName\\": \\"name\\",\\n \\"Nickname\\": \\"nick\\",\\n \\"WorkspaceId\\": \\"spaceId\\"\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetYikeUserCredit' => [ 'summary' => 'Retrieves the credit balance for a Yike user.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'YikeUserId', 'in' => 'query', 'schema' => ['description' => 'The user ID of the Yike sub-account.', 'type' => 'string', 'required' => true, 'example' => 'id', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'CreditUsage' => ['description' => 'The remaining credit.', 'type' => 'string', 'example' => '100', 'title' => ''], 'CreditTotal' => ['description' => 'The total allocated credit.', 'type' => 'string', 'example' => '400', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'GetYikeUserCredit', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:GetYikeUserCredit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"CreditUsage\\": \\"100\\",\\n \\"CreditTotal\\": \\"400\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'InsertMediaToSearchLib' => [ 'summary' => 'Insert a media asset into the search library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library. Default value: ims-default-search-lib.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset. Each media ID is unique. If you leave this parameter empty, a media ID is automatically generated for this parameter.', 'type' => 'string', 'required' => false, 'example' => '411bed50018971edb60b0764a0ec6***', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the media asset. Valid values:'."\n" ."\n" .'- video (default)'."\n" ."\n" .'- image'."\n" ."\n" .'- audio', 'enumValueTitles' => ['image' => 'image', 'video' => 'video', 'audio' => 'audio'], 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => '', ], ], [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The URL of the video, audio, or image file that you want to import to the search library.'."\n" ."\n" .'Note: Make sure that you specify a correct file name and the bucket in which the file resides is in the same region where this operation is called. Otherwise, the file cannot be found or the operation may fail.'."\n" ."\n" .'Specify an Object Storage Service (OSS) URL in the following format: oss\\://\\[Bucket name]/\\[File path]. For example, you can specify oss\\://\\[example-bucket-****]/\\[object\\_path-****].'."\n" ."\n" .'Specify an HTTP URL in the following format: public endpoint. For example, you can specify http\\://example-test-\\*\\*\\*\\*.mp4.', 'type' => 'string', 'required' => true, 'example' => 'oss://[example-bucket-]/[object_path-]', 'title' => ''], ], [ 'name' => 'MsgBody', 'in' => 'query', 'schema' => ['description' => 'The message body.', 'type' => 'string', 'required' => false, 'example' => '{"title":"test","customFields":{"intField1":12,"strField1":"abc"}}', 'title' => ''], ], [ 'name' => 'ImagesInput', 'in' => 'query', 'schema' => ['description' => 'Image set information. Supports only the IPCamera scenario, and MediaType must be video.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "images": ['."\n" .' "oss://[example-bucket-]/[object_path-]xxx1.jpg",'."\n" .' "oss://[example-bucket-]/[object_path-]xxx2.jpg",'."\n" .' "oss://[example-bucket-]/[object_path-]xxx3.jpg",'."\n" .' "oss://[example-bucket-]/[object_path-]xxx4.jpg"'."\n" .' ]'."\n" .'}', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'Insert a media asset into the search library ', 'description' => '### Prerequisites'."\n" ."\n" .'Before inserting a media asset into the search library, you must call the [CreateSearchLib](~~2584454~~) API to create the search library.', 'changeSet' => [ ['createdAt' => '2025-07-09T08:14:41.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-06-11T06:24:27.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-22T08:19:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InsertMediaToSearchLib'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:InsertMediaToSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListAIAgentDialogues' => [ 'summary' => 'Returns the session history.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '235498', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => 'f27f9b9be28642a88e18****', 'title' => ''], ], [ 'name' => 'RoundLimit', 'in' => 'query', 'schema' => ['description' => 'The number of most recent dialogue rounds to return. This value must be a positive integer. This parameter is mutually exclusive with pagination parameters; if specified, it overrides them.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start Unix timestamp (inclusive), in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end Unix timestamp (inclusive), in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '17358082464030', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of items per page. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['description' => 'The sort order. Valid values: `ASC` (ascending) and `DESC` (descending). Default value: `DESC`.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-***************'], 'Dialogues' => [ 'description' => 'A list of dialogues.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DialogueId' => ['description' => 'The unique ID of the dialogue.', 'type' => 'string', 'example' => '19de81b3b3d94abda22****', 'title' => ''], 'RoundId' => ['description' => 'The ID of the dialogue round.', 'type' => 'string', 'example' => 'f27f9b9be28642a88e18****', 'title' => ''], 'Producer' => [ 'description' => 'The producer of this message.'."\n" ."\n" .'- user: A message from the user.'."\n" ."\n" .'- agent: A message from the agent.', 'enumValueTitles' => ['agent' => 'agent', 'user' => 'user'], 'type' => 'string', 'example' => 'user', 'title' => '', ], 'Text' => ['description' => 'The text content of the dialogue entry.', 'type' => 'string', 'example' => 'Hello', 'title' => ''], 'ReasoningText' => ['description' => 'The agent\'s reasoning text, which can reveal its thought process.', 'type' => 'string', 'example' => '我在思考', 'title' => ''], 'AttachedFileList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'The URL of the attachment.', 'type' => 'string', 'example' => 'https://media.w3.org/2010/05/sintel/trailer.mp3', 'title' => ''], 'Id' => ['description' => 'The unique identifier of the attachment.', 'type' => 'string', 'example' => '7B117AF5-***************'."\n", 'title' => ''], 'Format' => ['description' => 'The format of the attachment, such as mp3, wav, or pdf.', 'type' => 'string', 'example' => 'mp3', 'title' => ''], 'Type' => ['description' => 'The attachment type, represented by a numeric value. The meaning of this value is defined by your business logic.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Name' => ['description' => 'The file name of the attachment.', 'type' => 'string', 'example' => 'MusicDemix', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of file attachments referenced in the dialogue.', 'title' => '', 'example' => '', ], 'Time' => ['description' => 'The Unix timestamp (in milliseconds) when the dialogue entry was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1734511087000', 'title' => ''], 'Type' => ['description' => 'The type of the message. Valid values include:'."\n" ."\n" .'For a call:'."\n" ."\n" .'1. greeting: A welcome message.'."\n" ."\n" .'2. normal: A standard voice response.'."\n" ."\n" .'3. speech: A proactive voice broadcast.'."\n" ."\n" .'For a chat:'."\n" ."\n" .'1. normal: A standard text response.'."\n" ."\n" .'2. announcement: A proactive text push.'."\n" ."\n" .'3. custom: A custom message.', 'type' => 'string', 'example' => 'announcement', 'title' => ''], 'Source' => ['description' => 'The source channel of the message. Valid values:'."\n" ."\n" .'chat: The message is from a text chat.'."\n" ."\n" .'call: The message is from a voice call.', 'type' => 'string', 'example' => 'chat', 'title' => ''], 'NodeId' => ['description' => 'The ID of the workflow node that generated the dialogue entry, which you can use for tracing.', 'type' => 'string', 'example' => 'e01-cn-to345ikn62o', 'title' => ''], 'Extend' => ['description' => 'A JSON-formatted string for extended information. Use this field to store custom data, such as sentiment labels or intent recognition results.', 'type' => 'string', 'example' => '{\\"addTransferLock\\":true}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-***************\\",\\n \\"Dialogues\\": [\\n {\\n \\"DialogueId\\": \\"19de81b3b3d94abda22****\\",\\n \\"RoundId\\": \\"f27f9b9be28642a88e18****\\",\\n \\"Producer\\": \\"user\\",\\n \\"Text\\": \\"Hello\\",\\n \\"ReasoningText\\": \\"我在思考\\",\\n \\"AttachedFileList\\": [\\n {\\n \\"Url\\": \\"https://media.w3.org/2010/05/sintel/trailer.mp3\\",\\n \\"Id\\": \\"7B117AF5-***************\\\\n\\",\\n \\"Format\\": \\"mp3\\",\\n \\"Type\\": 1,\\n \\"Name\\": \\"MusicDemix\\"\\n }\\n ],\\n \\"Time\\": 1734511087000,\\n \\"Type\\": \\"announcement\\",\\n \\"Source\\": \\"chat\\",\\n \\"NodeId\\": \\"e01-cn-to345ikn62o\\",\\n \\"Extend\\": \\"{\\\\\\\\\\\\\\"addTransferLock\\\\\\\\\\\\\\":true}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListAIAgentDialogues', 'changeSet' => [ ['createdAt' => '2025-04-28T10:34:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-04-08T03:25:30.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-02-27T07:13:06.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListAIAgentDialogues', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListAIAgentInstance' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236523', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4***', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time of the query in ISO 8601 format. No default value.', 'type' => 'string', 'required' => false, 'example' => '2023-01-01T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time of the query in ISO 8601 format. No default value.', 'type' => 'string', 'required' => false, 'example' => '2023-01-02T00:00:00Z', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of results per page. Default is 10. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number. Default is 1. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'Instances' => [ 'description' => 'List of agent instance objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CallLogUrl' => ['description' => 'URL of the call log file. The file contains a JSON-formatted CallLog structure.', 'type' => 'string', 'example' => 'https://example.com/call_logs/12345.json', 'title' => ''], 'RuntimeConfig' => ['description' => 'Runtime configuration required by the agent.', '$ref' => '#/components/schemas/AIAgentRuntimeConfig', 'example' => '{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}', 'title' => ''], 'Status' => [ 'description' => 'Instance status:'."\n" ."\n" .'- Created: The call started but no connection was established between both ends.'."\n" ."\n" .'- Executing: The call is in progress and a connection is established between both ends.'."\n" ."\n" .'- Finished: The call ended.', 'enumValueTitles' => ['Finished' => 'Finished', 'Executing' => 'Executing'], 'type' => 'string', 'example' => 'Finished', 'title' => '', ], 'TemplateConfig' => ['description' => 'Template configuration used by the agent instance.', 'deprecated' => true, '$ref' => '#/components/schemas/AIAgentTemplateConfig', 'example' => '{"VoiceChat": {"VoiceId": "zhixiaoxia"}}', 'title' => ''], 'UserData' => ['description' => 'User-defined information.', 'type' => 'string', 'example' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}', 'title' => ''], 'AgentConfig' => ['description' => 'Template configuration used by the agent instance.', '$ref' => '#/components/schemas/AIAgentConfig', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query AI Agent Instance List', 'summary' => 'List AI agent instances. You can retrieve all instances or filter them by specified conditions.', 'description' => 'This operation lists AI agent instances. Filter results by agent ID (`AIAgentId`). Optionally, specify a time range (`StartTime` and `EndTime`), the number of results per page (`PageSize`), and the page number (`PageNumber`). The response includes each instance’s status, runtime configuration, template configuration, user-defined data, and a download link for the conversation call log.'."\n" ."\n" .'>'."\n" ."\n" .'Default pagination values: PageSize is 10. PageNumber is 1.'."\n" ."\n" .'>', 'changeSet' => [ ['createdAt' => '2025-05-29T07:43:21.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListAIAgentInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"CallLogUrl\\": \\"https://example.com/call_logs/12345.json\\",\\n \\"RuntimeConfig\\": {\\n \\"AvatarChat3D\\": {\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\"\\n },\\n \\"VisionChat\\": {\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\"\\n },\\n \\"VoiceChat\\": {\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\"\\n },\\n \\"AgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"AuthToken\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\\\n\\"\\n },\\n \\"Status\\": \\"Finished\\",\\n \\"TemplateConfig\\": {\\n \\"AvatarChat3D\\": {\\n \\"AsrMaxSilence\\": 400,\\n \\"AvatarId\\": \\"1231\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"EnablePushToTalk\\": false,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"GracefulShutdown\\": false,\\n \\"Greeting\\": \\"早上好，我的朋友！\\",\\n \\"UseVoiceprint\\": false,\\n \\"UserOnlineTimeout\\": 60,\\n \\"VoiceId\\": \\"zhixiaoxia\\",\\n \\"Volume\\": 100,\\n \\"VoiceprintId\\": \\"uniqueId\\",\\n \\"BailianAppParams\\": \\"{}\\",\\n \\"UserOfflineTimeout\\": 5,\\n \\"MaxIdleTime\\": 600,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\",\\n \\"InterruptWords\\": [\\n \\"停止\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CharBreak\\": false,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ]\\n },\\n \\"VisionChat\\": {\\n \\"AsrMaxSilence\\": 400,\\n \\"EnableIntelligentSegment\\": true,\\n \\"EnablePushToTalk\\": false,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"GracefulShutdown\\": false,\\n \\"Greeting\\": \\"早上好，我的朋友！\\\\n\\",\\n \\"UseVoiceprint\\": false,\\n \\"UserOnlineTimeout\\": 60,\\n \\"VoiceId\\": \\"zhixiaoxia\\",\\n \\"Volume\\": 100,\\n \\"VoiceprintId\\": \\"uniqueId\\",\\n \\"BailianAppParams\\": \\"{}\\",\\n \\"UserOfflineTimeout\\": 5,\\n \\"MaxIdleTime\\": 600,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\\\n\\",\\n \\"InterruptWords\\": [\\n \\"停止\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CharBreak\\": false,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ]\\n },\\n \\"VoiceChat\\": {\\n \\"AsrMaxSilence\\": 400,\\n \\"EnableIntelligentSegment\\": true,\\n \\"EnablePushToTalk\\": false,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"GracefulShutdown\\": false,\\n \\"Greeting\\": \\"早上好，我的朋友\\",\\n \\"UseVoiceprint\\": false,\\n \\"UserOnlineTimeout\\": 60,\\n \\"VoiceId\\": \\"zhixiaoxia\\",\\n \\"Volume\\": 100,\\n \\"VoiceprintId\\": \\"uniqueId\\",\\n \\"BailianAppParams\\": \\"{}\\",\\n \\"UserOfflineTimeout\\": 5,\\n \\"AvatarUrl\\": \\"http://example.com/a.jpg\\",\\n \\"AvatarUrlType\\": \\"USER\\",\\n \\"MaxIdleTime\\": 600,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\",\\n \\"InterruptWords\\": [\\n \\"停止\\"\\n ],\\n \\"VadLevel\\": 11,\\n \\"CharBreak\\": false,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ]\\n }\\n },\\n \\"UserData\\": \\"{\\\\\\"Email\\\\\\":\\\\\\"johndoe@example.com\\\\\\",\\\\\\"Preferences\\\\\\":{\\\\\\"Language\\\\\\":\\\\\\"en\\\\\\"}}\\",\\n \\"AgentConfig\\": {\\n \\"Greeting\\": \\"你好\\",\\n \\"WakeUpQuery\\": \\"今天天气怎么样？\\\\n\\",\\n \\"MaxIdleTime\\": 600,\\n \\"UserOnlineTimeout\\": 60,\\n \\"UserOfflineTimeout\\": 5,\\n \\"EnablePushToTalk\\": false,\\n \\"GracefulShutdown\\": true,\\n \\"Volume\\": 100,\\n \\"WorkflowOverrideParams\\": \\"{}\\",\\n \\"AvatarUrl\\": \\"http://example.com/a.jpg\\\\n\\",\\n \\"AvatarUrlType\\": \\"USER\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AsrConfig\\": {\\n \\"AsrLanguageId\\": \\"zh_mandarin\\",\\n \\"AsrMaxSilence\\": 400,\\n \\"AsrHotWords\\": [\\n \\"检查\\"\\n ],\\n \\"VadLevel\\": 11,\\n \\"CustomParams\\": \\"mode=fast&sample=16000&format=wav\\",\\n \\"VadDuration\\": 300\\n },\\n \\"TtsConfig\\": {\\n \\"VoiceId\\": \\"longcheng_v2\\\\n\\\\n\\",\\n \\"VoiceIdList\\": [\\n \\"zhixiaoxia\\"\\n ],\\n \\"PronunciationRules\\": [\\n {\\n \\"Word\\": \\"一一零\\",\\n \\"Pronunciation\\": \\"幺幺零\\",\\n \\"Type\\": \\"replacement\\"\\n }\\n ],\\n \\"ModelId\\": \\"speech-01-turbo\\",\\n \\"LanguageId\\": \\"Chinese\\",\\n \\"Emotion\\": \\"happy\\",\\n \\"SpeechRate\\": 1\\n },\\n \\"LlmConfig\\": {\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"user\\",\\n \\"Content\\": \\"你好\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 10,\\n \\"LlmSystemPrompt\\": \\"你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\\\\n\\",\\n \\"BailianAppParams\\": \\"\\\\\\"{\\\\\\\\\\\\\\"biz_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"user_defined_params\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"your_plugin_id\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"article_index\\\\\\\\\\\\\\":2}}},\\\\\\\\\\\\\\"memory_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"your_memory_id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"image_list\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"https://your_image_url\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"rag_options\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"pipeline_ids\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"your_id\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"file_ids\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"文档ID1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"文档ID2\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"metadata_filter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"张三\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"structured_filter\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key2\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value2\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"tags\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"标签2\\\\\\\\\\\\\\"]}}\\\\\\"\\",\\n \\"OpenAIExtraQuery\\": \\"api-version=2024-02-01&api-key=sk-xxx\\",\\n \\"LlmCompleteReply\\": true,\\n \\"FunctionMap\\": [\\n {\\n \\"Function\\": \\"hangup\\",\\n \\"MatchFunction\\": \\"hangup\\"\\n }\\n ],\\n \\"OutputMinLength\\": 5,\\n \\"OutputMaxDelay\\": 2000,\\n \\"HistorySyncWithTTS\\": false\\n },\\n \\"AvatarConfig\\": {\\n \\"AvatarId\\": \\"5257\\"\\n },\\n \\"InterruptConfig\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"InterruptWords\\": [\\n \\"打断一下\\"\\n ],\\n \\"NoInterruptMode\\": \\"cache\\",\\n \\"KeepInterruptWordsForLLM\\": true\\n },\\n \\"VoiceprintConfig\\": {\\n \\"UseVoiceprint\\": false,\\n \\"VoiceprintId\\": \\"zhixiaoxia\\",\\n \\"RegistrationMode\\": \\"Explicit\\"\\n },\\n \\"TurnDetectionConfig\\": {\\n \\"TurnEndWords\\": [\\n \\"我说完了\\"\\n ],\\n \\"Mode\\": \\"Semantic\\",\\n \\"SemanticWaitDuration\\": -1,\\n \\"Eagerness\\": \\"High\\"\\n },\\n \\"ExperimentalConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"VcrConfig\\": {\\n \\"StillFrameMotion\\": {\\n \\"Enabled\\": false,\\n \\"CallbackDelay\\": 3000\\n },\\n \\"InvalidFrameMotion\\": {\\n \\"Enabled\\": false,\\n \\"CallbackDelay\\": 3000\\n },\\n \\"PeopleCount\\": {\\n \\"Enabled\\": false\\n },\\n \\"Equipment\\": {\\n \\"Enabled\\": false\\n },\\n \\"HeadMotion\\": {\\n \\"Enabled\\": false\\n },\\n \\"LookAway\\": {\\n \\"Enabled\\": true\\n }\\n },\\n \\"AmbientSoundConfig\\": {\\n \\"ResourceId\\": \\"f67901c595834************\\",\\n \\"Volume\\": 50\\n },\\n \\"AutoSpeechConfig\\": {\\n \\"UserIdle\\": {\\n \\"WaitTime\\": 5000,\\n \\"MaxRepeats\\": 5,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"您还在吗？\\",\\n \\"Probability\\": 0.5\\n }\\n ],\\n \\"HangupEndWord\\": \\"我挂了，再见\\"\\n },\\n \\"LlmPending\\": {\\n \\"WaitTime\\": 3000,\\n \\"Mode\\": \\"\\",\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"稍等一下\\",\\n \\"Probability\\": 0.5\\n }\\n ]\\n }\\n },\\n \\"BackChannelingConfigs\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"pause_detected\\",\\n \\"Probability\\": 0.5,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"嗯嗯\\",\\n \\"Probability\\": 0.3\\n }\\n ]\\n }\\n ],\\n \\"BackChannelingConfig\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"pause_detected\\",\\n \\"Probability\\": 0.5,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"嗯嗯\\",\\n \\"Probability\\": 0.3\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListAIAgentPhoneNumber' => [ 'summary' => 'List user phone resources API.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236523', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, indicating the number of records displayed per page. Default Value is 50, with a maximum value of 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number. Default Value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'Phone number. Specify Number to directly query the corresponding phone number.', 'type' => 'string', 'required' => false, 'example' => '139xxxxxxxxx', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'Status of the target phone number to query.'."\n" ."\n" .'- 1: "Activation in progress".'."\n" ."\n" .'- 2: "Normal".'."\n" ."\n" .'- 3: "Deactivation in progress".'."\n" ."\n" .'- 4: "Deactivated".', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Array of returned Data.', 'type' => 'array', 'items' => [ 'description' => 'Returned Data.', 'type' => 'object', 'properties' => [ 'PhoneNumber' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '132*****683', 'title' => ''], 'Status' => ['description' => 'Phone number status.'."\n" ."\n" .'- 1: "Activation in progress".'."\n" ."\n" .'- 2: "Normal".'."\n" ."\n" .'- 3: "Deactivation in progress".'."\n" ."\n" .'- 4: "Deactivated".', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '************16-412C-B127-******'], 'TotalNumber' => ['description' => 'Total number of phone numbers found in the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '186', 'title' => ''], 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of records returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"PhoneNumber\\": \\"132*****683\\",\\n \\"Status\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"************16-412C-B127-******\\",\\n \\"TotalNumber\\": 186,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', 'title' => 'List user phone resources', 'description' => 'This API allows a User to query phone resources based on the number of records per page (`PageSize`) and the current page number (`PageNumber`). The Return Result includes phone numbers and their corresponding status.', 'changeSet' => [ ['createdAt' => '2025-07-01T02:22:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListAIAgentPhoneNumber', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListAIAgentVoiceprints' => [ 'summary' => 'Retrieves a list of AI agent voiceprints.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'VoiceprintId', 'in' => 'query', 'schema' => ['description' => 'The unique voiceprint ID. If specified, this operation returns the details of a single voiceprint. If omitted, it returns a paginated list of all voiceprints under your account.', 'type' => 'string', 'required' => false, 'example' => 'vp_1699123456_8527'."\n", 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return. Must be 1 or greater.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'RegistrationMode', 'in' => 'query', 'schema' => [ 'description' => 'The registration mode for the voiceprint. The default value is `Explicit`.', 'enumValueTitles' => ['Explicit' => 'explicit registration mode', 'Implicit' => 'implicit registration mode'], 'type' => 'string', 'required' => false, 'example' => 'Explicit', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Voiceprints' => [ 'description' => 'A list of voiceprint objects.', 'type' => 'array', 'items' => [ 'description' => 'A voiceprint object.', 'type' => 'object', 'properties' => [ 'VoiceprintId' => ['description' => 'The unique voiceprint ID.', 'type' => 'string', 'example' => 'vp_1699123456_8527', 'title' => ''], 'GmtCreate' => ['description' => 'The time the voiceprint was created. The time is in UTC and formatted according to the ISO 8601 standard.', 'type' => 'string', 'example' => '2025-07-28T10:03:58.000+00:00', 'title' => ''], 'GmtModified' => ['description' => 'The time the voiceprint was last modified. The time is in UTC and formatted according to the ISO 8601 standard.', 'type' => 'string', 'example' => '2025-07-28T10:03:58.000+00:00', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of matching voiceprints.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Voiceprints\\": [\\n {\\n \\"VoiceprintId\\": \\"vp_1699123456_8527\\",\\n \\"GmtCreate\\": \\"2025-07-28T10:03:58.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-28T10:03:58.000+00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', 'title' => 'ListAIAgentVoiceprints', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListAIAgentVoiceprints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListAdInsertions' => [ 'summary' => 'Obtains ad insertion configurations.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238120', 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The configuration name. Fuzzy match is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ad'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting order of the configurations by creation time. asc: ascending. desc: descending.', 'enumValueTitles' => ['asc' => '', 'desc' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token that is used in the next request to retrieve a new page of results. If this parameter is used, the pagination parameters become invalid.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '******8EqYpQbZ6Eh7+Zz8DxVYoQ*****'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to retrieve in a subsequent request. If this parameter is used, the pagination parameters become invalid. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'title' => '', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Configs' => [ 'title' => '', 'description' => 'Array', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'AdInsertionConifgItemType', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'title' => '', 'example' => '2024-06-13T08:26:09Z'], 'LastModified' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'title' => '', 'example' => '2024-06-13T08:26:09Z'."\n"], 'Name' => ['description' => 'The name of the ad insertion configuration.', 'type' => 'string', 'title' => '', 'example' => 'my_ad'], 'ContentUrlPrefix' => ['description' => 'The URL prefix for the source content.', 'type' => 'string', 'title' => '', 'example' => 'https://source.com/'], 'AdsUrl' => ['description' => 'The request URL of the ad decision server (ADS).', 'type' => 'string', 'title' => '', 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'], 'ConfigAliases' => ['description' => 'The player parameter variables and aliases.', 'type' => 'string', 'title' => '', 'example' => '{'."\n" .' "player_params.p1": {'."\n" .' "1": "abc"'."\n" .' }'."\n" .'}'], 'PersonalizationThreshold' => ['description' => 'The personalization threshold that defines the maximum duration of underfilled time allowed in an ad break.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'SlateAdUrl' => ['description' => 'The URL of the slate ad.', 'type' => 'string', 'title' => '', 'example' => 'http://storage.com/slate1.mp4'], 'CdnConfig' => [ 'title' => '', 'description' => 'The CDN configurations.', 'type' => 'object', 'properties' => [ 'ContentSegmentUrlPrefix' => ['description' => 'The CDN prefix for content segments.', 'type' => 'string', 'title' => '', 'example' => 'http://cdn.com/'], 'AdSegmentUrlPrefix' => ['description' => 'The CDN prefix for ad segments.', 'type' => 'string', 'title' => '', 'example' => 'http://cdn.com/'], ], 'example' => '', ], 'AdMarkerPassthrough' => ['description' => 'Indicates whether ad marker passthrough is enabled.', 'type' => 'string', 'title' => '', 'example' => 'ON'], 'ManifestEndpointConfig' => [ 'title' => '', 'description' => 'The playback endpoint configuration.', 'type' => 'object', 'properties' => [ 'HlsPrefix' => ['description' => 'The prefix of the playback endpoint for HLS manifests.', 'type' => 'string', 'title' => '', 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'], 'DashPrefix' => ['description' => 'DASH manifest playback endpoint prefix', 'type' => 'string', 'title' => '', 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'], ], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'SortBy' => ['description' => 'The sorting order of the configurations by creation time. asc: ascending. desc: descending.', 'type' => 'string', 'title' => '', 'example' => 'asc'], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'NextToken' => ['description' => 'The token that is used in the next request to retrieve a new page of results. If this parameter is used, the pagination parameters become invalid.', 'type' => 'string', 'title' => '', 'example' => '******8EqYpQbZ6Eh7+Zz8DxVYoQ*****'], 'MaxResults' => ['description' => 'The maximum number of entries to retrieve in a subsequent request. If this parameter is used, the pagination parameters become invalid.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Configs\\": [\\n {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\\\n\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\",\\n \\"ConfigAliases\\": \\"{\\\\n \\\\\\"player_params.p1\\\\\\": {\\\\n \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\"\\\\n }\\\\n}\\",\\n \\"PersonalizationThreshold\\": 5,\\n \\"SlateAdUrl\\": \\"http://storage.com/slate1.mp4\\",\\n \\"CdnConfig\\": {\\n \\"ContentSegmentUrlPrefix\\": \\"http://cdn.com/\\",\\n \\"AdSegmentUrlPrefix\\": \\"http://cdn.com/\\"\\n },\\n \\"AdMarkerPassthrough\\": \\"ON\\",\\n \\"ManifestEndpointConfig\\": {\\n \\"HlsPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\",\\n \\"DashPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\"\\n }\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SortBy\\": \\"asc\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"******8EqYpQbZ6Eh7+Zz8DxVYoQ*****\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', 'title' => 'ListAdInsertions', 'changeSet' => [ ['createdAt' => '2025-05-29T03:34:26.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAdInsertions'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListAdInsertions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListAlerts' => [ 'summary' => 'Lists alerts received in MediaWeaver.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'ResourceArn', 'in' => 'query', 'schema' => ['description' => 'The ARN of the source or program.', 'type' => 'string', 'required' => true, 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The alert type.', 'type' => 'string', 'example' => 'Scheduling Error: An error occurred when building the schedule.'."\n" .'PlayBack Warning: Address pull exception when adding source.'."\n" .'info: Information.', 'required' => false, 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order. By default, the query results are sorted by creation time in descending order. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ 'name' => 'SortByModifiedTime', 'in' => 'query', 'schema' => ['description' => 'The sorting order by modification time. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ 'name' => 'GmtStart', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '2024-11-21T16:10:45Z', 'title' => ''], ], [ 'name' => 'GmtEnd', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '2024-11-22T16:10:45Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Alerts' => [ 'description' => 'The alerts.', 'type' => 'array', 'items' => [ 'description' => 'The alert information.', 'type' => 'object', 'properties' => [ 'ResourceArn' => ['description' => 'The ARN of the resource.', 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ScheduleError', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'Category' => ['description' => 'The alert type.', 'type' => 'string', 'example' => 'Scheduling Error: An error occurred when building the schedule.'."\n" .'PlayBack Warning: Address pull exception when adding source.'."\n" .'info: Information.', 'title' => ''], 'RelatedResourceArns' => ['description' => 'The ARN of the related resource.', 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the alert was received in UTC.', 'type' => 'string', 'example' => '2024-07-16T10:03Z', 'title' => ''], 'GmtModified' => ['description' => 'The time when the alert was modified in UTC.', 'type' => 'string', 'example' => '2024-07-16T10:03Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Alerts\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource\\",\\n \\"Code\\": \\"ScheduleError\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"Category\\": \\"Scheduling Error: An error occurred when building the schedule.\\\\nPlayBack Warning: Address pull exception when adding source.\\\\ninfo: Information.\\",\\n \\"RelatedResourceArns\\": \\"acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource\\",\\n \\"GmtCreate\\": \\"2024-07-16T10:03Z\\",\\n \\"GmtModified\\": \\"2024-07-16T10:03Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListAlerts', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListAlerts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListAllPublicMediaTags' => [ 'summary' => 'Queries a list of tags of media assets in the public media library.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'BusinessType', 'in' => 'query', 'schema' => ['description' => 'The business type of the media asset.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '"sticker"'], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID, which is used to distinguish between media assets of different types in the public domain.'."\n" ."\n" .'Set this parameter to Copyright\\_Music, which indicates music in the public domain.', 'type' => 'string', 'required' => false, 'example' => 'Copyright_Music', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B45F83B7-7F87-4792-BFE9-63CD2137CAF0'], 'MediaTagList' => [ 'title' => '', 'description' => 'The tags of media assets in the public media library.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MediaTagId' => ['description' => 'The ID of the media tag.', 'type' => 'string', 'title' => '', 'example' => 'sticker-gif'], 'MediaTagNameChinese' => ['description' => 'The name of the media tag in Chinese.', 'type' => 'string', 'title' => '', 'example' => 'Gif'], 'MediaTagNameEnglish' => ['description' => 'The name of the material tag in English.', 'type' => 'string', 'example' => 'Animated image', 'title' => ''], 'Options' => [ 'description' => 'The options.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OptionId' => ['description' => 'The option ID.', 'type' => 'string', 'example' => 'Angry', 'title' => ''], 'OptionEnglishName' => ['description' => 'The option name in English.', 'type' => 'string', 'example' => 'Angry', 'title' => ''], 'OptionChineseName' => ['description' => 'The option name in Chinese.', 'type' => 'string', 'example' => '愤怒', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B45F83B7-7F87-4792-BFE9-63CD2137CAF0\\",\\n \\"MediaTagList\\": [\\n {\\n \\"MediaTagId\\": \\"sticker-gif\\",\\n \\"MediaTagNameChinese\\": \\"Gif\\",\\n \\"MediaTagNameEnglish\\": \\"Animated image\\",\\n \\"Options\\": [\\n {\\n \\"OptionId\\": \\"Angry\\",\\n \\"OptionEnglishName\\": \\"Angry\\",\\n \\"OptionChineseName\\": \\"愤怒\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListAllPublicMediaTags', 'changeSet' => [ ['createdAt' => '2021-11-25T06:45:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'ListAvatarTrainingJobs' => [ 'summary' => 'Queries a list of digital human training jobs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '- The page number.'."\n" ."\n" .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '- The number of entries per page.'."\n" ."\n" .'- Default value: 10.'."\n" ."\n" .'- Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => '- The job state.'."\n" ."\n" .'- Valid values: Init, Queuing, Training, Success, and Fail.', 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'AvatarTrainingJobList' => [ 'description' => 'The list of digital human training jobs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'example' => '*****aded114489ea02e0addf93*****', 'title' => ''], 'AvatarId' => ['description' => 'The ID of the digital human.', 'type' => 'string', 'example' => 'Avatar-XXX', 'title' => ''], 'AvatarName' => ['description' => 'The name of the digital human.', 'type' => 'string', 'example' => 'Decimal', 'title' => ''], 'AvatarDescription' => ['description' => 'The description of the digital human.', 'type' => 'string', 'example' => 'This is a digital human used for a specific scenario.', 'title' => ''], 'AvatarType' => ['description' => 'The type of the digital human.', 'type' => 'string', 'example' => '2DAvatar', 'title' => ''], 'Status' => ['description' => 'The state of the digital human training job.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The status description.', 'type' => 'string', 'example' => 'Training succeeded', 'title' => ''], 'Portrait' => ['description' => 'The media asset ID of the portrait image.', 'type' => 'string', 'example' => '*****aded114489ea02e0addf93*****', 'title' => ''], 'FirstTrainingTime' => ['description' => '- The time when the first training was initiated.'."\n" ."\n" .'- The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:40Z', 'title' => ''], 'LastTrainingTime' => ['description' => '- The time when the last training was initiated.'."\n" ."\n" .'- The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:40Z', 'title' => ''], 'CreateTime' => ['description' => '- The time when the job was created.'."\n" ."\n" .'- The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-23T13:33:40Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"AvatarTrainingJobList\\": [\\n {\\n \\"JobId\\": \\"*****aded114489ea02e0addf93*****\\",\\n \\"AvatarId\\": \\"Avatar-XXX\\",\\n \\"AvatarName\\": \\"Decimal\\",\\n \\"AvatarDescription\\": \\"This is a digital human used for a specific scenario.\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"Training succeeded\\",\\n \\"Portrait\\": \\"*****aded114489ea02e0addf93*****\\",\\n \\"FirstTrainingTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"LastTrainingTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"CreateTime\\": \\"2020-12-23T13:33:40Z\\"\\n }\\n ],\\n \\"TotalCount\\": 3\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListAvatarTrainingJobs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvatarTrainingJobs'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListAvatarTrainingJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListAvatars' => [ 'summary' => 'Queries a list of trained digital humans.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => '- The page number.'."\n" ."\n" .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '- The number of entries per page.'."\n" ."\n" .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'AvatarType', 'in' => 'query', 'schema' => ['description' => '- The type of the digital human.'."\n" ."\n" .'- 2DAvatar', 'type' => 'string', 'required' => false, 'example' => '2DAvatar', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'AvatarList' => [ 'description' => 'The queried digital humans.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AvatarId' => ['description' => 'The ID of the digital human.', 'type' => 'string', 'example' => 'Avatar-XXX', 'title' => ''], 'AvatarName' => ['description' => 'The name of the digital human.', 'type' => 'string', 'example' => 'Decimal', 'title' => ''], 'AvatarDescription' => ['description' => 'The description of the digital human.', 'type' => 'string', 'example' => 'This is a digital human used for a specific scenario.', 'title' => ''], 'AvatarType' => ['description' => 'The type of the digital human.', 'type' => 'string', 'example' => '2DAvatar', 'title' => ''], 'Thumbnail' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', 'title' => ''], 'Portrait' => ['description' => 'The media asset ID of the portrait image.', 'type' => 'string', 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], 'Transparent' => ['description' => 'Indicates whether the digital human image supports the alpha channels.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"AvatarList\\": [\\n {\\n \\"AvatarId\\": \\"Avatar-XXX\\",\\n \\"AvatarName\\": \\"Decimal\\",\\n \\"AvatarDescription\\": \\"This is a digital human used for a specific scenario.\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Thumbnail\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png\\",\\n \\"Portrait\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Transparent\\": true\\n }\\n ],\\n \\"TotalCount\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListAvatars', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvatars'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListAvatars', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListBatchMediaProducingJobs' => [ 'summary' => 'Queries a list of quick video production jobs based on conditions such as the job type and state.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '216608', 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the quick video production job.', 'type' => 'string', 'required' => false, 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], [ 'name' => 'JobType', 'in' => 'query', 'schema' => [ 'description' => 'The job type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Script: script-based editing job that mixes media assets.'."\n" ."\n" .'- Smart\\_Mix: intelligent editing job that mixes media assets.', 'enumValueTitles' => ['Script' => '', 'Smart_Mix' => ''], 'type' => 'string', 'required' => false, 'example' => 'Script', 'title' => '', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The job state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Finished'."\n" ."\n" .'- Init'."\n" ."\n" .'- Failed'."\n" ."\n" .'- Processing', 'enumValueTitles' => ['Finished' => '', 'Init' => '', 'Failed' => '', 'Processing' => ''], 'type' => 'string', 'required' => false, 'example' => 'Finished', 'title' => '', ], ], [ 'name' => 'StartTime', '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.', 'type' => 'string', 'required' => false, 'example' => '2022-02-02T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', '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.', 'type' => 'string', 'required' => false, 'example' => '2023-06-05T15:59:59Z', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting parameter. Valid values:'."\n" ."\n" .'- desc (default): sorted by creation time in descending order.'."\n" ."\n" .'- asc: sorted by creation time in ascending order.'."\n" ."\n" .'', 'enumValueTitles' => ['asc' => '', 'desc' => ''], 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => 'mRZkKAovub0xWVfH14he4Q==', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'EditingBatchJobList' => [ 'description' => 'The queried quick video production jobs.', 'type' => 'array', 'items' => [ 'description' => 'The queried quick video production job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the quick video production job.', 'type' => 'string', 'example' => '******7ecbee4c6d9b8474498e******', 'title' => ''], 'InputConfig' => ['description' => 'The input configurations.', 'type' => 'string', 'example' => '{'."\n" .'  "MediaGroupArray": [{'."\n" .'      "MediaArray": ['."\n" .'        "****9d46c886b45481030f6e****",'."\n" .'        "****6c886b4549d481030f6e****" ]'."\n" .'    }, {'."\n" .'      "MediaArray": ['."\n" .'        "****d46c886810b454930f6e****",'."\n" .'        "****4549d886810b46c30f6e****" ]'."\n" .'  }],'."\n" .'  "TitleArray": ['."\n" .'      "Hema Fresh grand opening at Huilongguan"],'."\n" .'  "SpeechTextArray": ['."\n" .'      "A new Hema Fresh store just opened at the nearby mall, today is the first day of business"]'."\n" .'}', 'title' => ''], 'EditingConfig' => ['description' => 'The editing configurations. For more information, see [EditingConfig](~~2692547#1be9bba03b7qu~~).', 'type' => 'string', 'example' => '{'."\n" .' "MediaConfig": {'."\n" .' "Volume": 0'."\n" .' },'."\n" .' "SpeechConfig": {'."\n" .' "Volume": 1'."\n" .' },'."\n" .' "BackgroundMusicConfig": {'."\n" .' "Volume": 0.3'."\n" .' }'."\n" .'}', 'title' => ''], 'OutputConfig' => ['description' => 'The output configurations. For more information, see [OutputConfig](~~2692547#447b928fcbuoa~~).', 'type' => 'string', 'example' => '{'."\n" .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" .' "Count": 20,'."\n" .' "MaxDuration": 15,'."\n" .' "Width": 1080,'."\n" .' "Height": 1920,'."\n" .' "Video": {"Crf": 27}'."\n" .'}', 'title' => ''], 'Status' => [ 'description' => 'The job state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Finished'."\n" ."\n" .'- Init'."\n" ."\n" .'- Failed'."\n" ."\n" .'- Processing', 'enumValueTitles' => ['Finished' => '', 'Init' => '', 'Failed' => '', 'Processing' => ''], 'type' => 'string', 'example' => 'Finished', 'title' => '', ], 'UserData' => ['description' => 'The user-defined data in the JSON format, which can be up to 512 bytes in length. You can specify a custom callback URL. For more information, see [Configure a callback upon editing completion](~~451631~~).', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}', 'title' => ''], 'Extend' => ['description' => 'The extended information of the job.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-06-09T06:36:48Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2023-06-09T06:37:58Z', 'title' => ''], 'CompleteTime' => [ 'description' => 'The time when the job was complete. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'enumValueTitles' => [], 'type' => 'string', 'example' => '2023-06-09T06:38:09Z'."\n", 'title' => '', ], 'JobType' => [ 'description' => 'The job type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Script: script-based editing job that mixes media assets.'."\n" ."\n" .'- Smart\\_Mix: intelligent editing job that mixes media assets.', 'enumValueTitles' => ['Script' => '', 'Smart_Mix' => ''], 'type' => 'string', 'example' => 'Script', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', 'title' => ''], 'MaxResults' => ['description' => 'The number of entries per page. Valid values: 1 to 100.'."\n" ."\n" .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"EditingBatchJobList\\": [\\n {\\n \\"JobId\\": \\"******7ecbee4c6d9b8474498e******\\",\\n \\"InputConfig\\": \\"{\\\\n  \\\\\\"MediaGroupArray\\\\\\": [{\\\\n      \\\\\\"MediaArray\\\\\\": [\\\\n        \\\\\\"****9d46c886b45481030f6e****\\\\\\",\\\\n        \\\\\\"****6c886b4549d481030f6e****\\\\\\" ]\\\\n    }, {\\\\n      \\\\\\"MediaArray\\\\\\": [\\\\n        \\\\\\"****d46c886810b454930f6e****\\\\\\",\\\\n        \\\\\\"****4549d886810b46c30f6e****\\\\\\" ]\\\\n  }],\\\\n  \\\\\\"TitleArray\\\\\\": [\\\\n      \\\\\\"Hema Fresh grand opening at Huilongguan\\\\\\"],\\\\n  \\\\\\"SpeechTextArray\\\\\\": [\\\\n      \\\\\\"A new Hema Fresh store just opened at the nearby mall, today is the first day of business\\\\\\"]\\\\n}\\",\\n \\"EditingConfig\\": \\"{\\\\n \\\\\\"MediaConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0\\\\n },\\\\n \\\\\\"SpeechConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 1\\\\n },\\\\n \\\\\\"BackgroundMusicConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0.3\\\\n }\\\\n}\\",\\n \\"OutputConfig\\": \\"{\\\\n \\\\\\"MediaURL\\\\\\": \\\\\\"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\\\\\\",\\\\n \\\\\\"Count\\\\\\": 20,\\\\n \\\\\\"MaxDuration\\\\\\": 15,\\\\n \\\\\\"Width\\\\\\": 1080,\\\\n \\\\\\"Height\\\\\\": 1920,\\\\n \\\\\\"Video\\\\\\": {\\\\\\"Crf\\\\\\": 27}\\\\n}\\",\\n \\"Status\\": \\"Finished\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"} or {\\\\\\"NotifyAddress\\\\\\":\\\\\\"https://xx.xx.xxx\\\\\\"} or {\\\\\\"NotifyAddress\\\\\\":\\\\\\"ice-callback-demo\\\\\\"}\\",\\n \\"Extend\\": \\"{}\\",\\n \\"CreateTime\\": \\"2023-06-09T06:36:48Z\\",\\n \\"ModifiedTime\\": \\"2023-06-09T06:37:58Z\\",\\n \\"CompleteTime\\": \\"2023-06-09T06:38:09Z\\\\n\\",\\n \\"JobType\\": \\"Script\\"\\n }\\n ],\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"MaxResults\\": 100\\n}","type":"json"}]', 'title' => 'ListBatchMediaProducingJobs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListBatchMediaProducingJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListChannelAlerts' => [ 'summary' => 'Lists alerts for resources in a MediaWeaver channel.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'ResourceArn', 'in' => 'query', 'schema' => ['description' => 'The ARN of the channel.', 'type' => 'string', 'required' => true, 'example' => 'acs:ims:mediaweaver:::channel/myChannel', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The alert type.', 'type' => 'string', 'example' => 'Scheduling Error: An error occurred when building the schedule.'."\n" .'PlayBack Warning: Address pull exception when adding source.'."\n" .'info: Information.', 'required' => false, 'title' => ''], ], [ 'name' => 'SortByModifiedTime', 'in' => 'query', 'schema' => ['description' => 'The sorting order by modification time. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'GmtStart', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '2024-11-21T16:10:45Z', 'title' => ''], ], [ 'name' => 'GmtEnd', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '2024-11-21T16:10:45Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'TotalCount' => ['description' => 'The total number of alerts returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'ProgramAlerts' => [ 'description' => 'The alerts.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Arn' => ['description' => 'The ARN of the program.', 'type' => 'string', 'example' => 'acs:ims:mediaweaver:::program/myChannel/MyProgram', 'title' => ''], 'ProgramName' => ['description' => 'The name of the program.', 'type' => 'string', 'example' => 'program_name', 'title' => ''], 'Category' => ['description' => 'The alert type.', 'type' => 'string', 'example' => 'Scheduling Error: An error occurred when building the schedule.'."\n" .'PlayBack Warning: Address pull exception when adding source.'."\n" .'info: Information.', 'title' => ''], 'Count' => ['description' => 'The number of alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'GmtModified' => ['description' => 'The time when the alert was last modified in UTC.', 'type' => 'string', 'example' => '2024-07-16T10:03Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 4,\\n \\"ProgramAlerts\\": [\\n {\\n \\"Arn\\": \\"acs:ims:mediaweaver:::program/myChannel/MyProgram\\",\\n \\"ProgramName\\": \\"program_name\\",\\n \\"Category\\": \\"Scheduling Error: An error occurred when building the schedule.\\\\nPlayBack Warning: Address pull exception when adding source.\\\\ninfo: Information.\\",\\n \\"Count\\": 4,\\n \\"GmtModified\\": \\"2024-07-16T10:03Z\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', 'title' => 'ListChannelAlerts', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListChannelAlerts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListChannels' => [ 'summary' => 'Lists MediaWeaver channels.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => false, 'example' => 'MyChannel', 'title' => ''], ], [ 'name' => 'ChannelTier', 'in' => 'query', 'schema' => ['description' => 'The tier of the channel. Valid values: basic and standard.', 'type' => 'string', 'required' => false, 'example' => 'basic', 'title' => ''], ], [ 'name' => 'PlaybackMode', 'in' => 'query', 'schema' => ['description' => 'The playback mode. Valid values: loop and linear.', 'type' => 'string', 'required' => false, 'example' => 'loop', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The channel status. A value of 0 specifies stopped. A value of 1 specifies started.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SortByModifiedTime', 'in' => 'query', 'schema' => ['description' => 'The sorting order by modification time. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order by creation time. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'TotalCount' => ['description' => 'The total number of channels returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '180', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ChannelList' => [ 'description' => 'The channels.', 'type' => 'array', 'items' => ['description' => 'The channel information.', '$ref' => '#/components/schemas/ChannelAssemblyChannel', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 180,\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"ChannelList\\": [\\n {\\n \\"FillerSourceName\\": \\"MySource\\",\\n \\"FillerSourceLocationName\\": \\"MySourceLocation\\",\\n \\"GmtCreate\\": \\"2024-01-15T03:44:16Z\\\\n\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"ChannelTier\\": \\"basic\\",\\n \\"AccessToken\\": \\"xxxxx\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"2024-09-01T10:09Z\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::channel/myChannel\\\\n\\",\\n \\"PlaybackMode\\": \\"loop\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"index1\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"Format\\": \\"hls\\",\\n \\"PlaybackUrl\\": \\"https://xxxxx.com/xxx.m3u8\\\\n\\",\\n \\"ManifestSettings\\": \\"{\\\\\\"WindowDuration\\\\\\": 60,\\\\\\"AdMarkType\\\\\\":\\\\\\"Daterange\\\\\\"}\\\\n\\",\\n \\"SourceGroupName\\": \\"group1\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListChannels', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListChannels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListCustomTemplates' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceEO4QPO'], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The type of the template. Valid values:'."\n" ."\n" .'- 1: Transcoding Template'."\n" ."\n" .'- 2: Screenshot Template'."\n" ."\n" .'- 3: Animated GIF Template'."\n" ."\n" .'- 4: Image Watermark Template'."\n" ."\n" .'- 5: Text Watermark Template'."\n" ."\n" .'- 6: Subtitle Template'."\n" ."\n" .'- 7: AI Content Moderation'."\n" ."\n" .'- 8: AI-powered Smart Cover'."\n" ."\n" .'- 9: AI-powered Object Removal', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Subtype', 'in' => 'query', 'schema' => ['description' => 'The subtype of the template. This parameter applies only when `Type` is set to 1, 2, 7, or 9.'."\n" ."\n" .'- Transcoding Template subtypes:'."\n" ."\n" .' - 1: Normal (`Normal`)'."\n" ."\n" .' - 2: Audio-only (`AudioTranscode`)'."\n" ."\n" .' - 3: Remuxing (`Remux`)'."\n" ."\n" .' - 4: Narrowband HD 1.0 (`NarrowBandV1`)'."\n" ."\n" .' - 5: Narrowband HD 2.0 (`NarrowBandV2`)'."\n" ."\n" .'- Screenshot Template subtypes:'."\n" ."\n" .' - 1: Normal (`Normal`)'."\n" ."\n" .' - 2: Sprite Image (`Sprite`)'."\n" ."\n" .' - 3: WebVTT (`WebVtt`)'."\n" ."\n" .'- AI Content Moderation subtypes:'."\n" ."\n" .' - 1: Video moderation (`Video`)'."\n" ."\n" .' - 2: Audio moderation (`Audio`)'."\n" ."\n" .' - 3: Image moderation (`Image`)'."\n" ."\n" .'- AI-powered Object Removal subtypes:'."\n" ."\n" .' - 1: Logo Removal (`VideoDelogo`)'."\n" ."\n" .' - 2: Text Removal (`VideoDetext`)', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the template.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-template'], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****96e8864746a0b6f3****'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => 'The sort order of the results. Valid values:'."\n" ."\n" .'- `CreationTime:Desc`: Sorts the results by Creation Time in descending order.'."\n" ."\n" .'- `CreationTime:Asc`: Sorts the results by Creation Time in ascending order.', 'enumValueTitles' => [], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CreateTimeDesc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The root object of the response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Total' => ['description' => 'The total number of templates.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'CustomTemplateList' => [ 'title' => '', 'description' => 'An array of custom template objects.', 'type' => 'array', 'items' => [ 'description' => 'Details of a custom template.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'test-template', 'title' => ''], 'Type' => ['description' => 'The template type ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TypeName' => ['description' => 'The template type name.', 'type' => 'string', 'example' => 'TranscodeTemplate', 'title' => ''], 'Subtype' => ['description' => 'The template subtype ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'SubtypeName' => ['description' => 'The template subtype name.', 'type' => 'string', 'example' => 'AudioTranscode', 'title' => ''], 'Status' => [ 'description' => 'The template status.', 'enumValueTitles' => ['Normal' => 'The template is in a normal state.'], 'type' => 'string', 'example' => 'Normal', 'title' => '', ], 'IsDefault' => [ 'description' => 'Whether the template is a default template.', 'enumValueTitles' => ['true' => 'The template is a default template.', 'false' => 'The template is not a default template.'], 'type' => 'boolean', 'example' => 'true', 'title' => '', ], 'TemplateConfig' => ['description' => 'The template configuration, as a JSON string.', 'type' => 'string', 'title' => '', 'example' => '{"Container":{"Format":"mp3"},"Audio":{"Codec":"mp3","Bitrate":"64","Samplerate":"22050","Channels":"2"}}'], 'CreateTime' => ['description' => 'The time when the template was created, in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified, in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'FrontendHint' => [ 'type' => 'object', 'properties' => [ 'TranscodeTemplateHint' => [ 'type' => 'object', 'properties' => [ 'BitrateControlType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'ListCustomTemplates', 'summary' => 'Retrieves a list of user-defined Video on Demand (VOD) media processing templates.', 'changeSet' => [ ['createdAt' => '2024-10-24T00:59:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-18T03:29:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-11T09:38:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomTemplates'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListCustomTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Total\\": 20,\\n \\"CustomTemplateList\\": [\\n {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": 2,\\n \\"SubtypeName\\": \\"AudioTranscode\\",\\n \\"Status\\": \\"Normal\\",\\n \\"IsDefault\\": true,\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"mp3\\\\\\"},\\\\\\"Audio\\\\\\":{\\\\\\"Codec\\\\\\":\\\\\\"mp3\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"64\\\\\\",\\\\\\"Samplerate\\\\\\":\\\\\\"22050\\\\\\",\\\\\\"Channels\\\\\\":\\\\\\"2\\\\\\"}}\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FrontendHint\\": {\\n \\"TranscodeTemplateHint\\": {\\n \\"BitrateControlType\\": \\"\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListCustomizedVoiceJobs' => [ 'summary' => 'Queries a list of human voice cloning jobs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the human voice cloning job. Valid values:'."\n" ."\n" .'- Basic'."\n" ."\n" .'- Standard'."\n" ."\n" .'> : If you do not specify this parameter, the default value Basic is used.', 'type' => 'string', 'enum' => ['Basic', 'Standard', 'Premium'], 'required' => false, 'example' => 'Standard', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'CustomizedVoiceJobList' => [ 'description' => 'The queried human voice cloning jobs.', 'type' => 'array', 'items' => [ 'description' => 'The queried human voice cloning job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the human voice cloning job.', 'type' => 'string', 'example' => '2245ab99a7fd4116a4fd3f499b7a56c5', 'title' => ''], 'VoiceId' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'xiaozhuan', 'title' => ''], 'Status' => ['description' => 'The job state. Valid values:'."\n" ."\n" .'- Initialization'."\n" ."\n" .'- AudioDetecting'."\n" ."\n" .'- PreTraining'."\n" ."\n" .'- Training'."\n" ."\n" .'- Success'."\n" ."\n" .'- Fail', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Training succeeded', 'title' => ''], 'VoiceName' => ['description' => 'The voice name.'."\n" ."\n" .'- The name can be up to 32 characters in length.', 'type' => 'string', 'example' => '小专', 'title' => ''], 'VoiceDesc' => ['description' => 'The voice description.'."\n" ."\n" .'- The description can be up to 256 characters in length.', 'type' => 'string', 'example' => '这是这个声音的描述', 'title' => ''], 'Type' => ['description' => '- The voice type. Valid values:'."\n" ."\n" .' - Basic'."\n" ."\n" .' - Standard', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'Gender' => ['description' => 'The gender. Valid values:'."\n" ."\n" .'- female'."\n" ."\n" .'- male', 'type' => 'string', 'example' => 'female', 'title' => ''], 'Scenario' => ['description' => 'The scenario. Valid values:'."\n" ."\n" .'- story'."\n" ."\n" .'- interaction'."\n" ."\n" .'- navigation', 'type' => 'string', 'example' => 'story', 'title' => ''], 'CreateTime' => ['description' => '- The time when the job was created.'."\n" ."\n" .'- The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-04-01T06:23:59Z', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-06-27T02:42:28Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '271', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Data\\": {\\n \\"CustomizedVoiceJobList\\": [\\n {\\n \\"JobId\\": \\"2245ab99a7fd4116a4fd3f499b7a56c5\\",\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"Training succeeded\\",\\n \\"VoiceName\\": \\"小专\\",\\n \\"VoiceDesc\\": \\"这是这个声音的描述\\",\\n \\"Type\\": \\"Standard\\",\\n \\"Gender\\": \\"female\\",\\n \\"Scenario\\": \\"story\\",\\n \\"CreateTime\\": \\"2023-04-01T06:23:59Z\\",\\n \\"GmtCreate\\": \\"2022-06-27T02:42:28Z\\"\\n }\\n ],\\n \\"TotalCount\\": 271\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListCustomizedVoiceJobs', 'changeSet' => [ ['createdAt' => '2023-11-21T07:13:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomizedVoiceJobs'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListCustomizedVoiceJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListCustomizedVoices' => [ 'summary' => 'Queries a list of personalized human voices.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => '- The voice type. Valid values:'."\n" ."\n" .' - Basic'."\n" ."\n" .' - Standard'."\n" ."\n" .'- If you do not specify this parameter, the default value Basic is used.', 'type' => 'string', 'required' => false, 'example' => 'Standard', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'CustomizedVoiceList' => [ 'description' => 'The queried personalized human voices.', 'type' => 'array', 'items' => [ 'description' => 'The personalized human voice.', 'type' => 'object', 'properties' => [ 'VoiceId' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'xiaozhuan', 'title' => ''], 'VoiceName' => ['description' => 'The voice name.', 'type' => 'string', 'example' => '小专', 'title' => ''], 'VoiceDesc' => ['description' => 'The voice description.', 'type' => 'string', 'example' => '这是一个个性化人声小专', 'title' => ''], 'Gender' => ['description' => 'The gender. Valid values:'."\n" ."\n" .'- female'."\n" ."\n" .'- male', 'type' => 'string', 'example' => 'male', 'title' => ''], 'Scenario' => ['description' => 'The scenario. Valid values:'."\n" ."\n" .'- story'."\n" ."\n" .'- interaction'."\n" ."\n" .'- navigation', 'type' => 'string', 'example' => 'story', 'title' => ''], 'DemoAudioMediaId' => ['description' => 'The media asset ID of the sample audio file.', 'type' => 'string', 'example' => '****4d5e829d498aaf966b119348****', 'title' => ''], 'Type' => ['description' => '- The voice type. Valid values:'."\n" ."\n" .' - Basic'."\n" ."\n" .' - Standard', 'type' => 'string', 'example' => 'Standard', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '41', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"CustomizedVoiceList\\": [\\n {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"VoiceName\\": \\"小专\\",\\n \\"VoiceDesc\\": \\"这是一个个性化人声小专\\",\\n \\"Gender\\": \\"male\\",\\n \\"Scenario\\": \\"story\\",\\n \\"DemoAudioMediaId\\": \\"****4d5e829d498aaf966b119348****\\",\\n \\"Type\\": \\"Standard\\"\\n }\\n ],\\n \\"TotalCount\\": 41\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListCustomizedVoices', 'changeSet' => [ ['createdAt' => '2023-11-21T07:13:54.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomizedVoices'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListCustomizedVoices', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListDNADB' => [ 'summary' => 'Queries a list of media fingerprint libraries.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '146937', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'DBIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the media fingerprint libraries. We recommend that you query at most 10 libraries at a time. Separate multiple library IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '2288c6ca184c0e47098a5b665e2a12****,78dc866518b843259669df58ed30****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBList' => [ 'description' => 'The queried media fingerprint libraries.', 'type' => 'array', 'items' => [ 'description' => 'The queried media fingerprint library.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The state of the media fingerprint library. Default value: **offline**. \\*\\*\\*\\*Valid values:'."\n" ."\n" .'- **offline**: The media fingerprint library is offline.'."\n" ."\n" .'- **active**: The media fingerprint library is online.'."\n" ."\n" .'- **deleted**: The media fingerprint library is deleted.', 'type' => 'string', 'example' => 'active', 'title' => ''], 'Description' => ['description' => 'The description of the media fingerprint library.', 'type' => 'string', 'example' => 'This is a video DNA library.', 'title' => ''], 'Name' => ['description' => 'The name of the media fingerprint library.', 'type' => 'string', 'example' => 'example-name', 'title' => ''], 'Model' => ['description' => 'The model of the media fingerprint library. Valid values:'."\n" ."\n" .'- **Video**'."\n" ."\n" .'- **Audio**'."\n" ."\n" .'- **Image**'."\n" ."\n" .'- **Text** (supported only in the China (Shanghai) region)', 'type' => 'string', 'example' => 'Video', 'title' => ''], 'DBId' => ['description' => 'The ID of the media fingerprint library.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBList\\": [\\n {\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"This is a video DNA library.\\",\\n \\"Name\\": \\"example-name\\",\\n \\"Model\\": \\"Video\\",\\n \\"DBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\"\\n }\\n ],\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\"\\n}","type":"json"}]', 'title' => 'ListDNADB', 'changeSet' => [ ['createdAt' => '2024-07-23T02:07:32.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-25T07:23:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDNADB'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListDNADB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListDNAFiles' => [ 'summary' => 'Lists files in a media fingerprint library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], '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. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => 'ae0fd49c0840e14daf0d66a75b83****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '10', 'title' => ''], ], [ 'name' => 'DBId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media fingerprint library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2AE89FA5-E620-56C7-9B80-75D09757385A', 'title' => ''], 'NextPageToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'ae0fd49c0840e14daf0d66a75b83****', 'title' => ''], 'FileList' => [ 'description' => 'The queried files.', 'type' => 'array', 'items' => [ 'description' => 'The queried file.', 'type' => 'object', 'properties' => [ 'PrimaryKey' => ['description' => 'The primary key of the file.', 'type' => 'string', 'example' => 'ae0fd49c0840e14daf0d66a75b83****', 'title' => ''], 'InputFile' => [ 'description' => 'The Object Storage Service (OSS) information about the input file.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The name of the OSS object that is used as the input file.', 'type' => 'string', 'example' => 'example-****.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS region in which the input file resides.', 'type' => 'string', 'example' => 'oss-cn-beijing', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AE89FA5-E620-56C7-9B80-75D09757385A\\",\\n \\"NextPageToken\\": \\"ae0fd49c0840e14daf0d66a75b83****\\",\\n \\"FileList\\": [\\n {\\n \\"PrimaryKey\\": \\"ae0fd49c0840e14daf0d66a75b83****\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-****.mp4\\",\\n \\"Location\\": \\"oss-cn-beijing\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListDNAFiles', 'description' => 'Queries files in a media fingerprint library based on the library ID. The queried results can be paginated.', 'changeSet' => [ ['createdAt' => '2023-05-25T07:23:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDNAFiles'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListDNAFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListDynamicImageJobs' => [ 'summary' => 'Queries a list of image animation jobs.', 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range during which the jobs to be queried were created.', 'type' => 'string', 'required' => false, 'example' => '2022-07-12T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range during which the jobs to be queried were created.', 'type' => 'string', 'required' => false, 'example' => '2022-07-14T00:00:00Z', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The state of the job.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Init: The job is submitted.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Fail: The job failed.', 'enumValueTitles' => ['Init' => '', 'Success' => '', 'Fail' => ''], 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => '', ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => 'The order that you use to sort the query results. Valid values:'."\n" ."\n" .'1. CreateTimeAsc: sorts the jobs by creation time in ascending order.'."\n" ."\n" .'2. CreateTimeDesc: sorts the jobs by creation time in descending order.', 'enumValueTitles' => ['CreateTimeDesc' => '', 'CreateTimeAsc' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CreateTimeDesc', ], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****cdb3e74639973036bc84****'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cdb3e74639973036bc84'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResponse\\', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Jobs' => [ 'description' => 'The list of jobs.', 'type' => 'array', 'items' => [ 'description' => 'The information about an image animation job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], 'TriggerSource' => [ 'description' => 'The request trigger source.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Console'."\n" ."\n" .'- Workflow'."\n" ."\n" .'- API', 'enumValueTitles' => ['Console' => '', 'Workflow' => '', 'API' => 'API'], 'type' => 'string', 'example' => 'API', 'title' => '', ], 'Name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'SampleJob', 'title' => ''], 'Input' => [ 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'2. Media: a media asset.'."\n" ."\n" .'-'."\n" ."\n" .'-', 'enumValueTitles' => ['Media' => '', 'OSS' => ''], 'type' => 'string', 'example' => 'OSS', 'title' => '', ], 'Media' => ['description' => 'The input file. The file can be an OSS object or a media asset. The URL of an OSS object can be in one of the following formats:'."\n" ."\n" .'1. OSS://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS.', 'type' => 'string', 'example' => 'oss://bucket/object', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'The output of the job.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the output file. Valid values:'."\n" ."\n" .'1. OSS: an OSS object.'."\n" ."\n" .'2. Media: a media asset.'."\n" ."\n" .'-'."\n" ."\n" .'-', 'enumValueTitles' => ['Media' => '', 'OSS' => ''], 'type' => 'string', 'example' => 'Media', 'title' => '', ], 'Media' => ['description' => 'The input file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats:'."\n" ."\n" .'1. OSS://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], 'Status' => [ 'description' => 'The state of the job.'."\n" ."\n" .'- **Success**: The job is successful.'."\n" ."\n" .'- **Fail**: The job failed.'."\n" ."\n" .'- **Init**: The job is submitted.', 'enumValueTitles' => ['Init' => '', 'Success' => '', 'Fail' => ''], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'SubmitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****'."\n", 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Jobs\\": [\\n {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"SampleJob\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"Media\\",\\n \\"Media\\": \\"****cdb3e74639973036bc84****\\"\\n },\\n \\"TemplateId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"PipelineId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"Status\\": \\"Success\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"****cdb3e74639973036bc84****\\\\n\\"\\n}","type":"json"}]', 'title' => 'ListDynamicImageJobs', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDynamicImageJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListDynamicImageJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListEditingProjects' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'PrivateKey' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '182100', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'ProjectType', 'in' => 'query', 'schema' => ['description' => 'The type of the editing project. Valid values:'."\n" ."\n" .'- EditingProject: a regular editing project.'."\n" ."\n" .'- LiveEditingProject: a live stream editing project.', 'type' => 'string', 'required' => false, 'example' => 'EditingProject', 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => 'The template type. This parameter is required if you create a template-based online editing project. Default value: Timeline.'."\n" ."\n" .'-'."\n" ."\n" .'-'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Timeline: a regular template.'."\n" ."\n" .'- VETemplate: an advanced template.'."\n" ."\n" .'- None: general editing.', 'enumValueTitles' => ['Timeline' => '', 'VETemplate' => '', 'None' => ''], 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => '', ], ], [ 'name' => 'StartTime', '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.', 'type' => 'string', 'required' => false, 'example' => '2017-12-21T08:00:01Z', 'title' => ''], ], [ 'name' => 'EndTime', '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.', 'type' => 'string', 'required' => false, 'example' => '2022-02-02T23:59:59Z', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. You can search by job ID.', 'type' => 'string', 'required' => false, 'example' => '******6f36bc45d09a9d5cde49******', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status of the online editing project. By default, online editing projects in all states are queried.', 'type' => 'string', 'required' => false, 'example' => 'Produced', 'title' => ''], ], [ 'name' => 'CreateSource', 'in' => 'query', 'schema' => ['description' => 'The method for creating the online editing project. Valid values:'."\n" ."\n" .'\\- OpenAPI'."\n" ."\n" .'\\- AliyunConsole'."\n" ."\n" .'\\- WebSDK', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. A maximum of 100 entries can be returned on each page.'."\n" ."\n" .'Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The order of sorting of the results. Valid values:'."\n" ."\n" .'- CreationTime:Desc (default): sorts the results in reverse chronological order.'."\n" ."\n" .'- CreationTime:Asc: sorts the results in chronological order.', 'type' => 'string', 'required' => false, 'example' => 'CreationTime:Desc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Nzv3rcKla9wHUGua9YXHNA=='], 'MaxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'ProjectList' => [ 'description' => 'The queried online editing projects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'example' => '****fddd7748b58bf1d47e95****', 'title' => ''], 'Title' => ['description' => 'The title of the online editing project.', 'type' => 'string', 'example' => 'Project title', 'title' => ''], 'Description' => ['description' => 'The description of the online editing project.', 'type' => 'string', 'example' => '工程描述', 'title' => ''], 'CoverURL' => ['description' => 'The thumbnail URL of the online editing project.', 'type' => 'string', 'example' => 'https://xxx.com/cover/xxx.jpg', 'title' => ''], 'CreateTime' => ['description' => 'The time when the online editing project was created.', 'type' => 'string', 'example' => '2017-01-11T12:00:00Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the online editing project was last modified.', 'type' => 'string', 'example' => '2017-01-11T12:00:00Z', 'title' => ''], 'Status' => ['description' => 'The status of the online editing project. Valid values:'."\n" ."\n" .'\\- Draft'."\n" ."\n" .'\\- Editing'."\n" ."\n" .'\\- Producing'."\n" ."\n" .'\\- Produced'."\n" ."\n" .'\\- ProduceFailed', 'type' => 'string', 'example' => 'Produced', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the production of the online editing project failed.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned if the production of the online editing project failed.', 'type' => 'string', 'example' => 'The specified parameter \\"LiveStreamConfig\\" is not valid. specified parameter example is not valid.', 'title' => ''], 'CreateSource' => ['description' => 'The method for editing the online editing project. Valid values:'."\n" ."\n" .'\\- OpenAPI'."\n" ."\n" .'\\- AliyunConsole'."\n" ."\n" .'\\- WebSDK', 'type' => 'string', 'example' => 'OpenAPI', 'title' => ''], 'ModifiedSource' => ['description' => 'The method for modifying the online editing project last time.', 'type' => 'string', 'example' => 'OpenAPI', 'title' => ''], 'TemplateType' => ['description' => 'The template type. Valid values:'."\n" ."\n" .'- Timeline: a regular template.'."\n" ."\n" .'- VETemplate: an advanced template.', 'type' => 'string', 'example' => 'Timeline', 'title' => ''], 'ProjectType' => ['description' => 'The type of the editing project. Valid values:'."\n" ."\n" .'- EditingProject: a regular editing project.'."\n" ."\n" .'- LiveEditingProject: a live stream editing project.', 'type' => 'string', 'example' => 'EditingProject', 'title' => ''], 'BusinessConfig' => ['description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'BusinessStatus' => ['description' => 'The business status of the project. This parameter can be ignored for general editing projects.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListEditingProjects', 'summary' => 'Queries a list of projects that meet the specified conditions. You can filter projects by project creation time.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListEditingProjects', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"NextToken\\": \\"Nzv3rcKla9wHUGua9YXHNA==\\",\\n \\"MaxResults\\": 10,\\n \\"ProjectList\\": [\\n {\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"Title\\": \\"Project title\\",\\n \\"Description\\": \\"工程描述\\",\\n \\"CoverURL\\": \\"https://xxx.com/cover/xxx.jpg\\",\\n \\"CreateTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Status\\": \\"Produced\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"ErrorMessage\\": \\"The specified parameter \\\\\\\\\\\\\\"LiveStreamConfig\\\\\\\\\\\\\\" is not valid. specified parameter example is not valid.\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"ProjectType\\": \\"EditingProject\\",\\n \\"BusinessConfig\\": \\"{}\\",\\n \\"BusinessStatus\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListHotwordLibraries' => [ 'summary' => 'Queries hotword libraries that meet specific search conditions.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '****73f33c91-d59383e8280b****', 'title' => '', 'required' => false], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order. By default, the query results are sorted by creation time in descending order.', 'type' => 'string', 'example' => 'CreationTime:Desc', 'title' => '', 'required' => false], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the hotword library.', 'type' => 'string', 'example' => 'Hotword library name', 'required' => false, 'title' => ''], ], [ 'name' => 'UsageScenario', 'in' => 'query', 'schema' => ['description' => 'The usage scenario of the hotword library. Valid values:'."\n" ."\n" .'- ASR: Automatic Speech Recognition'."\n" ."\n" .'- StructuredMediaAssets: structured media analysis'."\n" ."\n" .'- VideoTranslation: Video translation. This field cannot be modified after the hotword library is created.', 'type' => 'string', 'example' => 'ASR', 'title' => '', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => '', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => '', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return.'."\n" ."\n" .'Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', 'title' => ''], 'NextToken' => ['description' => 'A pagination token that can be used in the next request to retrieve a new page of results. If it is empty, all results are returned.', 'type' => 'string', 'example' => 'CBB6BC61D08', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of hotword libraries that can be returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of hotword libraries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'HotwordLibraryList' => [ 'description' => 'The hotword libraries.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'The description of the hotword library. It can be up to 200 characters in length.', 'type' => 'string', 'example' => 'Lexicon containing celebrity names', 'title' => ''], 'UsageScenario' => ['description' => 'The usage scenario of the hotword library. Valid values:'."\n" ."\n" .'- ASR: Automatic Speech Recognition'."\n" ."\n" .'- StructuredMediaAssets: structured media analysis'."\n" ."\n" .'- VideoTranslation: Video translation This field cannot be modified after the hotword library is created.', 'type' => 'string', 'example' => 'ASR', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the hotword library was last modified.', 'type' => 'string', 'example' => '2017-01-11T12:00:00Z'."\n", 'title' => ''], 'CreationTime' => ['description' => 'The time when the hotword library was created.', 'type' => 'string', 'example' => '2017-01-11T12:00:00Z', 'title' => ''], 'HotwordLibraryId' => ['description' => 'The ID of the hotword library.', 'type' => 'string', 'example' => 'a93b91141c0f422fa114af203f8b****', 'title' => ''], 'Name' => ['description' => 'The name of the hotword library.', 'type' => 'string', 'example' => 'my_hotwords', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"NextToken\\": \\"CBB6BC61D08\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 20,\\n \\"HotwordLibraryList\\": [\\n {\\n \\"Description\\": \\"Lexicon containing celebrity names\\",\\n \\"UsageScenario\\": \\"ASR\\",\\n \\"ModifiedTime\\": \\"2017-01-11T12:00:00Z\\\\n\\",\\n \\"CreationTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"HotwordLibraryId\\": \\"a93b91141c0f422fa114af203f8b****\\",\\n \\"Name\\": \\"my_hotwords\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListHotwordLibraries', 'description' => '## [](#)'."\n" ."\n" .'- Get information about all hotword libraries that you created.'."\n" ."\n" .'- The API supports fuzzy search by `Name`, filtering by creation time range, and pagination.'."\n" ."\n" .'- By default, the results are sorted by creation time in descending order. You can set `SortBy` to change the sorting order.'."\n" ."\n" .'- The maximum number of entries returned for each request is 100. Default value: 10.'."\n" ."\n" .'- Use `NextToken` for pagination.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListHotwordLibraries', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLivePackageChannelGroups' => [ 'summary' => 'Queries live package channel groups by page. Fuzzy search by name or description and sorting are supported.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238120', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The channel group name or description. Fuzzy match is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'channel-group'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sort order by creation time. Default value: desc.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageChannelGroups' => [ 'title' => '', 'description' => 'The channel groups returned.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'LivePackageChannelGroupItemType', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the channel group was created. It is in the `yyyy-MM-ddTHH:mm:ssZ` format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The channel group description.', 'type' => 'string', 'title' => '', 'example' => '这是频道组的描述信息。'], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'testChannelGroup'], 'LastModified' => ['description' => 'The time when the channel group was last modified. It is in the `yyyy-MM-ddTHH:mm:ssZ` format and displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2023-04-02T12:00:00Z'], 'OriginDomain' => ['description' => 'The origin domain.', 'type' => 'string', 'title' => '', 'example' => 'origin.example.com'], ], 'example' => '', ], 'example' => '', ], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864'], 'SortBy' => ['description' => 'The sort order.', 'type' => 'string', 'example' => 'desc', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroups\\": [\\n {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是频道组的描述信息。\\",\\n \\"GroupName\\": \\"testChannelGroup\\",\\n \\"LastModified\\": \\"2023-04-02T12:00:00Z\\",\\n \\"OriginDomain\\": \\"origin.example.com\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', 'title' => 'ListLivePackageChannelGroups', 'description' => '## [](#)Usage notes', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListLivePackageChannelGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLivePackageChannels' => [ 'summary' => 'Queries live package channels by channel group and keyword. Paging and sorting are supported.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239703', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'example' => 'channel-group-1', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The channel name or description. Fuzzy match is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'group-1'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sort order by creation time. Default value: desc.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- asc'."\n" ."\n" .'- desc', 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageChannels' => [ 'title' => '', 'description' => 'The live package channels.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'LivePackageChannelItemType', 'type' => 'object', 'properties' => [ 'ChannelName' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'ch3'], 'CreateTime' => ['description' => 'The time when the channel was created.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'."\n"], 'Description' => ['description' => 'The channel description.', 'type' => 'string', 'example' => 'Test channel', 'title' => ''], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'channel-group-1'], 'IngestEndpoints' => [ 'description' => 'The ingest endpoints.', 'type' => 'array', 'items' => [ 'description' => 'The information about the ingest endpoint.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The ingest endpoint ID.', 'type' => 'string', 'example' => 'ingest1', 'title' => ''], 'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => '2F9e9******18b569c8', 'title' => ''], 'Url' => ['description' => 'The ingest endpoint URL.', 'type' => 'string', 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', 'title' => ''], 'Username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'us12******das', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LastModified' => ['description' => 'The time when the channel was last modified.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Protocol' => ['description' => 'The ingest protocol. Only HLS is supported.', 'type' => 'string', 'title' => '', 'example' => 'HLS'], 'SegmentCount' => ['description' => 'The number of M3U8 segments.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], 'SegmentDuration' => ['description' => 'The segment duration.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], ], 'example' => '', ], 'example' => '', ], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'SortBy' => ['description' => 'The sort order. Valid values: asc and desc (default).', 'type' => 'string', 'example' => 'asc/desc', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '15'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannels\\": [\\n {\\n \\"ChannelName\\": \\"ch3\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\\\n\\",\\n \\"Description\\": \\"Test channel\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"ingest1\\",\\n \\"Password\\": \\"2F9e9******18b569c8\\",\\n \\"Url\\": \\"http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"Username\\": \\"us12******das\\"\\n }\\n ],\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SortBy\\": \\"asc/desc\\",\\n \\"TotalCount\\": 15\\n}","type":"json"}]', 'title' => 'ListLivePackageChannels', 'description' => '## [](#)Usage notes'."\n" ."\n" .'This API operation allows you to query live package channels by **GroupName** and **Keyword**. Keyword is optional. You can sort the channels by creation time in ascending or descending order and paginate the results. This facilitates the management of channels and retrieval of channel information.'."\n" ."\n" .'- **GroupName** is required to specify the channel group to which the channel belongs.'."\n" ."\n" .'- **Keyword** supports fuzzy match of channel names or descriptions, which helps quickly filter desired channels.'."\n" ."\n" .'- **PageNo** and **PageSize** can help control the paging of returned results to facilitate batch processing of data.'."\n" ."\n" .'- **SortBy** allows you to customize how the results are sorted. By default, the results are sorted in descending order.'."\n" ."\n" .'**RequestId** in the response is used for subsequent troubleshooting. **TotalCount** indicates the total number of channels that meet the conditions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListLivePackageChannels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLivePackageOriginEndpoints' => [ 'summary' => 'Queries origin endpoints by channel group and channel name. Paging and sorting are supported.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239774', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The endpoint name or description. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'endpoint-', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sort order by creation time. Valid values: asc and desc (default).', 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'LivePackageOriginEndpoints' => [ 'title' => '', 'description' => 'The origin endpoints returned.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'LivePackageOriginEndpointItemType', 'type' => 'object', 'properties' => [ 'AuthorizationCode' => ['description' => 'The authorization code.', 'type' => 'string', 'title' => '', 'example' => 'Abc123Def456'], 'ChannelName' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'channel-1'], 'CreateTime' => ['description' => 'The time when the endpoint was created.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'Description' => ['description' => 'The endpoint description.', 'type' => 'string', 'example' => 'This is an origin endpoint.', 'title' => ''], 'EndpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'title' => '', 'example' => 'endpoint-1'], 'EndpointUrl' => ['description' => 'The endpoint URL.', 'type' => 'string', 'title' => '', 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest.m3u8'], 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'channel-group-1'], 'IpBlacklist' => ['description' => 'The IP address blacklist.', 'type' => 'string', 'title' => '', 'example' => '10.21.222.1/32,192.168.100.0/24'], 'IpWhitelist' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'title' => '', 'example' => '192.168.1.0/24,10.0.0.1/24'], 'LastModified' => ['description' => 'The time when the endpoint was last modified.', 'type' => 'string', 'title' => '', 'example' => '2023-04-01T12:00:00Z'], 'ManifestName' => ['description' => 'The playlist name.', 'type' => 'string', 'title' => '', 'example' => 'manifest'], 'Protocol' => ['description' => 'The distribution protocol.', 'type' => 'string', 'title' => '', 'example' => 'HLS'], 'TimeshiftVision' => ['description' => 'The number of days that time-shifted content is available.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'example' => '', ], 'example' => '', ], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'b9f90a7ac8904db28dc18e0c2a72c75d'], 'SortBy' => ['description' => 'The sort order. Valid values: `asc` and `desc` (default).', 'type' => 'string', 'example' => 'desc', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoints\\": [\\n {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"This is an origin endpoint.\\",\\n \\"EndpointName\\": \\"endpoint-1\\",\\n \\"EndpointUrl\\": \\"https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest.m3u8\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IpBlacklist\\": \\"10.21.222.1/32,192.168.100.0/24\\",\\n \\"IpWhitelist\\": \\"192.168.1.0/24,10.0.0.1/24\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"TimeshiftVision\\": 1\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"b9f90a7ac8904db28dc18e0c2a72c75d\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 10\\n}","type":"json"}]', 'title' => 'ListLivePackageOriginEndpoints', 'description' => '## [](#)Usage notes'."\n" ."\n" .'This API operation allows you to query origin endpoints associated with a live package channel. The results include detailed configurations about the origin endpoints, such as access URL, protocol, and security policies. Paging and sorting by creation time are supported.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListLivePackageOriginEndpoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLiveRecordFiles' => [ 'summary' => 'Queries all recording index files in the specified period of time.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The maximum time range to query is four days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2017-12-22T08:00:00Z', 'title' => ''], ], [ 'name' => 'StartTime', '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.', 'type' => 'string', 'required' => false, 'example' => '2017-12-21T08:00:01Z', 'title' => ''], ], [ 'name' => 'JobIds', 'in' => 'query', 'style' => 'flat', 'schema' => [ 'description' => 'The list of job IDs.', 'type' => 'array', 'items' => ['description' => 'The ID of the recording job.', 'type' => 'string', 'required' => false, 'example' => '9E83D5D0-8D72-5E7D-B61A-****', 'title' => ''], 'required' => false, 'maxItems' => 100, 'title' => '', 'example' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 5 to 30. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order of the index files by creation time. Valid values:'."\n" ."\n" .'asc: The query results are displayed in ascending order. This is the default value.'."\n" ."\n" .'desc: The query results are displayed in descending order.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ 'name' => 'RecordFormat', 'in' => 'query', 'schema' => ['description' => 'The format of the recording file. Valid values:'."\n" ."\n" .'M3U8, FLV, and MP4', 'type' => 'string', 'required' => false, 'example' => 'm3u8', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DE24625C-7C0F-4020-8448-****', 'title' => ''], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'SortBy' => ['description' => 'The sorting order of the index files by creation time.', 'type' => 'string', 'example' => 'asc', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of files that meet the specified conditions.', 'type' => 'string', 'example' => '100', 'title' => ''], 'Files' => [ 'description' => 'The list of index files.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RecordUrl' => ['description' => 'The URL of the index file.', 'type' => 'string', 'example' => 'http://****/atestObject****.m3u8', 'title' => ''], 'StartTime' => ['description' => 'The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2015-12-01T07:36:00Z', 'title' => ''], 'EndTime' => ['description' => 'The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2015-12-01T07:36:10Z', 'title' => ''], 'Duration' => ['description' => 'The recording length. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100.0', 'title' => ''], 'Width' => ['description' => 'The width of the video.', 'type' => 'integer', 'format' => 'int32', 'example' => '480', 'title' => ''], 'Height' => ['description' => 'The height of the video.', 'type' => 'integer', 'format' => 'int32', 'example' => '640', 'title' => ''], 'CreateTime' => ['description' => 'The time when the file was created in UTC.', 'type' => 'string', 'example' => '2016-05-27T09:40:56Z', 'title' => ''], 'RecordOutput' => ['description' => 'The storage information about the recording file.', 'type' => 'string', 'example' => '{ "Type": "oss", "Endpoint":"oss-cn-shanghai.aliyuncs.com", "Bucket": "test-bucket" }', 'title' => ''], 'RecordId' => ['description' => 'The ID of the index file.', 'type' => 'string', 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', 'title' => ''], 'StreamUrl' => ['description' => 'The name of the live stream.', 'type' => 'string', 'example' => 'LiveStream***', 'title' => ''], 'JobName' => ['description' => 'The name of the recording job.', 'type' => 'string', 'example' => 'LiveRecordJob***', 'title' => ''], 'Format' => ['description' => 'The format of the recording file.', 'type' => 'string', 'example' => 'm3u8', 'title' => ''], 'JobId' => ['description' => 'The ID of the recording job.', 'type' => 'string', 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE24625C-7C0F-4020-8448-****\\",\\n \\"PageNo\\": 1,\\n \\"SortBy\\": \\"asc\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Files\\": [\\n {\\n \\"RecordUrl\\": \\"http://****/atestObject****.m3u8\\",\\n \\"StartTime\\": \\"2015-12-01T07:36:00Z\\",\\n \\"EndTime\\": \\"2015-12-01T07:36:10Z\\",\\n \\"Duration\\": 100,\\n \\"Width\\": 480,\\n \\"Height\\": 640,\\n \\"CreateTime\\": \\"2016-05-27T09:40:56Z\\",\\n \\"RecordOutput\\": \\"{ \\\\\\"Type\\\\\\": \\\\\\"oss\\\\\\", \\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Bucket\\\\\\": \\\\\\"test-bucket\\\\\\" }\\",\\n \\"RecordId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f****\\",\\n \\"StreamUrl\\": \\"LiveStream***\\",\\n \\"JobName\\": \\"LiveRecordJob***\\",\\n \\"Format\\": \\"m3u8\\",\\n \\"JobId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f****\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListLiveRecordFiles', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordFiles'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveRecordFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLiveRecordJobs' => [ 'summary' => 'Queries a list of live stream recording jobs by page.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. You can use the job ID or name as the keyword to search for jobs.', 'type' => 'string', 'required' => false, 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', 'title' => ''], ], [ 'name' => 'StartTime', '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.', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2022-07-15T08:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The maximum time range between EndTime and StartTime cannot exceed 30 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2022-07-11T08:00:00Z', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The state of the job. By default, the state is not filtered.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- paused: The job is paused.'."\n" ."\n" .'- initial: The job is not started.'."\n" ."\n" .'- started: The job is in progress.', 'enumValueTitles' => ['paused' => 'paused', 'initial' => 'initial', 'started' => 'started'], 'type' => 'string', 'required' => false, 'example' => 'started', 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting order. By default, the query results are sorted by creation time in descending order.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- asc: sorts the query results in ascending order.'."\n" ."\n" .'- desc: sorts the query results in descending order.', 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A27DFFA4-F272-5563-8363-CB0BC42740BA'], 'LiveRecordJobs' => [ 'title' => '', 'description' => 'The list of live stream recording jobs.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'LiveRecordJobItemType', 'type' => 'object', 'properties' => [ 'RecordOutput' => [ 'description' => 'The storage address of the recording.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the storage address.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- vod'."\n" ."\n" .'- oss', 'enumValueTitles' => ['vod' => 'vod', 'oss' => 'oss'], 'type' => 'string', 'example' => 'oss', 'title' => '', ], 'Bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'imsbucket1', 'title' => ''], 'Endpoint' => ['description' => 'The endpoint of the storage service.', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com', 'title' => ''], ], 'deprecated' => false, 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the recording job.', 'type' => 'string', 'example' => 'Live event recording task 1', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => ''], 'NotifyUrl' => ['description' => 'The callback URL.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'https://example.com/imsnotify'], 'TemplateId' => ['description' => 'The ID of the recording template.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66'], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'format' => 'iso8601', 'title' => '', 'example' => '2022-07-20T03:26:36Z'], 'StreamInput' => [ 'description' => 'The URL of the live stream.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the live stream URL.', 'type' => 'string', 'example' => 'rtmp', 'title' => ''], 'Url' => ['description' => 'The URL of the live stream.', 'type' => 'string', 'example' => 'rtmp://example-live.com/live/stream1', 'title' => ''], ], 'deprecated' => false, 'title' => '', 'example' => '', ], 'JobId' => ['description' => 'The ID of the recording job.', 'type' => 'string', 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', 'title' => ''], 'Status' => ['description' => 'The state of the recording job.', 'type' => 'string', 'example' => 'paused', 'title' => ''], 'TemplateName' => ['description' => 'The name of the recording template.', 'type' => 'string', 'example' => 'test template', 'title' => ''], ], 'example' => '', ], 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '180'], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'SortBy' => ['description' => 'The sorting order. By default, the query results are sorted by creation time in descending order.', 'type' => 'string', 'example' => 'desc', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A27DFFA4-F272-5563-8363-CB0BC42740BA\\",\\n \\"LiveRecordJobs\\": [\\n {\\n \\"RecordOutput\\": {\\n \\"Type\\": \\"oss\\",\\n \\"Bucket\\": \\"imsbucket1\\",\\n \\"Endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\"\\n },\\n \\"Name\\": \\"Live event recording task 1\\",\\n \\"NotifyUrl\\": \\"https://example.com/imsnotify\\",\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"CreateTime\\": \\"2022-07-20T03:26:36Z\\",\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"Url\\": \\"rtmp://example-live.com/live/stream1\\"\\n },\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\",\\n \\"Status\\": \\"paused\\",\\n \\"TemplateName\\": \\"test template\\"\\n }\\n ],\\n \\"TotalCount\\": 180,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"SortBy\\": \\"desc\\"\\n}","type":"json"}]', 'title' => 'ListLiveRecordJobs', 'changeSet' => [ ['createdAt' => '2022-08-18T07:45:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-08-17T07:09:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveRecordJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLiveRecordTemplates' => [ 'summary' => 'Call `ListLiveRecordTemplates` to retrieve a list of your real-time recording templates.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The keyword to search for templates by ID or name. Fuzzy matching is supported for template names.', 'type' => 'string', 'required' => false, 'example' => 'test template', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The template type.', 'enumValueTitles' => ['system' => 'System-defined', 'custom' => 'Custom'], 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => '', ], ], [ 'name' => 'TemplateIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The template ID.', 'type' => 'string', 'required' => false, 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', 'title' => ''], 'required' => false, 'maxItems' => 100, 'description' => 'The template IDs to retrieve.', 'title' => '', 'example' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Value range: 1–100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sort order. The default sort is descending by creation time.', 'enumValueTitles' => ['asc' => 'Ascending', 'desc' => 'Descending (default)'], 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RecordTemplateList' => [ 'title' => '', 'description' => 'The list of recording templates.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The recording template.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The template name.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'test template'], 'Type' => ['description' => 'The template type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'custom'], 'LastModified' => ['description' => 'The time the template was last modified.', 'type' => 'string', 'format' => 'iso8601', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '2022-07-20T03:26:36Z'], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66'], 'RecordFormatList' => [ 'title' => '', 'description' => 'The list of recording formats.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The recording format.', 'type' => 'object', 'properties' => [ 'Format' => [ 'description' => 'The recording file format.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'enum' => ['m3u8', 'mp4', 'flv'], 'title' => '', 'example' => 'm3u8', ], 'SliceDuration' => ['description' => 'The duration of each slice, in seconds.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '30'], 'OssObjectPrefix' => ['description' => 'The object prefix for the recording file stored in Object Storage Service (OSS).', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}'], 'SliceOssObjectPrefix' => ['description' => 'The object prefix for the Transport Stream (TS) slice.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}'], 'CycleDuration' => ['description' => 'The duration of the recording cycle, in seconds.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '21600', 'title' => ''], ], 'deprecated' => false, 'example' => '', ], 'deprecated' => false, 'example' => '', ], 'CreateTime' => ['description' => 'The time the template was created.', 'type' => 'string', 'format' => 'iso8601', 'title' => '', 'example' => '2022-07-20T02:48:58Z'], ], 'example' => '', ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C'], 'TotalCount' => ['description' => 'The total number of templates.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5'], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of templates per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'SortBy' => [ 'description' => 'The sort order. By default, templates are sorted by creation time in descending order.', 'enumValueTitles' => ['asc' => 'Ascending order', 'desc' => 'Descending order (default value)'], 'type' => 'string', 'example' => 'desc', 'title' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecordTemplateList\\": [\\n {\\n \\"Name\\": \\"test template\\",\\n \\"Type\\": \\"custom\\",\\n \\"LastModified\\": \\"2022-07-20T03:26:36Z\\",\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"RecordFormatList\\": [\\n {\\n \\"Format\\": \\"m3u8\\",\\n \\"SliceDuration\\": 30,\\n \\"OssObjectPrefix\\": \\"record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"SliceOssObjectPrefix\\": \\"record/{JobId}/{UnixTimestamp}_{Sequence}\\",\\n \\"CycleDuration\\": 21600\\n }\\n ],\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"TotalCount\\": 5,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SortBy\\": \\"desc\\"\\n}","type":"json"}]', 'title' => 'ListLiveRecordTemplates', 'changeSet' => [ ['createdAt' => '2022-08-18T07:45:39.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordTemplates'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveRecordTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListLiveSnapshotFiles' => [ 'summary' => 'Queries a list of live stream snapshot files by page.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ 'name' => 'StartTime', '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.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2022-02-02T00:00:00Z'], ], [ 'name' => 'EndTime', '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" ."\n" .'- The maximum time range that can be specified is one day.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2022-02-02T23:59:59Z'], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => ['description' => 'The number of results to return each time. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting order. Default value: asc.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- asc: sorts the query results by creation time in ascending order.'."\n" ."\n" .'- desc: sorts the query results by creation time in descending order.', 'enumValueTitles' => ['asc' => '', 'desc' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'FileList' => [ 'title' => '', 'description' => 'The list of files.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OssEndpoint' => ['description' => 'The Object Storage Service (OSS) domain name.', 'type' => 'string', 'title' => '', 'example' => 'oss-cn-shanghai.aliyuncs.com'], 'OssBucket' => ['title' => '', 'description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'testbucket'], 'OssObject' => ['description' => 'The location in which the OSS object is stored.', 'type' => 'string', 'title' => '', 'example' => 'snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg'], 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'title' => '', 'example' => '2022-02-02T22:22:22Z'], 'CreateTimestamp' => ['description' => 'The creation timestamp that is used as an input parameter for a delete API operation.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1619503516000'], 'IsOverlay' => ['description' => 'Specifies whether to overlay snapshots.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'NextStartTime' => ['description' => 'The start time of the next page. If no value is returned, the pagination ends.', 'type' => 'string', 'title' => '', 'example' => '2022-02-02T22:22:22Z'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'MalformedStartTime', 'errorMessage' => 'Specified parameter StartTime is not valid.', 'description' => ''], ['errorCode' => 'MalformedEndTime', 'errorMessage' => 'Specified parameter EndTime is not valid.', 'description' => ''], ['errorCode' => 'EndTimeMismatch', 'errorMessage' => 'Specified end time does not math the specified start time.', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], [ ['errorCode' => 'JobNotFound', 'errorMessage' => 'No such job.', 'description' => ''], ['errorCode' => 'NoValidSnapshot', 'errorMessage' => 'No snapshots found with given parameters.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"FileList\\": [\\n {\\n \\"OssEndpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"OssBucket\\": \\"testbucket\\",\\n \\"OssObject\\": \\"snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg\\",\\n \\"CreateTime\\": \\"2022-02-02T22:22:22Z\\",\\n \\"CreateTimestamp\\": 1619503516000,\\n \\"IsOverlay\\": true\\n }\\n ],\\n \\"NextStartTime\\": \\"2022-02-02T22:22:22Z\\"\\n}","type":"json"}]', 'title' => 'ListLiveSnapshotFiles', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveSnapshotFiles'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveSnapshotFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLiveSnapshotJobs' => [ 'summary' => 'Retrieves a paginated list of live snapshot jobs.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query. Specify the time in the ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`. The time must be in UTC.'."\n" ."\n" .'- If this parameter is not specified, the default is 7 days ago.'."\n" ."\n" .'- The interval between `StartTime` and `EndTime` cannot exceed 30 days.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-02-02T00:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`. The time must be in UTC.'."\n" ."\n" .'- If this parameter is not specified, the default is the current time.'."\n" ."\n" .'-', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-02-02T23:59:59Z'], ], [ 'name' => 'SearchKeyWord', 'in' => 'query', 'schema' => ['description' => 'The search keyword. You can search by Job ID or Job Name. Fuzzy search is supported for Job Name.'."\n" ."\n" .'- The maximum length is 128 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The job status to filter by. If omitted, jobs of all statuses are returned.', 'enumValueTitles' => ['init' => 'The job has not started.', 'paused' => 'The job is paused.', 'started' => 'The job is running.'], 'type' => 'string', 'title' => '', 'required' => false, 'example' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number to return. The value must be an integer greater than or equal to 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of jobs to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sort order. The results are sorted by `CreateTime`. Default: `desc` (Descending).', 'enumValueTitles' => ['asc' => 'Ascending', 'desc' => 'Descending'], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned by the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'JobList' => [ 'title' => '', 'description' => 'The list of jobs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'Screenshot task1', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => '****a046-263c-3560-978a-fb287666****'], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''], 'Status' => [ 'description' => 'The job status.', 'enumValueTitles' => ['init' => 'The job has not started.', 'paused' => 'The job is paused.', 'started' => 'The job is running.'], 'type' => 'string', 'title' => '', 'example' => 'started', ], 'SnapshotOutput' => [ 'title' => '', 'description' => 'Details of the snapshot output.', 'type' => 'object', 'properties' => [ 'StorageType' => ['description' => 'The storage type. Only Object Storage Service (OSS) is supported.', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Endpoint' => ['description' => 'The domain name of the OSS endpoint.', 'type' => 'string', 'title' => '', 'example' => 'oss-cn-shanghai.aliyuncs.com'], 'Bucket' => ['description' => 'The name of the OSS Bucket.', 'type' => 'string', 'title' => '', 'example' => 'testbucket'], ], 'example' => '', ], 'TimeInterval' => ['description' => 'The interval between snapshots, in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'CreateTime' => ['description' => 'The creation time of the job.', 'type' => 'string', 'title' => '', 'example' => '2022-07-20T02:48:58Z'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of jobs to return per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'SortBy' => ['description' => 'The sort order for the job list. For example, "desc" indicates descending order.', 'type' => 'string', 'title' => '', 'example' => 'desc'], 'TotalCount' => ['description' => 'The total number of jobs found.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'MalformedStartTime', 'errorMessage' => 'Specified parameter StartTime is not valid.', 'description' => ''], ['errorCode' => 'MalformedEndTime', 'errorMessage' => 'Specified parameter EndTime is not valid.', 'description' => ''], ['errorCode' => 'EndTimeMismatch', 'errorMessage' => 'Specified end time does not math the specified start time.', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobList\\": [\\n {\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"JobName\\": \\"Screenshot task1\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"Status\\": \\"started\\",\\n \\"SnapshotOutput\\": {\\n \\"StorageType\\": \\"oss\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"Bucket\\": \\"testbucket\\"\\n },\\n \\"TimeInterval\\": 5,\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', 'title' => 'ListLiveSnapshotJobs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveSnapshotJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveSnapshotJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListLiveSnapshotTemplates' => [ 'summary' => 'Returns a paginated list of Live Snapshot templates.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SearchKeyWord', 'in' => 'query', 'schema' => ['description' => 'The search keyword. You can perform a fuzzy search by template ID or template name.'."\n" ."\n" .'- Maximum length: 128 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ 'name' => 'TemplateIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '', 'description' => 'The template IDs.'."\n" ."\n" .'- This parameter does not take effect if `SearchKeyWord` is specified.'."\n" ."\n" .'- You can specify a maximum of 200 template IDs.', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '****a046-263c-3560-978a-fb287782****', 'title' => ''], 'required' => false, 'maxItems' => 100, 'example' => '', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the template. By default, templates of all types are queried.', 'enumValueTitles' => ['system' => 'System template', 'custom' => 'Custom template'], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'custom', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be greater than or equal to 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting method. By default, results are sorted by creation time in descending order.', 'enumValueTitles' => ['asc' => 'Sorts results by creation time in ascending order.', 'desc' => 'Sorts results by creation time in descending order.'], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'TemplateList' => [ 'title' => '', 'description' => 'The list of templates.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The ID of the template.', 'type' => 'string', 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], 'TemplateName' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''], 'Type' => [ 'description' => 'The type of the template.', 'enumValueTitles' => ['system' => 'A system template.', 'custom' => 'A custom template.'], 'type' => 'string', 'title' => '', 'example' => 'custom', ], 'TimeInterval' => ['description' => 'The snapshot interval in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'CreateTime' => ['description' => 'The time when the template was created. The time format is UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-07-20T02:48:58Z'], ], 'description' => 'A template object.', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'SortBy' => ['description' => 'The sort order.', 'type' => 'string', 'title' => '', 'example' => 'desc'], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateList\\": [\\n {\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"Type\\": \\"custom\\",\\n \\"TimeInterval\\": 10,\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', 'title' => 'ListLiveSnapshotTemplates', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveSnapshotTemplates'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveSnapshotTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListLiveTranscodeJobs' => [ 'summary' => 'Queries a list of live stream transcoding jobs.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the template used by the transcoding job.'."\n" ."\n" .'- normal'."\n" ."\n" .'- narrow-band'."\n" ."\n" .'- audio-only'."\n" ."\n" .'- origin', 'type' => 'string', 'enum' => ['normal', 'narrow-band', 'audio-only', 'origin'], 'title' => '', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'StartMode', 'in' => 'query', 'schema' => [ 'description' => 'The start mode of the transcoding job.'."\n" ."\n" .'- 0: The transcoding job immediately starts.'."\n" ."\n" .'- 1: The transcoding job starts at the scheduled time.', 'enumValueTitles' => ['0', '1'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => '', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The state of the job.'."\n" ."\n" .'0: The job is not started. 1: The job is in progress. 2: The job is stopped.', 'enumValueTitles' => ['0', '1', '2'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '50', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting order. By default, the query results are sorted by creation time in descending order. Valid values:'."\n" ."\n" .'- asc'."\n" ."\n" .'- desc', 'type' => 'string', 'default' => 'desc', 'enum' => ['asc', 'desc'], 'required' => false, 'example' => 'asc', 'title' => '', ], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['description' => 'The search keyword. You can use the job ID or name as the keyword to search for jobs. If you search for jobs by name, fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => '24ecbb5c-4f98-4194-9400-f17102e27fc5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'JobList' => [ 'description' => 'The list of transcoding jobs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the transcoding job.', 'type' => 'string', 'example' => 'mytask', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****a046-263c-3560-978a-fb287782****', 'title' => ''], 'TemplateType' => ['description' => 'The type of the transcoding template used by the transcoding job.', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the transcoding template used by the transcoding job.', 'type' => 'string', 'example' => '****a046-263c-3560-978a-fb287666****', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template 1', 'title' => ''], 'StartMode' => ['description' => 'The start mode of the job.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Status' => ['description' => 'The state of the job.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'StreamInput' => [ 'description' => 'The information about the input stream.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input stream.', 'type' => 'string', 'example' => 'rtmp', 'title' => ''], 'InputUrl' => ['description' => 'The URL of the input stream.', 'type' => 'string', 'example' => 'rtmp://mydomain/app/stream1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'OutputStream' => [ 'description' => 'The information about the output stream.', 'type' => 'object', 'properties' => [ 'StreamInfos' => [ 'description' => 'The list of stream URLs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output stream protocol. Only the RTMP protocol is supported.', 'type' => 'string', 'example' => 'rtmp', 'title' => ''], 'OutputUrl' => ['description' => 'The URL of the output stream.', 'type' => 'string', 'example' => 'rtmp://mydomain/app/mytranscode1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-20T02:48:58Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TotalCount\\": 100,\\n \\"JobList\\": [\\n {\\n \\"Name\\": \\"mytask\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateType\\": \\"normal\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"Template 1\\",\\n \\"StartMode\\": 0,\\n \\"Status\\": 1,\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"InputUrl\\": \\"rtmp://mydomain/app/stream1\\"\\n },\\n \\"OutputStream\\": {\\n \\"StreamInfos\\": [\\n {\\n \\"Type\\": \\"rtmp\\",\\n \\"OutputUrl\\": \\"rtmp://mydomain/app/mytranscode1\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListLiveTranscodeJobs', 'changeSet' => [ ['createdAt' => '2022-08-24T03:10:25.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveTranscodeJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveTranscodeJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListLiveTranscodeTemplates' => [ 'summary' => 'Queries a list of live stream transcoding templates.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the template. Valid values:'."\n" ."\n" .'- normal'."\n" ."\n" .'- narrow-band'."\n" ."\n" .'- audio-only'."\n" ."\n" .'- origin', 'type' => 'string', 'enum' => ['normal', 'narrow-band', 'audio-only', 'origin'], 'title' => '', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'VideoCodec', 'in' => 'query', 'schema' => [ 'description' => 'The video codec. Valid values:'."\n" ."\n" .'- H.264'."\n" ."\n" .'- H.265', 'type' => 'string', 'enum' => ['H.264', 'H.265'], 'required' => false, 'example' => 'H.264', 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '50', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting order. By default, the query results are sorted by creation time in descending order. Valid values:'."\n" ."\n" .'- asc'."\n" ."\n" .'- desc', 'type' => 'string', 'default' => 'desc', 'enum' => ['asc', 'desc'], 'required' => false, 'example' => 'asc', 'title' => '', ], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['description' => 'The search keyword. You can use the template ID or name as the keyword to search for templates. If you search for templates by name, fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'my_template', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The category of the template. Valid values:'."\n" ."\n" .'- system'."\n" ."\n" .'- customized', 'type' => 'string', 'enum' => ['system', 'customized'], 'required' => false, 'example' => 'customized', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TemplateContentList' => [ 'description' => 'The list of transcoding templates.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'my_template', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9b1571b513cb44f7a1ba6ae561ff46f7', 'title' => ''], 'Type' => ['description' => 'The type of the template.', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Category' => ['description' => 'The category of the template. Valid values:', 'type' => 'string', 'example' => 'system', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-20T03:26:36Z', 'title' => ''], 'TemplateConfig' => [ 'description' => 'The configuration of the template.', 'type' => 'object', 'properties' => [ 'VideoParams' => [ 'description' => 'The video parameters.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => '264', 'title' => ''], 'Height' => ['description' => 'The vertical resolution of the video.', 'type' => 'string', 'example' => '1280', 'title' => ''], 'Width' => ['description' => 'The horizontal resolution of the video.', 'type' => 'string', 'example' => '720', 'title' => ''], 'Fps' => ['description' => 'The video frame rate.', 'type' => 'string', 'example' => '30', 'title' => ''], 'Bitrate' => ['description' => 'The video bitrate.', 'type' => 'string', 'example' => '2500', 'title' => ''], 'Gop' => ['description' => 'The group of pictures (GOP) of the output video. Unit: frame.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Profile' => ['description' => 'The encoding profile.', 'type' => 'string', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AudioParams' => [ 'description' => 'The audio parameters.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'The audio codec.', 'type' => 'string', 'required' => false, 'example' => 'AAC', 'title' => ''], 'Bitrate' => ['description' => 'The audio bitrate.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'Samplerate' => ['description' => 'The audio sampling rate.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Profile' => ['description' => 'The encoding profile.', 'type' => 'string', 'example' => 'aac_low', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TotalCount\\": 100,\\n \\"TemplateContentList\\": [\\n {\\n \\"Name\\": \\"my_template\\",\\n \\"TemplateId\\": \\"9b1571b513cb44f7a1ba6ae561ff46f7\\",\\n \\"Type\\": \\"normal\\",\\n \\"Category\\": \\"system\\",\\n \\"CreateTime\\": \\"2022-07-20T03:26:36Z\\",\\n \\"TemplateConfig\\": {\\n \\"VideoParams\\": {\\n \\"Codec\\": \\"264\\",\\n \\"Height\\": \\"1280\\",\\n \\"Width\\": \\"720\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"2500\\",\\n \\"Gop\\": \\"1000\\",\\n \\"Profile\\": \\"3\\"\\n },\\n \\"AudioParams\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Bitrate\\": \\"1000\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"Profile\\": \\"aac_low\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListLiveTranscodeTemplates', 'changeSet' => [ ['createdAt' => '2022-08-23T11:40:01.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveTranscodeTemplates'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListLiveTranscodeTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListMediaBasicInfos' => [ 'summary' => 'Returns basic information about media assets that match the specified parameters.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the query range, based on the creation time (`utcCreated`).'."\n" ."\n" .'- The query returns results created after this time (exclusive).'."\n" ."\n" .'- The time must be in UTC and comply with the ISO 8601 standard. The format is `YYYY-MM-DD\'T\'HH:mm:ss\'Z\'`. For example, `2017-01-11T12:00:00Z` corresponds to 20:00:00 on January 11, 2017 (UTC+8).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2020-12-20T12:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the query range, based on the creation time (`utcCreated`).'."\n" ."\n" .'- The query returns results created at or before this time (inclusive).'."\n" ."\n" .'- The time must be in UTC and comply with the ISO 8601 standard. The format is `YYYY-MM-DD\'T\'HH:mm:ss\'Z\'`. For example, `2017-01-11T12:00:00Z` corresponds to 20:00:00 on January 11, 2017 (UTC+8).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2020-12-20T13:00:00Z'], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'The media type. Valid values:'."\n" ."\n" .'- `image`: image'."\n" ."\n" .'- `video`: video'."\n" ."\n" .'- `audio`: audio'."\n" ."\n" .'- `text`: text', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'video'], ], [ 'name' => 'BusinessType', 'in' => 'query', 'schema' => ['description' => 'The business type. Valid values:'."\n" ."\n" .'- `subtitles`: subtitles'."\n" ."\n" .'- `watermark`: watermark'."\n" ."\n" .'- `opening`: opening'."\n" ."\n" .'- `ending`: ending'."\n" ."\n" .'- `general`: General', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'opening'], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The source. Valid values:'."\n" ."\n" .'- `oss`: OSS'."\n" ."\n" .'- `vod`: video on demand'."\n" ."\n" .'- `live`: live streaming'."\n" ."\n" .'- `general`: Other sources (default).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'oss'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The media status. Valid values:'."\n" ."\n" .'- `Init`: The source file is not ready.'."\n" ."\n" .'- `Preparing`: The source file is being prepared. For example, it is being uploaded or composited.'."\n" ."\n" .'- `PrepareFail`: The source file failed to prepare. This may occur, for example, if the system fails to retrieve information about the source file.'."\n" ."\n" .'- `Normal`: The source file is ready.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Normal'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token used to retrieve the next page of results. An empty value indicates that all results have been returned.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pSa1SQ0wCe5pzVrQ6mWZEw=='], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return per page.'."\n" ."\n" .'Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '5'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sort order for results based on the creation time (`utcCreated`). The default is descending. Valid values:'."\n" ."\n" .'- `desc`: Descending order'."\n" ."\n" .'- `asc`: Ascending order', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc'], ], [ 'name' => 'IncludeFileBasicInfo', 'in' => 'query', 'schema' => ['description' => 'Set to `true` to include basic file information in the response.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The media ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****019b82e24b37a1c2958dec38****'], ], [ 'name' => 'AuthTimeout', 'in' => 'query', 'schema' => ['description' => 'The authentication expiration time, in seconds.'."\n" ."\n" .'- Minimum value: 1.'."\n" ."\n" .'- Maximum value: 86400.'."\n" ."\n" .'- Default value: 3600.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******B7-7F87-4792-BFE9-63CD21******'], 'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '4'], 'MediaInfos' => [ 'title' => '', 'description' => 'The list of matching media assets.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'title' => '', 'example' => '****019b82e24b37a1c2958dec38****'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'The basic information about the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The media asset ID.', 'type' => 'string', 'example' => '****019b82e24b37a1c2958dec38****'], 'InputURL' => ['description' => 'The source URL of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], 'MediaType' => ['description' => 'The media type.', 'type' => 'string', 'title' => '', 'example' => 'video'], 'BusinessType' => ['description' => 'The business type.', 'type' => 'string', 'title' => '', 'example' => 'opening'], 'Source' => ['description' => 'The source of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'The title of the media asset.', 'type' => 'string', 'example' => 'My video title', 'title' => ''], 'Description' => ['description' => 'The description of the media asset.', 'type' => 'string', 'example' => 'A short description of the media', 'title' => ''], 'Category' => ['description' => 'The category of the media asset.', 'type' => 'string', 'example' => 'video', 'title' => ''], 'MediaTags' => ['description' => 'Tags associated with the media asset.', 'type' => 'string', 'title' => '', 'example' => 'tags,tags2'], 'CoverURL' => ['description' => 'The cover URL.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'title' => '', 'example' => 'userData'], 'Snapshots' => ['description' => 'Information about the snapshots.', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]'], 'Status' => ['description' => 'The status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'TranscodeStatus' => ['description' => 'The transcoding status.', 'type' => 'string', 'title' => '', 'example' => 'Init'], 'CreateTime' => ['description' => 'The time the media asset was created.', 'type' => 'string', 'title' => '', 'example' => '2021-01-08T16:52:04Z'], 'ModifiedTime' => ['description' => 'The time the media asset was last modified.', 'type' => 'string', 'title' => '', 'example' => '2021-01-08T16:52:07Z'], 'DeletedTime' => ['description' => 'The time the media asset was deleted.', 'type' => 'string', 'title' => '', 'example' => '2021-01-08T16:52:07Z'], 'SpriteImages' => ['description' => 'Information about the image sprites.', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3049', 'title' => ''], 'Biz' => ['description' => 'The associated business.', 'type' => 'string', 'example' => 'ICE', 'title' => ''], 'UploadSource' => ['description' => 'The upload source of the media asset.', 'type' => 'string', 'example' => 'general', 'title' => ''], 'ReferenceId' => ['description' => 'A user-defined ID that must be unique within your account. The ID must be 6 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'example' => '123-123', 'title' => ''], ], 'example' => '', ], 'FileInfoList' => [ 'title' => '', 'description' => 'A list of file information objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'Basic information about the file, such as its duration and size.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'title' => '', 'example' => 'example.mp4'], 'FileStatus' => ['description' => 'The status of the file.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'The type of the file.', 'type' => 'string', 'example' => 'source_file', 'title' => ''], 'FileSize' => ['description' => 'The size of the file, in bytes.', 'type' => 'string', 'title' => '', 'example' => '14340962'], 'FileUrl' => ['description' => 'The Object Storage Service (OSS) URL of the file.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['description' => 'The region where the file is stored.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'FormatName' => ['description' => 'The container format.', 'type' => 'string', 'title' => '', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2'], 'Duration' => ['description' => 'The duration of the file, in seconds.', 'type' => 'string', 'title' => '', 'example' => '60.00000'], 'Bitrate' => ['description' => 'The bitrate of the file, in Kbit/s.', 'type' => 'string', 'title' => '', 'example' => '1912.13'], 'Width' => ['description' => 'The width of the video, in pixels.', 'type' => 'string', 'title' => '', 'example' => '1280'], 'Height' => ['description' => 'The height of the video, in pixels.', 'type' => 'string', 'title' => '', 'example' => '720'], 'CreateTime' => ['description' => 'The time the file was created.', 'type' => 'string', 'example' => '2021-01-08T16:52:04Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time the file was last modified.', 'type' => 'string', 'example' => '2021-01-08T16:52:07Z', 'title' => ''], ], 'example' => '', ], ], 'description' => 'The file information.', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => 'The information about the media asset.', 'title' => '', 'example' => '', ], 'example' => '', ], 'NextToken' => ['description' => 'The token for retrieving the next page of results. If this parameter is not returned, all results have been retrieved.', 'type' => 'string', 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******B7-7F87-4792-BFE9-63CD21******\\",\\n \\"TotalCount\\": 4,\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"opening\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"My video title\\",\\n \\"Description\\": \\"A short description of the media\\",\\n \\"Category\\": \\"video\\",\\n \\"MediaTags\\": \\"tags,tags2\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"3\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******f48f0e4154976b2b8c45******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-beijing\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e6a6440b29eb60bd7c******\\\\\\"}]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"DeletedTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"CateId\\": 3049,\\n \\"Biz\\": \\"ICE\\",\\n \\"UploadSource\\": \\"general\\",\\n \\"ReferenceId\\": \\"123-123\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"14340962\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"60.00000\\",\\n \\"Bitrate\\": \\"1912.13\\",\\n \\"Width\\": \\"1280\\",\\n \\"Height\\": \\"720\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:07Z\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"MaxResults\\": 2\\n}","type":"json"}]', 'title' => 'ListMediaBasicInfos', 'description' => '- If the `includeFileBasicInfo` field is set to true, the response also includes basic source file information, such as its duration and file size.'."\n" ."\n" .'- Returns a maximum of 100 matching media assets.'."\n" ."\n" .'- The query returns only media assets that exactly match all specified non-empty fields. The fields that support exact matching are media type, source, business type, category, and resource status.'."\n" ."\n" .'- If the result set is too large for a single response, use the returned `nextToken` to retrieve the next page of results.', 'changeSet' => [ ['createdAt' => '2025-07-02T09:50:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-01T03:57:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-14T07:50:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-03-31T06:11:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaBasicInfos'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:ListMediaBasicInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListMediaConvertJobs' => [ 'summary' => 'This operation lists media convert jobs.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceHPAMBQ', 'FEATUREice5MI8QL', 'FEATUREiceCJ90B2', 'FEATUREice6MQPM7'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Filters the results by job ID.', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e47098a5b665e2****', 'title' => ''], ], [ 'name' => 'StartOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to filter jobs by creation time. The time must be in the `yyyy-MM-ddTHH:mm:ssZ` ISO 8601 format.', 'type' => 'string', 'example' => '2022-07-01T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'EndOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to filter jobs by creation time. The time must be in the `yyyy-MM-ddTHH:mm:ssZ` ISO 8601 format.', 'type' => 'string', 'example' => '2022-07-15T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'- `Inited`: The job has been submitted.'."\n" ."\n" .'- `Running`: The job is running.'."\n" ."\n" .'- `Complete`: The job is complete.'."\n" ."\n" .'- `Error`: The job failed due to an error.', 'type' => 'string', 'example' => 'Success', 'title' => '', 'required' => false], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => ['description' => 'The sort order for the results. Valid values: `CreateTimeDesc` (descending by creation time) and `CreateTimeAsc` (ascending by creation time).', 'type' => 'string', 'example' => 'CreateTimeDesc', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The token for the next page of results. Leave this empty for the first request. To retrieve the next page, pass the `NextPageToken` value from the previous response.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82dfa8e8', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'NextPageToken' => ['description' => 'The token to retrieve the next page of results. This value is empty when there are no more results to return.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****cdb3e74639973036bc84****'."\n"], 'Jobs' => [ 'description' => 'A list of media convert jobs.', 'type' => 'array', 'items' => ['description' => 'Job information, excluding the `Detail` field.', '$ref' => '#/components/schemas/MediaConvertJobWithoutDetail', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"NextPageToken\\": \\"****cdb3e74639973036bc84****\\\\n\\",\\n \\"Jobs\\": [\\n {\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"ClientToken\\": \\"****12e8864746a0a398****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"Config\\": {\\n \\"Inputs\\": [\\n {\\n \\"Name\\": \\"InputVideo\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://bucket.loction.aliyuncs.com/path/to/video.mp4\\"\\n }\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"output-video\\",\\n \\"OutputFile\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://bucket.loction.aliyuncs.com/path/to/video.mp4\\"\\n },\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"Priority\\": 6,\\n \\"Features\\": \\"{}\\",\\n \\"OverrideParams\\": \\"{}\\"\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"Name\\": \\"hls-group\\",\\n \\"GroupConfig\\": {\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Type\\": \\"Hls\\",\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://bucket.loction.aliyuncs.com/path/to/video.mp4\\"\\n }\\n },\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"group-output\\",\\n \\"OutputFileName\\": \\"720p.mp4\\",\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\\\n\\",\\n \\"Priority\\": 6,\\n \\"Features\\": \\"{}\\",\\n \\"OverrideParams\\": \\"{}\\"\\n }\\n ]\\n }\\n ],\\n \\"JobName\\": \\"Name\\"\\n },\\n \\"PipelineId\\": \\"688c2a8bfa4e44ddbba0c8730db91b0c\\",\\n \\"UserData\\": \\"{\\\\\\"info\\\\\\": \\\\\\"xxx\\\\\\"}\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"Message\\": \\"The resource operated \\\\\\"%s\\\\\\" cannot be found\\",\\n \\"State\\": \\"Inited\\",\\n \\"CreateTime\\": \\"2024-12-07T13:01:07Z\\\\n\\",\\n \\"FinishTime\\": \\"2024-12-07T13:01:07Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListMediaConvertJobs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListMediaConvertJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListMediaInfoJobs' => [ 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range during which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'example' => '2022-07-01T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'EndOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range during which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'example' => '2022-07-15T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '7b38a5d86f1e47838927b6e7ccb1****', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The state of the job. Valid values:'."\n" ."\n" .'- Init: The job is submitted.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Fail: The job failed.', 'type' => 'string', 'example' => 'Success', 'title' => '', 'required' => false], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => ['description' => 'The order that you use to sort the query results. Valid values:'."\n" ."\n" .'- CreateTimeDesc: sorts the query results by creation time in descending order.'."\n" ."\n" .'- CreateTimeAsc: sorts the query results by creation time in ascending order.', 'type' => 'string', 'example' => 'CreateTimeDesc', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], ], [ '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.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82df****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], 'Jobs' => [ 'description' => 'The list of media information analysis jobs.', 'type' => 'array', 'items' => [ 'description' => 'The details of the job.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job-name', 'title' => ''], 'TriggerSource' => ['description' => 'The source of the job. Valid values:'."\n" ."\n" .'- API'."\n" ."\n" .'- WorkFlow'."\n" ."\n" .'- Console', 'type' => 'string', 'example' => 'API', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82df****', 'title' => ''], 'Input' => [ 'title' => '', 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" .'- OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media object.'."\n" ."\n" .'- If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported.'."\n" ."\n" .'- If Type is set to Media, the ID of a media asset is returned.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], 'Async' => ['description' => 'Indicates whether asynchronous processing was performed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => 'user-data', 'title' => ''], 'ScheduleConfig' => [ 'title' => '', 'description' => 'The scheduling information.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f****', 'title' => ''], 'Priority' => ['description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'example' => '', ], 'Status' => ['description' => 'The state of the job. Valid values:'."\n" ."\n" .'- Init: The job is submitted.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Fail: The job failed.', 'type' => 'string', 'example' => 'Init', 'title' => ''], 'SubmitResultJson' => ['description' => 'The job submission information.', 'type' => 'object', 'title' => '', 'example' => ''], 'MediaInfoProperty' => [ 'title' => '', 'description' => 'The details of the media information.', 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'The basic file information.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => '4765337007f571edbfdf81848c01****'], 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'file.m3u8', 'title' => ''], 'FileStatus' => ['description' => 'The state of the file.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'FileType' => ['description' => 'The file type. Valid values: source\\_file and transcode\\_file.', 'type' => 'string', 'example' => 'source_file', 'title' => ''], 'FileSize' => ['description' => 'The file size. Unit: bytes.', 'type' => 'string', 'example' => '31737', 'title' => ''], 'FileUrl' => ['description' => 'The URL of the file.', 'type' => 'string', 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', 'title' => ''], 'Region' => ['description' => 'The region in which the file resides.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'FormatName' => ['description' => 'The name of the video format.', 'type' => 'string', 'example' => 'hls,applehttp', 'title' => ''], 'Duration' => ['description' => 'The duration of the video. Unit: seconds.', 'type' => 'string', 'example' => '403.039999', 'title' => ''], 'Bitrate' => ['description' => 'The video bitrate.', 'type' => 'string', 'example' => '888.563', 'title' => ''], 'Width' => ['description' => 'The width.', 'type' => 'string', 'example' => '848', 'title' => ''], 'Height' => ['description' => 'The height.', 'type' => 'string', 'example' => '478', 'title' => ''], ], 'example' => '', ], 'AudioStreamInfoList' => [ 'title' => '', 'description' => 'The information about the audio stream.', 'type' => 'array', 'items' => [ 'description' => 'The information about the audio stream.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The sequence number of the stream.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CodecName' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => 'aac', 'title' => ''], 'CodecLongName' => ['description' => 'The name of the encoding format.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], 'CodecTimeBase' => ['description' => 'The time base of the encoder.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], 'CodecTagString' => ['description' => 'The name of the encoder tag.', 'type' => 'string', 'example' => '[15][0][0][0]', 'title' => ''], 'CodecTag' => ['description' => 'The encoder tag.', 'type' => 'string', 'example' => '0x000f', 'title' => ''], 'SampleFmt' => ['description' => 'The sampling format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], 'SampleRate' => ['description' => 'The sampling rate. Unit: Hz.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Channels' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], 'ChannelLayout' => ['description' => 'The sound channel layout.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], 'StartTime' => ['description' => 'The start time of the stream.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], 'Duration' => ['description' => 'The duration of the stream. Unit: seconds.', 'type' => 'string', 'example' => '403.039989', 'title' => ''], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '0.f', 'title' => ''], 'Lang' => ['description' => 'The language of the stream.', 'type' => 'string', 'example' => 'cn', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoStreamInfoList' => [ 'title' => '', 'description' => 'The information about the video stream.', 'type' => 'array', 'items' => [ 'description' => 'The information about the video stream.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The sequence number of the stream.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Codec_name' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => 'h264', 'title' => ''], 'Codec_long_name' => ['description' => 'The name of the encoding format.', 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'title' => ''], 'Profile' => ['description' => 'The encoder profile.', 'type' => 'string', 'example' => 'High', 'title' => ''], 'Codec_time_base' => ['description' => 'The time base of the encoder.', 'type' => 'string', 'example' => '1/50', 'title' => ''], 'Codec_tag_string' => ['description' => 'The tag string of the encoding format.', 'type' => 'string', 'example' => '[27][0][0][0]', 'title' => ''], 'Codec_tag' => ['description' => 'The tag of the encoding format.', 'type' => 'string', 'example' => '0x001b', 'title' => ''], 'Width' => ['description' => 'The width.', 'type' => 'string', 'example' => '848', 'title' => ''], 'Height' => ['description' => 'The height.', 'type' => 'string', 'example' => '478', 'title' => ''], 'Has_b_frames' => ['description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). Valid values:'."\n" ."\n" .'- 0: The stream contains no B-frames.'."\n" ."\n" .'- 1: The stream contains one B-frame.'."\n" ."\n" .'- 2: The stream contains multiple consecutive B-frames.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Sar' => ['description' => 'The aspect ratio of the area from which the sampling points are collected.', 'type' => 'string', 'example' => '478:477', 'title' => ''], 'Dar' => ['description' => 'The display aspect ratio.', 'type' => 'string', 'example' => '16:9', 'title' => ''], 'PixFmt' => ['description' => 'The pixel format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Level' => ['description' => 'The codec level.', 'type' => 'string', 'example' => '31', 'title' => ''], 'Fps' => ['description' => 'The frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Avg_fps' => ['description' => 'The average frame rate.', 'type' => 'string', 'example' => '25.0', 'title' => ''], 'Time_base' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], 'Start_time' => ['description' => 'The start time of the stream.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], 'Duration' => ['description' => 'The duration of the stream. Unit: seconds.', 'type' => 'string', 'example' => '403.039989', 'title' => ''], 'Bit_rate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '888.563', 'title' => ''], 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '10040', 'title' => ''], 'Lang' => ['description' => 'The language of the stream.', 'type' => 'string', 'example' => 'cn', 'title' => ''], 'Rotate' => ['description' => 'The rotation angle of the video image.'."\n" ."\n" .'- Valid values: 0, 90, 180, and 270.'."\n" ."\n" .'- Default value: 0.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'SubmitTime' => ['description' => 'The time when the job was submitted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextPageToken' => ['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 for the first time.', 'type' => 'string', 'example' => '019daf5780f74831b0e1a767c9f1c178', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"Jobs\\": [\\n {\\n \\"Name\\": \\"job-name\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82df****\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"Async\\": true,\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f****\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"SubmitResultJson\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"4765337007f571edbfdf81848c01****\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"cn\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"019daf5780f74831b0e1a767c9f1c178\\"\\n}","type":"json"}]', 'title' => 'ListMediaInfoJobs', 'summary' => 'Queries a list of media information analysis jobs.', 'changeSet' => [ ['createdAt' => '2022-07-20T07:56:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-20T06:27:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-19T09:22:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-19T08:08:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaInfoJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListMediaInfoJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListMediaLiveChannels' => [ 'summary' => 'Queries MediaLive channels.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value:'."\n" ."\n" .'- If you do not specify this parameter or if you set a value smaller than 10, the default value is 10.'."\n" ."\n" .'- If you set a value greater than 100, the default value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'formData', 'schema' => ['description' => 'The number of entries to be skipped in the query. If the number of entries you attempt to skip exceeds the number of entries that meet the condition, an empty list is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', '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. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ 'name' => 'SortOrder', 'in' => 'formData', 'schema' => ['description' => 'The sorting order of the channels by creation time. Default value: asc. Valid values: desc and asc. asc indicates the ascending order, and desc indicates the descending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['description' => 'The keyword of the query. You can perform a fuzzy search on channel ID or name.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'States', 'in' => 'formData', 'schema' => ['description' => 'The state of channels you want to query. You can separate multiple states with commas (,) in a JSON array.', 'type' => 'string', 'required' => false, 'example' => '["IDLE","RUNNING"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Channels' => [ 'title' => '', 'description' => 'The channels.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ChannelId' => ['description' => 'The ID of the channel.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], 'Name' => ['description' => 'The name of the channel.', 'type' => 'string', 'title' => '', 'example' => 'mych'], 'State' => ['description' => 'The state of the channel. Valid values: IDLE, STARTING, RUNNING, RECOVERING, and STOPPING.', 'type' => 'string', 'title' => '', 'example' => 'IDLE'], 'InputAttachments' => [ 'title' => '', 'description' => 'The inputs associated with the channel.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InputId' => ['description' => 'The ID of the input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], 'InputName' => ['description' => 'The name of the input.', 'type' => 'string', 'title' => '', 'example' => 'myinput'], 'LanguageName' => ['description' => 'The name of the language.', 'type' => 'string', 'title' => '', 'example' => 'eng'], 'AudioSelectors' => [ 'title' => '', 'description' => 'The audio selectors.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the audio selector.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myselector'], 'AudioLanguageSelection' => [ 'title' => '', 'description' => 'The audio language selection.', 'type' => 'object', 'properties' => [ 'LanguageCode' => ['description' => 'A three-letter ISO 639-2 language code from within an audio source.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eng'], ], 'example' => '', ], 'AudioPidSelection' => [ 'title' => '', 'description' => 'The audio PID selection.', 'type' => 'object', 'properties' => [ 'Pid' => ['title' => '', 'description' => 'A PID from within a source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], 'example' => '', ], 'AudioTrackSelection' => [ 'title' => '', 'description' => 'The audio track selection.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TrackId' => ['description' => 'The track ID from within a source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'OutputGroups' => [ 'title' => '', 'description' => 'The output groups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the output group.', 'type' => 'string', 'title' => '', 'example' => 'group1'], 'Type' => ['description' => 'The output group type.', 'type' => 'string', 'title' => '', 'example' => 'MediaPackage'], 'Outputs' => [ 'title' => '', 'description' => 'The outputs in the output group.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the output.', 'type' => 'string', 'title' => '', 'example' => 'output1'], 'MediaType' => ['description' => 'The media type of the output.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], 'MediaPackageOutputSetting' => [ 'title' => '', 'description' => 'The settings of the output delivered to MediaPackage.', 'type' => 'object', 'properties' => [ 'NameModifier' => ['description' => 'The manifest name modifier. The child manifests include this modifier in their M3U8 file names.', 'type' => 'string', 'title' => '', 'example' => '480p'], 'AudioGroupId' => ['description' => 'The manifest audio group ID.', 'type' => 'string', 'title' => '', 'example' => 'audiogroup'], ], 'example' => '', ], 'VideoSettingName' => ['description' => 'The name of the referenced VideoSettings.', 'type' => 'string', 'title' => '', 'example' => 'myVideo1'], 'AudioSettingNames' => [ 'title' => '', 'description' => 'The referenced AudioSettings.', 'type' => 'array', 'items' => ['description' => 'The name of the referenced AudioSettings.', 'type' => 'string', 'example' => 'myAudio1', 'title' => ''], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'MediaPackageGroupSetting' => [ 'title' => '', 'description' => 'The MediaPackage destination.', 'type' => 'object', 'properties' => [ 'GroupName' => ['description' => 'GroupName in MediaPackage.', 'type' => 'string', 'title' => '', 'example' => 'myPackageGroup'], 'ChannelName' => ['description' => 'ChannelName in MediaPackage.', 'type' => 'string', 'title' => '', 'example' => 'myPackageChannel'], ], 'example' => '', ], 'MonitorUrl' => ['description' => 'The URL for monitoring the output group. The parameter is returned only when the output gourp type is MediaPackage.', 'type' => 'string', 'title' => '', 'example' => 'rtmp://xxx'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'AudioSettings' => [ 'title' => '', 'description' => 'The audio settings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the audio settings.', 'type' => 'string', 'title' => '', 'example' => 'zhuanfengzhuang'], 'AudioSelectorName' => ['description' => 'The name of the audio selector.', 'type' => 'string', 'title' => '', 'example' => 'myselector'], 'LanguageCode' => ['description' => 'A three-letter ISO 639-2 language code.', 'type' => 'string', 'title' => '', 'example' => 'eng'], 'LanguageName' => ['description' => 'The name of the language.', 'type' => 'string', 'title' => '', 'example' => 'English'], 'AudioCodec' => ['description' => 'The audio codec.', 'type' => 'string', 'title' => '', 'example' => 'aac'], 'AudioCodecSetting' => [ 'title' => '', 'description' => 'The audio encoding settings.', 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The audio codec profile.', 'type' => 'string', 'title' => '', 'example' => 'AAC-LOW'], 'Bitrate' => ['description' => 'The audio bitrate. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200000'], 'SampleRate' => ['description' => 'The audio sample rate. Unit: Hz.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '44100'], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'VideoSettings' => [ 'title' => '', 'description' => 'The video settings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the video settings.', 'type' => 'string', 'title' => '', 'example' => 'video1'], 'Width' => ['description' => 'The width of the video in pixels.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1280'], 'Height' => ['description' => 'The height of the video in pixels.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '720'], 'VideoCodec' => ['description' => 'The video codec.', 'type' => 'string', 'title' => '', 'example' => 'H264'], 'VideoCodecSetting' => [ 'title' => '', 'description' => 'The video encoding settings.', 'type' => 'object', 'properties' => [ 'Rate' => [ 'title' => '', 'description' => 'The video encoding rate.', 'type' => 'object', 'properties' => [ 'Bitrate' => ['description' => 'The video bitrate. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2500000'], 'RateControlMode' => ['description' => 'The bitrate control mode.', 'type' => 'string', 'title' => '', 'example' => 'ABR'], 'MaxBitrate' => ['description' => 'The maximum bitrate. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '6000000'], 'BufferSize' => ['description' => 'The video buffer size. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '6000000'], ], 'example' => '', ], 'Framerate' => [ 'title' => '', 'description' => 'The frame rate.', 'type' => 'object', 'properties' => [ 'FramerateControl' => ['description' => 'The frame rate mode.', 'type' => 'string', 'title' => '', 'example' => 'SPECIFIED'], 'FramerateNumerator' => ['description' => 'The numerator of the fixed frame rate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '25'], 'FramerateDenominator' => ['description' => 'The denominator of the fixed frame rate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'example' => '', ], 'Gop' => [ 'title' => '', 'description' => 'The GOP setting.', 'type' => 'object', 'properties' => [ 'GopSizeUnits' => ['description' => 'The GOP size unit.', 'type' => 'string', 'title' => '', 'example' => 'FRAMES'], 'GopSize' => ['description' => 'The GOP size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '90'], 'BframesNum' => ['description' => 'The number of B frames.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], ], 'example' => '', ], 'CodecDetail' => [ 'title' => '', 'description' => 'The video encoding settings.', 'type' => 'object', 'properties' => [ 'Profile' => ['description' => 'The H.264 profile.', 'type' => 'string', 'title' => '', 'example' => 'MAIN'], 'Level' => ['description' => 'The video encoding level. It is not supported yet.', 'type' => 'string', 'title' => '', 'example' => 'H264_LEVEL_AUTO'], ], 'example' => '', ], ], 'example' => '', ], 'VideoCodecType' => ['description' => 'The video transcoding method. Valid values: NORMAL (regular transcoding) and NBHD (Narrowband HD™ transcoding).', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'The time when the channel was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'example' => '2024-12-03T06:56:42Z'], 'LastStartTime' => ['description' => 'The time when the channel was last started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. If the channel has never been started since it was created, an empty string is returned.', 'type' => 'string', 'title' => '', 'example' => '2024-12-03T06:56:42Z'], 'LastStopTime' => ['description' => 'The time when the channel was last stopped. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. If the channel has never stopped since it was created, an empty string is returned.', 'type' => 'string', 'title' => '', 'example' => '2024-12-03T06:56:42Z'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'MaxResults' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Channels\\": [\\n {\\n \\"ChannelId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mych\\",\\n \\"State\\": \\"IDLE\\",\\n \\"InputAttachments\\": [\\n {\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"InputName\\": \\"myinput\\",\\n \\"LanguageName\\": \\"eng\\",\\n \\"AudioSelectors\\": [\\n {\\n \\"Name\\": \\"myselector\\",\\n \\"AudioLanguageSelection\\": {\\n \\"LanguageCode\\": \\"eng\\"\\n },\\n \\"AudioPidSelection\\": {\\n \\"Pid\\": 123\\n },\\n \\"AudioTrackSelection\\": [\\n {\\n \\"TrackId\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"Name\\": \\"group1\\",\\n \\"Type\\": \\"MediaPackage\\",\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"output1\\",\\n \\"MediaType\\": 0,\\n \\"MediaPackageOutputSetting\\": {\\n \\"NameModifier\\": \\"480p\\",\\n \\"AudioGroupId\\": \\"audiogroup\\"\\n },\\n \\"VideoSettingName\\": \\"myVideo1\\",\\n \\"AudioSettingNames\\": [\\n \\"myAudio1\\"\\n ]\\n }\\n ],\\n \\"MediaPackageGroupSetting\\": {\\n \\"GroupName\\": \\"myPackageGroup\\",\\n \\"ChannelName\\": \\"myPackageChannel\\"\\n },\\n \\"MonitorUrl\\": \\"rtmp://xxx\\"\\n }\\n ],\\n \\"AudioSettings\\": [\\n {\\n \\"Name\\": \\"zhuanfengzhuang\\",\\n \\"AudioSelectorName\\": \\"myselector\\",\\n \\"LanguageCode\\": \\"eng\\",\\n \\"LanguageName\\": \\"English\\",\\n \\"AudioCodec\\": \\"aac\\",\\n \\"AudioCodecSetting\\": {\\n \\"Profile\\": \\"AAC-LOW\\",\\n \\"Bitrate\\": 200000,\\n \\"SampleRate\\": 44100\\n }\\n }\\n ],\\n \\"VideoSettings\\": [\\n {\\n \\"Name\\": \\"video1\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"H264\\",\\n \\"VideoCodecSetting\\": {\\n \\"Rate\\": {\\n \\"Bitrate\\": 2500000,\\n \\"RateControlMode\\": \\"ABR\\",\\n \\"MaxBitrate\\": 6000000,\\n \\"BufferSize\\": 6000000\\n },\\n \\"Framerate\\": {\\n \\"FramerateControl\\": \\"SPECIFIED\\",\\n \\"FramerateNumerator\\": 25,\\n \\"FramerateDenominator\\": 1\\n },\\n \\"Gop\\": {\\n \\"GopSizeUnits\\": \\"FRAMES\\",\\n \\"GopSize\\": 90,\\n \\"BframesNum\\": 3\\n },\\n \\"CodecDetail\\": {\\n \\"Profile\\": \\"MAIN\\",\\n \\"Level\\": \\"H264_LEVEL_AUTO\\"\\n }\\n },\\n \\"VideoCodecType\\": \\"NORMAL\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStartTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStopTime\\": \\"2024-12-03T06:56:42Z\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', 'title' => 'ListMediaLiveChannels', 'description' => '## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [ ['createdAt' => '2025-05-14T07:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaLiveChannels'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListMediaLiveChannels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListMediaLiveInputSecurityGroups' => [ 'summary' => 'Queries the security groups in MediaLive.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: If you do not specify this parameter or if you set a value smaller than 10, the default value is 10. If you set a value greater than 100, the default value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'formData', 'schema' => ['description' => 'The number of entries to be skipped in the query. If the number of entries you attempt to skip exceeds the number of entries that meet the condition, an empty list is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', '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. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ 'name' => 'SortOrder', 'in' => 'formData', 'schema' => ['description' => 'The sorting order of the security groups by creation time. Default value: asc. Valid values: desc and asc. asc indicates the ascending order, and desc indicates the descending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['description' => 'The keyword of the query. You can perform a fuzzy search on security group ID or name.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-426614174000', 'title' => ''], 'SecurityGroups' => [ 'title' => '', 'description' => 'The security groups.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The information about a security group.', 'type' => 'object', 'properties' => [ 'SecurityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], 'Name' => ['description' => 'The security group name.', 'type' => 'string', 'title' => '', 'example' => 'mysg'], 'WhitelistRules' => [ 'title' => '', 'description' => 'The security group rules.', 'type' => 'array', 'items' => ['description' => 'The IPv4 addresses that are allowed to push content to MediaLive.', 'type' => 'string', 'example' => '10.1.1.0/24"', 'title' => ''], 'example' => '', ], 'CreateTime' => ['description' => 'The time when the security group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-12-03T06:56:42Z', 'title' => ''], 'InputIds' => [ 'description' => 'The IDs of the inputs associated with the security group.', 'type' => 'array', 'items' => ['description' => 'The input ID associated with the security group.', 'type' => 'string', 'example' => 'SEGK5KA6KYKAWQQH', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'example' => '', ], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], 'MaxResults' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123e4567-e89b-12d3-a456-426614174000\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mysg\\",\\n \\"WhitelistRules\\": [\\n \\"10.1.1.0/24\\\\\\"\\"\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"InputIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', 'title' => 'ListMediaLiveInputSecurityGroups', 'description' => '## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaLiveInputSecurityGroups'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListMediaLiveInputSecurityGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListMediaLiveInputs' => [ 'summary' => 'Query the list of media live inputs.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: If you do not specify this parameter or if you set a value smaller than 10, the default value is 10. If you set a value greater than 100, the default value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'formData', 'schema' => ['description' => 'The number of entries to be skipped in the query. If the number of entries you attempt to skip exceeds the number of entries that meet the condition, an empty list is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', '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. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ 'name' => 'SortOrder', 'in' => 'formData', 'schema' => ['description' => 'The sorting order of the inputs by creation time. Default value: asc. Valid values: desc and asc. asc indicates the ascending order, and desc indicates the descending order.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc'], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['description' => 'The keyword of the query. You can perform a fuzzy search on input ID or name.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'Types', 'in' => 'formData', 'schema' => ['description' => 'The type of inputs you want to query. You can separate multiple input types with commas (,) in a JSON array.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '["RTMP_PUSH","SRT_PULL"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Inputs' => [ 'title' => '', 'description' => 'The inputs.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The input configurations.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The input type.', 'type' => 'string', 'title' => '', 'example' => 'RTMP_PUSH'], 'CreateTime' => ['description' => 'The time when the input was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-12-03T06:56:42Z', 'title' => ''], 'InputId' => ['description' => 'The ID of the input.', 'type' => 'string', 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], 'InputInfos' => [ 'title' => '', 'description' => 'The input configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'The ID of the flow from MediaConnect.', 'type' => 'string', 'example' => '******81-9693-40dc-bbab-db5e49******', 'title' => ''], 'SourceUrl' => ['description' => 'The source URL where the stream is pulled from. This parameter is returned for PULL inputs.', 'type' => 'string', 'title' => '', 'example' => 'rtmp://domain/app/stream'], 'StreamName' => ['description' => 'The name of the pushed stream. This parameter is returned for PUSH inputs.', 'type' => 'string', 'title' => '', 'example' => 'mystream'], 'MonitorUrl' => ['description' => 'The URL for input monitoring.', 'type' => 'string', 'example' => 'rtmp://domain/app/stream_for_monitor', 'title' => ''], 'SrtPassphrase' => ['description' => 'SRT encryption configuration—the password for the SRT stream.', 'type' => 'string', 'example' => 'srtencryption', 'title' => ''], 'SrtMaxBitrate' => ['description' => 'The maximum bitrate of the SRT stream, in bps.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000000', 'title' => ''], 'FlowOutputName' => ['description' => 'The output name of the MediaConnect flow.', 'type' => 'string', 'example' => 'myFlowOutputName', 'title' => ''], 'SrtLatency' => ['description' => 'Latency of the SRT stream, in milliseconds (ms).', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'DestHost' => ['description' => 'The endpoint that the stream is pushed to. This parameter is returned for PUSH inputs.', 'type' => 'string', 'title' => '', 'example' => 'rtmp://domain/app/stream'], 'SrtPbKeyLen' => ['description' => 'Encryption configuration for SRT. Specifies the key length for the SRT stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'SecurityGroupIds' => [ 'title' => '', 'description' => 'The IDs of the security groups associated with the input.', 'type' => 'array', 'items' => ['description' => 'The ID of the security group.', 'type' => 'string', 'example' => 'SEGK5KA6KYKAWQQH', 'title' => ''], 'example' => '', ], 'ChannelIds' => [ 'description' => 'The IDs of the channels associated with the input.', 'type' => 'array', 'items' => ['description' => 'The ID of the channel.', 'type' => 'string', 'example' => 'SEGK5KA6KYKAWQQH', 'title' => ''], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the input.', 'type' => 'string', 'title' => '', 'example' => 'myinput'], ], 'example' => '', ], 'example' => '', ], 'MaxResults' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Inputs\\": [\\n {\\n \\"Type\\": \\"RTMP_PUSH\\",\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"InputInfos\\": [\\n {\\n \\"FlowId\\": \\"******81-9693-40dc-bbab-db5e49******\\",\\n \\"SourceUrl\\": \\"rtmp://domain/app/stream\\",\\n \\"StreamName\\": \\"mystream\\",\\n \\"MonitorUrl\\": \\"rtmp://domain/app/stream_for_monitor\\",\\n \\"SrtPassphrase\\": \\"srtencryption\\",\\n \\"SrtMaxBitrate\\": 3000000,\\n \\"FlowOutputName\\": \\"myFlowOutputName\\",\\n \\"SrtLatency\\": 1000,\\n \\"DestHost\\": \\"rtmp://domain/app/stream\\",\\n \\"SrtPbKeyLen\\": 16\\n }\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ],\\n \\"ChannelIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ],\\n \\"Name\\": \\"myinput\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"TotalCount\\": 200\\n}","type":"json"}]', 'title' => 'Query media live streaming input list', 'description' => '- You can invoke this API to query the list of media live inputs.'."\n" ."\n" .'## QPS Limit'."\n" ."\n" .'The queries per second (QPS) limit for this API is 50 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.', 'changeSet' => [ ['createdAt' => '2025-08-07T07:13:03.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-02-27T07:59:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaLiveInputs'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListMediaLiveInputs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListMediaMarks' => [ 'summary' => 'Queries a list of marks of a media asset.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '411bed50018971edb60b0764a0ec6***', 'title' => ''], ], [ 'name' => 'MediaMarkIds', 'in' => 'query', 'schema' => ['description' => 'The mark ID. You can specify multiple IDs separated with commas (,). This parameter is discontinued.', 'type' => 'string', 'required' => false, 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '******b48fb04483915d4f2cd8******'], 'MediaMarks' => ['title' => '', 'description' => 'The marks of the media asset, in the JSONArray format.', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "MarkStartTime": "12.1",'."\n" .' "MarkEndTime": "12.2",'."\n" .' "MarkTag": "tag-1",'."\n" .' "MarkContent": "content-1",'."\n" .' "MarkStatus": "a"'."\n" .' },'."\n" .' {'."\n" .' "MarkStartTime": "12.3",'."\n" .' "MarkEndTime": "12.4",'."\n" .' "MarkTag": "tag-2",'."\n" .' "MarkContent": "content-2",'."\n" .' "MarkStatus": "online"'."\n" .' }'."\n" .']'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"MediaMarks\\": \\"[\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.1\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.2\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-1\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-1\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"a\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.3\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.4\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-2\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-2\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"online\\\\\\"\\\\n }\\\\n]\\"\\n}","type":"json"}]', 'title' => 'ListMediaMarks', 'responseParamsDescription' => '## MediaMark'."\n" ."\n" .'| Field | Type | Required | Description |'."\n" .'| ------------- | ------ | -------- | --------------------------------------- |'."\n" .'| MarkId | String | No | The mark ID. |'."\n" .'| MarkStartTime | Float | No | The start time of the mark. |'."\n" .'| MarkEndTime | Float | No | The end time of the mark. |'."\n" .'| MarkTag | String | No | The custom tag for easy classification. |'."\n" .'| MarkContent | String | No | The mark content. |'."\n" .'| MarkStatus | String | No | The mark status. |', 'changeSet' => [ ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-09-15T09:22:59.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaMarks'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListMediaMarks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListMediaProducingJobs' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '12624', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The job state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Init: The job is initialized.'."\n" ."\n" .'- Failed: The job failed.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Processing: The job is in progress.', 'enumValueTitles' => ['Init' => '', 'Failed' => '', 'Success' => '', 'Processing' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Success', ], ], [ 'name' => 'JobType', 'in' => 'query', 'schema' => [ 'description' => 'The job type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- LiveEditingJob: live editing job.'."\n" ."\n" .'- EditingJob: regular template-based editing job'."\n" ."\n" .'- VETemplateJob: advanced template-based editing job.', 'enumValueTitles' => ['LiveEditingJob' => '', 'EditingJob' => '', 'VETemplateJob' => ''], 'type' => 'string', 'required' => false, 'example' => 'EditingJob', 'title' => '', ], ], [ 'name' => 'StartTime', '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.', 'type' => 'string', 'required' => false, 'example' => '2017-01-11T12:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The maximum time range between EndTime and StartTime cannot exceed 30 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2022-02-02T23:59:59Z', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. For example, you can use a job ID as the keyword to search for jobs.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'required' => false, 'example' => '******927cfb53d05b96c1bfe1******', 'title' => ''], ], [ 'name' => 'MasterJobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the quick video production job. If this parameter is specified, the subjobs of the quick video production job are queried.', 'type' => 'string', 'required' => false, 'example' => '******8750b54e3c976a47da6f******', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return.'."\n" ."\n" .'Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting parameter. By default, the query results are sorted by creation time in descending order.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- CreationTime:Asc: sorted by creation time in ascending order.'."\n" ."\n" .'- CreationTime:Desc: sorted by creation time in descending order.', 'enumValueTitles' => ['CreationTime:Asc' => '', 'CreationTime:Desc' => ''], 'type' => 'string', 'required' => false, 'example' => 'CreationTime:Desc', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaProducingJobList' => [ 'description' => 'The queried media editing and production jobs.', 'type' => 'array', 'items' => [ 'description' => 'The queried media editing and production job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The ID of the online editing job.', 'type' => 'string', 'example' => '******8750b54e3c976a47da6f******', 'title' => ''], 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'example' => '******faa3b542f5a6135217e3******', 'title' => ''], 'MediaId' => ['description' => 'The media asset ID of the output file.', 'type' => 'string', 'example' => '0ce4ea70f52471edab61f7e7d6786302', 'title' => ''], 'MediaURL' => ['description' => 'The URL of the output file.', 'type' => 'string', 'example' => 'http://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4', 'title' => ''], 'TemplateId' => ['description' => 'The ID of the online editing template.', 'type' => 'string', 'example' => 'cb786a39c5d44cecb23d8c864facffc1', 'title' => ''], 'ClipsParam' => ['description' => 'The template material parameters.', 'type' => 'string', 'example' => '{"Text1":"text","Text0":"text","Media1":"mediaId","Media0":"mediaId"}', 'title' => ''], 'Duration' => ['description' => 'The duration of the output file. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '15.5', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-03-21T16:40:00Z', 'title' => ''], 'CompleteTime' => ['description' => 'The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-03-21T16:40:30Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2022-03-21T16:41:00Z', 'title' => ''], 'Status' => ['description' => 'The job state.', 'type' => 'string', 'example' => 'Sucess', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The returned message. Note: Pay attention to this parameter if the job failed.', 'type' => 'string', 'example' => 'The resource operated InputFile is bad', 'title' => ''], 'UserData' => ['description' => 'The user-defined data in the JSON format.', 'type' => 'string', 'example' => '{"key":"value"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'MaxResults' => ['description' => 'The maximum number of entries returned.'."\n" ."\n" .'Default value: 10. Valid values: 1 to 100.', 'type' => 'string', 'example' => '100', 'title' => ''], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'ListMediaProducingJobs', 'summary' => 'Queries a list of media editing and production jobs that meet the specified conditions. You can query the jobs based on the job state and type.', 'changeSet' => [ ['createdAt' => '2024-08-14T09:27:47.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaProducingJobs'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListMediaProducingJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaProducingJobList\\": [\\n {\\n \\"JobId\\": \\"******8750b54e3c976a47da6f******\\",\\n \\"ProjectId\\": \\"******faa3b542f5a6135217e3******\\",\\n \\"MediaId\\": \\"0ce4ea70f52471edab61f7e7d6786302\\",\\n \\"MediaURL\\": \\"http://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4\\",\\n \\"TemplateId\\": \\"cb786a39c5d44cecb23d8c864facffc1\\",\\n \\"ClipsParam\\": \\"{\\\\\\"Text1\\\\\\":\\\\\\"text\\\\\\",\\\\\\"Text0\\\\\\":\\\\\\"text\\\\\\",\\\\\\"Media1\\\\\\":\\\\\\"mediaId\\\\\\",\\\\\\"Media0\\\\\\":\\\\\\"mediaId\\\\\\"}\\",\\n \\"Duration\\": 15.5,\\n \\"CreateTime\\": \\"2022-03-21T16:40:00Z\\",\\n \\"CompleteTime\\": \\"2022-03-21T16:40:30Z\\",\\n \\"ModifiedTime\\": \\"2022-03-21T16:41:00Z\\",\\n \\"Status\\": \\"Sucess\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"UserData\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n }\\n ],\\n \\"MaxResults\\": \\"100\\",\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListPackageJobs' => [ 'summary' => 'Queries packaging jobs.', 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range during which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'example' => '2022-07-01T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'EndOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range during which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'example' => '2022-07-15T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '7b38a5d86f1e47838927b6e7ccb1****', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The state of the job.'."\n" ."\n" .'- Init: The job is submitted.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Fail: The job failed.', 'type' => 'string', 'example' => 'Success', 'title' => '', 'required' => false], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => ['description' => 'The order that you use to sort the query results. Valid values:'."\n" ."\n" .'- CreateTimeDesc: sorts the jobs by creation time in descending order.'."\n" ."\n" .'- CreateTimeAsc: sorts the jobs by creation time in ascending order.', 'type' => 'string', 'example' => 'CreateTimeDesc', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 0 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], ], [ '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.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82df****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], 'PackageJobList' => [ 'title' => '', 'description' => 'The list of packaging jobs.', 'type' => 'object', 'properties' => [ 'PackageJobs' => [ 'description' => 'The list of packaging jobs.', 'type' => 'array', 'items' => [ 'description' => 'The packaging job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '7b38a5d86f1e47838927b6e7ccb1****', 'title' => ''], 'TriggerSource' => ['description' => 'The source of the job. Valid values:'."\n" ."\n" .'- API'."\n" ."\n" .'- WorkFlow'."\n" ."\n" .'- Console', 'type' => 'string', 'example' => 'API', 'title' => ''], 'Name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'job-name', 'title' => ''], 'Inputs' => [ 'description' => 'The input of the job.', 'type' => 'array', 'items' => [ 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Input' => [ 'title' => '', 'description' => 'The information about the input stream file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" .'- OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media object.'."\n" ."\n" .'- If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported.'."\n" ."\n" .'- If Type is set to Media, set this parameter to the ID of a media asset.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'The output of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" .'- OSS: an OSS object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media object.'."\n" ."\n" .'- If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported.'."\n" ."\n" .'- If Type is set to Media, set this parameter to the ID of a media asset.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.', 'type' => 'string', 'example' => '5b40833e4c3e4d4e95a866abb9a4****', 'title' => ''], 'Priority' => ['description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority. Default value: 6.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Status' => ['description' => 'The state of the job.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job fails.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], 'Message' => ['description' => 'The error message that is returned.', 'type' => 'string', 'example' => 'Resource content bad. ', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the job was submitted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-07-07T14:00:32Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-07-07T15:00:32Z', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"param": "value"}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-07-07T14:00:32Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-07-07T15:00:32Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextPageToken' => ['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 for the first time.', 'type' => 'string', 'example' => '019daf5780f74831b0e1a767c9f1****', 'title' => ''], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"PackageJobList\\": {\\n \\"PackageJobs\\": [\\n {\\n \\"JobId\\": \\"7b38a5d86f1e47838927b6e7ccb1****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"job-name\\",\\n \\"Inputs\\": [\\n {\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n ],\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"PipelineId\\": \\"5b40833e4c3e4d4e95a866abb9a4****\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"Resource content bad. \\",\\n \\"SubmitTime\\": \\"2022-07-07T14:00:32Z\\",\\n \\"FinishTime\\": \\"2022-07-07T15:00:32Z\\",\\n \\"UserData\\": \\"{\\\\\\"param\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-07-07T14:00:32Z\\",\\n \\"ModifiedTime\\": \\"2022-07-07T15:00:32Z\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"019daf5780f74831b0e1a767c9f1****\\"\\n }\\n}","type":"json"}]', 'title' => 'ListPackageJobs', 'changeSet' => [ ['createdAt' => '2022-09-20T10:02:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPackageJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListPackageJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListPipelines' => [ 'summary' => 'Queries a list of ApsaraVideo Media Processing (MPS) queues.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Speed', 'in' => 'query', 'schema' => [ 'description' => 'The type of the MPS queue.'."\n" ."\n" .'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.', 'enumValueTitles' => ['Boost' => '', 'Standard' => '', 'NarrowBandHDV2' => ''], 'type' => 'string', 'required' => false, 'example' => 'Standard', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'PipelineList' => [ 'description' => 'The queried MPS queues.', 'type' => 'array', 'items' => [ 'description' => 'The information about the MPS queue.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Name' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'example' => 'test-pipeline', 'title' => ''], 'Speed' => ['description' => 'The type of the MPS queue.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'Priority' => ['description' => 'The priority of the MPS queue.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Status' => [ 'description' => 'The state of the MPS queue.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Active'."\n" ."\n" .'- Paused', 'enumValueTitles' => ['Active' => '', 'Paused' => ''], 'type' => 'string', 'example' => 'Active', 'title' => '', ], 'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PipelineList\\": [\\n {\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"test-pipeline\\",\\n \\"Speed\\": \\"Standard\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Active\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListPipelines', 'changeSet' => [ ['createdAt' => '2022-07-18T03:28:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelines'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListPipelines', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListPrograms' => [ 'summary' => 'Lists programs.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProgramName', 'in' => 'query', 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => false, 'example' => 'program1', 'title' => ''], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order. By default, the query results are sorted by creation time in descending order. Valid values:'."\n" ."\n" .'- asc: ascending order.'."\n" ."\n" .'- desc: descending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'TotalCount' => ['description' => 'The total number of programs returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'Programs' => [ 'description' => 'The programs.', 'type' => 'array', 'items' => ['description' => 'The information about the program.', '$ref' => '#/components/schemas/ChannelAssemblyProgram', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"Programs\\": [\\n {\\n \\"GmtCreate\\": \\"2024-04-02T00:58:19Z\\\\n\\",\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"{\\\\\\"segmentationEventID\\\\\\":0,\\\\\\"segmentationUPIDType\\\\\\":14,\\\\\\"segmentationUPID\\\\\\":\\\\\\"upid\\\\\\",\\\\\\"segmentationTypeID\\\\\\":48,\\\\\\"segmentNumber\\\\\\":0,\\\\\\"segmentsExpected\\\\\\":0,\\\\\\"subSegmentNumber\\\\\\":1,\\\\\\"subSegmentsExpected\\\\\\":0}\\\\n\\",\\n \\"OffsetMillis\\": 1000,\\n \\"ChannelName\\": \\"MyChannel\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\",\\n \\"SpliceInsertSettings\\": \\"{\\\\\\"AvailNumber\\\\\\":0,\\\\\\"AvailExpected\\\\\\":0,\\\\\\"SpliceEventID\\\\\\":1,\\\\\\"UniqueProgramID\\\\\\":0}\\\\n\\",\\n \\"SourceName\\": \\"MyAdSource\\",\\n \\"ProgramName\\": \\"program_name\\\\n\\",\\n \\"MessageType\\": \\"SPLICE_INSERT\\"\\n }\\n ],\\n \\"SourceType\\": \\"vodSource\\",\\n \\"Transition\\": \\"{\\\\\\"Type\\\\\\": \\\\\\"RELATIVE\\\\\\", \\\\\\"RelativePosition\\\\\\": \\\\\\"AFTER_PROGRAM\\\\\\", \\\\\\"RelativeProgram\\\\\\": \\\\\\"program2\\\\\\"}\\\\n\\",\\n \\"GmtModified\\": \\"2024-04-02T00:58:19Z\\\\n\\",\\n \\"SourceName\\": \\"MySource\\",\\n \\"ClipRange\\": \\"{StartOffsetMillis: 213123, EndOffsetMillis: 213134}\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::program/myChannel/MyProgram\\\\n\\",\\n \\"ProgramName\\": \\"program1\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', 'title' => 'ListPrograms', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListPrograms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListPublicMediaBasicInfos' => [ 'summary' => 'Queries a list of media assets in the public media library that meet the specified conditions. A maximum of 100 media assets can be returned.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaTagId', 'in' => 'query', 'schema' => ['description' => 'The media tag. All media assets that contain the specified media tag are returned. Valid values:'."\n" ."\n" .'- Sticker tags:'."\n" ."\n" .' - sticker-atmosphere'."\n" ."\n" .' - sticker-bubble'."\n" ."\n" .' - sticker-cute'."\n" ."\n" .' - sticker-daily'."\n" ."\n" .' - sticker-expression'."\n" ."\n" .' - sticker-gif'."\n" ."\n" .'- Background music (BGM) tags:'."\n" ."\n" .' - bgm-romantic'."\n" ."\n" .' - bgm-cuisine'."\n" ."\n" .' - bgm-chinese-style'."\n" ."\n" .' - bgm-upbeat'."\n" ."\n" .' - bgm-dynamic'."\n" ."\n" .' - bgm-relaxing'."\n" ."\n" .' - bgm-quirky'."\n" ."\n" .' - bgm-beauty'."\n" ."\n" .'- Background image (BGI) tags:'."\n" ."\n" .' - bgi-grad'."\n" ."\n" .' - bgi-solid'."\n" ."\n" .' - bgi-pic', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'sticker-atmosphere'], ], [ 'name' => 'NextToken', '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. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pSa1SQ0wCe5pzVrQ6mWZEw=='], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return.'."\n" ."\n" .'Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '5'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'IncludeFileBasicInfo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the basic information of the media asset.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], [ 'name' => 'BusinessType', 'in' => 'query', 'schema' => ['description' => 'The business type of the media asset. Valid values:'."\n" ."\n" .'- sticker'."\n" ."\n" .'- bgm'."\n" ."\n" .'- bgi', 'type' => 'string', 'required' => false, 'example' => 'sticker', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******B7-7F87-4792-BFE9-63CD21******'], 'TotalCount' => ['description' => 'The total number of media assets that meet the specified conditions.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'], 'MediaInfos' => [ 'title' => '', 'description' => 'The media assets that meet the specified conditions.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => '****019b82e24b37a1c2958dec38****'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'The basic information of the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****019b82e24b37a1c2958dec38****'], 'InputURL' => ['description' => 'The URL of the media asset in another service.', 'type' => 'string', 'title' => '', 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], 'MediaType' => ['description' => 'The type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'video'], 'BusinessType' => ['description' => 'The business type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'general'], 'Source' => ['description' => 'The source of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'The title of the media asset.', 'type' => 'string', 'example' => 'My video title', 'title' => ''], 'Description' => ['description' => 'The description of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'description'], 'Category' => ['description' => 'The category of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'video'], 'MediaTags' => ['description' => 'The tags of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'sticker-daily'], 'CoverURL' => ['description' => 'The thumbnail URL of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'title' => '', 'example' => 'userData'], 'Snapshots' => ['description' => 'The snapshots of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'null'], 'Status' => ['description' => 'The status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'TranscodeStatus' => ['description' => 'The transcoding status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Init'], 'CreateTime' => ['description' => 'The time when the media asset was created.', 'type' => 'string', 'title' => '', 'example' => '2021-01-08T16:52:04Z'], 'ModifiedTime' => ['description' => 'The time when the media asset was last modified.', 'type' => 'string', 'title' => '', 'example' => '2021-01-08T16:52:04Z'], 'DeletedTime' => ['description' => 'The time when the media asset was deleted.', 'type' => 'string', 'title' => '', 'example' => '2021-01-08T16:52:04Z'], ], 'example' => '', ], 'FileInfoList' => [ 'title' => '', 'description' => 'The file information of the media asset.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'The basic information of the file, such as the duration and size.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'example.mp4'], 'FileStatus' => ['description' => 'The file status.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'title' => '', 'example' => 'source_file'], 'FileSize' => ['description' => 'The file size. Unit: bytes.', 'type' => 'string', 'title' => '', 'example' => '338990717'], 'FileUrl' => ['description' => 'The Object Storage Service (OSS) URL of the file.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'Region' => ['description' => 'The region in which the file resides.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], 'FormatName' => ['description' => 'The container format.', 'type' => 'string', 'title' => '', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2'], 'Duration' => ['description' => 'The duration.', 'type' => 'string', 'title' => '', 'example' => '10.040000'], 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'title' => '', 'example' => '270112.12'], 'Width' => ['description' => 'The width.', 'type' => 'string', 'title' => '', 'example' => '1920'], 'Height' => ['description' => 'The height.', 'type' => 'string', 'title' => '', 'example' => '1080'], ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******B7-7F87-4792-BFE9-63CD21******\\",\\n \\"TotalCount\\": 2,\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"My video title\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"video\\",\\n \\"MediaTags\\": \\"sticker-daily\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"null\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"DeletedTime\\": \\"2021-01-08T16:52:04Z\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"338990717\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"10.040000\\",\\n \\"Bitrate\\": \\"270112.12\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"MaxResults\\": 2\\n}","type":"json"}]', 'title' => 'ListPublicMediaBasicInfos', 'changeSet' => [ ['createdAt' => '2024-01-26T06:16:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-09T01:45:46.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'ListRecognitionEntities' => [ 'summary' => 'Lists entities in a specified recognition library. Pagination is supported.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm associated with the entity. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1965304870001', '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. Valid values: 1 to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', '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 returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Entities' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Entity' => [ 'description' => 'The entities.', 'type' => 'array', 'items' => [ 'description' => 'The entity.', 'type' => 'object', 'properties' => [ 'EntityId' => ['description' => 'The ID of the entity.', 'type' => 'string', 'example' => '**************544cb84754************', 'title' => ''], 'EntityName' => ['description' => 'The name of the entity.', 'type' => 'string', 'example' => 'Eiffel Tower', 'title' => ''], 'EntityInfo' => ['description' => 'The additional information of the entity, in JSON format.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Entities\\": {\\n \\"Entity\\": [\\n {\\n \\"EntityId\\": \\"**************544cb84754************\\",\\n \\"EntityName\\": \\"Eiffel Tower\\",\\n \\"EntityInfo\\": \\"{}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListRecognitionEntities', 'description' => '- This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- Supports up to 50 calls per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:ListRecognitionEntities', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListRecognitionLibs' => [ 'summary' => 'Perform a paged query to retrieve information about all Custom detection libraries under the current User.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face'."\n" ."\n" .'- label', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', '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. Valid values: 1 to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'Library ID. If provided, the query returns only this specific library. A list of IDs separated by commas (",") is also supported.', 'type' => 'string', 'required' => false, 'example' => 'lib1,lib2,lib3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', '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 returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'title' => ''], 'Libs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Lib' => [ 'description' => 'The recognition libraries.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LibId' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'example' => '*************24b47865c6**************', 'title' => ''], 'LibName' => ['description' => 'The name of the recognition library.', 'type' => 'string', 'example' => 'LLM ACP', 'title' => ''], 'LibDescription' => ['description' => 'The description of the recognition library.', 'type' => 'string', 'example' => '用于商品识别的库', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 180,\\n \\"Libs\\": {\\n \\"Lib\\": [\\n {\\n \\"LibId\\": \\"*************24b47865c6**************\\",\\n \\"LibName\\": \\"LLM ACP\\",\\n \\"LibDescription\\": \\"用于商品识别的库\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Retrieve the List of Custom Detection Libraries', 'description' => '- This API currently supports the following Regions: China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen). Other Regions are not supported at this time.'."\n" ."\n" .'- The queries per second (QPS) limit for this API is 50 per User. If this 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~~).', 'changeSet' => [ ['createdAt' => '2025-11-17T14:18:38.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:ListRecognitionLibs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListRecognitionSamples' => [ 'summary' => 'Retrieves all samples of a custom entity. Pagination is supported.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Algorithm', 'in' => 'query', 'schema' => ['description' => 'The type of recognition algorithm. Valid values:'."\n" ."\n" .'- landmark'."\n" ."\n" .'- object'."\n" ."\n" .'- logo'."\n" ."\n" .'- face', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'landmark', 'title' => ''], ], [ 'name' => 'LibId', 'in' => 'query', 'schema' => ['description' => 'The library ID. If you specify this parameter, the system performs an exact match. You can specify multiple library IDs. Separate them with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lib1,lib2,lib3', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID. If you set this parameter to ANY, the system queries by EntityName.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '**************544cb84754************', '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.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'EntityName', 'in' => 'query', 'schema' => ['description' => 'The entity name.', 'type' => 'string', 'required' => false, 'example' => 'custom_person', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', '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' => '20', 'title' => ''], 'TotalCount' => ['description' => 'The total number of samples.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'Samples' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Sample' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SampleId' => ['description' => 'The sample ID.', 'type' => 'string', 'example' => '**************4d2ba728e2f**************', 'title' => ''], 'ImageUrl' => ['description' => 'The URL of the image sample.', 'type' => 'string', 'example' => 'https://example.com/sample.png', 'title' => ''], 'EntityId' => ['description' => 'The entity ID.', 'type' => 'string', 'example' => '*******49ff-9b15******', 'title' => ''], 'LibId' => ['description' => 'The library ID.', 'type' => 'string', 'example' => '**********23da4529998************', 'title' => ''], ], 'description' => 'A sample.', 'title' => '', 'example' => '', ], 'description' => 'The samples.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"Samples\\": {\\n \\"Sample\\": [\\n {\\n \\"SampleId\\": \\"**************4d2ba728e2f**************\\",\\n \\"ImageUrl\\": \\"https://example.com/sample.png\\",\\n \\"EntityId\\": \\"*******49ff-9b15******\\",\\n \\"LibId\\": \\"**********23da4529998************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Retrieve the list of detection samples for a Custom entity', 'description' => '- This API is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\n" ."\n" .'- You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.', 'changeSet' => [ ['createdAt' => '2025-11-17T14:18:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:ListRecognitionSamples', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListSchedules' => [ 'summary' => 'Lists the program schedule of a MediaWeaver channel.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ 'name' => 'WindowDurationSeconds', 'in' => 'query', 'schema' => ['description' => 'The time window of the program schedule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14400', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Programs' => [ 'description' => 'The program schedule.', 'type' => 'array', 'items' => ['description' => 'The schedule information.', '$ref' => '#/components/schemas/ChannelAssemblyScheduleData', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 5,\\n \\"Programs\\": [\\n {\\n \\"EntryType\\": \\"program\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\\\n\\",\\n \\"AdBreaks\\": [\\n {\\n \\"OffsetMillis\\": \\"100000\\",\\n \\"TimeSignalSettings\\": \\"{\\\\\\"segmentationEventID\\\\\\":0,\\\\\\"segmentationUPIDType\\\\\\":14,\\\\\\"segmentationUPID\\\\\\":\\\\\\"upid\\\\\\",\\\\\\"segmentationTypeID\\\\\\":48,\\\\\\"segmentNumber\\\\\\":0,\\\\\\"segmentsExpected\\\\\\":0,\\\\\\"subSegmentNumber\\\\\\":1,\\\\\\"subSegmentsExpected\\\\\\":0}\\\\n\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\",\\n \\"SpliceInsertSettings\\": \\"{\\\\\\"AvailNumber\\\\\\":0,\\\\\\"AvailExpected\\\\\\":0,\\\\\\"SpliceEventID\\\\\\":1,\\\\\\"UniqueProgramID\\\\\\":0}\\\\n\\",\\n \\"SourceName\\": \\"MySource\\",\\n \\"MessageType\\": \\"SPLICE_INSERT\\"\\n }\\n ],\\n \\"SourceType\\": \\"vodSource\\",\\n \\"SourceName\\": \\"MySource\\",\\n \\"ApproximateDurationSeconds\\": 100000,\\n \\"ApproximateStartTime\\": \\"1989128002313\\",\\n \\"ProgramName\\": \\"program1\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', 'title' => 'ListSchedules', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListSchedules', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListSearchLib' => [ 'summary' => 'Retrieves a list of search libraries.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '237778', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Max value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'SearchLibInfoList' => [ 'description' => 'Search library information.', 'type' => 'array', 'items' => [ 'description' => 'Information about a search library.', 'type' => 'object', 'properties' => [ 'SearchLibName' => ['description' => 'The search library.', 'type' => 'string', 'example' => 'faceSearchLib', 'title' => ''], 'Status' => [ 'description' => 'The status of the search library.', 'enumValueTitles' => ['normal' => 'The search library is in the normal state.', 'deleting' => 'The search library is being deleted.', 'deleteFail' => 'Failed to delete the search library.'], 'type' => 'string', 'example' => 'normal', 'title' => '', ], 'IndexInfo' => [ 'description' => 'The index information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IndexType' => ['description' => 'The index type. Valid values:'."\n" ."\n" .'- mm: Large language model (LLM).'."\n" ."\n" .'- face: Face recognition.'."\n" ."\n" .'- aiLabel: Smart tagging.', 'type' => 'string', 'example' => 'face', 'title' => ''], 'IndexStatus' => ['description' => 'The index status.'."\n" ."\n" .'Default value: Active. Valid values:'."\n" ."\n" .'- Active: The index is active.'."\n" ."\n" .'- Deactive: The index is inactive.', 'type' => 'string', 'example' => 'Active', 'title' => ''], 'IndexReadiness' => ['description' => 'The readiness status of the index. Valid values:'."\n" ."\n" .'- Initializing: The index is being initialized.'."\n" ."\n" .'- Normal: The index is ready.'."\n" ."\n" .'- Fail: The index failed to be created.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SearchLibConfig' => ['description' => 'The search library configuration.', 'type' => 'string', 'title' => '', 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibInfoList\\": [\\n {\\n \\"SearchLibName\\": \\"faceSearchLib\\",\\n \\"Status\\": \\"normal\\",\\n \\"IndexInfo\\": [\\n {\\n \\"IndexType\\": \\"face\\",\\n \\"IndexStatus\\": \\"Active\\",\\n \\"IndexReadiness\\": \\"Normal\\"\\n }\\n ],\\n \\"SearchLibConfig\\": \\"{\\\\\\"faceGroupIds\\\\\\":\\\\\\"xxx1,xxx2,xx3\\\\\\"}\\"\\n }\\n ],\\n \\"Total\\": 8\\n}","type":"json"}]', 'title' => 'Obtain the search library list ', 'changeSet' => [ ['createdAt' => '2024-12-24T02:50:22.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-12-04T02:32:04.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchLib'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListSearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'manual', ], 'ListSmartJobs' => [ 'summary' => 'Queries a list of intelligent jobs based on specified parameters.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '****73f33c91-d59383e8280b****', 'title' => '', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return.'."\n" ."\n" .'Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'JobType', 'in' => 'query', 'schema' => [ 'description' => 'The job type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- ASR: automatic speech recognition(job) job.'."\n" ."\n" .'- DynamicChart: dynamic chart job.'."\n" ."\n" .'- VideoTranslation: video translation job.'."\n" ."\n" .'- TextToSpeech: intelligent audio production job.', 'enumValueTitles' => ['ASR' => '', 'DynamicChart' => '', 'VideoTranslation' => '', 'TextToSpeech' => ''], 'type' => 'string', 'example' => 'ASR', 'title' => '', 'required' => false, ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting parameter. By default, the query results are sorted by creation time in descending order.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- CreationTime:Asc: sorted by creation time in ascending order.'."\n" ."\n" .'- CreationTime:Desc: sorted by creation time in descending order.', 'enumValueTitles' => ['CreationTime:Asc' => '', 'CreationTime:Desc' => ''], 'type' => 'string', 'example' => 'CreationTime:Desc', 'title' => '', 'required' => false, ], ], [ 'name' => 'JobState', 'in' => 'query', 'schema' => [ 'description' => 'The job state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Finished: The job is complete.'."\n" ."\n" .'- Failed: The job failed.'."\n" ."\n" .'- Executing: The job is in progress.'."\n" ."\n" .'- Created: The job is created.', 'enumValueTitles' => ['Finished' => '', 'Failed' => '', 'Executing' => '', 'Created' => ''], 'type' => 'string', 'example' => 'Finished', 'title' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', 'title' => ''], 'SmartJobList' => [ 'description' => 'The queried intelligent jobs.', 'type' => 'array', 'items' => [ 'description' => 'The queried intelligent job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Title' => ['description' => 'The job title.', 'type' => 'string', 'example' => 'Test title', 'title' => ''], 'Description' => ['description' => 'The job description.', 'type' => 'string', 'example' => 'Test description', 'title' => ''], 'UserId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1084506228******', 'title' => ''], 'JobType' => [ 'description' => 'The job type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- ASR: ASR job.'."\n" ."\n" .'- DynamicChart: dynamic chart job.'."\n" ."\n" .'- TextToSpeech: intelligent audio production job.', 'enumValueTitles' => ['ASR' => '', 'DynamicChart' => '', 'TextToSpeech' => ''], 'type' => 'string', 'example' => 'ASR', 'title' => '', ], 'EditingConfig' => ['description' => 'The editing configurations.', 'type' => 'string', 'example' => '{"AudioConfig":{},"InputConfig":""}', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"user":"data"}', 'title' => ''], 'JobState' => [ 'description' => 'The job state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Finished: The job is complete.'."\n" ."\n" .'- Failed: The job failed.'."\n" ."\n" .'- Executing: The job is in progress.'."\n" ."\n" .'- Created: The job is created.', 'enumValueTitles' => ['Finished' => '', 'Failed' => '', 'Executing' => '', 'Created' => ''], 'type' => 'string', 'example' => 'Finished', 'title' => '', ], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'InputConfig' => [ 'title' => '', 'description' => 'The input configurations.', 'type' => 'object', 'properties' => [ 'InputFile' => ['description' => 'The information about the input file.', 'type' => 'string', 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', 'title' => ''], 'Keyword' => ['description' => 'The keyword information.', 'type' => 'string', 'example' => 'Test keyword', 'title' => ''], ], 'example' => '', ], 'OutputConfig' => [ 'title' => '', 'description' => 'The output configurations.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The Object Storage Service (OSS) bucket.', 'type' => 'string', 'example' => 'test-bucket', 'title' => ''], 'Object' => ['description' => 'The OSS object.', 'type' => 'string', 'example' => 'test-object', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'example' => 'CBB6BC61D08', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of entries returned on a single page. The value is set to the maximum number of entries returned on each page except for the last page. Valid example: 10,10,5. Invalid example: 10,5,10.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Optional. The total number of entries returned. By default, this parameter is not returned.', 'type' => 'string', 'example' => '110', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'ListSmartJobs', 'changeSet' => [ ['createdAt' => '2022-02-21T07:05:10.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-02-03T09:23:53.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSmartJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListSmartJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"SmartJobList\\": [\\n {\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Title\\": \\"Test title\\",\\n \\"Description\\": \\"Test description\\",\\n \\"UserId\\": 0,\\n \\"JobType\\": \\"ASR\\",\\n \\"EditingConfig\\": \\"{\\\\\\"AudioConfig\\\\\\":{},\\\\\\"InputConfig\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"UserData\\": \\"{\\\\\\"user\\\\\\":\\\\\\"data\\\\\\"}\\",\\n \\"JobState\\": \\"Finished\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"InputConfig\\": {\\n \\"InputFile\\": \\"oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"Keyword\\": \\"Test keyword\\"\\n },\\n \\"OutputConfig\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Object\\": \\"test-object\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"CBB6BC61D08\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"110\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListSmartSysAvatarModels' => [ 'summary' => 'Retrieves a paginated list of system digital avatars.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172912', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of items to return on each page. The default value is 10. The maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SdkVersion', 'in' => 'query', 'schema' => ['description' => 'The SDK version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'SmartSysAvatarModelList' => [ 'description' => 'A list of system digital avatars.', 'type' => 'array', 'items' => [ 'description' => 'A system digital avatar.', 'type' => 'object', 'properties' => [ 'AvatarName' => ['description' => 'The digital avatar name.', 'type' => 'string', 'example' => 'Yun Qiao', 'title' => ''], 'AvatarId' => ['description' => 'The digital avatar ID. Use this ID when you submit a rendering job or use the digital avatar in an intelligent timeline.', 'type' => 'string', 'example' => 'yunqiao', 'title' => ''], 'CoverUrl' => ['description' => 'The URL of the sample cover for the digital avatar.', 'type' => 'string', 'example' => 'http://ice-pub-media.myalicdn.com/smart/avatarModel/coverDemo/yunqiao.mp4', 'title' => ''], 'VideoUrl' => ['description' => 'The URL of the sample video for the digital avatar.', 'type' => 'string', 'example' => 'http://ice-pub-media.myalicdn.com/smart/avatarModel/videoDemo/yunqiao.mp4', 'title' => ''], 'Width' => ['description' => 'The video width.', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], 'Height' => ['description' => 'The video height.', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], 'Bitrate' => ['description' => 'The video bitrate.', 'type' => 'integer', 'format' => 'int32', 'example' => '4000', 'title' => ''], 'OutputMask' => ['description' => 'Indicates whether portrait mask rendering is supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of system digital avatars.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListSmartSysAvatarModels', 'changeSet' => [ ['createdAt' => '2023-08-25T02:46:11.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-24T02:04:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-13T12:57:17.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSmartSysAvatarModels'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListSmartSysAvatarModels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"SmartSysAvatarModelList\\": [\\n {\\n \\"AvatarName\\": \\"Yun Qiao\\",\\n \\"AvatarId\\": \\"yunqiao\\",\\n \\"CoverUrl\\": \\"http://ice-pub-media.myalicdn.com/smart/avatarModel/coverDemo/yunqiao.mp4\\",\\n \\"VideoUrl\\": \\"http://ice-pub-media.myalicdn.com/smart/avatarModel/videoDemo/yunqiao.mp4\\",\\n \\"Width\\": 1080,\\n \\"Height\\": 1920,\\n \\"Bitrate\\": 4000,\\n \\"OutputMask\\": false\\n }\\n ],\\n \\"TotalCount\\": 4\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListSmartVoiceGroups' => [ 'summary' => 'Retrieves a list of available smart voices, including their names, genders, and sample audio. The voices are grouped by scenario.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '147883', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'VoiceType', 'in' => 'query', 'schema' => ['description' => 'The voice type. If you do not specify this parameter, the operation returns voices from the small model by default. Set this parameter to `CosyVoice` to retrieve voices from the Cosyvoice large model.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CosyVoice'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '627B30EB-1D0A-5C6D-8467-431626E0FA10'], 'VoiceGroups' => [ 'description' => 'An array of voice groups.', 'type' => 'array', 'items' => [ 'description' => 'A voice group.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The name of the voice group.', 'type' => 'string', 'example' => 'Ultra HD', 'title' => ''], 'VoiceList' => [ 'description' => 'The voice list.', 'type' => 'array', 'items' => [ 'description' => 'A voice.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the voice.', 'type' => 'string', 'example' => 'Zhi Tian', 'title' => ''], 'VoiceType' => [ 'description' => 'The voice type.', 'enumValueTitles' => ['Male' => 'A male voice.', 'Female' => 'A female voice.', 'Boy' => 'A boy\'s voice.', 'Girl' => 'A girl\'s voice.'], 'type' => 'string', 'example' => 'Female', 'title' => '', ], 'Voice' => ['description' => 'The voice ID.', 'type' => 'string', 'example' => 'zhitian', 'title' => ''], 'Desc' => ['description' => 'The description of the voice.', 'type' => 'string', 'example' => '甜美女声', 'title' => ''], 'Tag' => ['description' => 'The tag for the voice category.', 'type' => 'string', 'example' => 'General scenario', 'title' => ''], 'Remark' => ['description' => 'Notes for the voice.', 'type' => 'string', 'example' => '中文及中英文混合场景', 'title' => ''], 'VoiceUrl' => ['description' => 'The URL of the sample audio.', 'type' => 'string', 'example' => 'https://***.com/zhitian.mp3', 'title' => ''], 'SupportSampleRate' => ['description' => 'The sample rates supported by the voice.', 'type' => 'string', 'example' => '48000', 'title' => ''], 'VoiceSource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'List Intelligent Speech Voice Information ', 'changeSet' => [ ['createdAt' => '2025-09-23T08:07:19.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-03-21T01:25:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-14T04:56:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-03-12T06:02:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-07-30T14:19:48.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSmartVoiceGroups'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListSmartVoiceGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"627B30EB-1D0A-5C6D-8467-431626E0FA10\\",\\n \\"VoiceGroups\\": [\\n {\\n \\"Type\\": \\"Ultra HD\\",\\n \\"VoiceList\\": [\\n {\\n \\"Name\\": \\"Zhi Tian\\",\\n \\"VoiceType\\": \\"Female\\",\\n \\"Voice\\": \\"zhitian\\",\\n \\"Desc\\": \\"甜美女声\\",\\n \\"Tag\\": \\"General scenario\\",\\n \\"Remark\\": \\"中文及中英文混合场景\\",\\n \\"VoiceUrl\\": \\"https://***.com/zhitian.mp3\\",\\n \\"SupportSampleRate\\": \\"48000\\",\\n \\"VoiceSource\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListSnapshotJobs' => [ 'summary' => 'Queries a list of snapshot jobs.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice7O9OLB'], ], 'parameters' => [ [ 'name' => 'StartOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range during which the jobs to be queried were created.', 'type' => 'string', 'required' => false, 'example' => '2022-07-12T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range during which the jobs to be queried were created.', 'type' => 'string', 'required' => false, 'example' => '2022-07-14T00:00:00Z', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The state of the job.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Init: The job is submitted.'."\n" ."\n" .'- Success: The job is successful.'."\n" ."\n" .'- Fail: The job failed.', 'enumValueTitles' => ['Init' => '', 'Success' => '', 'Fail' => ''], 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => '', ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => 'The order that you use to sort the query results.'."\n" ."\n" .'1. CreateTimeDesc'."\n" ."\n" .'2. CreateTimeAsc'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- CreateTimeDesc: sorts the jobs by creation time in descending order'."\n" ."\n" .'- CreateTimeAsc: sorts the jobs by creation time in ascending order.', 'enumValueTitles' => ['CreateTimeDesc' => '', 'CreateTimeAsc' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CreateTimeDesc', ], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Jobs' => [ 'description' => 'The list of jobs.', 'type' => 'array', 'items' => [ 'description' => 'The information about the snapshot job.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'TriggerSource' => [ 'description' => 'The request trigger source.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Console'."\n" ."\n" .'- Workflow'."\n" ."\n" .'- API', 'enumValueTitles' => ['Console' => '', 'Workflow' => '', 'API' => 'API'], 'type' => 'string', 'example' => 'API', 'title' => '', ], 'Name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'SampleJob', 'title' => ''], 'Type' => [ 'description' => 'The type of the job.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- WebVtt'."\n" ."\n" .'- Sprite'."\n" ."\n" .'- Normal', 'enumValueTitles' => ['WebVtt' => '', 'Sprite' => '', 'Normal' => ''], 'type' => 'string', 'example' => 'Sprite', 'title' => '', ], 'Input' => [ 'description' => 'The input of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'2. Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The input file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats: 1. OSS://bucket/object 2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS.', 'type' => 'string', 'example' => 'oss://bucket/object.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'The output of the job.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid values:'."\n" ."\n" .'1. OSS: an OSS object.'."\n" ."\n" .'2. Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The output file. If Type is set to OSS, the URL of an OSS object is returned. If Type is set to Media, the ID of a media asset is returned. The URL of an OSS object can be in one of the following formats:'."\n" ."\n" .'1. OSS://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object'."\n" ."\n" .'In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object URL in OSS. If multiple static snapshots were captured, the object must contain the "{Count}" placeholder. In the case of a sprite, the object must contain the "{TileCount}" placeholder. The suffix of the WebVTT snapshot objects must be ".vtt".', 'type' => 'string', 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Count' => ['description' => 'The number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Async' => ['description' => 'Indicates whether the snapshots were captured in asynchronous mode.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Status' => [ 'description' => 'The state of the job.'."\n" ."\n" .'- **Success**: The job is successful.'."\n" ."\n" .'- **Fail**: The job failed.'."\n" ."\n" .'- **Init**: The job is submitted.', 'enumValueTitles' => ['Init' => '', 'Success' => '', 'Fail' => ''], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'SubmitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-12T16:17:54Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2022-07-12T16:30:54Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'ListSnapshotJobs', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshotJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListSnapshotJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Jobs\\": [\\n {\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"SampleJob\\",\\n \\"Type\\": \\"Sprite\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object.mp4\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg\\"\\n },\\n \\"Count\\": 10,\\n \\"Async\\": true,\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Status\\": \\"Success\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListSourceLocations' => [ 'summary' => 'Lists source locations.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => false, 'example' => 'MySourceLocation', 'title' => ''], ], [ 'name' => 'FilterState', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to ignore source locations marked as deleted. A value of true means ignoring source locations marked as deleted.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => '- The page number.'."\n" ."\n" .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortByModifiedTime', 'in' => 'query', 'schema' => ['description' => 'The sorting order of the source locations based on the time when they were last modified.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order. By default, the query results are sorted by creation time in descending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'SourceLocationList' => [ 'description' => 'The source locations.', 'type' => 'array', 'items' => ['description' => 'The source location information.', '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SourceLocationList\\": [\\n {\\n \\"GmtCreate\\": \\"2024-03-29T02:03:17Z\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\\\n\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"2024-03-29T02:03:17Z\\\\n\\",\\n \\"SegmentDeliveryConfigurations\\": \\"http://segmentdelivery.com\\\\n\\",\\n \\"BaseUrl\\": \\"http://xxxx.com\\\\n\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::sourcelocation/MySourceLocation\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListSourceLocations', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListSourceLocations', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListSources' => [ 'summary' => 'Lists sources in MediaWeaver.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SourceLocationName', 'in' => 'query', 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => false, 'example' => 'MySourceLocation', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The source type. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => false, 'example' => 'vodSource', 'title' => ''], ], [ 'name' => 'SourceName', 'in' => 'query', 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => false, 'example' => 'MyVodSource', 'title' => ''], ], [ 'name' => 'FilterState', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to ignore sources marked as deleted.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortByModifiedTime', 'in' => 'query', 'schema' => ['description' => 'The sorting order by modification time. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order. By default, the query results are sorted by creation time in descending order. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'SourceList' => [ 'description' => 'The sources.', 'type' => 'array', 'items' => ['description' => 'The source information.', '$ref' => '#/components/schemas/ChannelAssemblySource', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"SourceList\\": [\\n {\\n \\"GmtCreate\\": \\"2022-10-20T07:15:51Z\\",\\n \\"SourceLocationName\\": \\"MySourceLocation\\\\n\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"vodSource\\",\\n \\"GmtModified\\": \\"2024-11-07T10:12:01Z\\\\n\\",\\n \\"SourceName\\": \\"MyVodSource\\\\n\\",\\n \\"HttpPackageConfigurations\\": \\"[{\\\\n\\\\t\\\\\\"sourceGroupName\\\\\\": \\\\\\"mySourceGroup-1\\\\\\",\\\\n\\\\t\\\\\\"relativePath\\\\\\": \\\\\\"group1/hls.m3u8\\\\\\",\\\\n\\\\t\\\\\\"packageType\\\\\\": \\\\\\"hls\\\\\\"\\\\n}]\\",\\n \\"Arn\\": \\"acs:ims:mediaweaver:::vodSource/mySourceLocation/mySource\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListSources', 'changeSet' => [ ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListSystemTemplates' => [ 'summary' => 'Queries a list of system templates.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceHPAMBQ'], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The template type. Separate multiple types with commas (,).', 'type' => 'string', 'required' => true, 'example' => '1,2', 'title' => ''], ], [ 'name' => 'Subtype', 'in' => 'query', 'schema' => ['description' => 'The subtype ID of the template.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The template name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'SampleTemplate'], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****96e8864746a0b6f3****'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The template state. Valid values: Normal, Invisible, and All.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Normal'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 20 Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Total' => ['description' => 'The total number of templates.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'SystemTemplateList' => [ 'title' => '', 'description' => 'The queried templates.', 'type' => 'array', 'items' => [ 'description' => 'The information about the system template.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'S00000001-000000', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'FLV-COPY', 'title' => ''], 'Type' => ['description' => 'The type ID of the template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TypeName' => ['description' => 'The type name of the template.', 'type' => 'string', 'example' => 'TranscodeTemplate', 'title' => ''], 'Subtype' => ['description' => 'The subtype ID of the template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SubtypeName' => ['description' => 'The subtype name of the template.', 'type' => 'string', 'example' => 'Remux', 'title' => ''], 'Status' => ['description' => 'The template state.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'TemplateConfig' => ['description' => 'The template parameters.', 'type' => 'string', 'title' => '', 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'ListSystemTemplates', 'description' => 'Template types:'."\n" ."\n" .'1. 1: transcoding template.'."\n" ."\n" .'2. 2: snapshot template.'."\n" ."\n" .'3. 3: animated image template.'."\n" ."\n" .'4. 4\\. image watermark template.'."\n" ."\n" .'5. 5: text watermark template.'."\n" ."\n" .'6. 6: subtitle template.'."\n" ."\n" .'7. 7: AI-assisted content moderation template.'."\n" ."\n" .'8. 8: AI-assisted intelligent thumbnail template.'."\n" ."\n" .'9. 9: AI-assisted intelligent erasure template.'."\n" ."\n" .'Subtypes of transcoding templates:'."\n" ."\n" .'1. 1 (Normal): regular template.'."\n" ."\n" .'2. 2 (AudioTranscode): audio transcoding template.'."\n" ."\n" .'3. 3 (Remux): container format conversion template.'."\n" ."\n" .'4. 4 (NarrowBandV1): Narrowband HD 1.0 template.'."\n" ."\n" .'5. 5 (NarrowBandV2): Narrowband HD 2.0 template.'."\n" ."\n" .'Subtypes of snapshot templates:'."\n" ."\n" .'1. 1 (Normal): regular template.'."\n" ."\n" .'2. 2 (Sprite): sprite template.'."\n" ."\n" .'3. 3 (WebVtt): WebVTT template.'."\n" ."\n" .'Subtypes of AI-assisted content moderation templates:'."\n" ."\n" .'1. 1 (Video): video moderation template.'."\n" ."\n" .'2. 2 (Audio): audio moderation template.'."\n" ."\n" .'3. 3 (Image): image moderation template.'."\n" ."\n" .'Subtypes of AI-assisted intelligent erasure templates:'."\n" ."\n" .'1. 1 (VideoDelogo): logo erasure template.'."\n" ."\n" .'2. 2 (VideoDetext): subtitle erasure template.', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSystemTemplates'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:ListSystemTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Total\\": 20,\\n \\"SystemTemplateList\\": [\\n {\\n \\"TemplateId\\": \\"S00000001-000000\\",\\n \\"TemplateName\\": \\"FLV-COPY\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": 1,\\n \\"SubtypeName\\": \\"Remux\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"flv\\\\\\"},\\\\\\"Video\\\\\\":{},\\\\\\"Audio\\\\\\":{}}\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListTemplates' => [ 'summary' => 'Queries a list of templates that meet the specified conditions. You can query templates based on information such as the template status and creation source.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The template type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Timeline'."\n" ."\n" .'- VETemplate', 'enumValueTitles' => ['Timeline' => 'Timeline', 'VETemplate' => 'VETemplate'], 'type' => 'string', 'example' => 'Timeline', 'title' => '', 'required' => false, ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The template state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- UploadFailed: Failed to upload the video.'."\n" ."\n" .'- ProcessFailed: Failed to process the advanced template.'."\n" ."\n" .'- Available: The template is available.'."\n" ."\n" .'- Uploading: The video is being uploaded.'."\n" ."\n" .'- Created: The template is created but not ready for use.'."\n" ."\n" .'- Processing: The advanced template is being processed.', 'enumValueTitles' => ['UploadFailed' => '', 'ProcessFailed' => '', 'Available' => '', 'Uploading' => '', 'Created' => '', 'Processing' => ''], 'type' => 'string', 'example' => 'Available', 'title' => '', 'required' => false, ], ], [ 'name' => 'CreateSource', 'in' => 'query', 'schema' => [ 'description' => 'The source from which the template was created.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- WebSDK'."\n" ."\n" .'- OpenAPI', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'example' => 'OpenAPI', 'title' => '', 'required' => false, ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. You can use the template ID or title as the keyword to search for templates.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], [ 'name' => 'SortType', 'in' => 'query', 'schema' => [ 'description' => 'The sorting parameter. By default, the query results are sorted by creation time in descending order.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- CreationTime:Asc: sorted by creation time in ascending order.'."\n" ."\n" .'- CreationTime:Desc: sorted by creation time in descending order.', 'enumValueTitles' => ['CreationTime:ASC' => '', 'CreationTime:Desc' => ''], 'type' => 'string', 'example' => 'CreationTime:Desc', 'title' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'Templates' => [ 'description' => 'The queried templates.', 'type' => 'array', 'items' => [ 'description' => 'The template information.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Name' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Cloud editing template', 'title' => ''], 'Type' => [ 'description' => 'The template type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Timeline: regular template.'."\n" ."\n" .'- VETemplate: advanced template.', 'enumValueTitles' => ['Timeline' => '', 'VETemplate' => ''], 'type' => 'string', 'example' => 'Timeline', 'title' => '', ], 'Config' => ['description' => 'The template configurations.', 'type' => 'string', 'example' => 'See Timeline template configuration details.', 'title' => ''], 'PreviewMedia' => ['description' => 'The preview media asset.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Status' => [ 'description' => 'The template state.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- UploadFailed: Failed to upload the video.'."\n" ."\n" .'- ProcessFailed: Failed to process the advanced template.'."\n" ."\n" .'- Available: The template is available.'."\n" ."\n" .'- Uploading: The video is being uploaded.'."\n" ."\n" .'- Created: The template is created but not ready for use.'."\n" ."\n" .'- Processing: The advanced template is being processed.', 'enumValueTitles' => ['UploadFailed' => '', 'ProcessFailed' => '', 'Available' => '', 'Uploading' => '', 'Created' => '', 'Processing' => ''], 'type' => 'string', 'example' => 'Available', 'title' => '', ], 'CreateSource' => [ 'description' => 'The source from which the template was created.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- WebSDK'."\n" ."\n" .'- OpenAPI', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'example' => 'OpenAPI', 'title' => '', ], 'ModifiedSource' => [ 'description' => 'The source from which the template was modified.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- AliyunConsole'."\n" ."\n" .'- WebSDK'."\n" ."\n" .'- OpenAPI', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'example' => 'OpenAPI', 'title' => '', ], 'PreviewMediaStatus' => [ 'description' => 'The state of the preview media asset.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- PrepareFail'."\n" ."\n" .'- Init'."\n" ."\n" .'- Normal'."\n" ."\n" .'- Preparing', 'enumValueTitles' => ['PrepareFail' => '', 'Init' => '', 'Normal' => '', 'Preparing' => ''], 'type' => 'string', 'example' => 'Normal', 'title' => '', ], 'CreationTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2020-12-26T04:11:10Z', 'title' => ''], 'CoverURL' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', 'title' => ''], 'ClipsParam' => ['description' => 'The clip parameters.', 'type' => 'string', 'example' => '{"Media1":"mediaId","Text1":"text"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'ListTemplates', 'description' => 'A template is an encapsulation of the timeline of a media editing and production job. You can define a common timeline as a template. When you have the same requirements, you need to only specify key parameters and materials to produce videos.'."\n" ."\n" .'- For more information about how to use a regular template, see [Create and use a regular template](~~445399~~).'."\n" ."\n" .'- For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TotalCount\\": 100,\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"Cloud editing template\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"See Timeline template configuration details.\\",\\n \\"PreviewMedia\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Status\\": \\"Available\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"PreviewMediaStatus\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg\\",\\n \\"ClipsParam\\": \\"{\\\\\\"Media1\\\\\\":\\\\\\"mediaId\\\\\\",\\\\\\"Text1\\\\\\":\\\\\\"text\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListTranscodeJobs' => [ 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to filter jobs by their creation time. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2022-07-01T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'EndOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to filter jobs by their creation time. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2022-07-15T00:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'ParentJobId', 'in' => 'query', 'schema' => ['description' => 'Filters by job ID.', 'type' => 'string', 'example' => '7b38a5d86f1e47838927b6e7ccb1****', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The job status. Valid values:'."\n" ."\n" .'- `Init`: Submitted.'."\n" ."\n" .'- `Success`: Succeeded.'."\n" ."\n" .'- `Fail`: Failed.', 'type' => 'string', 'example' => 'Success', 'title' => '', 'required' => false], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => ['description' => 'The sort order. Valid values:'."\n" ."\n" .'- `CreateTimeDesc`: Sorts by creation time in descending order.'."\n" ."\n" .'- `CreateTimeAsc`: Sorts by creation time in ascending order.', 'type' => 'string', 'example' => 'CreateTimeDesc', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1-100. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'The token for the next page of results. Not required for the first page.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82df****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], 'Jobs' => [ 'description' => 'The list of jobs.', 'type' => 'array', 'items' => [ 'description' => 'The job details.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the job was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'transcode-job', 'title' => ''], 'RequestId' => ['description' => 'The request ID of the job.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], 'ParentJobId' => ['description' => 'The parent job ID.', 'type' => 'string', 'example' => '8b2198504dd340b7b3c9842a74fc****', 'title' => ''], 'JobCount' => ['description' => 'The number of sub-jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Status' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'- `Success`: The job is successful if at least one sub-job is successful.'."\n" ."\n" .'- `Fail`: The job fails if all sub-jobs fail.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'TriggerSource' => ['description' => 'The source of the job. Valid values:'."\n" ."\n" .'- `API`: The job is submitted by calling an API operation.'."\n" ."\n" .'- `Workflow`: The job is triggered by a workflow.'."\n" ."\n" .'- `Console`: The job is submitted on the console.', 'type' => 'string', 'example' => 'API', 'title' => ''], 'Percent' => ['description' => 'The progress of the job.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the job was submitted. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], 'InputGroup' => [ 'title' => '', 'description' => 'The input group of the job. A single input indicates a transcoding job. Multiple inputs indicate a composition job.', 'type' => 'array', 'items' => [ 'description' => 'The job input.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media asset. Valid values:'."\n" ."\n" .'- `OSS`: an OSS file.'."\n" ."\n" .'- `Media`: a media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media information. The value of this parameter varies based on the value of Type.'."\n" ."\n" .'- If Type is set to `OSS`, the value of this parameter must be an OSS URL. Both the `oss://` and `http(s)://` protocols are supported.'."\n" ."\n" .'- If Type is set to `Media`, the value of this parameter must be a media ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], 'InputUrl' => ['description' => 'The URL of the media stream. This parameter is required only when you transcode a media stream.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'OutputGroup' => [ 'title' => '', 'description' => 'The output group of the job.', 'type' => 'array', 'items' => [ 'description' => 'The job output.', 'type' => 'object', 'properties' => [ 'Output' => [ 'title' => '', 'description' => 'The output media configuration.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media asset. Valid values:'."\n" ."\n" .'- `OSS`: an OSS file.'."\n" ."\n" .'- `Media`: a media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media information. The value of this parameter varies based on the value of Type.'."\n" ."\n" .'- If Type is set to `OSS`, the value of this parameter must be an OSS URL. Both the `oss://` and `http(s)://` protocols are supported.'."\n" ."\n" .'- If Type is set to `Media`, the value of this parameter must be a media ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], 'OutputUrl' => ['description' => 'The URL of the output stream. This parameter is required only when you transcode a media stream.', 'type' => 'string', 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4', 'title' => ''], ], 'example' => '', ], 'ProcessConfig' => [ 'title' => '', 'description' => 'The job processing configuration.', 'type' => 'object', 'properties' => [ 'Transcode' => [ 'title' => '', 'description' => 'The transcoding configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18****', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'The override parameter. If you specify this parameter, the corresponding parameter in the template is overwritten.', 'type' => 'object', 'properties' => [ 'Video' => [ 'title' => '', 'description' => 'The video settings.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'The video codec.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], 'Profile' => ['description' => 'The encoding profile. Valid values include baseline, main, and high.'."\n" ."\n" .'- `baseline`: suitable for mobile devices.'."\n" ."\n" .'- `main`: suitable for standard-definition devices.'."\n" ."\n" .'- `high`: suitable for high-definition devices.'."\n" ."\n" .'Default value: `high`.', 'type' => 'string', 'example' => 'Main', 'title' => ''], 'Bitrate' => ['description' => 'The average video bitrate.'."\n" ."\n" .'- Valid values: 10 to 50000.'."\n" ."\n" .'- Unit: Kbit/s.', 'type' => 'string', 'example' => '3000', 'title' => ''], 'Crf' => ['description' => 'The quality-to-bitrate control factor.'."\n" ."\n" .'- Valid values: 0 to 51.'."\n" ."\n" .'- Default value: If the codec is H.264, the default value is 23. If the codec is H.265, the default value is 26.'."\n" ."\n" .'If you specify Crf, the value of Bitrate is ignored.', 'type' => 'string', 'example' => '23', 'title' => ''], 'Width' => ['description' => 'The width.'."\n" ."\n" .'- Valid values: 128 to 4096.'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'- Default value: the width of the source video.', 'type' => 'string', 'example' => '1920', 'title' => ''], 'Height' => ['description' => 'The height.'."\n" ."\n" .'- Valid values: 128 to 4096.'."\n" ."\n" .'- Unit: px.'."\n" ."\n" .'- Default value: the height of the source video.', 'type' => 'string', 'example' => '1080', 'title' => ''], 'Fps' => ['description' => 'The frame rate.'."\n" ."\n" .'- Valid values: 0 to 60.'."\n" ."\n" .'- If the frame rate of the input file is greater than 60, the value is 60.'."\n" ."\n" .'- Default value: the frame rate of the input file.', 'type' => 'string', 'example' => '25', 'title' => ''], 'Gop' => ['description' => 'The maximum number of frames in a Group of Pictures (GOP).'."\n" ."\n" .'- Valid values: 1 to 1080000.'."\n" ."\n" .'- Default value: 250.', 'type' => 'string', 'example' => '250', 'title' => ''], 'Preset' => ['description' => 'The preset of the video encoder. This parameter is supported only when the video codec is H.264. Valid values: `veryfast`, `fast`, `medium`, `slow`, and `slower`. Default value: `medium`.', 'type' => 'string', 'example' => 'medium', 'title' => ''], 'ScanMode' => ['description' => 'The scan mode. Valid values: `interlaced` and `progressive`.', 'type' => 'string', 'example' => 'progressive', 'title' => ''], 'PixFmt' => ['description' => 'The pixel format. Valid values include `yuv420p` and `yuvj420p`.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], 'Remove' => ['description' => 'Specifies whether to delete the video. Valid values: `true` and `false`.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Crop' => ['description' => 'The cropping settings. Two modes are supported.'."\n" ."\n" .'- Automatic: Set the value to `border` to automatically detect and crop black borders.'."\n" ."\n" .'- Manual: Specify the crop area in the `width:height:left:top` format. Example: `1280:800:0:140`.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'Pad' => ['description' => 'The settings for adding black bars.'."\n" ."\n" .'- Format: `width:height:left:top`.'."\n" ."\n" .'- Example: `1280:800:0:140`.', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], 'LongShortMode' => ['description' => 'Specifies whether to enable adaptive resolution by long and short sides.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Bufsize' => ['description' => 'The buffer size.'."\n" ."\n" .'- Valid values: 1000 to 128000.'."\n" ."\n" .'- Default value: 6000.'."\n" ."\n" .'- Unit: Kbit.', 'type' => 'string', 'example' => '6000', 'title' => ''], 'Maxrate' => ['description' => 'The maximum video bitrate. Valid values: 10 to 50000. Unit: Kbit/s.', 'type' => 'string', 'example' => '9000', 'title' => ''], 'AbrMax' => ['description' => 'The maximum bitrate for adaptive bitrate (ABR) streaming. This parameter is valid only for videos with a narrow height and a wide width. Valid values: 10 to 50000. Unit: Kbit/s.', 'type' => 'string', 'example' => '6000', 'title' => ''], ], 'example' => '', ], 'Audio' => [ 'title' => '', 'description' => 'The audio settings.', 'type' => 'object', 'properties' => [ 'Codec' => ['description' => 'The audio codec. Valid values: `AAC`, `MP3`, `VORBIS`, and `FLAC`. Default value: `AAC`.', 'type' => 'string', 'example' => 'AAC', 'title' => ''], 'Profile' => ['description' => 'The audio encoding preset. This parameter is supported only when the audio codec is AAC. Valid values: `aac_low`, `aac_he`, `aac_he_v2`, `aac_ld`, and `aac_eld`.', 'type' => 'string', 'example' => 'aac_low', 'title' => ''], 'Samplerate' => ['description' => 'The sample rate.'."\n" ."\n" .'- Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" ."\n" .'- Default value: 44100.'."\n" ."\n" .'- Unit: Hz.', 'type' => 'string', 'example' => '44100', 'title' => ''], 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" ."\n" .'- Valid values: 8 to 1000.'."\n" ."\n" .'- Unit: Kbit/s.'."\n" ."\n" .'- Default value: 128.', 'type' => 'string', 'example' => '128', 'title' => ''], 'Channels' => ['description' => 'The number of audio channels. Default value: 2.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Remove' => ['description' => 'Specifies whether to delete the audio stream. Valid values: `true` and `false`.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Volume' => [ 'title' => '', 'description' => 'The volume control settings.', 'type' => 'object', 'properties' => [ 'Method' => ['description' => 'The volume adjustment method.', 'type' => 'string', 'example' => 'auto', 'title' => ''], 'IntegratedLoudnessTarget' => ['description' => 'The target integrated loudness.', 'type' => 'string', 'example' => '-6', 'title' => ''], 'TruePeak' => ['description' => 'The true peak level.', 'type' => 'string', 'example' => '-1', 'title' => ''], 'LoudnessRangeTarget' => ['description' => 'The target loudness range.', 'type' => 'string', 'example' => '8', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'Container' => [ 'title' => '', 'description' => 'The container format settings.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The container format.', 'type' => 'string', 'example' => 'mp4', 'title' => ''], ], 'example' => '', ], 'MuxConfig' => [ 'title' => '', 'description' => 'The muxing settings.', 'type' => 'object', 'properties' => [ 'Segment' => [ 'title' => '', 'description' => 'The segment settings.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The duration of each segment.', 'type' => 'string', 'example' => '10', 'title' => ''], 'ForceSegTime' => ['description' => 'The time points at which to enforce segmentation.', 'type' => 'string', 'example' => '2,3', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'Tags' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The key-value pairs of custom tags.', 'type' => 'string', 'title' => '', 'example' => ''], 'description' => 'The custom tags.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'ImageWatermarks' => [ 'title' => '', 'description' => 'The image watermark configurations.', 'type' => 'array', 'items' => [ 'description' => 'The image watermark configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18****', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'The override parameter. If you specify this parameter, the corresponding parameter in the template is overwritten.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'The width of the watermark.', 'type' => 'string', 'example' => '32', 'title' => ''], 'Height' => ['description' => 'The height of the watermark.', 'type' => 'string', 'example' => '32', 'title' => ''], 'Dx' => ['description' => 'The horizontal offset of the watermark.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Dy' => ['description' => 'The vertical offset of the watermark.', 'type' => 'string', 'example' => '10', 'title' => ''], 'ReferPos' => ['description' => 'The reference position. Valid values: `TopLeft`, `TopRight`, `BottomLeft`, and `BottomRight`. Default value: `TopLeft`.', 'type' => 'string', 'example' => 'TopLeft', 'title' => ''], 'Timeline' => [ 'title' => '', 'description' => 'The timeline settings.', 'type' => 'object', 'properties' => [ 'Start' => ['description' => 'The start time.', 'type' => 'string', 'example' => '00:00:05', 'title' => ''], 'Duration' => ['description' => 'The display duration in seconds. You can also set the value to `ToEND`.', 'type' => 'string', 'example' => 'ToEND', 'title' => ''], ], 'example' => '', ], 'File' => [ 'title' => '', 'description' => 'The watermark image file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media asset. Valid values:'."\n" ."\n" .'- `OSS`: an OSS file.'."\n" ."\n" .'- `Media`: a media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media information. The value of this parameter varies based on the value of Type.'."\n" ."\n" .'- If Type is set to `OSS`, the value of this parameter must be an OSS URL. Both the `oss://` and `http(s)://` protocols are supported.'."\n" ."\n" .'- If Type is set to `Media`, the value of this parameter must be a media ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TextWatermarks' => [ 'title' => '', 'description' => 'The text watermark configurations.', 'type' => 'array', 'items' => [ 'description' => 'The text watermark configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18****', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'The override parameter. If you specify this parameter, the corresponding parameter in the template is overwritten.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'The watermark text, which must be UTF-8 encoded. The text does not need to be Base64 encoded.', 'type' => 'string', 'example' => 'Test watermark', 'title' => ''], 'FontName' => ['description' => 'The font.', 'type' => 'string', 'example' => 'SimSun', 'title' => ''], 'FontColor' => ['description' => 'The color.', 'type' => 'string', 'example' => '#006400', 'title' => ''], 'FontAlpha' => ['description' => 'The transparency.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'Top' => ['description' => 'The distance of the watermark from the top edge.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Left' => ['description' => 'The distance from the left edge of the video.', 'type' => 'string', 'example' => '10', 'title' => ''], 'FontSize' => ['description' => 'The font size.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], 'BorderWidth' => ['description' => 'The width of the border.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'BorderColor' => ['description' => 'The color of the border.', 'type' => 'string', 'example' => '#006400', 'title' => ''], 'Adaptive' => ['description' => 'Specifies whether to adjust the font size based on the output video size.'."\n" ."\n" .'- `true`: The font size is automatically adjusted based on the output video size.'."\n" ."\n" .'- `false`: The font size remains fixed and is not affected by the output video size.'."\n" ."\n" .'Default value: false', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Subtitles' => [ 'title' => '', 'description' => 'The subtitle burn-in settings.', 'type' => 'array', 'items' => [ 'description' => 'The subtitle burn-in configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18****', 'title' => ''], 'OverwriteParams' => [ 'title' => '', 'description' => 'The overwrite parameters. If specified, these parameters overwrite the corresponding parameters in the template.', 'type' => 'object', 'properties' => [ 'Format' => ['description' => 'The format of the subtitle file.', 'type' => 'string', 'example' => 'vtt', 'title' => ''], 'CharEnc' => ['description' => 'The file encoding format.', 'type' => 'string', 'example' => 'UTF-8', 'title' => ''], 'File' => [ 'title' => '', 'description' => 'The subtitle file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" .'- OSS: an Object Storage Service (OSS) file.'."\n" ."\n" .'- Media: the ID of the Media Asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The media value:'."\n" ."\n" .'- If type is OSS, the value is a URL. Both OSS and HTTP protocols are supported.'."\n" ."\n" .'- If type is Media, the value is the Media Asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Encryption' => [ 'title' => '', 'description' => 'The encryption settings.', 'type' => 'object', 'properties' => [ 'EncryptType' => ['description' => 'The encryption type.', 'type' => 'string', 'example' => 'PrivateEncryption', 'title' => ''], 'CipherText' => ['description' => 'The key ciphertext for standard encryption.', 'type' => 'string', 'example' => 'MTYi00NDU0LTg5O****', 'title' => ''], 'DecryptKeyUri' => ['description' => 'The URL of the decryption service for standard encryption.', 'type' => 'string', 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', 'title' => ''], ], 'example' => '', ], 'CombineConfigs' => [ 'title' => '', 'description' => 'The configurations for combining multiple inputs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AudioIndex' => ['description' => 'The audio stream index.', 'type' => 'string', 'example' => '0 or exclude', 'required' => true, 'title' => ''], 'VideoIndex' => ['description' => 'The index of the video stream.', 'type' => 'string', 'example' => '0 or exclude', 'required' => true, 'title' => ''], 'Start' => ['description' => 'The start time of the input stream. The default value is 0.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => ''], 'Duration' => ['description' => 'The duration of the input stream. The default is the duration of the video.', 'type' => 'number', 'format' => 'double', 'example' => '20.0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'IsInheritTags' => ['description' => 'Specifies whether to inherit tags from the input stream. This parameter applies only when the input is a Media Asset. Default Value: false', 'type' => 'boolean', 'title' => '', 'example' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => 'user-data', 'title' => ''], 'ScheduleConfig' => [ 'title' => '', 'description' => 'The schedule configuration of the job.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f****', 'title' => ''], 'Priority' => ['description' => 'The priority of the job. A larger value indicates a higher priority. The value can be an integer from 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The token for the next page of results. Leave this parameter empty for the first request. The token is returned after the first query.', 'type' => 'string', 'example' => '019daf5780f74831b0e1a767c9f1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"Jobs\\": [\\n {\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc****\\",\\n \\"JobCount\\": 1,\\n \\"Status\\": \\"Success\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Percent\\": 0,\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"InputUrl\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n ],\\n \\"OutputGroup\\": [\\n {\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"OutputUrl\\": \\"oss://bucket/path/to/{MediaId}/{JobId}.mp4\\"\\n },\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"Test watermark\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 or exclude\\",\\n \\"VideoIndex\\": \\"0 or exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ],\\n \\"IsInheritTags\\": false\\n }\\n }\\n ],\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f****\\",\\n \\"Priority\\": 5\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"019daf5780f74831b0e1a767c9f1****\\"\\n}","type":"json"}]', 'title' => 'ListTranscodeJobs', 'summary' => 'Lists the transcoding jobs for a media file.', 'changeSet' => [ ['createdAt' => '2022-11-15T10:04:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-09-20T09:39:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-20T08:45:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-20T07:56:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-19T09:22:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-19T08:08:51.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTranscodeJobs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:ListTranscodeJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListVodPackagingAssets' => [ 'summary' => 'Lists VOD packaging assets.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order of the assets based on the time when they were ingested. Valid values:'."\n" ."\n" .'- desc (default): descending order.'."\n" ."\n" .'- asc: ascending order.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc'], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. The names of the returned assets are prefixed with this keyword.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'movie'], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Assets' => [ 'description' => 'The VOD packaging assets.', 'type' => 'array', 'items' => [ 'description' => 'The information about a VOD packaging asset.', 'type' => 'object', 'properties' => [ 'AssetName' => ['description' => 'The name of the VOD packaging asset.', 'type' => 'string', 'example' => '30min_movie', 'title' => ''], 'GroupName' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'example' => 'vod_hls', 'title' => ''], 'Description' => ['description' => 'The asset description.', 'type' => 'string', 'example' => 'movie 30min', 'title' => ''], 'Input' => [ 'description' => 'The asset input configurations.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The input type. Only Object Storage Service (OSS) is supported.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The URL of the media file. Only M3U8 files stored in OSS are supported.', 'type' => 'string', 'example' => 'OSS://***test-bucket***/***video/input.m3u8', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the asset was ingested. It follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-11-21T06:45:32Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SortBy' => ['description' => 'The sorting order of the assets based on the time when they were ingested. Valid values:'."\n" ."\n" .'- desc: descending order.'."\n" ."\n" .'- asc: ascending order.', 'type' => 'string', 'example' => 'desc', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Assets\\": [\\n {\\n \\"AssetName\\": \\"30min_movie\\",\\n \\"GroupName\\": \\"vod_hls\\",\\n \\"Description\\": \\"movie 30min\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"OSS://***test-bucket***/***video/input.m3u8\\"\\n },\\n \\"CreateTime\\": \\"2024-11-21T06:45:32Z\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"SortBy\\": \\"desc\\"\\n}","type":"json"}]', 'title' => 'ListVodPackagingAssets', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListVodPackagingAssets', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListVodPackagingConfigurations' => [ 'summary' => 'Lists VOD packaging configurations.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order of the packaging configurations based on the time when they were created. Valid values:'."\n" ."\n" .'- desc (default): descending order.'."\n" ."\n" .'- asc: ascending order.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc'], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. The names of the returned packaging configurations contain the keyword.', 'type' => 'string', 'required' => false, 'example' => 'hls', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'SortBy' => ['description' => 'The sorting order of the packaging configurations based on the time when they were created. Valid values:'."\n" ."\n" .'- desc: descending order.'."\n" ."\n" .'- asc: ascending order.', 'type' => 'string', 'title' => '', 'example' => 'desc'], 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'PackagingConfigurations' => [ 'title' => '', 'description' => 'The packaging configurations.', 'type' => 'array', 'items' => ['description' => 'The information about packaging configurations.', '$ref' => '#/components/schemas/VodPackagingConfiguration', 'title' => '', 'example' => ''], 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"PackagingConfigurations\\": [\\n {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ConfigurationName\\": \\"\\",\\n \\"Protocol\\": \\"\\",\\n \\"PackageConfig\\": {\\n \\"ManifestName\\": \\"\\",\\n \\"StreamSelection\\": {\\n \\"MinVideoBitsPerSecond\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitsPerSecond\\": 0\\n },\\n \\"DrmProvider\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n }\\n ],\\n \\"TotalCount\\": 5\\n}","type":"json"}]', 'title' => 'ListVodPackagingConfigurations', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListVodPackagingConfigurations', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListVodPackagingGroups' => [ 'summary' => 'Lists VOD packaging groups.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice20UKYV'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting order of the packaging groups based on the time when they were created. Valid values:'."\n" ."\n" .'- desc (default): descending order.'."\n" ."\n" .'- asc: ascending order.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc'], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. The names of the returned packaging groups contain the keyword.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hls'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The query results.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'SortBy' => ['description' => 'The sorting order of the packaging groups based on the time when they were created. Valid values:'."\n" ."\n" .'- desc: descending order.'."\n" ."\n" .'- asc: ascending order.', 'type' => 'string', 'title' => '', 'example' => 'desc'], 'PageNo' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'PackagingGroups' => [ 'title' => '', 'description' => 'The packaging groups.', 'type' => 'array', 'items' => ['description' => 'The information about packaging groups.', '$ref' => '#/components/schemas/VodPackagingGroup', 'title' => '', 'example' => ''], 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PackagingGroups\\": [\\n {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DomainName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ApproximateAssetCount\\": 0,\\n \\"ConfigurationCount\\": 0\\n }\\n ],\\n \\"TotalCount\\": 5\\n}","type":"json"}]', 'title' => 'ListVodPackagingGroups', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:ListVodPackagingGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListWorkflowTasks' => [ 'summary' => 'Retrieves workflow tasks.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'WorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workflow template.[](https://ims.console.aliyun.com/settings/workflow/list)', 'type' => 'string', 'required' => false, 'example' => '******b4fb044839815d4f2cd8******', 'title' => ''], ], [ 'name' => 'WorkflowName', 'in' => 'query', 'schema' => ['description' => 'The name of the workflow template.', 'type' => 'string', 'required' => false, 'example' => 'example-workflow-****', 'title' => ''], ], [ 'name' => 'KeyText', 'in' => 'query', 'schema' => ['description' => 'A keyword for fuzzy matching against the TaskInput, such as a file name or Media ID. Max length: 32 characters.', 'type' => 'string', 'example' => '******7aa4cc4459ada8ef35f7******'."\n" .'or'."\n" .'**TestVideo***.flv', 'required' => false, 'title' => ''], ], [ 'name' => 'StartOfCreateTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range for filtering tasks by their creation time. Supports querying data from the last 90 days only.', 'type' => 'string', 'required' => false, 'example' => '2025-07-12T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndOfCreateTime', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The end of the time range for filtering tasks by their creation time. Supports querying data from the last 90 days only.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-07-15T00:00:00Z'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of media workflow instances to return. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', '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.', 'type' => 'string', 'required' => false, 'example' => '**************VRpbWUQARgBIpcBCgkA1bUtaAAAAAAKiQEDhAAAADFTMzg2NTY2NjU2MzM3NjU2NjYyMzkzMTYyMzI2MjYzNjY2**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries returned. By default, this parameter is not returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C0C02296-113C-5838-8FE9-8F3A32998DDC'], 'NextToken' => ['description' => 'A pagination token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****8EqYpQbZ6Eh7+Zz8DxVYoQ=='], 'TaskList' => [ 'description' => 'The media workflow tasks.', 'type' => 'array', 'items' => [ 'description' => 'The details of a workflow task.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'example' => '*****4c93d2f404f8345b16a965*****', 'title' => ''], 'TaskInput' => ['description' => 'The input data for the workflow task.', 'type' => 'string', 'example' => '{\\"Type\\":\\"Media\\",\\"Media\\":\\"****8b40884171efb0d9e7f7f458****\\"}', 'title' => ''], 'Status' => ['description' => 'The task state.'."\n" ."\n" .'**Valid values**:'."\n" ."\n" .'- Init: Initializing'."\n" ."\n" .'- Failed'."\n" ."\n" .'- Canceled'."\n" ."\n" .'- Processing'."\n" ."\n" .'- Succeed', 'type' => 'string', 'example' => 'Succeed', 'title' => ''], 'CreateTime' => ['description' => 'The time the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-07-15T09:45:48Z', 'title' => ''], 'FinishTime' => ['description' => 'The time the task was completed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-12-07T10:53:45Z', 'title' => ''], 'Workflow' => [ 'description' => 'The information about the workflow template.', 'type' => 'object', 'properties' => [ 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => '******2491c84dce913da9fe65******', 'title' => ''], 'Name' => ['description' => 'The name of the workflow template.', 'type' => 'string', 'example' => 'example-workflow-***', 'title' => ''], 'Status' => ['description' => 'The status of the workflow template.', 'type' => 'string', 'example' => 'Active', 'title' => ''], 'Type' => ['description' => 'The type of the workflow template.', 'type' => 'string', 'example' => 'Common', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the workflow template.', 'type' => 'string', 'example' => '2025-03-21T01:48:49Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The last modification time of the workflow template.', 'type' => 'string', 'example' => '2025-02-23 10:19:37 +0800', 'title' => ''], 'MediaType' => ['description' => 'The source of the media file. Valid values:'."\n" ."\n" .'- OSS: an OSS object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], ], 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'The custom data that was passed when the task was submitted.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'MaxResults' => ['description' => 'The maximum number of entries returned in this response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"C0C02296-113C-5838-8FE9-8F3A32998DDC\\",\\n \\"NextToken\\": \\"****8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"TaskList\\": [\\n {\\n \\"TaskId\\": \\"*****4c93d2f404f8345b16a965*****\\",\\n \\"TaskInput\\": \\"{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"****8b40884171efb0d9e7f7f458****\\\\\\\\\\\\\\"}\\",\\n \\"Status\\": \\"Succeed\\",\\n \\"CreateTime\\": \\"2024-07-15T09:45:48Z\\",\\n \\"FinishTime\\": \\"2024-12-07T10:53:45Z\\",\\n \\"Workflow\\": {\\n \\"WorkflowId\\": \\"******2491c84dce913da9fe65******\\",\\n \\"Name\\": \\"example-workflow-***\\",\\n \\"Status\\": \\"Active\\",\\n \\"Type\\": \\"Common\\",\\n \\"CreateTime\\": \\"2025-03-21T01:48:49Z\\",\\n \\"ModifiedTime\\": \\"2025-02-23 10:19:37 +0800\\",\\n \\"MediaType\\": \\"OSS\\"\\n },\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\"\\n }\\n ],\\n \\"MaxResults\\": 10\\n}","type":"json"}]', 'title' => 'ListWorkflowTasks', 'description' => 'This API only returns data from the last 90 days.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListWorkflowTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListYikeAssetFolders' => [ 'summary' => 'Retrieves a list of Yike folders.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'ProductionId', 'in' => 'query', 'schema' => ['description' => 'The project ID. If this parameter is omitted, folders in the default project are returned.', 'type' => 'string', 'required' => false, 'example' => 'ProductionId', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'FolderList' => [ 'description' => 'The folder list.', 'type' => 'array', 'items' => [ 'description' => 'The details of the folder.', 'type' => 'object', 'properties' => [ 'FolderId' => ['description' => 'The folder ID.', 'type' => 'string', 'example' => 'fd-EXRyxc5SHY', 'title' => ''], 'FolderName' => ['description' => 'The folder name.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'ProductionId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'pd_183320223010****', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the folder is the default folder.', 'type' => 'boolean', 'example' => '1', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-01-22T02:07:06Z', 'title' => ''], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'llm-odl2p61i4vfbph4g', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Total' => ['description' => 'The total count of folders.', 'type' => 'integer', 'format' => 'int32', 'example' => '78', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'NextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is not returned, all results have been retrieved.', 'type' => 'string', 'example' => 'Token', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve Folder List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListYikeAssetFolders', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"FolderList\\": [\\n {\\n \\"FolderId\\": \\"fd-EXRyxc5SHY\\",\\n \\"FolderName\\": \\"default\\",\\n \\"ProductionId\\": \\"pd_183320223010****\\",\\n \\"IsDefault\\": true,\\n \\"CreateTime\\": \\"2026-01-22T02:07:06Z\\",\\n \\"WorkspaceId\\": \\"llm-odl2p61i4vfbph4g\\"\\n }\\n ],\\n \\"Total\\": 78,\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"Token\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListYikeProductions' => [ 'summary' => 'Queries the list of Yike projects.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token from a previous response. Use this to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'Token', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of results to return on each page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-zna577pdximvztk5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'ProductionList' => [ 'description' => 'The list of projects.', 'type' => 'array', 'items' => [ 'description' => 'Details of a single project.', 'type' => 'object', 'properties' => [ 'ProductionId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'pd_463862****', 'title' => ''], 'Title' => ['description' => 'The title of the project.', 'type' => 'string', 'example' => 'Harvest', 'title' => ''], 'Description' => ['description' => 'The project description.', 'type' => 'string', 'example' => 'Swas_QuerySwasInstanceByRegion', 'title' => ''], 'Auth' => ['description' => 'The authentication method.', 'type' => 'string', 'example' => 'Manage', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the project.', 'type' => 'string', 'example' => '2026-01-07T02:21:36Z', 'title' => ''], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'llm-m3r546h1n9kq3mtm', 'title' => ''], 'CoverUrl' => ['description' => 'The cover URL.', 'type' => 'string', 'example' => 'https://tagvvcloud-material-center-prod.oss-cn-hangzhou.aliyuncs.com/sumvideo/utils_image/sumvideo-video-cover.png', 'title' => ''], 'CreateUserName' => ['description' => 'The creator name.', 'type' => 'string', 'example' => 'aliyun_183320223010****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'MaxResults' => ['description' => 'The maximum number of results returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'NextToken' => ['description' => 'A pagination token. If more results are available, you can use this token in the next request to retrieve the next page of results. If this field is empty, all results have been returned.', 'type' => 'string', 'example' => 'Token', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve the project list ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'ice:ListYikeProductions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"ProductionList\\": [\\n {\\n \\"ProductionId\\": \\"pd_463862****\\",\\n \\"Title\\": \\"Harvest\\",\\n \\"Description\\": \\"Swas_QuerySwasInstanceByRegion\\",\\n \\"Auth\\": \\"Manage\\",\\n \\"CreateTime\\": \\"2026-01-07T02:21:36Z\\",\\n \\"WorkspaceId\\": \\"llm-m3r546h1n9kq3mtm\\",\\n \\"CoverUrl\\": \\"https://tagvvcloud-material-center-prod.oss-cn-hangzhou.aliyuncs.com/sumvideo/utils_image/sumvideo-video-cover.png\\",\\n \\"CreateUserName\\": \\"aliyun_183320223010****\\"\\n }\\n ],\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"Token\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'OpenMediaConnectFlowFailover' => [ 'summary' => 'Enables Source Failover for a MediaConnect flow.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => false, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '11357BE8-4C54-58EA-890A-5AB646EDE4B2'], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Content' => ['description' => 'The response body.', 'type' => 'string', 'example' => '""', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11357BE8-4C54-58EA-890A-5AB646EDE4B2\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', 'title' => 'OpenMediaConnectFlowFailover', 'description' => '- Before this operation, you must add a source to the flow.'."\n" ."\n" .'- After Source Failover is enabled, you can add an additional source. The input type of the two sources must be identical.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:OpenMediaConnectFlowFailover', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'PrecheckYikeAIAppJob' => [ 'summary' => 'Validates the parameters of an application.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app-1000000', 'title' => ''], ], [ 'name' => 'AppParams', 'in' => 'query', 'schema' => ['description' => 'The application\'s runtime parameters, serialized as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{\\"LoadImage.1.TargetImage\\":\\"794da8a01b8c71f1b973e6e7c7586301\\"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'Status' => ['description' => 'The precheck result. Valid values are:'."\n" ."\n" .'- Success: The precheck was successful.'."\n" ."\n" .'- Failed: The precheck failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Result' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The cause of the parameter validation error.', 'type' => 'string', 'example' => 'ImageCheckFailed', 'title' => ''], 'Key' => ['description' => 'The application parameter name.', 'type' => 'string', 'example' => 'LoadImage.1.TargetImage', 'title' => ''], ], 'description' => 'The parameter that failed the pre-check.', 'title' => '', 'example' => '', ], 'description' => 'Returned if the precheck fails. This parameter contains only the parameters that failed the check.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'PrecheckYikeAIAppJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:PrecheckYikeAIAppJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Status\\": \\"Success\\",\\n \\"Result\\": [\\n {\\n \\"ErrorCode\\": \\"ImageCheckFailed\\",\\n \\"Key\\": \\"LoadImage.1.TargetImage\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'QueryCopyrightExtractJob' => [ 'summary' => 'Queries a job for extracting a copyright watermark.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID. You can obtain the value of this parameter from the response of the SubmitCopyrightExtractJob operation.', 'type' => 'string', 'required' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The copyright watermark information.', 'type' => 'string', 'title' => '', 'example' => '版权水印测试'], ], 'example' => '', ], 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'Copyright watermark test', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Message\\": \\"版权水印测试\\"\\n },\\n \\"Message\\": \\"Copyright watermark test\\",\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', 'title' => 'QueryCopyrightExtractJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightExtractJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:QueryCopyrightExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'manual', ], 'QueryCopyrightJobList' => [ 'summary' => 'Queries copyright watermarking jobs.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'CreateTimeStart', 'in' => 'query', 'schema' => ['description' => 'The start of the creation time range for the query, 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 range for the query, in UNIX timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1627357325', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****cdb3e74639973036bc84****', 'title' => ''], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => ['description' => 'The watermark level, indicating the color channel for embedding. 0: U. 1: UV. 2: YUV.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.', 'type' => 'array', 'items' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The creation time of the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322', 'title' => ''], 'GmtModified' => ['description' => 'The last modification time of the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322', 'title' => ''], 'Input' => [ 'description' => 'Information about the input video for watermarking.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'2. Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The specific input information.', 'type' => 'string', 'example' => 'oss://bucket/object', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'Information about the watermarked output video.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid values:'."\n" ."\n" .'- OSS: an OSS object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The specific output information.', 'type' => 'string', 'example' => 'oss://bucket/object', 'title' => ''], ], 'title' => '', 'example' => '', ], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021****', 'title' => ''], 'Level' => ['description' => 'The watermark level.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'Message' => ['description' => 'The content of the embedded watermark.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Result' => ['description' => 'The job result.', 'type' => 'string', 'example' => '{"Code":"success","Message":"ok"}', 'title' => ''], 'Status' => ['description' => 'The status of the job.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '123', 'title' => ''], 'UserId' => ['description' => 'The ID of the user who initiated the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1346693***'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******36-3C1E-4417-BDB2-1E034F******'], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357322,\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"JobId\\": \\"bfb786c639894f4d80648792021****\\",\\n \\"Level\\": 2,\\n \\"Message\\": \\"test\\",\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', 'title' => 'QueryCopyrightJobList', 'description' => '- This operation is supported only in the China (Shanghai) and China (Beijing) regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:QueryCopyrightJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'manual', ], 'QueryDNAJobList' => [ 'summary' => 'Queries a list of media fingerprint analysis jobs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the media fingerprint analysis jobs that you want to query. We recommend that you query at most 10 jobs at a time. Separate multiple job IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'JobList' => [ 'description' => 'The queried media fingerprint analysis jobs.', 'type' => 'array', 'items' => [ 'description' => 'The queried media fingerprint analysis job.', 'type' => 'object', 'properties' => [ 'DNAResult' => ['description' => 'The URL of the media fingerprint analysis result.', 'type' => 'string', 'example' => 'http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt', 'title' => ''], 'PrimaryKey' => ['description' => 'The primary key of the video. You must make sure that each primary key is unique.', 'type' => 'string', 'example' => '3ca84a39a9024f19853b21be9cf9****', 'title' => ''], 'DBId' => ['description' => 'The ID of the media fingerprint library.', 'type' => 'string', 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], 'CreationTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-12-28T03:21:37Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was complete.', 'type' => 'string', 'example' => '2022-12-28T03:21:44Z', 'title' => ''], 'Status' => ['description' => 'The job state. Valid values:'."\n" ."\n" .'- **Queuing**: The job is waiting in the queue.'."\n" ."\n" .'- **Analysing**: The job is in progress.'."\n" ."\n" .'- **Success**: The job is successful.'."\n" ."\n" .'- **Fail**: The job failed.', 'type' => 'string', 'example' => 'Queuing', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => '"The resource operated \\"a887d0b***d805ef6f7f6786302\\" cannot be found"', 'title' => ''], 'Config' => ['description' => 'The configurations of the media fingerprint analysis job.', 'type' => 'string', 'example' => '{"SaveType": "save","MediaType"":"video"}', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => 'testdna', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '"InvalidParameter.ResourceNotFound"', 'title' => ''], 'Input' => [ 'description' => 'The details of the input file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: Object Storage Service (OSS) object.'."\n" ."\n" .'2. Media: media asset.', 'type' => 'string', 'example' => 'Media', 'title' => ''], 'Media' => ['description' => 'The input file. The file can be an OSS object or a media asset. The path of an OSS object can be in one of the following formats:'."\n" ."\n" .'1\\. oss\\://bucket/object'."\n" ."\n" .'2\\. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object'."\n" ."\n" .'In the preceding paths, bucket indicates an OSS bucket that resides in the same region as the current project, and object indicates the path of the object in the bucket.', 'type' => 'string', 'example' => '1b1b9cd148034739af413150fded****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobList\\": [\\n {\\n \\"DNAResult\\": \\"http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt\\",\\n \\"PrimaryKey\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"DBId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\",\\n \\"CreationTime\\": \\"2022-12-28T03:21:37Z\\",\\n \\"FinishTime\\": \\"2022-12-28T03:21:44Z\\",\\n \\"Status\\": \\"Queuing\\",\\n \\"Message\\": \\"\\\\\\"The resource operated \\\\\\\\\\\\\\"a887d0b***d805ef6f7f6786302\\\\\\\\\\\\\\" cannot be found\\\\\\"\\",\\n \\"Config\\": \\"{\\\\\\"SaveType\\\\\\": \\\\\\"save\\\\\\",\\\\\\"MediaType\\\\\\"\\\\\\":\\\\\\"video\\\\\\"}\\",\\n \\"UserData\\": \\"testdna\\",\\n \\"Code\\": \\"\\\\\\"InvalidParameter.ResourceNotFound\\\\\\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"Media\\",\\n \\"Media\\": \\"1b1b9cd148034739af413150fded****\\"\\n },\\n \\"Id\\": \\"88c6ca184c0e47098a5b665e2a12****\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'QueryDNAJobList', 'responseParamsDescription' => 'The value of DNAResult is an array of VideoMatchInfo.'."\n" ."\n" .'**VideoMatchInfo**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ------------------ | -------------------------- | ----------------------------------------------------------------------------- |'."\n" .'| PrimaryKey | String | The unique primary key of the file. |'."\n" .'| GlobalSimilarity | Double | The overall similarity. |'."\n" .'| VideoMatchSegments | Array of VideoMatchSegment | The video segments that match based on video search or video search by image. |'."\n" .'| AudioMatchSegments | Array of AudioMatchSegment | The audio segments that match based on audio search. |'."\n" .'| TextMatchSegments | Array of TextMatchSegment | The text segments that match based on text search. |'."\n" ."\n" .'**VideoMatchSegment or AudioMatchSegment**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| StartTime | Double | The start time of the input video or audio. |'."\n" .'| EndTime | Double | The end time of the input video or audio. |'."\n" .'| MasterStartTime | Double | The start time of the matching video or audio in the media fingerprint library. |'."\n" .'| MasterEndTime | Double | The end time of the matching video or audio in the media fingerprint library. |'."\n" .'| Similarity | Double | The similarity of the input segment against the matching segments that have similar fingerprints to the input segment in the media fingerprint library. |'."\n" ."\n" .'**TextMatchSegment**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Start | Double | The start time of the input segment. |'."\n" .'| End | Double | The end time of the input segment. |'."\n" .'| QueryText | String | The input text for text fingerprint analysis. |'."\n" .'| MasterText | String | The text segment that has similar fingerprints to the input text in the text fingerprint library. |'."\n" .'| Similarity | Double | The similarity of the input segment against the matching segments that have similar fingerprints to the input segment in the media fingerprint library. |', 'changeSet' => [ ['createdAt' => '2023-05-25T07:23:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDNAJobList'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:QueryDNAJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'QueryIProductionJob' => [ 'summary' => 'Call `QueryIProductionJob` to get the status and result of an intelligent production job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'A token that ensures request idempotence.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The intelligent job ID.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'Test task', 'title' => ''], 'FunctionName' => ['description' => 'The name of the algorithm to use. Valid values:'."\n" ."\n" .'- **Cover**: smart cover'."\n" ."\n" .'- **VideoClip**: video summary'."\n" ."\n" .'- **VideoDelogo**: video logo removal'."\n" ."\n" .'- **VideoDetext**: video text removal'."\n" ."\n" .'- **CaptionExtraction**: caption extraction'."\n" ."\n" .'- **VideoGreenScreenMatting**: green screen matting'."\n" ."\n" .'- **FaceBeauty**: video beautification'."\n" ."\n" .'- **VideoH2V**: horizontal-to-vertical video conversion'."\n" ."\n" .'- **MusicSegmentDetect**: chorus detection'."\n" ."\n" .'- **AudioBeatDetection**: beat detection'."\n" ."\n" .'- **AudioQualityAssessment**: audio quality assessment'."\n" ."\n" .'- **SpeechDenoise**: speech denoising'."\n" ."\n" .'- **AudioMixing**: audio mixing'."\n" ."\n" .'- **MusicDemix**: music source separation', 'type' => 'string', 'example' => 'Cover', 'title' => ''], 'Input' => [ 'description' => 'The input media.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The input type. Valid values:'."\n" ."\n" .'1. OSS: An OSS file URL.'."\n" ."\n" .'2. Media: A media asset ID.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'OSS', 'title' => '', ], 'Media' => ['description' => 'The source file for the job. Set this to an OSS file URL if `Type` is `OSS`, or a media asset ID if `Type` is `Media`.'."\n" .'Valid OSS URL formats:'."\n" ."\n" .'1. oss\\://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object'."\n" .' In these formats, `bucket` is the name of the OSS bucket in the same region as the current project, and `object` is the file path.', 'type' => 'string', 'example' => 'oss://bucket/object', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'The output media.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The media type. Valid values:'."\n" ."\n" .'- OSS: An OSS file URL.'."\n" ."\n" .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Biz' => [ 'description' => 'The service that the media asset belongs to.', 'enumValueTitles' => ['VOD' => 'VOD', 'IMS' => 'IMS'], 'type' => 'string', 'example' => 'IMS', 'title' => '', ], 'Media' => ['description' => 'The destination for the output. If the output `Type` is `OSS`, this parameter returns an OSS file URL. If the output `Type` is `Media`, it returns the specified or a newly generated media asset ID.'."\n" ."\n" .'Valid OSS URL formats:'."\n" ."\n" .'1. oss\\://bucket/object'."\n" ."\n" .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object'."\n" .' In these formats, `bucket` is the name of the OSS bucket in the same region as the current project, and `object` is the file path.', 'type' => 'string', 'example' => 'oss://bucket/object', 'title' => ''], 'OutputUrl' => ['description' => 'The OSS URL of the output file. This value is returned only when `Type` is `Media`.', 'type' => 'string', 'example' => 'http(s)://bucket.oss-[RegionId].aliyuncs.com/object ', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****96e8864746a0b6f3****', 'title' => ''], 'JobParams' => ['description' => 'A JSON object that contains the parameters for the algorithm job. The specific parameters vary depending on the selected algorithm.', 'type' => 'string', 'example' => '{"Model":"gif"}', 'title' => ''], 'ScheduleConfig' => [ 'description' => 'The job configuration.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'a54fdc9c9aab413caef0d1150f565e86', 'title' => ''], 'Priority' => ['description' => 'The job\'s priority within the pipeline.'."\n" ."\n" .'- A larger value indicates a higher priority. The highest priority is 10.'."\n" ."\n" .'- Default: **6**.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], ], 'title' => '', 'example' => '', ], 'UserData' => ['description' => 'The user data. The system returns this value unchanged.', 'type' => 'string', 'example' => '{"test":1}', 'title' => ''], 'Result' => ['description' => 'The algorithm output, returned as a JSON string. The structure of the output varies based on the `FunctionName`. For more information, see the additional notes below.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'CreateTime' => ['description' => 'The time when the job was created, in UTC.', 'type' => 'string', 'example' => '2022-07-07T07:16:11Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the job was completed, in UTC.', 'type' => 'string', 'example' => '2021-11-26T14:50:25Z', 'title' => ''], 'Status' => ['description' => 'The job status. Valid values:'."\n" ."\n" .'- Queuing: The job is awaiting processing.'."\n" ."\n" .'- Analyzing: The job is being processed.'."\n" ."\n" .'- Fail: The job failed to complete.'."\n" ."\n" .'- Success: The job completed successfully.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'OutputFiles' => [ 'description' => 'An array of output file paths.', 'type' => 'array', 'items' => ['description' => 'The path and name of the generated file.', 'type' => 'string', 'example' => 'output/xxx.mp4', 'title' => ''], 'title' => '', 'example' => '', ], 'OutputMediaIds' => [ 'description' => 'The output media asset IDs.', 'type' => 'array', 'items' => ['description' => 'An output media asset ID.', 'type' => 'string', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'OutputUrls' => [ 'description' => 'An array of output file URLs.', 'type' => 'array', 'items' => ['description' => 'The accessible URL of the generated file.', 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"Test task\\",\\n \\"FunctionName\\": \\"Cover\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Biz\\": \\"IMS\\",\\n \\"Media\\": \\"oss://bucket/object\\",\\n \\"OutputUrl\\": \\"http(s)://bucket.oss-[RegionId].aliyuncs.com/object \\"\\n },\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"JobParams\\": \\"{\\\\\\"Model\\\\\\":\\\\\\"gif\\\\\\"}\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"a54fdc9c9aab413caef0d1150f565e86\\",\\n \\"Priority\\": 6\\n },\\n \\"UserData\\": \\"{\\\\\\"test\\\\\\":1}\\",\\n \\"Result\\": \\"{}\\",\\n \\"CreateTime\\": \\"2022-07-07T07:16:11Z\\",\\n \\"FinishTime\\": \\"2021-11-26T14:50:25Z\\",\\n \\"Status\\": \\"Success\\",\\n \\"OutputFiles\\": [\\n \\"output/xxx.mp4\\"\\n ],\\n \\"OutputMediaIds\\": [\\n \\"\\"\\n ],\\n \\"OutputUrls\\": [\\n \\"http://xxx\\"\\n ]\\n}","type":"json"}]', 'title' => 'Query Intelligent Production Job ', 'responseParamsDescription' => '### Result examples'."\n" ."\n" .'#### Cover'."\n" ."\n" .'Example: \\[{"Score":8.270855992569906,"Time":"28278.25","Url":"cover/test-00001.jpg"},{"Score":7.474117489692728,"Time":"25942.583333333332","Url":"cover/test-00002.jpg"}]'."\n" ."\n" .'`Score` is the confidence, `Time` is the timestamp, and `Url` is the file path.'."\n" ."\n" .'#### VideoClip'."\n" ."\n" .'Example: {"VideoSummaryList":\\[{"EndTime":"5.28","StartTime":"0.28"}]}'."\n" ."\n" .'`VideoSummaryList` is a list of time ranges clipped from the source video, in seconds.'."\n" ."\n" .'#### VideoDelogo'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### VideoDetext'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### CaptionExtraction'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### VideoGreenScreenMatting'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### FaceBeauty'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### VideoH2V'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### MusicSegmentDetect'."\n" ."\n" .'Example: \\[{"start":39.32,"end":63.85,"title":"Chorus"},{"start":86.69,"end":114.45,"title":"Chorus"},{"start":135.75,"end":160.27,"title":"Chorus"}]'."\n" ."\n" .'#### AudioBeatDetection'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### AudioQualityAssessment'."\n" ."\n" .'Example:'."\n" .'\\[{'."\n" .'"Discontinuity":"Good",'."\n" .'"Loudness":"Excellent",'."\n" .'"Worst MOS(0-5)":"0.38",'."\n" .'"Discontinuity(0-5)":"3.52",'."\n" .'"Speech Ratio":"48.55",'."\n" .'"Loudness(0-5)":"4.91",'."\n" .'"Worst Discontinuity(0-5)":"0.88",'."\n" .'"Worst Coloration(0-5)":"0.42",'."\n" .'"Channel":"1",'."\n" .'"Coloration(0-5)":"0.99",'."\n" .'"Bad Mute Ratio(%)":"0.0",'."\n" .'"Time":"2022-12-02 16:14:06",'."\n" .'"Noisiness(0-5)":"3.28",'."\n" .'"MOS":"Poor",'."\n" .'"Worst Noisiness(0-5)":"0.91",'."\n" .'"Double Talk Ratio(%)":"19.23",'."\n" .'"Input":"/home/admin/algo/quality\\*\\*\\*\\*/example.wav",'."\n" .'"Total Duration":"42.78",'."\n" .'"Noisiness":"Good",'."\n" .'"Tag":"Valid",'."\n" .'"MOS(0-5)":"1.01",'."\n" .'"Loudness(-90dB-0dB)":"-0.59",'."\n" .'"Coloration":"Bad",'."\n" .'"Saturated Ratio(%)":"37.55"'."\n" .'},'."\n" .'{'."\n" .'"Discontinuity":"Fair",'."\n" .'"Loudness":"Excellent",'."\n" .'"Worst MOS(0-5)":"0.65",'."\n" .'"Discontinuity(0-5)":"2.45",'."\n" .'"Speech Ratio":"41.68",'."\n" .'"Loudness(0-5)":"4.52",'."\n" .'"Worst Discontinuity(0-5)":"0.66",'."\n" .'"Worst Coloration(0-5)":"0.72",'."\n" .'"Channel":"2",'."\n" .'"Coloration(0-5)":"2.34",'."\n" .'"Bad Mute Ratio(%)":"0.0",'."\n" .'"Time":"2022-12-02 16:14:06",'."\n" .'"Noisiness(0-5)":"2.53",'."\n" .'"MOS":"Poor",'."\n" .'"Worst Noisiness(0-5)":"0.67",'."\n" .'"Double Talk Ratio(%)":"25.93",'."\n" .'"Input":"/home/admin/algo/quality\\*\\*\\*\\*/example.wav",'."\n" .'"Total Duration":"42.78",'."\n" .'"Noisiness":"Fair",'."\n" .'"Tag":"Valid",'."\n" .'"MOS(0-5)":"1.69",'."\n" .'"Loudness(-90dB-0dB)":"-4.82",'."\n" .'"Coloration":"Fair",'."\n" .'"Saturated Ratio(%)":"0.0"'."\n" .'}]'."\n" ."\n" .'[Parameter descriptions](~~352026#section-1vi-l8s-fhd~~)'."\n" ."\n" .'#### SpeechDenoise'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### AudioMixing'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.'."\n" ."\n" .'#### MusicDemix'."\n" ."\n" .'Example: {}'."\n" ."\n" .'The output contains no additional information.', 'changeSet' => [ ['createdAt' => '2025-04-02T06:57:19.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-13T08:33:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryIProductionJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:QueryIProductionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'QueryIpcQuota' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start Time. UTC time in the format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-05-08T08:52:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time. UTC time in the format: yyyy-MM-ddTHH:mm:ssZ. The difference between EndTime and StartTime must not exceed 180 days.', 'type' => 'string', 'required' => false, 'example' => '2025-05-09T08:52:00Z', 'title' => ''], ], [ 'name' => 'Capability', 'in' => 'query', 'schema' => ['description' => 'Capability. Default value is understand. Valid values:'."\n" ."\n" .'- understand: understanding'."\n" ."\n" .'- understand-reid: understanding with reid'."\n" ."\n" .'- search: search', 'type' => 'string', 'required' => false, 'example' => 'understand', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'Page number for paging. Default Value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, which specifies the number of entries displayed per page. Default value is 10, and the maximum value is 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'IpcQuotaInfos' => [ 'description' => 'List of IPC usage information.', 'type' => 'array', 'items' => [ 'description' => 'IPC usage information.', 'type' => 'object', 'properties' => [ 'Capability' => ['description' => 'Capability. Valid values:'."\n" ."\n" .'- understand: understanding'."\n" ."\n" .'- understand-reid: understanding with reid'."\n" ."\n" .'- search: search', 'type' => 'string', 'example' => 'understand', 'title' => ''], 'DateTime' => ['description' => 'Corresponding time. UTC time in the format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2025-12-21T16:00:00Z', 'title' => ''], 'MaxQuota' => ['description' => 'Maximum available quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'ConsumedQuota' => ['description' => 'Consumed quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Total' => ['description' => 'Total number of records.', 'type' => 'string', 'example' => '39', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query IPC usage', 'summary' => 'Query IPC usage.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:QueryIpcQuota', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IpcQuotaInfos\\": [\\n {\\n \\"Capability\\": \\"understand\\",\\n \\"DateTime\\": \\"2025-12-21T16:00:00Z\\",\\n \\"MaxQuota\\": 10000,\\n \\"ConsumedQuota\\": 32\\n }\\n ],\\n \\"Total\\": \\"39\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'QueryMediaCensorJobDetail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], '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](~~444848~~) 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. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => 'ae0fd49c0840e14daf0d66a75b83****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per 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 request ID.', '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 content moderation job was created.', 'type' => 'string', 'example' => '2018-09-13T16:32:24Z', 'title' => ''], 'FinishTime' => ['description' => 'The time when the content moderation job was complete.', 'type' => 'string', 'example' => '2018-09-13T16:38:24Z', 'title' => ''], 'Suggestion' => ['description' => 'The overall result of the content moderation job. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content needs to be blocked.'."\n" ."\n" .'> If the moderation result of any type of content is review, the overall result is review. If the moderation result of any type of 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 detailed results.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The Object Storage Service (OSS) object that is used as the thumbnail.', 'type' => 'string', 'example' => 'test/ai/censor/v2/vme-****.jpg', 'title' => ''], 'Location' => ['description' => 'The OSS region in which the thumbnail resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket in which the thumbnail is stored.', 'type' => 'string', 'example' => 'bucket-out-test-****', 'title' => ''], 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Result' => [ 'description' => 'The moderation results.', 'type' => 'array', 'items' => [ 'description' => 'The detailed moderation results.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result.'."\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" .' - **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 ad.'."\n" ."\n" .' - **qrcode**: QR code.'."\n" ."\n" .' - **programCode**: mini program code.'."\n" ."\n" .'- Valid values in the undesirable scene 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 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 moderation.'."\n" ."\n" .'- **live**: undesirable scene moderation.'."\n" ."\n" .'- **logo**: logo moderation.', 'type' => 'string', 'example' => 'Antispam', '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 job state.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'TitleCensorResult' => [ 'description' => 'The moderation results of titles.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Valid values:'."\n" ."\n" .'- **normal**: normal content.'."\n" ."\n" .'- **spam**: spam.'."\n" ."\n" .'- **ad**: ads.'."\n" ."\n" .'- **abuse**: abuse content.'."\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. 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 failed. 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 file.', 'type' => 'string', 'example' => 'test/ai/censor/test-****.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS region in which the input file resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.', 'type' => 'string', 'example' => 'bucket-test-in-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'BarrageCensorResult' => [ 'description' => 'The moderation results 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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Valid values:'."\n" ."\n" .'- **normal**: normal content.'."\n" ."\n" .'- **spam**: spam.'."\n" ."\n" .'- **ad**: ads.'."\n" ."\n" .'- **abuse**: abuse content.'."\n" ."\n" .'- **flood**: excessive junk content.'."\n" ."\n" .'- **contraband**: prohibited content.'."\n" ."\n" .'- **meaningless**: meaningless content.', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. 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 results of descriptions.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'review', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Valid values:'."\n" ."\n" .'- **normal**: normal content.'."\n" ."\n" .'- **spam**: spam.'."\n" ."\n" .'- **ad**: ads.'."\n" ."\n" .'- **abuse**: abuse content.'."\n" ."\n" .'- **flood**: excessive junk content.'."\n" ."\n" .'- **contraband**: prohibited content.'."\n" ."\n" .'- **meaningless**: meaningless content.', 'type' => 'string', 'example' => 'terrorism', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. 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 OSS object that is generated as the output snapshot.'."\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 OSS region in which the output snapshot resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket in which the output snapshot is stored.', '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 user-defined data.', 'type' => 'string', 'example' => 'example userdata ****', 'title' => ''], 'Code' => ['description' => 'The error code returned if the job failed. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], 'VensorCensorResult' => [ 'description' => 'The moderation results of videos.', '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 OSS object that is generated as the output snapshot.'."\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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result.'."\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" .' - **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 ad.'."\n" ."\n" .' - **qrcode**: QR code.'."\n" ."\n" .' - **programCode**: mini program code.'."\n" ."\n" .'- Valid values in the undesirable scene 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 logo.'."\n" ."\n" .' - **trademark**: trademark.', 'type' => 'string', 'example' => 'flood', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. Valid values:'."\n" ."\n" .'- **porn**: pornographic content moderation.'."\n" ."\n" .'- **terrorism**: terrorist content moderation.'."\n" ."\n" .'- **ad**: ad 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' => 'A pagination token. It 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 moderation results. The information includes the summary about various scenarios such as pornographic content moderation and terrorist content moderation.', 'type' => 'array', 'items' => [ 'description' => 'The detailed moderation results.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'review', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result.'."\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" .' - **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 ad.'."\n" ."\n" .' - **qrcode**: QR code.'."\n" ."\n" .' - **programCode**: mini program code.'."\n" ."\n" .'- Valid values in the undesirable scene 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 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 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' => '', ], 'PipelineId' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.', 'type' => 'string', 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'QueryMediaCensorJobDetail', 'summary' => 'Queries the information about a content moderation job.', 'description' => 'In the content moderation results, the moderation results of the video are sorted in ascending order by time into a timeline. If the video is long, the content moderation results are paginated, and the first page is returned. Call this operation again to query the remaining moderation results of the video.', 'changeSet' => [ ['createdAt' => '2022-07-19T11:23:57.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobDetail'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:QueryMediaCensorJobDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', '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-13T16:38:24Z\\",\\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\\": \\"Antispam\\",\\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\\": \\"terrorism\\",\\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\\": \\"flood\\",\\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 \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\"\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'QueryMediaCensorJobList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'JobIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the content moderation jobs. You can obtain the ID of a content moderation job from the response parameters of the SubmitMediaCensorJob operation. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'fa9c34be3bcf42919ac4d1775239****,78dc866518b843259669df58ed30****', '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. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => '79aff3eee82242e092899db5****', 'title' => ''], ], [ 'name' => 'MaximumPageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.'."\n" ."\n" .'- Default value: **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 that you want to query. Valid values:'."\n" ."\n" .'- **All**: all jobs.'."\n" ."\n" .'- **Queuing**: the jobs that are waiting in the queue.'."\n" ."\n" .'- **Analysing**: the jobs that are in progress.'."\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 beginning of the time range to query.'."\n" ."\n" .'- Specify the time in the ISO 8601 standard. The time must be in UTC.'."\n" ."\n" .'- Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-12-22T03:48:05Z'."\n", 'title' => ''], ], [ 'name' => 'EndOfJobCreatedTimeRange', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query.'."\n" ."\n" .'- Specify the time in the ISO 8601 standard. The time must be in UTC.'."\n" ."\n" .'- Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2022-02-14T02:16:07Z'."\n", 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the jobs were submitted.', 'type' => 'string', 'required' => false, 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'MediaCensorJobList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MediaCensorJob' => [ 'description' => 'The queried content moderation jobs.', 'type' => 'array', 'items' => [ 'description' => 'The details of the content moderation job.', 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the content moderation job was created.', 'type' => 'string', 'example' => '2021-11-04T07:25:48Z'."\n", 'title' => ''], 'FinishTime' => ['description' => 'The time when the content moderation job was complete.', 'type' => 'string', 'example' => '2021-11-04T07:25:50Z'."\n", 'title' => ''], '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'CoverImageCensorResults' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CoverImageCensorResult' => [ 'description' => 'The moderation results of thumbnails.', 'type' => 'array', 'items' => [ 'description' => 'The detailed moderation result of the thumbnail.', 'type' => 'object', 'properties' => [ 'Object' => ['description' => 'The Object Storage Service (OSS) object that is used as the thumbnail.', 'type' => 'string', 'example' => 'test/ai/censor/v2/vme-****.jpg'."\n", 'title' => ''], 'Location' => ['description' => 'The OSS region in which the thumbnail resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai', 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket in which the thumbnail is stored.', 'type' => 'string', 'example' => 'example-Bucket-****'."\n", 'title' => ''], 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Result' => [ 'description' => 'The moderation results.', 'type' => 'array', 'items' => [ 'description' => 'The detailed moderation results.', 'type' => 'object', 'properties' => [ 'Suggestion' => ['description' => 'The overall result of the moderation job. Valid values:'."\n" ."\n" .'- **pass**: The content passes the moderation.'."\n" ."\n" .'- **review**: The content needs to be manually reviewed.'."\n" ."\n" .'- **block**: The content needs to be blocked.'."\n" ."\n" .'> If the moderation result of any type of content is review, the overall result is review. If the moderation result of any type of content is block, the overall result is block.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Separate multiple labels 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" .' - **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 ad.'."\n" ."\n" .' - **qrcode**: QR code.'."\n" ."\n" .' - **programCode**: mini program code.'."\n" ."\n" .'- Valid values in the undesirable scene 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 streaming in a running vehicle.'."\n" ."\n" .'- Valid values in the logo moderation scenario:'."\n" ."\n" .' - **normal**: normal content.'."\n" ."\n" .' - **TV**: controlled 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 moderation.'."\n" ."\n" .'- **live**: undesirable scene moderation.'."\n" ."\n" .'- **logo**: logo moderation.', '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 job state.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'TitleCensorResult' => [ 'description' => 'The moderation results of titles.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" ."\n" .'- **normal**: normal content.'."\n" ."\n" .'- **spam**: spam.'."\n" ."\n" .'- **ad**: ads.'."\n" ."\n" .'- **abuse**: abuse content.'."\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. The value is **antispam**.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score. Valid values: 0 to 100.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The error message returned if the job failed. 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 file.', 'type' => 'string', 'example' => 'test/ai/censor/test-****.mp4', 'title' => ''], 'Location' => ['description' => 'The OSS region in which the input file resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai'."\n", 'title' => ''], 'Bucket' => ['description' => 'The name of the OSS bucket in which the input file is stored.', 'type' => 'string', 'example' => 'bucket-test-in-****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'BarrageCensorResult' => [ 'description' => 'The moderation results 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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" ."\n" .'- **normal**: normal content.'."\n" ."\n" .'- **spam**: spam.'."\n" ."\n" .'- **ad**: ads.'."\n" ."\n" .'- **abuse**: abuse content.'."\n" ."\n" .'- **flood**: excessive junk content.'."\n" ."\n" .'- **contraband**: prohibited content.'."\n" ."\n" .'- **meaningless**: meaningless content.', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. The value is **antispam**.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score. Valid values: 0 to 100.', 'type' => 'string', 'example' => '99.91', 'title' => ''], ], 'title' => '', 'example' => '', ], 'DescCensorResult' => [ 'description' => 'The moderation results of descriptions.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" ."\n" .'- **normal**: normal content.'."\n" ."\n" .'- **spam**: spam.'."\n" ."\n" .'- **ad**: ads.'."\n" ."\n" .'- **abuse**: abuse content.'."\n" ."\n" .'- **flood**: excessive junk content.'."\n" ."\n" .'- **contraband**: prohibited content.'."\n" ."\n" .'- **meaningless**: meaningless content.', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'Scene' => ['description' => 'The moderation scenario. The value is **antispam**.', 'type' => 'string', 'example' => 'antispam', 'title' => ''], 'Rate' => ['description' => 'The score. Valid values: 0 to 100.', '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 OSS object that is generated as the output snapshot.'."\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 ID of the region in which the output snapshot resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai'."\n", 'title' => ''], 'Bucket' => ['description' => 'The OSS bucket in which the output snapshot is stored.', 'type' => 'string', 'example' => 'test-bucket-****'."\n", '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 moderation template. Default value: common. The default value indicates that the default template is used.'."\n" ."\n" .'> If the moderation template is not specified, the default value common is returned. If a custom moderation template that is created by submitting a ticket is specified, 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 user-defined data.', 'type' => 'string', 'example' => 'example userdata ****'."\n", 'title' => ''], 'Code' => ['description' => 'The error code returned if the job failed. This parameter is not returned if the job is successful.', 'type' => 'string', 'example' => 'InvalidParameter.ResourceNotFound', 'title' => ''], 'VensorCensorResult' => [ 'description' => 'The moderation results of videos.', '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 detailed moderation results.', '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 OSS object that is generated as the output snapshot.'."\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 detailed moderation results.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'block', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Separate multiple labels 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" .' - **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 ad.'."\n" ."\n" .' - **qrcode**: QR code.'."\n" ."\n" .' - **programCode**: mini program code.'."\n" ."\n" .'- Valid values in the undesirable scene 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 streaming in a running vehicle.'."\n" ."\n" .'- Valid values in the logo moderation scenario:'."\n" ."\n" .' - **normal**: normal content.'."\n" ."\n" .' - **TV**: controlled 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 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' => '', ], 'NextPageToken' => ['description' => 'A pagination token. It 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 moderation results. The information includes the summary about various scenarios such as pornographic content moderation and terrorist content moderation.', 'type' => 'array', 'items' => [ 'description' => 'The detailed moderation results.', '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.'."\n" ."\n" .'- **block**: The content needs to be blocked.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Label' => ['description' => 'The label of the moderation result. Separate multiple labels 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" .' - **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 ad.'."\n" ."\n" .' - **qrcode**: QR code.'."\n" ."\n" .' - **programCode**: mini program code.'."\n" ."\n" .'- Valid values in the undesirable scene 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 streaming in a running vehicle.'."\n" ."\n" .'- Valid values in the logo moderation scenario:'."\n" ."\n" .' - **normal**: normal content.'."\n" ."\n" .' - **TV**: controlled 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 moderation.'."\n" ."\n" .'- **live**: undesirable scene moderation.'."\n" ."\n" .'- **logo**: logo moderation.', 'type' => 'string', 'example' => 'ad', 'title' => ''], 'Rate' => ['description' => 'The score. Valid values: 0 to 100.', 'type' => 'string', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B'."\n", 'title' => ''], 'NextPageToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. The value is 32-character UUID. If the returned query results cannot be displayed within one page, this parameter is returned. The value of this parameter is updated for each query.', 'type' => 'string', 'example' => '9b1a42bc6e8d46e6a1383b7e7f01****'."\n", 'title' => ''], 'NonExistIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'String' => [ 'description' => 'The IDs of the jobs that do not exist. This parameter is not returned if all the specified jobs are found.', 'type' => 'array', 'items' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '78dc866518b843259669df58ed30****'."\n", 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'QueryMediaCensorJobList', 'summary' => 'Queries a list of content moderation jobs.', 'description' => 'Query only the content moderation jobs within the most recent three months.', 'changeSet' => [ ['createdAt' => '2022-11-18T08:47:52.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:QueryMediaCensorJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MediaCensorJobList\\": {\\n \\"MediaCensorJob\\": [\\n {\\n \\"CreationTime\\": \\"2021-11-04T07:25:48Z\\\\n\\",\\n \\"FinishTime\\": \\"2021-11-04T07:25:50Z\\\\n\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"CoverImageCensorResults\\": {\\n \\"CoverImageCensorResult\\": [\\n {\\n \\"Object\\": \\"test/ai/censor/v2/vme-****.jpg\\\\n\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"example-Bucket-****\\\\n\\",\\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\\": \\"100\\"\\n },\\n \\"Message\\": \\"The resource operated cannot be found\\",\\n \\"Input\\": {\\n \\"Object\\": \\"test/ai/censor/test-****.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\\\n\\",\\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\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"VideoCensorConfig\\": {\\n \\"OutputFile\\": {\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\\\n\\",\\n \\"Bucket\\": \\"test-bucket-****\\\\n\\"\\n },\\n \\"VideoCensor\\": \\"true\\",\\n \\"BizType\\": \\"common\\"\\n },\\n \\"JobId\\": \\"f8f166eea7a44e9bb0a4aecf9543\\",\\n \\"UserData\\": \\"example userdata ****\\\\n\\",\\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\\": \\"porn\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"NextPageToken\\": \\"ea04afcca7cd4e80b9ece8fbb251\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"ad\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n },\\n \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\\\n\\",\\n \\"NextPageToken\\": \\"9b1a42bc6e8d46e6a1383b7e7f01****\\\\n\\",\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"78dc866518b843259669df58ed30****\\\\n\\"\\n ]\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'QueryMediaIndexJob' => [ 'summary' => 'Queries the indexing jobs enabled for a media asset.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library. Default value: ims-default-search-lib.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c2e77390f75271ec802f0674a2ce6***'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'IndexJobInfoList' => [ 'description' => 'The indexing jobs enabled for the media asset.', 'type' => 'array', 'items' => [ 'description' => 'The indexing job enabled for the media asset.', 'type' => 'object', 'properties' => [ 'GmtSubmit' => ['description' => 'The time when the index job was submitted.', 'type' => 'string', 'example' => '2023-11-21 11:33:50', 'title' => ''], 'GmtFinish' => ['description' => 'The end time of the indexing job.', 'type' => 'string', 'example' => '2023-11-21 11:33:51', 'title' => ''], 'IndexType' => [ 'description' => 'The index type. Valid values:'."\n" ."\n" .'- mm: large visual model.'."\n" ."\n" .'- face: face recognition.'."\n" ."\n" .'- aiLabel: smart tagging.', 'enumValueTitles' => ['mm' => 'mm', 'face' => 'face', 'aiLabel' => 'aiLabel'], 'type' => 'string', 'example' => 'mm', 'title' => '', ], 'Status' => [ 'description' => 'The job status. Valid values:'."\n" ."\n" .'- Running'."\n" ."\n" .'- Success'."\n" ."\n" .'- Fail', 'enumValueTitles' => ['Running' => 'Running', 'Success' => 'Success', 'Fail' => 'Fail'], 'type' => 'string', 'example' => 'Success', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"IndexJobInfoList\\": [\\n {\\n \\"GmtSubmit\\": \\"2023-11-21 11:33:50\\",\\n \\"GmtFinish\\": \\"2023-11-21 11:33:51\\",\\n \\"IndexType\\": \\"mm\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'QueryMediaIndexJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaIndexJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:QueryMediaIndexJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'QuerySearchIndex' => [ 'summary' => 'Gets details about a search index.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.'."\n" ."\n" .'- If you leave this parameter empty, the search index is created in the default search library of Intelligent Media Service (IMS). Default value: ims-default-search-lib.'."\n" ."\n" .'- To query information about an existing search library, call the [QuerySearchLib](~~2584455~~) API operation.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'IndexType', 'in' => 'query', 'schema' => [ 'description' => 'The category of the index. Valid values:'."\n" ."\n" .'- mm: large visual model.'."\n" ."\n" .'- face: face recognition.'."\n" ."\n" .'- aiLabel: smart tagging.', 'enumValueTitles' => ['mm' => 'mm'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'SearchLibName' => ['description' => 'The name of the search library.', 'type' => 'string', 'title' => '', 'example' => 'test1'], 'IndexType' => [ 'description' => 'The category of the index. Valid values:'."\n" ."\n" .'- mm: large visual model.'."\n" ."\n" .'- face: face recognition.'."\n" ."\n" .'- aiLabel: smart tagging.', 'enumValueTitles' => ['mm' => 'mm', 'face' => 'face', 'aiLabel' => 'aiLabel'], 'type' => 'string', 'title' => '', 'example' => 'mm', ], 'IndexStatus' => [ 'description' => 'The state of the index. Valid values:'."\n" ."\n" .'- active: the index is enabled.'."\n" ."\n" .'- Deactive: the index is not enabled.', 'enumValueTitles' => ['Active' => 'Active', 'Deactive' => 'Deactive'], 'type' => 'string', 'example' => 'Active', 'title' => '', ], 'MediaTotal' => ['description' => 'The total number of media assets.', 'type' => 'string', 'example' => '12', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\",\\n \\"IndexType\\": \\"mm\\",\\n \\"IndexStatus\\": \\"Active\\",\\n \\"MediaTotal\\": \\"12\\"\\n}","type":"json"}]', 'title' => 'QuerySearchIndex', 'changeSet' => [ ['createdAt' => '2023-11-22T08:19:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySearchIndex'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:QuerySearchIndex', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'QuerySearchLib' => [ 'summary' => 'Gets information about a search library.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'SearchLibName' => ['description' => 'The name of the search library.', 'type' => 'string', 'example' => 'test1', 'title' => ''], 'Status' => [ 'description' => 'The status of the search library.', 'enumValueTitles' => ['normal' => 'The search library is in the normal state.', 'deleting' => 'The search library is being deleted.', 'deleteFail' => 'Failed to delete the search library.'], 'type' => 'string', 'example' => 'normal', 'title' => '', ], 'IndexInfo' => [ 'description' => 'The index information.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IndexType' => ['description' => 'The index type. Valid values:'."\n" ."\n" .'- mm: Large language model (LLM).'."\n" ."\n" .'- face: Face recognition.'."\n" ."\n" .'- aiLabel: Smart tagging.', 'type' => 'string', 'example' => 'face', 'title' => ''], 'IndexStatus' => ['description' => 'The status of the index. Valid values:'."\n" ."\n" .'- Active: The index is active.'."\n" ."\n" .'- Deactive: The index is inactive.', 'type' => 'string', 'example' => 'Active', 'title' => ''], 'IndexReadiness' => ['description' => 'The readiness status of the index. Valid values:'."\n" ."\n" .'- Initializing: The index is being initialized.'."\n" ."\n" .'- Normal: The index is ready.'."\n" ."\n" .'- Fail: The index failed to be created.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SearchLibConfig' => ['description' => 'The search library configuration.', 'type' => 'string', 'title' => '', 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\",\\n \\"Status\\": \\"normal\\",\\n \\"IndexInfo\\": [\\n {\\n \\"IndexType\\": \\"face\\",\\n \\"IndexStatus\\": \\"Active\\",\\n \\"IndexReadiness\\": \\"Normal\\"\\n }\\n ],\\n \\"SearchLibConfig\\": \\"{\\\\\\"faceGroupIds\\\\\\":\\\\\\"xxx1,xxx2,xx3\\\\\\"}\\"\\n}","type":"json"}]', 'title' => 'Query Search Library', 'changeSet' => [ ['createdAt' => '2024-12-24T02:50:22.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-22T08:19:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySearchLib'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:QuerySearchLib', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'QuerySmarttagJob' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the smart tagging job. You can obtain this ID from the response to the [SubmitSmarttagJob](~~478786~~) call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '88c6ca184c0e47098a5b665e2****', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'Additional request parameters, formatted as a JSON string. For example: `{"labelResultType":"auto"}`. The `labelResultType` parameter supports the following values:'."\n" ."\n" .'- `auto`: machine-generated tagging results'."\n" ."\n" .'- `hmi`: human-in-the-loop tagging results', 'type' => 'string', 'required' => false, 'example' => '{"labelResultType":"auto"} '."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'JobStatus' => ['description' => 'The job status. Valid values:'."\n" ."\n" .'- **Success**: The job was successful.'."\n" ."\n" .'- **Fail**: The job failed.'."\n" ."\n" .'- **Processing**: The job is in progress.'."\n" ."\n" .'- **Submitted**: The job is queued for processing.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'UserData' => ['description' => 'The custom data passed through the MNS callback. For details on the message format, see the callback message format definitions below.', 'type' => 'string', 'example' => '{"userId":"123432412831"}', 'title' => ''], 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Result' => [ 'description' => 'An array of analysis result objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the analysis result.'."\n" ."\n" .'- [ ] \\- Analysis result types for Tagging v1.0:'."\n" ."\n" .'1. TextLabel: text labels'."\n" ."\n" .'2. VideoLabel: video labels'."\n" ."\n" .'3. ASR: Raw results from automatic speech recognition. This is not returned by default.'."\n" ."\n" .'4. OCR: Raw results from optical character recognition. This is not returned by default.'."\n" ."\n" .'5. NLP: Results from natural language processing. This is not returned by default.'."\n" ."\n" .'- [ ] \\- Analysis result types for Tagging v2.0:'."\n" ."\n" .'1. CPVLabel'."\n" ."\n" .'2. Meta: Metadata such as the video title. This is not returned by default.'."\n" ."\n" .'- [ ] \\- Analysis result types for Tagging v2.0-custom:'."\n" ."\n" .'1. CPVLabel'."\n" ."\n" .'2. Meta: Metadata such as the video title. This is not returned by default.', 'type' => 'string', 'example' => 'Meta', 'title' => ''], 'Data' => ['description' => 'The analysis result data, formatted as a JSON string. The data structure depends on the `Type` value. For more information, see the `Result` parameter descriptions below.', 'type' => 'string', 'example' => '{"title":"example-title-****"} '."\n", 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Usages' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Usage' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Quota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'QuerySmarttagJob', 'summary' => 'Querying a smart tag task.', 'responseParamsDescription' => '**Callback message format**'."\n" .'When the execution status of a smart tag job changes, MPS sends a callback message to a queue you specify using the MPS UpdatePipeline API. The message body is a JSON string containing the following fields:'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------- | ------ | -------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | A fixed string with the value `smarttag`, indicating a smart tag job. |'."\n" .'| JobId | string | The unique ID of the job. |'."\n" .'| State | string | The current state of the job. This value matches the `JobStatus` returned by the `QuerySmarttagJob` operation. |'."\n" .'| State | string | The current state of the job. This value matches the `JobStatus` returned by the `QuerySmarttagJob` operation. |'."\n" .'| UserData | string | The user data passed to the `SubmitSmarttagJob` operation. |'."\n" .'| UserData | string | The user data passed to the `SubmitSmarttagJob` operation. |'."\n" ."\n" .'**Result parameters**'."\n" ."\n" .'**VideoLabel** data structure'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| persons | JSONArray | An array of objects, each representing a detected person. |'."\n" .'| persons.name | String | The name of the recognized person. |'."\n" .'| persons.category | String | The person\'s category. Possible values are: `celebrity`, `politician`, `sensitive` (sensitive person), and `unknown` (unknown person). For a person from a custom person library, this field contains the library\'s ID. |'."\n" .'| persons.ratio | double | The person\'s appearance ratio. The value ranges from 0 to 1. |'."\n" .'| persons.occurrences | JSONArray | An array of objects, each detailing an occurrence of the person. |'."\n" .'| persons.occurrences.score | double | The confidence score for the recognition. |'."\n" .'| persons.occurrences.from | double | The start time of the person\'s appearance, in seconds. |'."\n" .'| persons.occurrences.to | double | The end time of the person\'s appearance, in seconds. |'."\n" .'| persons.occurrences.position | JSONObject | The face coordinates. |'."\n" .'| persons.occurrences.position.leftTop | int[] | The x and y coordinates of the top-left corner of the face\'s bounding box. |'."\n" .'| persons.occurrences.position.rightBottom | int[] | The x and y coordinates of the bottom-right corner of the face\'s bounding box. |'."\n" .'| persons.occurrences.timestamp | double | The timestamp, in seconds, corresponding to the face coordinates. |'."\n" .'| persons.occurrences.scene | String | The shot type. Possible values are: `closeUp` (close-up shot), `medium-closeUp` (medium close-up shot), `medium` (medium shot), and `medium-long` (medium-long shot). |'."\n" .'| tags | JSONArray | An array of objects representing detected tags, such as objects and scenes. See the table below for examples. |'."\n" .'| tags.mainTagName | String | The main tag. |'."\n" .'| tags.subTagName | String | The sub-tag. |'."\n" .'| tags.ratio | double | The tag\'s appearance ratio. The value ranges from 0 to 1. |'."\n" .'| tags.occurrences | JSONArray | An array of objects, each detailing an occurrence of the tag. |'."\n" .'| tags.occurrences.score | double | The confidence score for the tag. |'."\n" .'| tags.occurrences.from | double | The start time of the occurrence, in seconds. |'."\n" .'| tags.occurrences.to | double | The end time of the occurrence, in seconds. |'."\n" .'| classifications | JSONArray | An array of objects, each representing a video classification. |'."\n" .'| classifications.score | double | The confidence score for the classification. |'."\n" .'| classifications.category1 | String | The level-1 category, such as Lifestyle, Anime, or Automotive. |'."\n" .'| classifications.category2 | String | The level-2 category, a sub-category of the level-1 category. For example, the Lifestyle category includes sub-categories like Health or Home. |'."\n" ."\n" .'Video tags: examples'."\n" ."\n" .'| Tag | Examples |'."\n" .'| --------- | -------------------------------------------------------------------------------------------- |'."\n" .'| program | "Where Are We Going, Dad?", "Top Funny Comedian" |'."\n" .'| character | doctor, nurse, teacher |'."\n" .'| object | piano, cup, table, scrambled eggs with tomatoes, car, cosmetics |'."\n" .'| logo | CCTV-1, CCTV-2, Youku, Dragon TV |'."\n" .'| action | dancing, kissing, hugging, meeting, singing, making a phone call, horseback riding, fighting |'."\n" .'| location | Tiananmen Square, the Statue of Liberty, Leshan Giant Buddha, China, the United States |'."\n" .'| scene | bedroom, subway station, terraced fields, beach, desert |'."\n" ."\n" .'**ImageLabel** data structure'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| persons | JSONArray | An array of objects, each representing a detected person. |'."\n" .'| persons.name | String | The name of the recognized person. |'."\n" .'| persons.category | String | The person category. Valid values are `celebrity`, `politician`, and `sensitive`. |'."\n" .'| persons.score | double | The confidence score for the detected person. |'."\n" .'| persons.position | JSONObject | The face coordinates. |'."\n" .'| persons.position.leftTop | int[] | The x and y coordinates for the top-left corner of the bounding box. |'."\n" .'| persons.position.rightBottom | int[] | The x and y coordinates for the bottom-right corner of the bounding box. |'."\n" .'| persons.scene | String | The camera shot. Valid values include: `closeUp` (close-up), `medium-closeUp` (medium close-up), `medium` (medium shot), and `medium-long` (medium-long shot). |'."\n" .'| tags | JSONArray | Tags for detected objects and scenes. For more information, see the examples in the table below. |'."\n" .'| tags.mainTagName | String | The main tag. |'."\n" .'| tags.subTagName | String | The sub-tag. |'."\n" .'| tags.score | double | The confidence score for the tag. |'."\n" ."\n" .'Image tag examples'."\n" ."\n" .'| Main tag | Sub-tag |'."\n" .'| --------- | -------------------------------------------------------------------------------------------------- |'."\n" .'| character | e.g., doctor, nurse, teacher |'."\n" .'| location | e.g., Tiananmen Square, the Statue of Liberty, Leshan Giant Buddha, China, United States |'."\n" .'| action | e.g., speaking |'."\n" .'| logo | e.g., CCTV1, CCTV2, Youku, Dragon TV |'."\n" .'| action | e.g., dancing, kissing, hugging, meeting, singing, making a phone call, horseback riding, fighting |'."\n" .'| object | e.g., piano, cup, table, scrambled eggs with tomatoes, car, cosmetics |'."\n" .'| scene | e.g., bedroom, subway station, terraced fields, beach, desert |'."\n" ."\n" .'The TextLabel Data Structure (Source: ASR and OCR)'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------- | --------- | -------------------------------------------------------------- |'."\n" .'| tags | JSONArray | A list of tags for the resource. |'."\n" .'| tags.name | String | The key of the tag. |'."\n" .'| tags.value | String | The value of the tag. Use a comma to separate multiple values. |'."\n" ."\n" .'Example image tags'."\n" ."\n" .'| Parameter | Value |'."\n" .'| ------------ | -------------------------------------------------------------------------------------------- |'."\n" .'| region | Examples: Tiananmen Square, the Statue of Liberty, Leshan Giant Buddha, China, United States |'."\n" .'| organization | Examples: China Wildlife Conservation Association, China Media Group |'."\n" .'| logo | Examples: Nike, Li-Ning |'."\n" .'| keyword | Example: core strength |'."\n" ."\n" .'**CPVLabel** data structure'."\n" ."\n" .'- `cates`: Hierarchical categories (e.g., level-1, level-2, and level-3).'."\n" ."\n" .'- `entities`: Category attributes (enriched with knowledge graph information).'."\n" ."\n" .'- `hotwords`: Popular keywords (terms reflecting user interest).'."\n" ."\n" .'- `freeTags`: Free-form tags (user-defined keywords).'."\n" ."\n" .'| Parameter | Type | Example value | Description |'."\n" .'| --------------------------------------- | --------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| type | String | hmi | The result type. Valid values: `hmi` (human-machine interaction result) and `autp` (automated tagging result). |'."\n" .'| cates | JSONArray | \\- | The category classification results. |'."\n" .'| cates.labelLevel1 | String | Travel | The level-1 label. |'."\n" .'| cates.labelLevel2 | String | Travel Scenery | The level-2 label. |'."\n" .'| cates.label | String | "" | The label name. The algorithm may return an empty string. |'."\n" .'| cates.appearanceProbability | double | 0.96 | The appearance probability. |'."\n" .'| cates.detailInfo | JSONArray | \\- | Detailed information about the category. |'."\n" .'| cates.detailInfo.score | double | 0.9 | The confidence score. |'."\n" .'| cates.detailInfo.startTime | double | 0.021 | The start time. |'."\n" .'| cates.detailInfo.endTime | double | 29.021 | The end time. |'."\n" .'| entities | JSONArray | \\- | Detected entities. |'."\n" .'| entities.labelLevel1 | String | Region | The level-1 label. |'."\n" .'| entities.labelLevel2 | String | Landmark | The level-2 label. |'."\n" .'| entities.label | String | Huangguoshu Waterfall | The label name. |'."\n" .'| entities.appearanceProbability | double | 0.067 | The appearance probability. |'."\n" .'| entities.knowledgeInfo | String | {"name": "黄果树瀑布", "nameEn": "Huangguoshu Waterfall", "description": "亚洲四大瀑布之一"} | Information from the knowledge graph. For a complete list of fields, refer to the tables for the following knowledge graph types: film and television IP, music, person, landmark, and object. |'."\n" .'| entities.detailInfo | JSONArray | \\- | Detailed information about the entity. |'."\n" .'| entities.detailInfo.score | double | 0.33292606472969055 | The confidence score. |'."\n" .'| entities.detailInfo.startTime | double | 6.021 | The start time. |'."\n" .'| entities.detailInfo.endTime | double | 8.021 | The end time. |'."\n" .'| entities.detailInfo.trackData | JSONArray | \\- | The structured information of the entity label. |'."\n" .'| entities.detailInfo.trackData.score | double | 0.32 | The confidence score. |'."\n" .'| entities.detailInfo.trackData.bbox | integer[] | 23，43，45，67 | The bounding box coordinates. |'."\n" .'| entities.detailInfo.trackData.timestamp | double | 7.9 | The timestamp. |'."\n" .'| hotwords | JSONArray | \\- | Detected hotwords. |'."\n" .'| hotwords.labelLevel1 | String | keyword | The level-1 label. |'."\n" .'| hotwords.labelLevel1 | String | keyword | The level-1 label. |'."\n" .'| hotwords.labelLevel2 | String | "" | The level-2 label. |'."\n" .'| hotwords.label | String | 中国气象局 | The hotword content. |'."\n" .'| hotwords.appearanceProbability | double | 0.96 | The appearance probability. |'."\n" .'| hotwords.detailInfo | JSONArray | | Detailed information about the hotword. |'."\n" .'| hotwords.detailInfo.score | double | 1.0 | The confidence score. |'."\n" .'| hotwords.detailInfo.startTime | double | 0.021 | The start time. |'."\n" .'| hotwords.detailInfo.endTime | double | 29.021 | The end time. |'."\n" .'| freeTags | JSONArray | | The free-form tags. |'."\n" .'| freeTags.labelLevel1 | String | keyword | The level-1 label. |'."\n" .'| freeTags.labelLevel2 | String | "" | The level-2 label. |'."\n" .'| freeTags.label | String | 中央气象台 | The tag content. |'."\n" .'| freeTags.appearanceProbability | double | 0.96 | The appearance probability. |'."\n" .'| freeTags.detailInfo | JSONArray | | Detailed information about the free-form tag. |'."\n" .'| freeTags.detailInfo.score | double | 0.9 | The confidence score. |'."\n" .'| freeTags.detailInfo.startTime | double | 0.021 | The start time. |'."\n" .'| freeTags.detailInfo.endTime | double | 29.021 | The end time. |'."\n" ."\n" .'**ASR result**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------------- | --------- | -------------------------------------------------- |'."\n" .'| details | JSONArray | Detailed task results. |'."\n" .'| details.from | double | Start timestamp of the speech segment, in seconds. |'."\n" .'| details.to | double | End timestamp of the speech segment, in seconds. |'."\n" .'| details.content | String | Transcribed text from the speech segment. |'."\n" ."\n" .'**OCR results**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------------------------------- | ---------- | -------------------------------------------------------------------------------------------- |'."\n" .'| details | JSONArray | An array of objects containing the task details. |'."\n" .'| details.timestamp | double | The timestamp, in seconds. |'."\n" .'| details.info | JSONArray | An array of objects, each containing recognized information for the corresponding timestamp. |'."\n" .'| details.info.score | double | The confidence score. |'."\n" .'| details.info.position | JSONObject | The text coordinates. |'."\n" .'| details.info.position.leftTop | int[] | The coordinates of the top-left corner. |'."\n" .'| details.info.position.rightBottom | int[] | The coordinates of the bottom-right corner. |'."\n" .'| details.info.content | String | The recognized text content. |'."\n" ."\n" .'**Meta annotation results**'."\n" ."\n" .'> If you do not use human annotation and you specify the `needMetaData` parameter when submitting a task with [SubmitSmarttagJob](~~478786~~), `QuerySmarttagJob` will return the original `title` that you entered.'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------- | ------ | ----------- |'."\n" .'| title | String | The title. |'."\n" ."\n" .'**Subtitle extraction results**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| -------------------- | --------- | -------------------------------------------------------------------------------------------------- |'."\n" .'| details | JSONArray | Detailed results of the task. |'."\n" .'| details.allResultUrl | String | URL for all subtitle results. The URL is valid for six months after the task is completed. |'."\n" .'| details.chResultUrl | String | URL for the Chinese subtitle results. The URL is valid for six months after the task is completed. |'."\n" .'| details.engResultUrl | String | URL for the English subtitle results. The URL is valid for six months after the task is completed. |'."\n" ."\n" .'> The subtitle result URL returns content in the following format: `sequence number + time range + subtitle content (one subtitle per line)`.'."\n" ."\n" .'**NLP results**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ----------------- | ------ | ----------------------------------------- |'."\n" .'| transcription | object | The speech-to-text output. |'."\n" .'| autoChapters | object | The automatically generated chapters. |'."\n" .'| summarization | object | The summary generated by the large model. |'."\n" .'| meetingAssistance | object | The intelligent meeting minutes. |'."\n" .'| translation | object | The translated text. |'."\n" ."\n" .'**Transcription**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ----------------------------------------------- | ------ | ------------------------------------------------------------------------------------ |'."\n" .'| transcription | object | The speech transcription result. |'."\n" .'| transcription.paragraphs | list[] | A list of paragraphs in the speech transcription. |'."\n" .'| transcription.paragraphs[i].paragraphId | string | The paragraph-level ID. |'."\n" .'| transcription.paragraphs[i].speakerId | string | The speaker ID. |'."\n" .'| transcription.paragraphs[i].words | list[] | A list of words in the paragraph. |'."\n" .'| transcription.paragraphs[i].words[i].id | int | The sequence number of the word. This field can typically be ignored. |'."\n" .'| transcription.paragraphs[i].words[i].sentenceId | int | The sentence ID. Words with the same sentenceId form a sentence. |'."\n" .'| transcription.paragraphs[i].words[i].start | long | The start time of the word, in milliseconds, relative to the beginning of the audio. |'."\n" .'| transcription.paragraphs[i].words[i].end | long | The end time of the word, in milliseconds, relative to the beginning of the audio. |'."\n" .'| transcription.paragraphs[i].words[i].text | string | The text of the word. |'."\n" ."\n" .'**Summarization: full-text summary, speaker summary, and question summary**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------------------------------------------- | ------------ | ---------------------------------------------------------------------------------------------- |'."\n" .'| summarization | object | The summary result object, which can contain results for multiple summary types. |'."\n" .'| summarization.paragraphSummary | string | The paragraph summary result. |'."\n" .'| summarization.conversationalSummary | list[] | A list of conversational summary results. |'."\n" .'| summarization.conversationalSummary[i].speakerId | string | The ID of the speaker. |'."\n" .'| summarization.conversationalSummary[i].speakerName | string | The name of the speaker. |'."\n" .'| summarization.conversationalSummary[i].summary | string | The summary for the speaker. |'."\n" .'| summarization.questionsAnsweringSummary | list[] | A list of question-answering summary results. |'."\n" .'| summarization.questionsAnsweringSummary[i].question | string | The question extracted from the speech transcription. |'."\n" .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfQuestion | list[] | IDs of sentences from the original speech transcription that form the question. |'."\n" .'| summarization.questionsAnsweringSummary[i].answer | string | The answer to the question. |'."\n" .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfAnswer | list[] | The IDs of sentences from the original speech transcription that are summarized in the answer. |'."\n" .'| summarization.mindMapSummary | list[object] | A list of mind map summary results, which may include topic summaries and their relationships. |'."\n" .'| summarization.mindMapSummary[i].title | string | The title of the mind map. |'."\n" .'| summarization.mindMapSummary[i].topic | list[object] | A list of the main topics, each with their respective sub-topics. |'."\n" .'| summarization.mindMapSummary[i].topic[i].title | string | The topic title. |'."\n" .'| summarization.mindMapSummary[i].topic[i].topic | list[object] | A list of sub-topics for the current topic, which can be empty. |'."\n" ."\n" .'**Full-text translation**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- |'."\n" .'| translation | object | The translation object. |'."\n" .'| translation.paragraphs | list[] | A list of translated paragraphs, corresponding to the speech recognition result. |'."\n" .'| translation.paragraphs.paragraphId | string | The paragraph ID, which corresponds to the `ParagraphId` from the speech recognition result. |'."\n" .'| translation.paragraphs.sentences | list[] | The sentences that make up the paragraph. |'."\n" .'| translation.paragraphs.sentences[i].sentenceId | long | The unique ID for the sentence. |'."\n" .'| translation.paragraphs.sentences[i].start | long | The start time of the sentence in milliseconds, relative to the beginning of the audio. |'."\n" .'| translation.paragraphs.sentences[i].end | long | The end time of the sentence in milliseconds, relative to the beginning of the audio. |'."\n" .'| translation.paragraphs.sentences[i].text | string | The translated text of the sentence. |'."\n" ."\n" .'**autoChapters (chapter recognition)**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ------------------------ | ------ | --------------------------------------------------------------------------------------------------- |'."\n" .'| autoChapters | list[] | A list of chapter overview objects. |'."\n" .'| autoChapters[i].id | int | Chapter ID. |'."\n" .'| autoChapters[i].start | long | The start time of the chapter, as a relative timestamp in milliseconds from the start of the audio. |'."\n" .'| autoChapters[i].end | long | The end time of the chapter, as a relative timestamp in milliseconds from the start of the audio. |'."\n" .'| autoChapters[i].headline | string | Chapter headline. |'."\n" .'| autoChapters[i].summary | string | Chapter summary. |'."\n" ."\n" .'**meetingAssistance (summary, keyword, key sentence, and action item extraction)**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| -------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------ |'."\n" .'| meetingAssistance | object | The intelligent minutes results object, which may contain zero or more results of various types. |'."\n" .'| meetingAssistance.keywords | list[] | The keyword extraction results. |'."\n" .'| meetingAssistance.keySentences | list[] | The key sentence extraction results, also known as key content. |'."\n" .'| meetingAssistance.keySentences[i].id | long | The ID of the key sentence. |'."\n" .'| meetingAssistance.keySentences[i].sentenceId | long | The ID of the corresponding sentence in the original ASR transcription. |'."\n" .'| meetingAssistance.keySentences[i].start | long | The start time relative to the beginning of the audio, in milliseconds. |'."\n" .'| meetingAssistance.keySentences[i].end | long | The end time relative to the beginning of the audio, in milliseconds. |'."\n" .'| meetingAssistance.keySentences[i].text | string | The text of the key sentence. |'."\n" .'| meetingAssistance.actions | list[] | A list of action items. |'."\n" .'| meetingAssistance.actions[i].id | long | The ID of the action item. |'."\n" .'| meetingAssistance.actions[i].sentenceId | long | The ID of the corresponding sentence in the original ASR transcription. |'."\n" .'| meetingAssistance.actions[i].start | long | The start time relative to the beginning of the audio, in milliseconds. |'."\n" .'| meetingAssistance.actions[i].end | long | The end time relative to the beginning of the audio, in milliseconds. |'."\n" .'| meetingAssistance.actions[i].text | string | The text of the action item. |'."\n" .'| meetingAssistance.classifications | object | The scene classification results. Currently, only three scene types are supported. |'."\n" .'| meetingAssistance.classifications.interview | float | The confidence score for the interview scene. |'."\n" .'| meetingAssistance.classifications.lecture | float | The confidence score for the lecture scene. |'."\n" .'| meetingAssistance.classifications.meeting | float | The confidence score for the meeting scene. |', 'changeSet' => [ ['createdAt' => '2025-12-23T02:17:40.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-08-25T12:28:16.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmarttagJob'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:QuerySmarttagJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"UserData\\": \\"{\\\\\\"userId\\\\\\":\\\\\\"123432412831\\\\\\"}\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Type\\": \\"Meta\\",\\n \\"Data\\": \\"{\\\\\\"title\\\\\\":\\\\\\"example-title-****\\\\\\"}\\\\t\\\\n\\"\\n }\\n ]\\n },\\n \\"Usages\\": {\\n \\"Usage\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Quota\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'QueryTraceAbJobList' => [ 'summary' => 'Queries A/B watermarking jobs.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID. You can obtain the value of this parameter from the response of the SubmitTraceAbJob operation.', 'type' => 'string', 'required' => false, 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], [ 'name' => 'TraceMediaId', 'in' => 'query', 'schema' => ['description' => 'The media ID for the trace watermark. You can obtain this from the response of the SubmitTraceAbJob operation.', 'type' => 'string', 'required' => false, 'example' => '****437bd2b51105d07b12a9****', 'title' => ''], ], [ 'name' => 'CreateTimeStart', 'in' => 'query', 'schema' => ['description' => 'The start of the creation time range for the query, 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 range for the query, in UNIX timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1627357325', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.', 'type' => 'array', 'items' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The creation time of the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322', 'title' => ''], 'GmtModified' => ['description' => 'The last modification time of the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322', 'title' => ''], 'Input' => [ 'description' => 'Information about the input video for watermarking.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: an Object Storage Service (OSS) object.'."\n" ."\n" .'2. Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The specific input file information.', 'type' => 'string', 'example' => 'oss://bucket/object', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Output' => [ 'description' => 'Information about the output path for the A/B stream.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid values:'."\n" ."\n" .'1. OSS: an OSS object.'."\n" ."\n" .'2. Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The output directory.', 'type' => 'string', 'example' => 'oss://bucket/dir/', 'title' => ''], ], 'title' => '', 'example' => '', ], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021eff90', 'title' => ''], 'Level' => ['description' => 'The watermark level.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'TraceMediaId' => ['description' => 'The media ID for the trace watermark.', 'type' => 'string', 'title' => '', 'example' => '****437bd2b51105d07b12a9****'], 'Result' => ['description' => 'The job result.', 'type' => 'string', 'example' => '{"Code":"success","Message":"ok"}', 'title' => ''], 'Status' => ['description' => 'The status of the job.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '123', 'title' => ''], 'UserId' => ['description' => 'The ID of the user who initiated the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '13466932****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357322,\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/dir/\\"\\n },\\n \\"JobId\\": \\"bfb786c639894f4d80648792021eff90\\",\\n \\"Level\\": 2,\\n \\"TraceMediaId\\": \\"****437bd2b51105d07b12a9****\\",\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', 'title' => 'QueryTraceAbJobList', 'description' => '- This operation is supported only in the China (Shanghai) and China (Beijing) regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceAbJobList'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:QueryTraceAbJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'manual', ], 'QueryTraceExtractJob' => [ 'summary' => 'Queries a job for extracting a trace watermark.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID. You can obtain the value of this parameter from the response of the SubmitTraceExtractJob operation.', 'type' => 'string', 'required' => true, 'example' => '31fa3c9ca8134fb4b0b0f7878301****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Trace' => ['description' => 'The trace watermark information.', 'type' => 'string', 'title' => '', 'example' => '测试溯源水印'], ], 'example' => '', ], 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Trace\\": \\"测试溯源水印\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', 'title' => 'QueryTraceExtractJob', 'description' => 'This operation is supported only in the China (Shanghai) and China (Beijing) regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceExtractJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:QueryTraceExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'manual', ], 'QueryTraceM3u8JobList' => [ 'summary' => 'Queries jobs for generating M3U8 files containing specific trace watermark information.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'CreateTimeStart', 'in' => 'query', 'schema' => ['description' => 'The start of the creation time range for the query, 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 range for the query, in UNIX timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1627357325', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID. You can obtain the value of this parameter from the response of the SubmitTraceM3u8Job operation.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.', 'type' => 'array', 'items' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'GmtCreate' => ['description' => 'The creation time of the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322', 'title' => ''], 'GmtModified' => ['description' => 'The last modification time of the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1627357322', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****d718e2ff4f018ccf419a7b71****', 'title' => ''], 'TraceMediaId' => ['description' => 'The media ID for the trace watermark.', 'type' => 'string', 'example' => '****437bd2b105d07b12a9a82****', 'title' => ''], 'Output' => [ 'description' => 'The output video.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid values:'."\n" ."\n" .'- OSS: an OSS object.'."\n" ."\n" .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The specific output information.', 'type' => 'string', 'example' => 'oss://bucket/object', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Status' => ['description' => 'The current status of the job.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Trace' => ['description' => 'The watermark information.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '112', 'title' => ''], 'UserId' => ['description' => 'The ID of the user who initiated the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '1346693276****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357322,\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\",\\n \\"TraceMediaId\\": \\"****437bd2b105d07b12a9a82****\\",\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Status\\": \\"success\\",\\n \\"Trace\\": \\"test\\",\\n \\"UserData\\": \\"112\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"Message\\": \\"ok\\",\\n \\"StatusCode\\": 200,\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'QueryTraceM3u8JobList', 'description' => '- This operation is supported only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" .'- The M3U8 file with absolute paths generated by the SubmitTraceM3u8Job API has a signed URL with an authentication validity period of 24 hours, starting from the moment the job is completed. After the signature expires, the M3U8 file will become inaccessible. You must submit a new M3U8 generation job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceM3u8JobList'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:QueryTraceM3u8JobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'manual', ], 'QueryVideoCognitionJob' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the intelligent tagging job. You can obtain this ID from the response of the [SubmitIntelligentTaggingJob](~~478786~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'Additional request parameters, specified as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'IncludeResults', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A container for parameters that determine which algorithm results to include in the response.', 'type' => 'object', 'properties' => [ 'NeedAsr' => ['description' => 'Specifies whether to return the ASR results.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'NeedOcr' => ['description' => 'Specifies whether to return the OCR results.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'NeedProcess' => ['description' => 'Specifies whether to return a link to the raw operator results.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ '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 in progress.'."\n" ."\n" .'- **Submitted**: The job has been submitted and is awaiting processing.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'."\n", 'title' => ''], 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => '{"userId":"123432412831"}'."\n", 'title' => ''], 'Results' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'result' => [ 'description' => 'An array of analysis result objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the analysis result. Valid values:'."\n" ."\n" .'1. TextLabel: text label'."\n" ."\n" .'2. VideoLabel: video label'."\n" ."\n" .'3. ASR: raw ASR result (not returned by default)'."\n" ."\n" .'4. OCR: raw OCR result (not returned by default)'."\n" ."\n" .'5. NLP: raw NLP result (not returned by default)'."\n" ."\n" .'6. Process: URL to the raw operator result (not returned by default)', 'type' => 'string', 'example' => 'ASR', 'title' => ''], 'Data' => ['description' => 'The analysis result data, formatted as a JSON string. The data structure varies based on the Type value. For more information, see the descriptions of the Result parameter.', 'type' => 'string', 'example' => '{"title":"example-title-****"} '."\n", 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => ''], 'Params' => ['description' => 'The request parameters.', 'type' => 'string', 'title' => '', 'example' => ''], 'Input' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid value: OSS.', 'type' => 'string', 'title' => '', 'example' => ''], 'Media' => ['description' => 'The URL of the input file.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'description' => 'The input file.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'QueryVideoCognitionJob', 'summary' => 'Querying video understanding task results', 'responseParamsDescription' => '**Result parameter**'."\n" ."\n" .'**VideoLabel** data structure'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| persons | JSONArray | A list of detected persons. |'."\n" .'| persons.name | String | The name of the recognized person. |'."\n" .'| persons.category | String | The category of the person. Possible values: `celebrity`, `politician`, `sensitive`, and `unknown`. If recognized from a custom figure library, this field returns the library\'s ID. |'."\n" .'| persons.ratio | double | The occurrence rate of the person, ranging from 0 to 1. |'."\n" .'| persons.occurrences | JSONArray | A list of the person\'s occurrences. |'."\n" .'| persons.occurrences.score | double | The confidence score. |'."\n" .'| persons.occurrences.from | double | The start time of the person\'s occurrence, in seconds. |'."\n" .'| persons.occurrences.to | double | The end time of the person\'s occurrence, in seconds. |'."\n" .'| persons.occurrences.position | JSONObject | The face coordinates. |'."\n" .'| persons.occurrences.position.leftTop | int[] | The x and y coordinates of the top-left corner. |'."\n" .'| persons.occurrences.position.rightBottom | int[] | The x and y coordinates of the bottom-right corner. |'."\n" .'| persons.occurrences.timestamp | double | The timestamp of the face coordinates, in seconds. |'."\n" .'| persons.occurrences.scene | String | The camera shot type. Possible values: `closeUp` (close-up), `medium-closeUp` (medium close-up), `medium` (medium shot), and `medium-long` (medium-long shot). |'."\n" .'| tags | JSONArray | A list of tags for detected elements, such as objects and scenes. |'."\n" .'| tags.mainTagName | String | The main tag. |'."\n" .'| tags.subTagName | String | The subtag. |'."\n" .'| tags.ratio | double | The occurrence rate of the tag, ranging from 0 to 1. |'."\n" .'| tags.occurrences | JSONArray | A list of the tag\'s occurrences. |'."\n" .'| tags.occurrences.score | double | The confidence score. |'."\n" .'| tags.occurrences.from | double | The start time of the occurrence, in seconds. |'."\n" .'| tags.occurrences.to | double | The end time of the occurrence, in seconds. |'."\n" .'| classifications | JSONArray | A list of video classifications. |'."\n" .'| classifications.score | double | The confidence score for the classification. |'."\n" .'| classifications.category1 | String | The primary category. For example: `Lifestyle`, `Animation`, or `Automotive`. |'."\n" .'| classifications.category2 | String | The secondary category. For example, a video with the `Lifestyle` primary category might have a secondary category of `Health` or `Home`. |'."\n" ."\n" .'Video Tag Examples'."\n" ."\n" .'| Category | Example |'."\n" .'| -------- | --------------------------------------------------------------------------------------------------- |'."\n" .'| program | e.g., *The Amazing Race* or *America\'s Got Talent* |'."\n" .'| role | e.g., doctor, nurse, or teacher |'."\n" .'| object | e.g., piano, cup, table, car, cosmetics, or food |'."\n" .'| logo | e.g., CNN, BBC, YouTube, or Netflix |'."\n" .'| action | e.g., dancing, kissing, hugging, meeting, singing, making a phone call, riding a horse, or fighting |'."\n" .'| location | e.g., Tiananmen Square, the Statue of Liberty, the Leshan Giant Buddha, China, or the United States |'."\n" .'| scene | e.g., a bedroom, subway station, terraced fields, beach, or desert |'."\n" ."\n" .'**ImageLabel** Data Structure'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| persons | JSONArray | The detected persons. |'."\n" .'| persons.name | String | The name of the recognized person. |'."\n" .'| persons.category | String | The person category. Valid values: `celebrity`, `politician`, and `sensitive person`. |'."\n" .'| persons.score | double | The confidence score for the person recognition. |'."\n" .'| persons.position | JSONObject | The bounding box of the detected person. |'."\n" .'| persons.position.leftTop | int[] | The x and y coordinates of the top-left corner of the bounding box. |'."\n" .'| persons.position.rightBottom | int[] | The x and y coordinates of the bottom-right corner of the bounding box. |'."\n" .'| persons.scene | String | The shot type. Valid values: `closeUp` (close-up), `medium-closeUp` (medium close-up), `medium` (medium shot), and `medium-long` (long shot). |'."\n" .'| tags | JSONArray | The detected tags for elements such as objects and scenes. See the table below for examples. |'."\n" .'| tags.mainTagName | String | The main tag. |'."\n" .'| tags.subTagName | String | The sub-tag. |'."\n" .'| tags.score | double | The confidence score. |'."\n" ."\n" .'Examples of image tags'."\n" ."\n" .'| Main tag name | Sub tag name |'."\n" .'| ------------- | ------------------------------------------------------------------------------------------------------- |'."\n" .'| character | such as doctor, nurse, or teacher |'."\n" .'| location | such as Tiananmen Square, the Statue of Liberty, the Leshan Giant Buddha, China, or the United States |'."\n" .'| action event | such as speaking |'."\n" .'| logo | such as CCTV-1, CCTV-2, Youku, or Dragon TV |'."\n" .'| action event | such as dancing, kissing, hugging, meeting, singing, making a phone call, horseback riding, or fighting |'."\n" .'| object | such as a piano, cup, table, scrambled eggs with tomatoes, car, or cosmetics |'."\n" .'| scene | such as a bedroom, subway station, terraced fields, beach, or desert |'."\n" ."\n" .'The `TextLabel` data structure (output from ASR and OCR)'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------- | --------- | ----------------------------------------------------------- |'."\n" .'| tags | JSONArray | An array of tags. |'."\n" .'| tags.name | String | The tag key. |'."\n" .'| tags.value | String | The tag value. Separate multiple values with a comma (`,`). |'."\n" ."\n" .'Examples of image tags'."\n" ."\n" .'| Parameter | Value |'."\n" .'| ------------ | --------------------------------------------------------------------- |'."\n" .'| region | e.g., us-east-1, eu-west-2, or ap-southeast-1 |'."\n" .'| organization | e.g., Marketing Department, Development Team, or Acme Corp |'."\n" .'| identifier | e.g., user-12345, prod-db-01, or f7b4c278-6e54-4a8f-8f9d-3e58a9c8b4e7 |'."\n" .'| keyword | e.g., database, billing, or error |'."\n" ."\n" .'**CPVLabel** data structure'."\n" ."\n" .'- `cates`: A list of categories (primary, secondary, or tertiary).'."\n" ."\n" .'- `entities`: A list of category attributes containing information from a knowledge graph.'."\n" ."\n" .'- `hotwords`: A list of popular terms.'."\n" ."\n" .'- `freeTags`: A list of free tags (keywords).'."\n" ."\n" .'| Parameter | Type | Example value | Description |'."\n" .'| --------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| type | String | hmi | The result type. Valid values: `hmi` (human-machine collaboration result) and `autp` (automated tagging result). |'."\n" .'| cates | JSONArray | \\- | An array of categorization results. |'."\n" .'| cates.labelLevel1 | String | Travel | The level-1 tag. |'."\n" .'| cates.labelLevel2 | String | Scenic Travel | The level-2 tag. |'."\n" .'| cates.label | String | "" | The tag name. This field may be empty if the algorithm does not return a value. |'."\n" .'| cates.appearanceProbability | double | 0.96 | The occurrence probability. |'."\n" .'| cates.detailInfo | JSONArray | \\- | An array of objects, each detailing an occurrence of the category. |'."\n" .'| cates.detailInfo.score | double | 0.9 | The confidence score. |'."\n" .'| cates.detailInfo.startTime | double | 0.021 | The start time. |'."\n" .'| cates.detailInfo.endTime | double | 29.021 | The end time. |'."\n" .'| entities | JSONArray | \\- | An array of detected entities. |'."\n" .'| entities.labelLevel1 | String | location | The level-1 tag. |'."\n" .'| entities.labelLevel2 | String | landmark | The level-2 tag. |'."\n" .'| entities.label | String | Huangguoshu Waterfall | The tag name. |'."\n" .'| entities.appearanceProbability | double | 0.067 | The occurrence probability. |'."\n" .'| entities.knowledgeInfo | String | {"name": "Huangguoshu Waterfall", "nameEn": "Huangguoshu Waterfall", "description": "One of the four major waterfalls in Asia"} | The knowledge graph information. For a complete list of fields, refer to the corresponding tables for Entertainment IPs, Music, Persons, Landmarks, and Objects. |'."\n" .'| entities.detailInfo | JSONArray | \\- | An array of objects, each detailing an occurrence of the entity. |'."\n" .'| entities.detailInfo.score | double | 0.33292606472969055 | The confidence score. |'."\n" .'| entities.detailInfo.startTime | double | 6.021 | The start time. |'."\n" .'| entities.detailInfo.endTime | double | 8.021 | The end time. |'."\n" .'| entities.detailInfo.trackData | JSONArray | \\- | An array of objects that contains structured tracking data for the entity. |'."\n" .'| entities.detailInfo.trackData.score | double | 0.32 | The confidence score. |'."\n" .'| entities.detailInfo.trackData.bbox | integer[] | 23, 43, 45, 67 | The bounding box. |'."\n" .'| entities.detailInfo.trackData.timestamp | double | 7.9 | The timestamp. |'."\n" .'| hotwords | JSONArray | \\- | An array of detected hotwords. |'."\n" .'| hotwords.labelLevel1 | String | keyword | The level-1 tag. |'."\n" .'| hotwords.labelLevel1 | String | keyword | The level-1 tag. |'."\n" .'| hotwords.labelLevel2 | String | "" | The level-2 tag. |'."\n" .'| hotwords.label | String | China Meteorological Administration | The hotword. |'."\n" .'| hotwords.appearanceProbability | double | 0.96 | The occurrence probability. |'."\n" .'| hotwords.detailInfo | JSONArray | | An array of objects, each detailing an occurrence of the hotword. |'."\n" .'| hotwords.detailInfo.score | double | 1.0 | The confidence score. |'."\n" .'| hotwords.detailInfo.startTime | double | 0.021 | The start time. |'."\n" .'| hotwords.detailInfo.endTime | double | 29.021 | The end time. |'."\n" .'| freeTags | JSONArray | | An array of detected free tags. |'."\n" .'| freeTags.labelLevel1 | String | keyword | The level-1 tag. |'."\n" .'| freeTags.labelLevel2 | String | "" | The level-2 tag. |'."\n" .'| freeTags.label | String | National Meteorological Center | The tag name. |'."\n" .'| freeTags.appearanceProbability | double | 0.96 | The occurrence probability. |'."\n" .'| freeTags.detailInfo | JSONArray | | An array of objects, each detailing an occurrence of the free tag. |'."\n" .'| freeTags.detailInfo.score | double | 0.9 | The confidence score. |'."\n" .'| freeTags.detailInfo.startTime | double | 0.021 | The start time. |'."\n" .'| freeTags.detailInfo.endTime | double | 29.021 | The end time. |'."\n" ."\n" .'**Automatic speech recognition (ASR) results**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------------- | --------- | ----------------------------- |'."\n" .'| details | JSONArray | Detailed results of the task. |'."\n" .'| details.from | double | Start timestamp, in seconds. |'."\n" .'| details.to | double | End timestamp, in seconds. |'."\n" .'| details.content | String | The recognized text. |'."\n" ."\n" .'**Text recognition (OCR) results**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------------------------------- | ---------- | ---------------------------------------------------------------- |'."\n" .'| details | JSONArray | Detailed task results. |'."\n" .'| details.timestamp | double | The timestamp, in seconds. |'."\n" .'| details.info | JSONArray | An array of recognition results for the corresponding timestamp. |'."\n" .'| details.info.score | double | The confidence score for the recognition. |'."\n" .'| details.info.position | JSONObject | Coordinates of the recognized text. |'."\n" .'| details.info.position.leftTop | int[] | The x and y coordinates of the top-left corner. |'."\n" .'| details.info.position.rightBottom | int[] | The x and y coordinates of the bottom-right corner. |'."\n" .'| details.info.content | String | The recognized text. |'."\n" ."\n" .'**Metadata Annotation Results**'."\n" ."\n" .'> If a customer specifies `needMetaData` in a [SubmitSmarttagJob](~~478786~~) call without using manual labeling, `QuerySmarttagJob` returns the original title.'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| --------- | ------ | ----------- |'."\n" .'| title | String | The title. |'."\n" ."\n" .'**Subtitle**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| -------------------- | --------- | -------------------------------------------------------------------------------------------- |'."\n" .'| details | JSONArray | Detailed task results. |'."\n" .'| details.allResultUrl | String | URL for all subtitle results. The URL is valid for six months after task completion. |'."\n" .'| details.chResultUrl | String | URL for the Chinese subtitle results. The URL is valid for six months after task completion. |'."\n" .'| details.engResultUrl | String | URL for the English subtitle results. The URL is valid for six months after task completion. |'."\n" ."\n" .'> The content at the subtitle results URL uses the following format: `sequence number+time period+subtitle content (one subtitle per line)`.'."\n" ."\n" .'**NLP results**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ----------------- | ------ | ------------------------------------------ |'."\n" .'| transcription | object | The generated transcription. |'."\n" .'| autoChapters | object | The generated chapter overview. |'."\n" .'| summarization | object | The generated large model summary. |'."\n" .'| meetingAssistance | object | The generated intelligent meeting minutes. |'."\n" .'| translation | object | The generated text translation. |'."\n" ."\n" .'**Transcription**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ----------------------------------------------- | ------ | ----------------------------------------------------------------------- |'."\n" .'| transcription | object | The `transcription` result object. |'."\n" .'| transcription.paragraphs | list[] | A list of `paragraph` objects that make up the transcription. |'."\n" .'| transcription.paragraphs[i].paragraphId | string | The `paragraph` id. |'."\n" .'| transcription.paragraphs[i].speakerId | string | The `speaker` id. |'."\n" .'| transcription.paragraphs[i].words | list[] | A list of `word` objects in the `paragraph`. |'."\n" .'| transcription.paragraphs[i].words[i].id | int | The sequence number of the `word`. This field can typically be ignored. |'."\n" .'| transcription.paragraphs[i].words[i].sentenceId | int | The `sentence` id. Words with the same `sentenceId` form a sentence. |'."\n" .'| transcription.paragraphs[i].words[i].start | long | The start time of the `word` as a `relative timestamp` in milliseconds. |'."\n" .'| transcription.paragraphs[i].words[i].end | long | The end time of the `word` as a `relative timestamp` in milliseconds. |'."\n" .'| transcription.paragraphs[i].words[i].text | string | The text of the `word`. |'."\n" ."\n" .'**Summarization (full-text, speaker-based, and question-based)**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------ |'."\n" .'| summarization | object | The summary result object, which contains results for zero or more summary types. |'."\n" .'| summarization.paragraphSummary | string | The full-text summary. |'."\n" .'| summarization.conversationalSummary | list[] | A list of conversational summaries. |'."\n" .'| summarization.conversationalSummary[i].speakerId | string | The speaker ID. |'."\n" .'| summarization.conversationalSummary[i].speakerName | string | The speaker name. |'."\n" .'| summarization.conversationalSummary[i].summary | string | The summary for this speaker. |'."\n" .'| summarization.questionsAnsweringSummary | list[] | A list of Q&A summaries. |'."\n" .'| summarization.questionsAnsweringSummary[i].question | string | The question. |'."\n" .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfQuestion | list[] | A list of SentenceId values from the original transcription corresponding to the question. |'."\n" .'| summarization.questionsAnsweringSummary[i].answer | string | The answer to the question. |'."\n" .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfAnswer | list[] | A list of SentenceId values from the original transcription corresponding to the answer. |'."\n" .'| summarization.mindMapSummary | list[object] | A list of mind map summaries, which represent topic hierarchies. |'."\n" .'| summarization.mindMapSummary[i].title | string | The title of the mind map. |'."\n" .'| summarization.mindMapSummary[i].topic | list[object] | An array of top-level topics, each of which can contain subtopics. |'."\n" .'| summarization.mindMapSummary[i].topic[i].title | string | The title of the topic. |'."\n" .'| summarization.mindMapSummary[i].topic[i].topic | list[object] | An array of subtopics for the parent topic. This array can be empty. |'."\n" ."\n" .'**Translation**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ---------------------------------------------- | ------ | --------------------------------------------------------------------------------------------- |'."\n" .'| translation | object | The translation result object. |'."\n" .'| translation.paragraphs | list[] | A list of translated paragraphs corresponding to the speech recognition result. |'."\n" .'| translation.paragraphs.paragraphId | string | The paragraph ID, which corresponds to the `ParagraphId` in the speech recognition result. |'."\n" .'| translation.paragraphs.sentences | list[] | A list of sentence objects. |'."\n" .'| translation.paragraphs.sentences[i].sentenceId | long | The sentence ID. |'."\n" .'| translation.paragraphs.sentences[i].start | long | The start time of the sentence in milliseconds, relative to the beginning of the audio. |'."\n" .'| translation.paragraphs.sentences[i].end | long | The end time of the sentence in milliseconds, relative to the beginning of the audio. |'."\n" .'| translation.paragraphs.sentences[i].text | string | The translated text, which corresponds to the sentence text in the speech recognition result. |'."\n" ."\n" .'**autoChapters**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| ------------------------ | ------ | -------------------------------------------------------------------------------------------------- |'."\n" .'| autoChapters | list[] | A list of chapter overview objects. |'."\n" .'| autoChapters[i].id | int | The chapter ID. |'."\n" .'| autoChapters[i].start | long | The chapter\'s start time, as a relative timestamp in milliseconds from the beginning of the audio. |'."\n" .'| autoChapters[i].end | long | The chapter\'s end time, as a relative timestamp in milliseconds from the beginning of the audio. |'."\n" .'| autoChapters[i].headline | string | The chapter\'s headline. |'."\n" .'| autoChapters[i].summary | string | The chapter\'s summary. |'."\n" ."\n" .'**meetingAssistance (intelligent meeting summary extraction: keywords, key sentences, and action items)**'."\n" ."\n" .'| Parameter | Type | Description |'."\n" .'| -------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------- |'."\n" .'| meetingAssistance | object | A container for the meeting assistance results. This object can hold multiple result types or be empty. |'."\n" .'| meetingAssistance.keywords | list[] | The keyword extraction results. |'."\n" .'| meetingAssistance.keySentences | list[] | The key sentence extraction results, also known as key content. |'."\n" .'| meetingAssistance.keySentences[i].id | long | The ID of the key sentence. |'."\n" .'| meetingAssistance.keySentences[i].sentenceId | long | The ID of the corresponding sentence in the original ASR transcription. |'."\n" .'| meetingAssistance.keySentences[i].start | long | The start time in milliseconds, relative to the beginning of the audio. |'."\n" .'| meetingAssistance.keySentences[i].end | long | The end time in milliseconds, relative to the beginning of the audio. |'."\n" .'| meetingAssistance.keySentences[i].text | string | The key sentence text. |'."\n" .'| meetingAssistance.actions | list[] | A list of action items and action item summaries. |'."\n" .'| meetingAssistance.actions[i].id | long | The ID of the action item. |'."\n" .'| meetingAssistance.actions[i].sentenceId | long | The ID of the corresponding sentence in the original ASR transcription. |'."\n" .'| meetingAssistance.actions[i].start | long | The start time in milliseconds, relative to the beginning of the audio. |'."\n" .'| meetingAssistance.actions[i].end | long | The end time in milliseconds, relative to the beginning of the audio. |'."\n" .'| meetingAssistance.actions[i].text | string | The action item text. |'."\n" .'| meetingAssistance.classifications | object | The scene classification results. Currently, three scene classes are supported. |'."\n" .'| meetingAssistance.classifications.interview | float | The confidence score for the interview class. |'."\n" .'| meetingAssistance.classifications.lecture | float | The confidence score for the lecture class. |'."\n" .'| meetingAssistance.classifications.meeting | float | The confidence score for the meeting class. |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:QueryVideoCognitionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\\\n\\",\\n \\"UserData\\": \\"{\\\\\\"userId\\\\\\":\\\\\\"123432412831\\\\\\"}\\\\n\\",\\n \\"Results\\": {\\n \\"result\\": [\\n {\\n \\"Type\\": \\"ASR\\",\\n \\"Data\\": \\"{\\\\\\"title\\\\\\":\\\\\\"example-title-****\\\\\\"}\\\\t\\\\n\\"\\n }\\n ]\\n },\\n \\"TemplateId\\": \\"\\",\\n \\"Params\\": \\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\"\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'RefreshUploadMedia' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '411bed50018971edb60b0764a0ec6***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => 'c2e77390f75271ec802f0674a2ce6***', 'title' => ''], 'UploadAddress' => ['description' => 'The upload URL.'."\n" ."\n" .'> The returned upload URL is a Base64-encoded URL. You must decode the Base64-encoded upload URL before you use an SDK or call an API operation to upload media files. You need to parse UploadAddress only if you use Object Storage Service (OSS) SDK or call an OSS API operation to upload media files.', 'type' => 'string', 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', 'title' => ''], 'UploadAuth' => ['description' => 'The upload credential.'."\n" ."\n" .'> The returned upload credential is a Base64-encoded value. You must decode the Base64-encoded upload credential before you use an SDK or call an API operation to upload media files. You need to parse UploadAuth only if you use OSS SDK or call an OSS API operation to upload media files.', 'type' => 'string', 'example' => 'eyJFbmRwb2ludCI6Imm****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'RefreshUploadMedia', 'summary' => 'Obtain a new upload credential for a media asset after its upload credential expires.', 'changeSet' => [ ['createdAt' => '2022-06-23T08:56:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshUploadMedia'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:RefreshUploadMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"c2e77390f75271ec802f0674a2ce6***\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'RegisterMediaInfo' => [ 'summary' => 'Registers a media asset with Intelligent Media Services (IMS). IMS assigns an ID to the media asset. This operation asynchronously accesses the media asset service in which the media asset is stored to obtain the file information of the media asset based on the input URL. You can also specify basic information, such as the title, tags, and description, for the media asset. This operation returns the ID of the media asset. You can call the GetMediaInfo operation based on the ID to query the details of the media asset. You can set InputURL only to the URL of an Object Storage Service (OSS) file or an ApsaraVideo VOD media asset.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '6889', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'InputURL', 'in' => 'query', 'schema' => ['description' => 'The URL of the media asset in another service. The URL is associated with the ID of the media asset in IMS. The URL cannot be modified once registered. The following types of URLs are supported:'."\n" ."\n" .'- OSS URL in one of the following formats:'."\n" ."\n" .' - `http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4`'."\n" ."\n" .' - `oss://example-bucket/example.mp4`: In this format, it is considered by default that the region of the OSS bucket in which the media asset resides is the same as the region in which IMS is activated.'."\n" ."\n" .'- URL of an ApsaraVideo VOD media asset'."\n" ."\n" .' `vod://***20b48fb04483915d4f2cd8ac****`', 'type' => 'string', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4  or  vod://****20b48fb04483915d4f2cd8ac****', 'required' => true, 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'The type of the media asset. Valid values:'."\n" ."\n" .'- image'."\n" ."\n" .'- video'."\n" ."\n" .'- audio'."\n" ."\n" .'- text'."\n" ."\n" .'We recommend that you specify this parameter based on your business requirements. If you set InputURL to an OSS URL, the media asset type can be automatically determined based on the file name extension. Refer to [](t2240981.xdita#)for details.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'video'], ], [ 'name' => 'BusinessType', 'in' => 'query', 'schema' => ['description' => 'The business type of the media asset. Valid values:'."\n" ."\n" .'- subtitles'."\n" ."\n" .'- watermark'."\n" ."\n" .'- opening'."\n" ."\n" .'- ending'."\n" ."\n" .'- general', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'opening'], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title. If you do not specify this parameter, a default title is automatically generated based on the date.'."\n" ."\n" .'- The value can be up to 128 bytes in length.'."\n" ."\n" .'- The value must be encoded in UTF-8.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'defaultTitle'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the media asset.'."\n" ."\n" .'- The value can be up to 1,024 bytes in length.'."\n" ."\n" .'- The value must be encoded in UTF-8.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'defaultDescription'], ], [ 'name' => 'MediaTags', 'in' => 'query', 'schema' => ['description' => 'The tags of the media asset.'."\n" ."\n" .'- Up to 16 tags are supported.'."\n" ."\n" .'- Separate multiple tags with commas (,).'."\n" ."\n" .'- Each tag can be up to 32 bytes in length.'."\n" ."\n" .'- The value must be encoded in UTF-8.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'tag1,tag2'], ], [ 'name' => 'CoverURL', 'in' => 'query', 'schema' => ['description' => 'The thumbnail URL of the media asset.'."\n" ."\n" .'- The value can be up to 128 bytes in length.'."\n" ."\n" .'- The value must be encoded in UTF-8.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png'], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user data. You can specify a custom callback URL. For more information, see [](t2243473.xdita#).'."\n" ."\n" .'- The value can be up to 1,024 bytes in length.'."\n" ."\n" .'- The value must be encoded in UTF-8.'."\n" ."\n" .'- The value must be in the JSON format.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or{"NotifyAddress":"https://xx.xx.xxx"} or{"NotifyAddress":"ice-callback-demo"}', 'title' => '', 'required' => false], ], [ 'name' => 'Overwrite', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to overwrite the media asset that has been registered by using the same URL. Default value: false. Valid values:'."\n" ."\n" .'- true: If a media asset has been registered by using the same URL, the original media asset is deleted and the new media asset is registered.'."\n" ."\n" .'- false: If a media asset has been registered by using the same URL, the new media asset is not registered. A URL cannot be used to register multiple media assets.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The value must be a UUID that contains 32 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****0311a423d11a5f7dee713535****'], ], [ 'name' => 'RegisterConfig', 'in' => 'query', 'schema' => ['description' => 'The registration configurations.'."\n" ."\n" .'By default, a sprite is generated for the media asset. You can set NeedSprite to false to disable automatic sprite generation.'."\n" ."\n" .'By default, a snapshot is generated for the media asset. You can set NeedSnapshot to false to disable automatic snapshot generation.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "NeedSprite": "false",'."\n" .' "CoverConfig": {'."\n" .' "StartTime": 1.0'."\n" .' },'."\n" .' "SearchLibName": "test"'."\n" .'}'], ], [ 'name' => 'CateId', 'in' => 'query', 'schema' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3048', 'title' => ''], ], [ 'name' => 'WorkflowId', 'in' => 'query', 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => false, 'example' => '******b4fb044839815d4f2cd8******', 'title' => ''], ], [ 'name' => 'ReferenceId', 'in' => 'query', 'schema' => ['description' => 'The custom ID. The ID can be 6 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (\\_). Make sure that the ID is unique among users.', 'type' => 'string', 'required' => false, 'example' => '123-123', 'title' => ''], ], [ 'name' => 'SmartTagTemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the smart tagging template. Valid values:'."\n" ."\n" .'- S00000101-300080: the system template that supports natural language processing (NLP) for content recognition.'."\n" ."\n" .'- S00000103-000001: the system template that supports NLP for content recognition and all [tagging capabilities](t2729541.xdita#93b27f536airj).'."\n" ."\n" .'- S00000103-000002: the system template that supports all [tagging capabilities](t2729541.xdita#93b27f536airj) but does not support NLP for content recognition.'."\n" ."\n" .'After you configure this parameter, a smart tag analysis task is automatically initiated after the media asset is registered.', 'type' => 'string', 'required' => false, 'example' => 'S00000101-300080', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******5A-CAAC-4850-A3AF-B74606******'], 'MediaId' => ['description' => 'The ID of the media asset in IMS.', 'type' => 'string', 'title' => '', 'example' => '******b48fb04483915d4f2cd8******'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******5A-CAAC-4850-A3AF-B74606******\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\"\\n}","type":"json"}]', 'title' => 'RegisterMediaInfo', 'description' => 'Registering a media asset is an asynchronous job that takes 2 to 3 seconds. When the operation returns the ID of the media asset, the registration may have not be completed. If you call the [GetMediaInfo](~~441155~~) operation at this time, you may fail to obtain the information about the media asset.', 'changeSet' => [ ['createdAt' => '2024-04-24T02:22:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-11T06:58:34.000Z', 'description' => 'Error codes changed, Request parameters changed'], ['createdAt' => '2022-09-01T03:57:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-11T05:19:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-14T07:50:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-12T11:59:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-04-07T10:59:29.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterMediaInfo'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:RegisterMediaInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'RegisterMediaStream' => [ 'summary' => 'Registers a media stream file stored in OSS with the media service and attaches the media stream to a specified MediaId.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ 'name' => 'InputURL', 'in' => 'query', 'schema' => ['description' => 'The URL of the media asset in another service. The URL is associated with the ID of the media asset in IMS. The URL cannot be modified once registered.'."\n" ."\n" .'Set this parameter to the OSS URL of the media asset. The following formats are supported:'."\n" ."\n" .'http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'."\n" ."\n" .'oss\\://example-bucket/example.mp4: In this format, it is considered by default that the region of the OSS bucket in which the media asset resides is the same as the region in which IMS is activated.', 'type' => 'string', 'required' => false, 'example' => 'oss://***/API-test/900d1-b8rs8.aac', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '5e778ec0027b71ed80a8909598506***', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user data.', 'type' => 'string', 'required' => false, 'example' => '{"MessageCallback":{"CallbackURL":"http://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}', 'title' => ''], ], [ 'name' => 'StreamTags', 'in' => 'query', 'schema' => ['description' => 'Custom stream tags used to identify transcoding streams.'."\n" ."\n" .'After the media stream is registered, you can invoke [GetPlayInfo](https://help.aliyun.com/zh/ims/developer-reference/api-ice-2020-11-09-getplayinfo?spm=a2c4g.11186623.help-menu-193643.d_5_0_3_1_4.56dc5a11JzNEVj) to retrieve this tag value.', 'type' => 'string', 'required' => false, 'example' => '{"key1": "value1"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '5e778ec0027b71ed80a8909598506302', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Register Media Stream ', 'changeSet' => [ ['createdAt' => '2025-08-19T11:48:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-13T06:51:39.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterMediaStream'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:RegisterMediaStream', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"5e778ec0027b71ed80a8909598506302\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'RegisterYikeAssetMediaInfo' => [ 'summary' => 'Registers a media asset in the asset library.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '6889', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'InputURL', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The URL of the media asset. You can use the FileURL value that is returned by the CreateYikeAssetUpload operation.', 'type' => 'string', 'required' => true, 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The type of the media asset.', 'type' => 'string', 'required' => true, 'example' => 'video'], ], [ 'name' => 'ProductionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the production. If this parameter is omitted, the media asset is uploaded to the default production.', 'type' => 'string', 'required' => false, 'example' => 'ProductionId', 'title' => ''], ], [ 'name' => 'FolderId', 'in' => 'query', 'schema' => ['description' => 'The ID of the folder.', 'type' => 'string', 'required' => false, 'example' => 'fd-ABMFfAB2bA', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'MediaId' => ['title' => '', 'description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '****c469e944b5a856828dc2****'."\n"], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], ], 'title' => 'Register media asset information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:RegisterYikeAssetMediaInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\\\n\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'ResumeMediaConnectFlowOutput' => [ 'summary' => 'Resumes an output of a MediaConnect flow. When resumed, the output can deliver the live stream to the destination.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => false, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ 'name' => 'OutputName', 'in' => 'query', 'schema' => ['description' => 'The name of the output.', 'type' => 'string', 'required' => false, 'example' => 'AliTestOutput', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262'], 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RetCode' => ['description' => 'The returned error code. A value of 0 indicates the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Content' => ['description' => 'The response body.', 'type' => 'string', 'example' => '""', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', 'title' => 'ResumeMediaConnectFlowOutput', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:ResumeMediaConnectFlowOutput', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ResumeYikeStoryboardJob' => [ 'summary' => 'Resumes a storyboard job.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the storyboard job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'JobId' => ['description' => 'The ID of the storyboard job. This ID is returned in the response when you submit the job.', 'type' => 'string', 'example' => '****a046-263c-3560-978a-fb287782****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ResumeYikeStoryboardJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:ResumeYikeStoryboardJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'SearchEditingProject' => [ 'summary' => 'Queries online editing projects by creation time and status.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2017-01-11T12:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2017-01-11T12:00:00Z'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the online editing project. Separate multiple values with commas (,). By default, all online editing projects are queried.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'-Draft'."\n" ."\n" .'-Producing'."\n" ."\n" .'-Produced'."\n" ."\n" .'-ProduceFailed', 'enumValueTitles' => ['Draft' => '', 'Produced' => '', 'Producing' => '', 'ProduceFailed' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Producing', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sorting rule of results. Valid values:'."\n" ."\n" .'\\- CreationTime:Desc (default): The results are sorted in reverse chronological order based on the creation time.'."\n" ."\n" .'\\- CreationTime:Asc: The results are sorted in chronological order based on the creation time.', 'enumValueTitles' => ['CreationTime:Asc' => '', 'CreationTime:Desc' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CreationTime:Desc', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'CreateSource', 'in' => 'query', 'schema' => [ 'description' => 'The source of the project.'."\n" ."\n" .'-OpenAPI'."\n" ."\n" .'-AliyunConsole'."\n" ."\n" .'-WebSDK'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- AliyunConsole: The project is created in the Alibaba Cloud console.'."\n" ."\n" .'- WebSDK: The project is created by using the SDK for Web.'."\n" ."\n" .'- OpenAPI: The project is created by calling API operations.', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'WebSDK', ], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => 'The template type. Valid values:'."\n" ."\n" .'-Timeline'."\n" ."\n" .'-VETemplate'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Timeline: regular template.'."\n" ."\n" .'- VETemplate: advanced template.'."\n" ."\n" .'- None: No template is used.', 'enumValueTitles' => ['Timeline' => '', 'VETemplate' => '', 'None' => ''], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Timeline', ], ], [ 'name' => 'ProjectType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the editing project. Default value: EditingProject. Valid values:'."\n" ."\n" .'- EditingProject: a regular editing project.'."\n" ."\n" .'- LiveEditingProject: a live stream editing project.', 'enumValueTitles' => ['LiveEditingProject' => '', 'EditingProject' => ''], 'type' => 'string', 'required' => false, 'example' => 'EditingProject', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****'], 'ProjectList' => [ 'title' => '', 'description' => 'The queried online editing projects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'title' => '', 'example' => '****fddd7748b58bf1d47e95****'], 'Title' => ['description' => 'The title of the online editing project.', 'type' => 'string', 'title' => '', 'example' => 'title'], 'Timeline' => ['description' => 'The timeline of the online editing project.', 'type' => 'string', 'title' => '', 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}'], 'Description' => ['description' => 'The description of the online editing project.', 'type' => 'string', 'title' => '', 'example' => 'sample description'], 'CoverURL' => ['description' => 'The thumbnail URL of the online editing project.', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg'], 'CreateTime' => ['description' => 'The time when the online editing project was created.', 'type' => 'string', 'title' => '', 'example' => '2017-01-11T12:00:00Z'], 'ModifiedTime' => ['description' => 'The time when the online editing project was last modified.', 'type' => 'string', 'title' => '', 'example' => '2017-01-11T12:00:00Z'], 'Duration' => ['description' => 'The total length of the online editing project. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30.100000'], 'Status' => [ 'description' => 'The status of the online editing project. Valid values:'."\n" ."\n" .'-Draft'."\n" ."\n" .'-Editing'."\n" ."\n" .'-Producing'."\n" ."\n" .'-Produced'."\n" ."\n" .'-ProduceFailed'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Draft'."\n" ."\n" .'- Produced'."\n" ."\n" .'- Editing'."\n" ."\n" .'- Producing'."\n" ."\n" .'- ProduceFailed', 'enumValueTitles' => ['Draft' => '', 'Produced' => '', 'Editing' => '', 'Producing' => '', 'ProduceFailed' => ''], 'type' => 'string', 'title' => '', 'example' => 'PRODUCE_FAILED', ], 'ErrorCode' => ['description' => 'The error code returned if the production of the online editing project failed.', 'type' => 'string', 'title' => '', 'example' => 'InvalidParameter'], 'ErrorMessage' => ['description' => 'The error message returned if the production of the online editing project failed.', 'type' => 'string', 'title' => '', 'example' => '"EventTime":"2021-08-12T10:04:15Z","ErrorCode":"InvalidParameter","ErrorMessage":"The specified parameter \\"LiveStreamConfig\\" is not valid. specified parameter example is not valid.'], 'CreateSource' => [ 'description' => 'The method for editing the online editing project.'."\n" ."\n" .'-OpenAPI'."\n" ."\n" .'-AliyunConsole'."\n" ."\n" .'-WebSDK'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- AliyunConsole: The project is created in the Alibaba Cloud console.'."\n" ."\n" .'- WebSDK: The project is created by using the SDK for Web.'."\n" ."\n" .'- OpenAPI: The project is created by calling API operations.', 'enumValueTitles' => ['AliyunConsole' => '', 'WebSDK' => '', 'OpenAPI' => ''], 'type' => 'string', 'title' => '', 'example' => 'OpenAPI', ], 'ModifiedSource' => ['description' => 'The method used when the online editing project was last modified.', 'type' => 'string', 'title' => '', 'example' => '2017-01-11T12:00:00Z'], 'TemplateType' => ['description' => 'The type of the template.', 'type' => 'string', 'title' => '', 'example' => 'Timeline'], 'ProjectType' => [ 'description' => 'The type of the editing project.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- LiveEditingProject: a live stream editing project.'."\n" ."\n" .'- EditingProject: a regular editing project.', 'enumValueTitles' => ['LiveEditingProject' => '', 'EditingProject' => ''], 'type' => 'string', 'example' => 'EditingProject', 'title' => '', ], 'BusinessConfig' => ['description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.', 'type' => 'string', 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', 'title' => ''], 'BusinessStatus' => [ 'description' => 'The business status of the project. This parameter can be ignored for general editing projects. Valid values:'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- BroadCasting:'."\n" ."\n" .'- ReservationCanceled'."\n" ."\n" .'- LiveFinished'."\n" ."\n" .'- LoadingFailed'."\n" ."\n" .'- Reserving', 'enumValueTitles' => ['BroadCasting' => '', 'ReservationCanceled' => '', 'LiveFinished' => '', 'LoadingFailed' => '', 'Reserving' => ''], 'type' => 'string', 'example' => 'Reserving', 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'MaxResults' => ['description' => 'The maximum number of entries returned on a single page. The value is set to the maximum number of entries returned on each page except for the last page.'."\n" ."\n" .'Examples:'."\n" ."\n" .'Valid example: 10,10,5. Invalid example: 10,5,10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'TotalCount' => ['description' => 'Optional. The total number of entries returned. By default, this parameter is not returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '110', 'title' => ''], 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"ProjectList\\": [\\n {\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"Title\\": \\"title\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"}]}]}\\",\\n \\"Description\\": \\"sample description\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg\\",\\n \\"CreateTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Duration\\": 30.1,\\n \\"Status\\": \\"PRODUCE_FAILED\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"ErrorMessage\\": \\"\\\\\\"EventTime\\\\\\":\\\\\\"2021-08-12T10:04:15Z\\\\\\",\\\\\\"ErrorCode\\\\\\":\\\\\\"InvalidParameter\\\\\\",\\\\\\"ErrorMessage\\\\\\":\\\\\\"The specified parameter \\\\\\\\\\\\\\"LiveStreamConfig\\\\\\\\\\\\\\" is not valid. specified parameter example is not valid.\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"2017-01-11T12:00:00Z\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"ProjectType\\": \\"EditingProject\\",\\n \\"BusinessConfig\\": \\"{ \\\\\\"OutputMediaConfig\\\\\\" : { \\\\\\"StorageLocation\\\\\\": \\\\\\"test-bucket.oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Path\\\\\\": \\\\\\"test-path\\\\\\" }, \\\\\\"OutputMediaTarget\\\\\\": \\\\\\"oss-object\\\\\\", \\\\\\"ReservationTime\\\\\\": \\\\\\"2021-06-21T08:05:00Z\\\\\\" }\\",\\n \\"BusinessStatus\\": \\"Reserving\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 110,\\n \\"NextToken\\": \\"null\\"\\n}","type":"json"}]', 'title' => 'SearchEditingProject', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchEditingProject'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SearchEditingProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchIndexJobRerun' => [ 'summary' => 'Rerun the search index jobs for the specified media assets in batch. You can rerun index jobs for up to 20 media assets per request.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236859', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-1'], ], [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******'], ], [ 'name' => 'Task', 'in' => 'query', 'schema' => ['description' => 'The type of the job. Separate multiple types with commas (,).'."\n" ."\n" .'- aiLabel: smart tagging.'."\n" ."\n" .'- face: face recognition.'."\n" ."\n" .'- mm: large visual model.', 'type' => 'string', 'required' => false, 'example' => 'aiLabel,face,mm', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'MediaIdsNoExist' => [ 'description' => 'The media asset IDs that do not exist.', 'type' => 'array', 'items' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '1c6ce34007d571ed94667630a6bc****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"MediaIdsNoExist\\": [\\n \\"1c6ce34007d571ed94667630a6bc****\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Rerun Search Index Job', 'changeSet' => [ ['createdAt' => '2025-07-09T08:14:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchIndexJobRerun'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:SearchIndexJobRerun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchMedia' => [ 'summary' => 'Returns media assets that match the specified conditions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '140243', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'Match', 'in' => 'query', 'schema' => ['description' => 'The filter condition for the search. For syntax rules, see the [Media Search Protocol](~~2584256~~).', 'type' => 'string', 'example' => 'Title = \'China\' and utcCreate = [\'1693367158561\',\'1693367158562\']', 'title' => '', 'required' => false], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sort field and sort order. Separate multiple sort criteria with a comma (,).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'utcCreate:Desc'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of results per page. The default value is 10, and the maximum value is 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The entity ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2d3bf1e35a1e42b5ab338d701efa****'], ], [ 'name' => 'ScrollToken', 'in' => 'query', 'schema' => ['description' => 'The scroll token for deep pagination. It is a 32-character string. This parameter is not required for the first search request. If a search is successful, the response includes a `ScrollToken` to mark the current position. Use this token in subsequent requests to retrieve the next page of results. This parameter is required to iterate through all matching results. For optimal performance, use this parameter when the `PageNo` value exceeds 200. You can scroll only forward, up to a maximum of 1,000 media assets.', 'type' => 'string', 'required' => false, 'example' => 'F8C4F642184DBDA5D93907A70AAE****', 'title' => ''], ], [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => false, 'example' => 'test-1', 'title' => ''], ], [ 'name' => 'CustomFilters', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The custom filter, specified as a JSON string. Supports the integer field intField1 and the string fields strField1 and strField2. Use only one match type per field. Conditions on different fields are combined with a logical AND.'."\n" ."\n" .'- Exact match: `{"intField1":12,"strField1":"abc"}`'."\n" ."\n" .'- Multi-value match: `{"intField1":[12,13],"strField1":["abc","cd"]}`'."\n" ."\n" .'- Range match: `{"intField1":{"gte":12,"lte":13}}`', 'type' => 'string', 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F61C357-ACC0-57FB-876E-D5879533****', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'True', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaInfoList' => [ 'title' => '', 'description' => 'A collection of media assets that match the criteria.', 'type' => 'array', 'items' => [ 'description' => 'A media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'title' => '', 'example' => '3b187b3620c8490886cfc2a9578c****'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'Basic information about the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The media asset ID.', 'type' => 'string', 'example' => '132bd600fc3c71ec99476732a78f****'], 'InputURL' => ['description' => 'The source URL of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****'], 'MediaType' => ['description' => 'The type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'video'], 'BusinessType' => ['description' => 'The business type of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'opening'], 'Source' => ['description' => 'The source of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'The title of the media asset.', 'type' => 'string', 'example' => 'Smart landscape-to-portrait conversion', 'title' => ''], 'Description' => ['description' => 'The description of the media asset.', 'type' => 'string', 'title' => '', 'example' => '对这个视频进行转码处理了'], 'Category' => ['description' => 'The category of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'image'], 'MediaTags' => ['description' => 'The tags assigned to the media asset. Multiple tags are separated by commas.', 'type' => 'string', 'title' => '', 'example' => 'tags,tags2'."\n"], 'CoverURL' => ['description' => 'The URL of the cover image.', 'type' => 'string', 'title' => '', 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg'], 'UserData' => ['description' => 'The custom user data.', 'type' => 'string', 'title' => '', 'example' => 'userData'], 'Snapshots' => ['description' => 'Snapshot information in JSON format.', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]'], 'Status' => ['description' => 'The status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'TranscodeStatus' => ['description' => 'The transcoding status of the media asset.', 'type' => 'string', 'title' => '', 'example' => 'Init'], 'CreateTime' => ['description' => 'The time when the media asset was created.', 'type' => 'string', 'title' => '', 'example' => '2020-12-01T19:48Z'], 'ModifiedTime' => ['description' => 'The time when the media asset was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-12-01T19:48Z'."\n"], 'DeletedTime' => ['description' => 'The time when the media asset was deleted.', 'type' => 'string', 'title' => '', 'example' => '2020-12-01T19:48Z'."\n"], 'SpriteImages' => ['description' => 'Sprite Image information in JSON format.', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], 'CateId' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '44', 'title' => ''], 'Biz' => ['description' => 'The business to which the media asset belongs.', 'type' => 'string', 'example' => 'IMS', 'title' => ''], 'UploadSource' => ['description' => 'The upload source.', 'type' => 'string', 'example' => 'general', 'title' => ''], 'CateName' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'Subcategory 1', 'title' => ''], 'ReferenceId' => ['description' => 'A unique, custom ID for the user. It must be 6 to 64 characters long and can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'example' => '123-123', 'title' => ''], 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'name-1', 'title' => ''], 'VisionDescription' => ['description' => 'A computer-vision-generated description of the media content.', 'type' => 'string', 'example' => '足球进球', 'title' => ''], 'StreamStatus' => ['title' => '', 'description' => 'The stream status.', 'type' => 'string', 'example' => 'Active'], ], 'example' => '', ], 'FileInfoList' => [ 'title' => '', 'description' => 'A list of file information.', 'type' => 'array', 'items' => [ 'description' => 'A file information object.', 'type' => 'object', 'properties' => [ 'FileBasicInfo' => [ 'title' => '', 'description' => 'Basic information about the file, such as its duration and size.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'title' => '', 'example' => '164265080291300080527050.wav'], 'FileStatus' => ['description' => 'The status of the file.', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'FileType' => ['description' => 'The type of the file.', 'type' => 'string', 'example' => 'source_file', 'title' => ''], 'FileSize' => ['description' => 'The file size in bytes.', 'type' => 'string', 'title' => '', 'example' => '324784'], 'FileUrl' => ['description' => 'The Object Storage Service (OSS) URL of the file.', 'type' => 'string', 'title' => '', 'example' => 'https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4'], 'Region' => ['description' => 'The region where the file is stored.', 'type' => 'string', 'title' => '', 'example' => 'cn-beijing'], 'FormatName' => ['description' => 'The container format of the file.', 'type' => 'string', 'title' => '', 'example' => 'mov,mp4,m4a,3gp,3g2,mj2'], 'Duration' => ['description' => 'The duration of the file.', 'type' => 'string', 'title' => '', 'example' => '60.00000'."\n"], 'Bitrate' => ['description' => 'The bitrate of the file.', 'type' => 'string', 'title' => '', 'example' => '1912.13'."\n"], 'Width' => ['description' => 'The width of the video in pixels.', 'type' => 'string', 'title' => '', 'example' => '1920'], 'Height' => ['description' => 'The height of the video in pixels.', 'type' => 'string', 'title' => '', 'example' => '480'], 'CreateTime' => ['description' => 'The time when the file was created.', 'type' => 'string', 'example' => '2022-05-30T02:02:17Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the file was last modified.', 'type' => 'string', 'example' => '2021-12-10T12:19Z', 'title' => ''], 'ImagesInput' => ['description' => 'Information about the image set.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'AiData' => [ 'description' => 'The detailed AI data.', 'type' => 'object', 'properties' => [ 'AiLabelInfo' => [ 'description' => 'A list of AI label information.', 'type' => 'array', 'items' => [ 'description' => 'An AI label object.', 'type' => 'object', 'properties' => [ 'FaceId' => ['description' => 'The ID of the recognized face.', 'type' => 'string', 'example' => '5FE19530C7A422197535FE74F5DB****', 'title' => ''], 'LabelType' => ['description' => 'The type of the label.', 'type' => 'string', 'example' => 'Object', 'title' => ''], 'Source' => ['description' => 'The source of the AI data.', 'type' => 'string', 'example' => 'vision', 'title' => ''], 'Category' => ['description' => 'The category of the label.', 'type' => 'string', 'example' => 'Vehicle', 'title' => ''], 'LabelName' => ['description' => 'The name of the entity.', 'type' => 'string', 'example' => 'Car', 'title' => ''], 'LabelId' => ['description' => 'The ID of the entity.', 'type' => 'string', 'example' => '10310250338', 'title' => ''], 'Occurrences' => [ 'description' => 'A list of clips where the entity appears.', 'type' => 'array', 'items' => [ 'description' => 'A clip object.', 'type' => 'object', 'properties' => [ 'Score' => ['description' => 'The confidence score for the recognition result.', 'type' => 'number', 'format' => 'double', 'example' => '0.75287705', 'title' => ''], 'Image' => ['description' => 'The optimal image of the recognized face, encoded in Base64.', 'type' => 'string', 'example' => '99C64F6287', 'title' => ''], 'TableBatchSeqId' => ['description' => 'The sequence ID of the vector table.', 'type' => 'string', 'example' => '85010D1', 'title' => ''], 'clipId' => ['description' => 'The clip ID.', 'type' => 'string', 'example' => '5FE19530C7A422197535FE74F5DB****', 'title' => ''], 'From' => ['description' => 'The start time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], 'To' => ['description' => 'The end time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '2.5', 'title' => ''], 'FinegrainName' => ['description' => 'The fine-grained name of the entity.', 'type' => 'string', 'example' => 'Car', 'title' => ''], 'FinegrainId' => ['description' => 'The fine-grained ID of the entity.', 'type' => 'string', 'example' => '10310250338', 'title' => ''], 'Content' => ['description' => 'The text content.', 'type' => 'string', 'example' => 'Pipi', 'title' => ''], 'Tracks' => [ 'description' => 'A sequence of tracks that represent the entity within the clip.', 'type' => 'array', 'items' => [ 'description' => 'A track data point.', 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The size of the bounding box.', 'type' => 'number', 'format' => 'double', 'example' => '50.2', 'title' => ''], 'Position' => ['description' => 'The coordinates of the bounding box.', 'type' => 'string', 'example' => '468.0;67.0;615.0;267.0', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the track data point.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AsrInfo' => [ 'description' => 'A list of Automatic Speech Recognition (ASR) results.', 'type' => 'array', 'items' => [ 'description' => 'An ASR result object.', 'type' => 'object', 'properties' => [ 'From' => ['description' => 'The start time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], 'To' => ['description' => 'The end time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '2.5', 'title' => ''], 'ClipId' => ['description' => 'The clip ID.', 'type' => 'string', 'example' => '5FE19530C7A422197535FE74F5DB****', 'title' => ''], 'Content' => ['description' => 'The transcribed text content.', 'type' => 'string', 'example' => 'I am Pipi.', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'OcrInfo' => [ 'description' => 'A list of Optical Character Recognition (OCR) results.', 'type' => 'array', 'items' => [ 'description' => 'An OCR result object.', 'type' => 'object', 'properties' => [ 'From' => ['description' => 'The start time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], 'To' => ['description' => 'The end time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '2.5', 'title' => ''], 'ClipId' => ['description' => 'The clip ID.', 'type' => 'string', 'example' => '5FE19530C7A422197535FE74F5DB****', 'title' => ''], 'Content' => ['description' => 'The recognized text content.', 'type' => 'string', 'example' => '我是皮皮', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AiRoughData' => [ 'description' => 'A summary of the AI processing data.', 'type' => 'object', 'properties' => [ 'SaveType' => ['description' => 'The save type of the AI data.', 'type' => 'string', 'example' => 'TEXT', 'title' => ''], 'Status' => ['description' => 'The save status of the AI data.', 'type' => 'string', 'example' => 'SaveSuccess', 'title' => ''], 'AiJobId' => ['description' => 'The ID of the AI job.', 'type' => 'string', 'example' => 'cd35b0b0025f71edbfcb472190a9****', 'title' => ''], 'Result' => ['description' => 'The URL of the raw AI result file.', 'type' => 'string', 'example' => 'http://xxxx.json', 'title' => ''], 'AiCategory' => ['description' => 'The AI category applied to the media asset.', 'type' => 'string', 'example' => '视频AI分类', 'title' => ''], ], 'title' => '', 'example' => '', ], 'IndexStatusList' => [ 'description' => 'A list of indexing statuses for different index types.', 'type' => 'array', 'items' => [ 'description' => 'An index status object.', 'type' => 'object', 'properties' => [ 'IndexType' => ['description' => 'The type of the index. Valid values:'."\n" ."\n" .'- `mm`: Large Language Model (LLM).'."\n" ."\n" .'- `face`: Face.'."\n" ."\n" .'- `aiLabel`: Smart tagging.', 'type' => 'string', 'example' => 'mm', 'title' => ''], 'IndexStatus' => ['description' => 'The status of the index. Valid values:'."\n" ."\n" .'- `Running`: The index is being created.'."\n" ."\n" .'- `Fail`: The index creation failed.'."\n" ."\n" .'- `Success`: The index was created.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CustomFields' => ['title' => '', 'description' => 'Custom fields for filtering, provided as a JSON string.', 'type' => 'string', 'example' => '{\\"intField1\\":12,\\"strField1\\":\\"abc\\"}'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ScrollToken' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'example' => 'F8C4F642184DBDA5D93907A70AAE****', 'title' => ''], 'Total' => ['description' => 'The total number of media assets matching the search criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '163', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F61C357-ACC0-57FB-876E-D5879533****\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaInfoList\\": [\\n {\\n \\"MediaId\\": \\"3b187b3620c8490886cfc2a9578c****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"132bd600fc3c71ec99476732a78f****\\",\\n \\"InputURL\\": \\"oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"opening\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"Smart landscape-to-portrait conversion\\",\\n \\"Description\\": \\"对这个视频进行转码处理了\\",\\n \\"Category\\": \\"image\\",\\n \\"MediaTags\\": \\"tags,tags2\\\\n\\",\\n \\"CoverURL\\": \\"https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"3\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******f48f0e4154976b2b8c45******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-beijing\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e6a6440b29eb60bd7c******\\\\\\"}]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-01T19:48Z\\",\\n \\"ModifiedTime\\": \\"2020-12-01T19:48Z\\\\n\\",\\n \\"DeletedTime\\": \\"2020-12-01T19:48Z\\\\n\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"CateId\\": 44,\\n \\"Biz\\": \\"IMS\\",\\n \\"UploadSource\\": \\"general\\",\\n \\"CateName\\": \\"Subcategory 1\\",\\n \\"ReferenceId\\": \\"123-123\\",\\n \\"Namespace\\": \\"name-1\\",\\n \\"VisionDescription\\": \\"足球进球\\",\\n \\"StreamStatus\\": \\"Active\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"164265080291300080527050.wav\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"324784\\",\\n \\"FileUrl\\": \\"https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"60.00000\\\\n\\",\\n \\"Bitrate\\": \\"1912.13\\\\n\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"480\\",\\n \\"CreateTime\\": \\"2022-05-30T02:02:17Z\\",\\n \\"ModifiedTime\\": \\"2021-12-10T12:19Z\\",\\n \\"ImagesInput\\": \\"{}\\"\\n }\\n }\\n ],\\n \\"AiData\\": {\\n \\"AiLabelInfo\\": [\\n {\\n \\"FaceId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"LabelType\\": \\"Object\\",\\n \\"Source\\": \\"vision\\",\\n \\"Category\\": \\"Vehicle\\",\\n \\"LabelName\\": \\"Car\\",\\n \\"LabelId\\": \\"10310250338\\",\\n \\"Occurrences\\": [\\n {\\n \\"Score\\": 0.75287705,\\n \\"Image\\": \\"99C64F6287\\",\\n \\"TableBatchSeqId\\": \\"85010D1\\",\\n \\"clipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"FinegrainName\\": \\"Car\\",\\n \\"FinegrainId\\": \\"10310250338\\",\\n \\"Content\\": \\"Pipi\\",\\n \\"Tracks\\": [\\n {\\n \\"Size\\": 50.2,\\n \\"Position\\": \\"468.0;67.0;615.0;267.0\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"AsrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"Content\\": \\"I am Pipi.\\",\\n \\"Timestamp\\": 1.4\\n }\\n ],\\n \\"OcrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"Content\\": \\"我是皮皮\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n },\\n \\"AiRoughData\\": {\\n \\"SaveType\\": \\"TEXT\\",\\n \\"Status\\": \\"SaveSuccess\\",\\n \\"AiJobId\\": \\"cd35b0b0025f71edbfcb472190a9****\\",\\n \\"Result\\": \\"http://xxxx.json\\",\\n \\"AiCategory\\": \\"视频AI分类\\"\\n },\\n \\"IndexStatusList\\": [\\n {\\n \\"IndexType\\": \\"mm\\",\\n \\"IndexStatus\\": \\"Success\\"\\n }\\n ],\\n \\"CustomFields\\": \\"{\\\\\\\\\\\\\\"intField1\\\\\\\\\\\\\\":12,\\\\\\\\\\\\\\"strField1\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"abc\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"ScrollToken\\": \\"F8C4F642184DBDA5D93907A70AAE****\\",\\n \\"Total\\": 163\\n}","type":"json"}]', 'title' => 'Search Media Information', 'description' => 'If you have any questions about the multi-modal search feature, join our DingTalk group (ID: 30415005038) for assistance.', 'changeSet' => [ ['createdAt' => '2025-11-04T06:36:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-09-18T09:20:14.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-06-11T06:24:27.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-08-26T06:30:38.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-26T08:53:25.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-27T07:25:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-29T09:16:07.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-15T02:30:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-09-01T03:57:50.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMedia'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:SearchMedia', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchMediaByAILabel' => [ 'summary' => 'You can perform multimodal search based on person names, captions, and AI categorization.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '195892', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-1'], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the media assets. Valid values:'."\n" ."\n" .'- image'."\n" ."\n" .'- video'."\n" ."\n" .'- audio', 'enumValueTitles' => ['image' => 'image', 'video' => 'video', 'audio' => 'audio'], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'video', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sorting method of the results. Valid values:'."\n" ."\n" .'- CreationTime:Desc (default): sorts results in reverse chronological order.'."\n" ."\n" .'- CreationTime:Asc: sorts results in chronological order.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CreationTime:Desc'."\n"], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The content that you want to query.', 'type' => 'string', 'example' => 'Kite', 'title' => '', 'required' => false], ], [ 'name' => 'MultimodalSearchType', 'in' => 'query', 'schema' => [ 'description' => 'The type of query. Valid values:'."\n" ."\n" .'- PersonName: queries media assets based on character names.'."\n" ."\n" .'- Ocr: queries media assets based on subtitles.'."\n" ."\n" .'- AiCategory: queries media assets based on AI categories.'."\n" ."\n" .'- FullSearch (default): queries all media assets.', 'enumValueTitles' => ['PersonName' => 'PersonName', 'AiCategory' => 'AiCategory', 'FullSearch' => 'FullSearch', 'Ocr' => 'Ocr'], 'type' => 'string', 'required' => false, 'example' => 'Ocr', 'title' => '', ], ], [ 'name' => 'SpecificSearch', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to query media asset clips. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset. This parameter is required if you want to query media asset clips.', 'type' => 'string', 'required' => false, 'example' => '****c469e944b5a856828dc2****'."\n", 'title' => ''], ], [ 'name' => 'MatchingMode', 'in' => 'query', 'schema' => [ 'description' => 'Matching pattern. The default value is fuzzy for Fuzzy Matching. Valid values:'."\n" ."\n" .'- fuzzy: Fuzzy Matching'."\n" ."\n" .'- precise: Precise matching. This pattern applies only to newly added media assets.', 'enumValueTitles' => ['precise' => 'precise', 'fuzzy' => 'fuzzy'], 'type' => 'string', 'required' => false, 'example' => 'fuzzy', 'title' => '', ], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'CustomFilters', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Custom filters. A JSON string. The following backing fields are supported: intField1 (integer type), strField1 and strField2 (string type). For the same field, only one matching method can be specified. Filters on different fields are combined with a logical AND relationship.'."\n" ."\n" .'- Exact match, for example: {"intField1":12,"strField1":"abc"}'."\n" ."\n" .'- Multi-value match, for example: {"intField1":\\[12,13],"strField1":\\["abc","cd"]}'."\n" ."\n" .'- Range match, for example: {"intField1":{"gte":12,"lte":13}}', 'type' => 'string', 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', 'required' => false], ], [ 'name' => 'UtcCreate', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Creation time, in milliseconds UNIX timestamp. Use gte for greater than or equal to, and lte for less than or equal to.'."\n" ."\n" .'- Example range: {"gte":1761205662998,"lte":1771205662998}', 'type' => 'string', 'example' => '{"gte":1761205662998,"lte":1771205662998}', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaList' => [ 'title' => '', 'description' => 'The media assets that contain the specified content.', 'type' => 'array', 'items' => [ 'description' => 'The information about the media asset.', 'type' => 'object', 'properties' => [ 'AiData' => [ 'description' => 'The details of the AI job.', 'type' => 'object', 'properties' => [ 'AiLabelInfo' => [ 'description' => 'The tags of the AI job.', 'type' => 'array', 'items' => [ 'description' => 'The information about the AI tag.', 'type' => 'object', 'properties' => [ 'FaceId' => ['description' => 'The ID of the face.', 'type' => 'string', 'example' => '5FE19530C7A422197535FE74F5DB****'."\n", 'title' => ''], 'LabelType' => ['description' => 'The type of the tag.', 'type' => 'string', 'example' => 'Object', 'title' => ''], 'Source' => ['description' => 'The source.', 'type' => 'string', 'example' => 'vision', 'title' => ''], 'Category' => ['description' => 'The category.', 'type' => 'string', 'example' => 'Vehicle', 'title' => ''], 'LabelName' => ['description' => 'The name of the entity.', 'type' => 'string', 'example' => 'Car', 'title' => ''], 'LabelId' => ['description' => 'The ID of the entity.', 'type' => 'string', 'example' => '103102503**', 'title' => ''], 'Occurrences' => [ 'description' => 'The information about the clips.', 'type' => 'array', 'items' => [ 'description' => 'The information about the clip.', 'type' => 'object', 'properties' => [ 'Score' => ['description' => 'The score.', 'type' => 'number', 'format' => 'double', 'example' => '0.75287705'."\n", 'title' => ''], 'Image' => ['description' => 'The image that contains the most face information.', 'type' => 'string', 'example' => 'https://service-****-public.oss-cn-hangzhou.aliyuncs.com/1563457****438522/service-image/f788974f-9595-43b2-a478-7c7a1afb****.jpg', 'title' => ''], 'TableBatchSeqId' => ['description' => 'The sequence ID of the vector table.', 'type' => 'string', 'example' => '85010D1**', 'title' => ''], 'ClipId' => ['description' => 'The ID of the clip.', 'type' => 'string', 'example' => '158730355E4B82257D8AA1583A58****', 'title' => ''], 'From' => ['description' => 'The start time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], 'To' => ['description' => 'The end time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '2.5', 'title' => ''], 'FinegrainName' => ['description' => 'The fine-grained name of the entity.', 'type' => 'string', 'example' => 'Car', 'title' => ''], 'FinegrainId' => ['description' => 'The fine-grained ID of the entity.', 'type' => 'string', 'example' => '103102503**', 'title' => ''], 'Content' => ['description' => 'The content of the text.', 'type' => 'string', 'example' => 'Test content', 'title' => ''], 'Tracks' => [ 'description' => 'The tracks.', 'type' => 'array', 'items' => [ 'description' => 'The track.', 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The size of the bounding box.', 'type' => 'number', 'format' => 'double', 'example' => '50', 'title' => ''], 'Position' => ['description' => 'The coordinates of the bounding box.', 'type' => 'string', 'example' => '468.0;67.0;615.0;267.0', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the track.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AsrInfo' => [ 'description' => 'The information about audio files.', 'type' => 'array', 'items' => [ 'description' => 'The information about the audio file.', 'type' => 'object', 'properties' => [ 'From' => ['description' => 'The start time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], 'To' => ['description' => 'The end time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '2.5', 'title' => ''], 'ClipId' => ['description' => 'The ID of the clip.', 'type' => 'string', 'example' => '5FE19530C7A422197535FE74F5DB****', 'title' => ''], 'Content' => ['description' => 'The content of the audio.', 'type' => 'string', 'example' => '智能标签测试', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'OcrInfo' => [ 'description' => 'The information about subtitle files.', 'type' => 'array', 'items' => [ 'description' => 'The information about the subtitle file.', 'type' => 'object', 'properties' => [ 'From' => ['description' => 'The start time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], 'To' => ['description' => 'The end time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '2.5', 'title' => ''], 'ClipId' => ['description' => 'The ID of the clip.', 'type' => 'string', 'example' => '5FE19530C7A422197535FE74F5DB****'."\n", 'title' => ''], 'Content' => ['description' => 'The content of the text.', 'type' => 'string', 'example' => 'Pipi', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '1.4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'StorageLocation' => ['description' => 'The storage address.', 'type' => 'string', 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com'."\n", 'title' => ''], 'Status' => [ 'description' => 'The status of the video.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- PrepareFail'."\n" ."\n" .'- UploadFail'."\n" ."\n" .'- Init'."\n" ."\n" .'- UploadSucc'."\n" ."\n" .'- Transcoding'."\n" ."\n" .'- TranscodeFail'."\n" ."\n" .'- Deleted'."\n" ."\n" .'- Normal'."\n" ."\n" .'- Uploading'."\n" ."\n" .'- Preparing'."\n" ."\n" .'- Blocked'."\n" ."\n" .'- Checking', 'enumValueTitles' => [ 'PrepareFail' => 'PrepareFail', 'UploadFail' => 'UploadFail', 'Init' => 'Init', 'UploadSucc' => 'UploadSucc', 'Transcoding' => 'Transcoding', 'TranscodeFail' => 'TranscodeFail', 'Deleted' => 'Deleted', 'Normal' => 'Normal', 'Uploading' => 'Uploading', 'Preparing' => 'Preparing', 'Blocked' => 'Blocked', 'Checking' => 'Checking', ], 'type' => 'string', 'example' => 'Normal', 'title' => '', ], 'CreationTime' => ['description' => 'The time when the media asset was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2017-11-14T09:15:50Z'."\n", 'title' => ''], 'ModificationTime' => ['description' => 'The time when the media asset was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2017-11-14T09:15:50Z'."\n", 'title' => ''], 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '1c6ce34007d571ed94667630a6bc****'."\n", 'title' => ''], 'Tags' => ['description' => 'The tags of the media asset.', 'type' => 'string', 'example' => 'Tag 1, Tag 2', 'title' => ''], 'Description' => ['description' => 'The description of the media asset.', 'type' => 'string', 'example' => 'Alibaba Cloud VOD video description', 'title' => ''], 'AppId' => ['description' => 'The ID of the application. Default value: app-1000000.', 'type' => 'string', 'example' => 'app-1000000', 'title' => ''], 'Size' => ['description' => 'The size of the source file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10897890', 'title' => ''], 'CoverUrl' => ['description' => 'The URL of the thumbnail.', 'type' => 'string', 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', 'title' => ''], 'Duration' => ['description' => 'The duration. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '12.2', 'title' => ''], 'Title' => ['description' => 'The title of the media asset.', 'type' => 'string', 'example' => 'The best music player ever', 'title' => ''], 'Snapshots' => [ 'description' => 'The array of video snapshot URLs.', 'type' => 'array', 'items' => ['description' => 'The URL of the video snapshot.', 'type' => 'string', 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Total' => ['description' => 'The total number of audio and video files that meet the conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaList\\": [\\n {\\n \\"AiData\\": {\\n \\"AiLabelInfo\\": [\\n {\\n \\"FaceId\\": \\"5FE19530C7A422197535FE74F5DB****\\\\n\\",\\n \\"LabelType\\": \\"Object\\",\\n \\"Source\\": \\"vision\\",\\n \\"Category\\": \\"Vehicle\\",\\n \\"LabelName\\": \\"Car\\",\\n \\"LabelId\\": \\"103102503**\\",\\n \\"Occurrences\\": [\\n {\\n \\"Score\\": 0.75287705,\\n \\"Image\\": \\"https://service-****-public.oss-cn-hangzhou.aliyuncs.com/1563457****438522/service-image/f788974f-9595-43b2-a478-7c7a1afb****.jpg\\",\\n \\"TableBatchSeqId\\": \\"85010D1**\\",\\n \\"ClipId\\": \\"158730355E4B82257D8AA1583A58****\\",\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"FinegrainName\\": \\"Car\\",\\n \\"FinegrainId\\": \\"103102503**\\",\\n \\"Content\\": \\"Test content\\",\\n \\"Tracks\\": [\\n {\\n \\"Size\\": 50,\\n \\"Position\\": \\"468.0;67.0;615.0;267.0\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"AsrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"Content\\": \\"智能标签测试\\",\\n \\"Timestamp\\": 1.4\\n }\\n ],\\n \\"OcrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\\\n\\",\\n \\"Content\\": \\"Pipi\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n },\\n \\"StorageLocation\\": \\"out-****.oss-cn-shanghai.aliyuncs.com\\\\n\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\\\n\\",\\n \\"ModificationTime\\": \\"2017-11-14T09:15:50Z\\\\n\\",\\n \\"MediaId\\": \\"1c6ce34007d571ed94667630a6bc****\\\\n\\",\\n \\"Tags\\": \\"Tag 1, Tag 2\\",\\n \\"Description\\": \\"Alibaba Cloud VOD video description\\",\\n \\"AppId\\": \\"app-1000000\\",\\n \\"Size\\": 10897890,\\n \\"CoverUrl\\": \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\",\\n \\"Duration\\": 12.2,\\n \\"Title\\": \\"The best music player ever\\",\\n \\"Snapshots\\": [\\n \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\"\\n ]\\n }\\n ],\\n \\"Total\\": 30\\n}","type":"json"}]', 'title' => 'DataQ - Smart Tag Service Text Search', 'description' => 'You can perform multimodal search based on person names, captions, and AI categorization. Coarse search supports returning results at the media asset granularity, while fine search supports returning hit segment information within media assets.', 'changeSet' => [ ['createdAt' => '2025-11-04T06:36:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-06-11T06:24:27.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-10-17T07:55:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-10-12T02:52:37.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByAILabel'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:SearchMediaByAILabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchMediaByFace' => [ 'summary' => 'Search media assets by face image (coarse search). Input a face image to retrieve information about media assets containing the person in the image.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2d3bf1e35a1e42b5ab338d701efa****'], ], [ 'name' => 'PersonImageUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face image.', 'type' => 'string', 'required' => true, 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/input/huangxuan****.jpg', 'title' => ''], ], [ 'name' => 'FaceSearchToken', 'in' => 'query', 'schema' => ['description' => 'The token that is used to identify the query. You can use this parameter in the SearchMediaClipByFace operation to specify the same query conditions.', 'type' => 'string', 'required' => true, 'example' => 'zxtest-huangxuan-2023-3-7-V1', 'title' => ''], ], [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'The type of the media asset. Valid values:'."\n" ."\n" .'- image'."\n" ."\n" .'- video', 'type' => 'string', 'required' => false, 'example' => 'video', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'CustomFilters', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Custom filters. A JSON string. The following backing fields are supported: intField1 (integer type), strField1 and strField2 (string type). For the same field, only one matching mode can be specified. Filters across different fields are combined with a logical AND relationship.'."\n" ."\n" .'- Exact match, for example: {"intField1":12,"strField1":"abc"}'."\n" ."\n" .'- Multi-value match, for example: {"intField1":\\[12,13],"strField1":\\["abc","cd"]}'."\n" ."\n" .'- Range match, for example: {"intField1":{"gte":12,"lte":13}}', 'type' => 'string', 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', 'required' => false], ], [ 'name' => 'UtcCreate', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Creation time, in milliseconds UNIX timestamp. Use gte for greater than or equal to, and lte for less than or equal to.'."\n" ."\n" .'- Example range: {"gte":1761205662998,"lte":1771205662998}', 'type' => 'string', 'example' => '{"gte":1761205662998,"lte":1771205662998}', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '7CA7D615-CFB1-5437-9A12-2D185C3EE6CB', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaInfoList' => [ 'title' => '', 'description' => 'The media assets that meet the conditions.', 'type' => 'array', 'items' => [ 'description' => 'The information about the media assets.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => '3b187b3620c8490886cfc2a9578c****'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Total' => ['description' => 'The total number of data records that meet the specified filter condition.', 'type' => 'integer', 'format' => 'int64', 'example' => '163', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CA7D615-CFB1-5437-9A12-2D185C3EE6CB\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaInfoList\\": [\\n {\\n \\"MediaId\\": \\"3b187b3620c8490886cfc2a9578c****\\"\\n }\\n ],\\n \\"Total\\": 163\\n}","type":"json"}]', 'title' => 'Search Media Assets by Face Image ', 'description' => 'For questions about using or troubleshooting the Intelligent Media Asset Search feature of Alibaba Cloud Intelligent Media Services, search for the DingTalk group (30415005038) and join the Intelligent Media Services multimodal search Customer Support DingTalk group to contact us.', 'changeSet' => [ ['createdAt' => '2025-11-04T06:36:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-06-11T06:24:27.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-10-12T02:52:37.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByFace'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:SearchMediaByFace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchMediaByHybrid' => [ 'summary' => 'Hybrid media asset search. Combines the text search capability of DataQ - Smart Tag Service and the LLM-based search capability to perform multi-channel recall, allowing users to search using natural language descriptions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '224461', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-1'], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of media assets. Valid values:'."\n" ."\n" .'- image'."\n" ."\n" .'- video', 'enumValueTitles' => ['image' => 'image', 'video' => 'video'], 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'video', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The natural language search query.', 'type' => 'string', 'example' => 'Two pandas are fighting.', 'required' => false, 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset. If provided, the details of the media asset are returned.', 'type' => 'string', 'required' => false, 'example' => '****c469e944b5a856828dc2****'."\n", 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'CustomFilters', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Custom filters. A JSON string. Supported backing fields include integer field intField1 and string fields strField1 and strField2. Only one matching condition can be applied per field, and filters across different fields are combined with a logical AND relationship.'."\n" ."\n" .'- Exact match example: {"intField1":12,"strField1":"abc"}'."\n" ."\n" .'- Multi-value example: {"intField1":\\[12,13],"strField1":\\["abc","cd"]}'."\n" ."\n" .'- Range example: {"intField1":{"gte":12,"lte":13}}', 'type' => 'string', 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', 'required' => false], ], [ 'name' => 'UtcCreate', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Creation time, in milliseconds UNIX timestamp. gte means greater than or equal to, and lte means less than or equal to.'."\n" ."\n" .'- Range example: {"gte":1761205662998,"lte":1771205662998}', 'type' => 'string', 'example' => '{"gte":1761205662998,"lte":1771205662998}', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaList' => [ 'title' => '', 'description' => 'The media assets that match the search query.', 'type' => 'array', 'items' => [ 'description' => 'The media asset that matches the search query.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => 'a18936e0e28771edb59ae6f6f47a****', 'title' => ''], 'ClipInfo' => [ 'description' => 'The information about the relevant clips.', 'type' => 'array', 'items' => [ 'description' => 'The information about the clip.', 'type' => 'object', 'properties' => [ 'From' => ['description' => 'The start time of the relevant clip.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => ''], 'To' => ['description' => 'The end time of the relevant clip.', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => ''], 'Score' => ['description' => 'The relevance score of the clip for the query.', 'type' => 'number', 'format' => 'double', 'example' => '0.99', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Total' => ['description' => 'The total number of media assets that match the search criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaList\\": [\\n {\\n \\"MediaId\\": \\"a18936e0e28771edb59ae6f6f47a****\\",\\n \\"ClipInfo\\": [\\n {\\n \\"From\\": 2,\\n \\"To\\": 4,\\n \\"Score\\": 0.99\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 30\\n}","type":"json"}]', 'title' => 'Hybrid Search', 'description' => 'For questions about or assistance with the Intelligent Media Services intelligent media asset search feature on Alibaba Cloud, please search for the DingTalk group (30415005038) and join the Intelligent Media Services multimodal search Customer support DingTalk group to contact us.', 'changeSet' => [ ['createdAt' => '2025-11-04T06:36:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-06-11T06:24:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByHybrid'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:SearchMediaByHybrid', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchMediaByMultimodal' => [ 'summary' => 'LLM search. You can use natural language descriptions to perform searches.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-1'], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the media assets.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- image'."\n" ."\n" .'- video (default)', 'enumValueTitles' => ['image' => 'image', 'video' => 'video'], 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'video', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The content that you want to query. You can describe the content in natural language.', 'type' => 'string', 'example' => 'Two pandas are fighting.', 'required' => false, 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'CustomFilters', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Custom filters. A JSON string. Supported backing fields include integer field intField1 and string fields strField1 and strField2. Only one matching condition can be applied per field, and filters across different fields are combined with a logical AND relationship.'."\n" ."\n" .'- Exact match example: {"intField1":12,"strField1":"abc"}'."\n" ."\n" .'- Multi-value match example: {"intField1":\\[12,13],"strField1":\\["abc","cd"]}'."\n" ."\n" .'- Range match example: {"intField1":{"gte":12,"lte":13}}', 'type' => 'string', 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', 'required' => false], ], [ 'name' => 'UtcCreate', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Creation time, in milliseconds UNIX timestamp. gte indicates greater than or equal to, and lte indicates less than or equal to.'."\n" ."\n" .'- Range example: {"gte":1761205662998,"lte":1771205662998}', 'type' => 'string', 'example' => '{"gte":1761205662998,"lte":1771205662998}', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaList' => [ 'title' => '', 'description' => 'The media assets that contain the specified content.', 'type' => 'array', 'items' => [ 'description' => 'The information about the media asset.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => 'a18936e0e28771edb59ae6f6f47a****', 'title' => ''], 'ClipInfo' => [ 'description' => 'The information about the clip.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'From' => ['description' => 'The start time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => ''], 'To' => ['description' => 'The end time of the clip.', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => ''], 'Score' => ['description' => 'The score.', 'type' => 'number', 'format' => 'double', 'example' => '0.99', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Total' => ['description' => 'The total number of data records that meet the specified filter condition.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaList\\": [\\n {\\n \\"MediaId\\": \\"a18936e0e28771edb59ae6f6f47a****\\",\\n \\"ClipInfo\\": [\\n {\\n \\"From\\": 2,\\n \\"To\\": 4,\\n \\"Score\\": 0.99\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 20\\n}","type":"json"}]', 'title' => 'LLM Search', 'description' => 'For questions about the Intelligent Media Services intelligent media asset search feature or related issues, search for the DingTalk group (30415005038) and join the Intelligent Media Services multimodal search Customer support DingTalk group to contact us.', 'changeSet' => [ ['createdAt' => '2025-11-04T06:36:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-06-11T06:24:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByMultimodal'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:SearchMediaByMultimodal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchMediaClipByFace' => [ 'summary' => 'The API for searching media asset segments by face image (fine search) returns information about relevant character segments in the media asset where the face appears, based on coarse search results.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2d3bf1e35a1e42b5ab338d701efa****'], ], [ 'name' => 'FaceSearchToken', 'in' => 'query', 'schema' => ['description' => 'The value of this parameter is the same as that of the FaceSearchToken parameter in the SearchMediaByFace request. This specifies to return media asset clips that meet the same query conditions.', 'type' => 'string', 'required' => true, 'example' => 'zxtest-huangxuan-2023-3-7-V1', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'example' => '3b187b3620c8490886cfc2a9578c****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E44FFACD-9E90-555A-A09A-6FD3B7335E39', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], 'MediaClipList' => [ 'title' => '', 'description' => 'The media asset clips that meet the requirements.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Score' => ['description' => 'The score of the clip. The value is of the Float type. The value is in the range of \\[0,1].', 'type' => 'number', 'format' => 'float', 'example' => '0.99041677', 'title' => ''], 'EntityId' => ['description' => 'The ID of the entity, which is the same as the entity ID returned in tag analysis.', 'type' => 'string', 'example' => '1031025****', 'title' => ''], 'LabelName' => ['description' => 'The name of the entity.', 'type' => 'string', 'example' => 'John Doe', 'title' => ''], 'OccurrencesInfos' => [ 'title' => '', 'description' => 'The information about clips related to the face.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The start time of the clip. Unit: seconds. The value is of the Float type.', 'type' => 'number', 'format' => 'float', 'example' => '61.066353', 'title' => ''], 'EndTime' => ['description' => 'The end time of the clip. Unit: seconds. The value is of the Float type.', 'type' => 'number', 'format' => 'float', 'example' => '69.06635', 'title' => ''], 'TrackData' => [ 'description' => 'The information about the face in the clip.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Timestamp' => ['description' => 'The timestamp when the face appears in the clip. Unit: seconds. The value is of the Float type.', 'type' => 'number', 'format' => 'float', 'example' => '62.03302', 'title' => ''], 'BoxPosition' => [ 'description' => 'The coordinates of the face.', 'type' => 'object', 'properties' => [ 'X' => ['description' => 'The x-axis coordinate of the upper-left corner. Unit: pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '517', 'title' => ''], 'Y' => ['description' => 'The y-axis coordinate of the upper-left corner. Unit: pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '409', 'title' => ''], 'W' => ['description' => 'The width of the rectangle frame. Unit: pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '128', 'title' => ''], 'H' => ['description' => 'The height of the rectangle frame. Unit: pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '168', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Expression' => ['description' => 'Expression.', 'type' => 'string', 'example' => '平静', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'Category' => [ 'description' => 'The type of the character. Valid values: celebrity sensitive politician custom unknown', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'celebrity', 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'Total' => ['description' => 'The total number of media asset clips that meet the conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E44FFACD-9E90-555A-A09A-6FD3B7335E39\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaClipList\\": [\\n {\\n \\"Score\\": 0.99041677,\\n \\"EntityId\\": \\"1031025****\\",\\n \\"LabelName\\": \\"John Doe\\",\\n \\"OccurrencesInfos\\": [\\n {\\n \\"StartTime\\": 61.066353,\\n \\"EndTime\\": 69.06635,\\n \\"TrackData\\": [\\n {\\n \\"Timestamp\\": 62.03302,\\n \\"BoxPosition\\": {\\n \\"X\\": 517,\\n \\"Y\\": 409,\\n \\"W\\": 128,\\n \\"H\\": 168\\n }\\n }\\n ],\\n \\"Expression\\": \\"平静\\"\\n }\\n ],\\n \\"Category\\": \\"celebrity\\"\\n }\\n ],\\n \\"Total\\": 5\\n}","type":"json"}]', 'title' => 'Search media asset clips by face image', 'description' => 'For questions about using or troubleshooting the Intelligent Media Search feature of Alibaba Cloud Intelligent Media Services, please search for the DingTalk group (30415005038) and join the Intelligent Media Services multimodal search Customer Support DingTalk group to contact us.', 'changeSet' => [ ['createdAt' => '2024-12-04T02:32:04.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-12T02:52:38.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaClipByFace'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'ice:SearchMediaClipByFace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SearchPublicMediaInfo' => [ 'summary' => 'Search for media assets that meet the conditions based on the parameters provided by the User.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'MediaIds', 'in' => 'query', 'schema' => ['description' => 'IMS media asset IDs.'."\n" ."\n" .'- Separate multiple IDs with commas.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****', 'title' => ''], ], [ 'name' => 'DynamicMetaDataMatchFields', 'in' => 'query', 'schema' => ['description' => 'Dynamic metadata search matching conditions.', 'type' => 'string', 'required' => false, 'example' => '"ApprovalStatus=\'Available\'&MaterialBags=\'boutiquemusic\'&Mood=\'Nervous\'"', 'title' => ''], ], [ 'name' => 'Favorite', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the User has collected this media asset.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Authorized', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the User has purchased a resource plan that includes this media asset.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'Result sorting method: :. Valid values:'."\n" ."\n" .'field:'."\n" ."\n" .'- "UsageCount": usage'."\n" ."\n" .'- "UnitPrice": unit price'."\n" ."\n" .'order:'."\n" ."\n" .'- "Desc": descending'."\n" ."\n" .'- "Asc": ascending', 'type' => 'string', 'required' => false, 'example' => 'UsageCount:Desc,UnitPrice:Asc', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'EntityId', 'in' => 'query', 'schema' => ['description' => 'Entity ID, used to identify different types of public copyright media assets. Valid values:'."\n" ."\n" .'- Copyright\\_Music: Public copyright music', 'type' => 'string', 'required' => false, 'example' => 'Copyright_Music', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '****3CFB-2767-54FD-B311-BD15A4C1****'], 'TotalCount' => ['description' => 'The total amount of Data under the current request conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'PublicMediaInfos' => [ 'description' => 'Public copyright media asset information', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Authorized' => ['description' => 'Indicates whether you have purchased a resource plan that includes this media asset.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Favorite' => ['description' => 'Whether the media asset is collected.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RemainingAuthTime' => ['description' => 'Remaining validity period of the resource plan (Day)', 'type' => 'string', 'example' => '100', 'title' => ''], 'MediaInfo' => [ 'description' => 'Media asset information', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'Media asset ID', 'type' => 'string', 'title' => '', 'example' => 'icepublic-****87b921bb4a55908a72a0537e****'], 'MediaBasicInfo' => [ 'title' => '', 'description' => 'BasicInfo', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'MediaId', 'type' => 'string', 'example' => 'icepublic-****87b921bb4a55908a72a0537e****'], 'MediaType' => ['description' => 'Media asset media type', 'type' => 'string', 'title' => '', 'example' => 'audio'], 'BusinessType' => ['description' => 'Media Asset Business Type', 'type' => 'string', 'title' => '', 'example' => 'general'], 'Source' => ['description' => 'Source', 'type' => 'string', 'title' => '', 'example' => 'oss'], 'Title' => ['description' => 'title', 'type' => 'string', 'title' => '', 'example' => 'title'], 'Description' => ['description' => 'Content description', 'type' => 'string', 'title' => '', 'example' => 'description'], 'Category' => ['description' => 'Categorization', 'type' => 'string', 'title' => '', 'example' => 'category'], 'MediaTags' => ['description' => 'Label', 'type' => 'string', 'example' => 'tag1', 'title' => ''], 'CoverURL' => ['description' => 'Thumbnail URL', 'type' => 'string', 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token='], 'UserData' => ['description' => 'User Data', 'type' => 'string', 'title' => '', 'example' => 'userDataTest'], 'Status' => ['description' => 'Resource status', 'type' => 'string', 'title' => '', 'example' => 'Normal'], 'CreateTime' => ['description' => 'Media Asset Creation Time', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T06:04:49Z'], 'ModifiedTime' => ['description' => 'Updated At', 'type' => 'string', 'title' => '', 'example' => '2020-12-26T06:04:50Z'], 'DeletedTime' => ['description' => 'Media Asset Deletion Time', 'type' => 'string', 'title' => '', 'example' => '2020-12-29T06:04:49Z'], 'SpriteImages' => ['description' => 'sprite', 'type' => 'string', 'title' => '', 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]'], ], 'example' => '', ], 'DynamicMetaData' => [ 'description' => 'Dynamic metadata', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Metadata JSON string', 'type' => 'string', 'example' => '"{\\"AuditionUrl\\": \\"http://xxx\\", \\"AuditionCount\\": 3...}"', 'title' => ''], 'Type' => ['description' => 'Type. Valid values:'."\n" ."\n" .'- "ai": AI data processed and normalized from original AI results'."\n" ."\n" .'- "user-defined": User-defined metadata'."\n" ."\n" .'- "system": System-provided', 'type' => 'string', 'example' => 'system', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****3CFB-2767-54FD-B311-BD15A4C1****\\",\\n \\"TotalCount\\": 100,\\n \\"PublicMediaInfos\\": [\\n {\\n \\"Authorized\\": true,\\n \\"Favorite\\": true,\\n \\"RemainingAuthTime\\": \\"100\\",\\n \\"MediaInfo\\": {\\n \\"MediaId\\": \\"icepublic-****87b921bb4a55908a72a0537e****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"icepublic-****87b921bb4a55908a72a0537e****\\",\\n \\"MediaType\\": \\"audio\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"category\\",\\n \\"MediaTags\\": \\"tag1\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\\",\\n \\"UserData\\": \\"userDataTest\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreateTime\\": \\"2020-12-26T06:04:49Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T06:04:50Z\\",\\n \\"DeletedTime\\": \\"2020-12-29T06:04:49Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\"\\n },\\n \\"DynamicMetaData\\": {\\n \\"Data\\": \\"\\\\\\"{\\\\\\\\\\\\\\"AuditionUrl\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"http://xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"AuditionCount\\\\\\\\\\\\\\": 3...}\\\\\\"\\",\\n \\"Type\\": \\"system\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Search public copyright media assets', 'changeSet' => [ ['createdAt' => '2021-11-25T06:45:51.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchPublicMediaInfo'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SearchPublicMediaInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SendAIAgentDataChannelMessage' => [ 'summary' => 'Sends a DataChannel message to an AI agent.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI agent in the conversation.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****'."\n", 'title' => ''], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => ['description' => 'The DataChannel message you want to send. You must specify a JSON string. The value can be up to 8,192 characters in length.', 'type' => 'string', 'required' => true, 'example' => '{"key":"value"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'."\n"], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\\\n\\"\\n}","type":"json"}]', 'title' => 'SendAIAgentDataChannelMessage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendAIAgentDataChannelMessage'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SendAIAgentDataChannelMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SendAIAgentSpeech' => [ 'summary' => 'Instructs a specified agent instance to immediately play back a text message, with support for interrupt settings.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '237311', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Agent instance ID.'."\n" ."\n" .'> The InstanceId is the unique ID returned after successfully starting an agent instance. For details about starting an agent instance, see [StartAIAgentInstance](~~2846201~~) and [GenerateAIAgentCall](~~2846209~~).', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The text content to be played back. The supported input format varies based on the Type parameter. The length cannot exceed 1024 characters.', 'type' => 'string', 'example' => 'Hello, welcome to our service.', 'required' => true, 'title' => ''], ], [ 'name' => 'EnableInterrupt', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the broadcast can interrupt the ongoing speech. Default value: true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'Input type. Valid values:'."\n" ."\n" .'- Text: Input is plain text.'."\n" ."\n" .'- AudioUrl: Input is an audio URL.'."\n" ."\n" .'Default value: Text.', 'type' => 'string', 'required' => false, 'example' => 'Text', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', 'title' => 'Send AI Agent Voice Message ', 'description' => 'You can use this API to immediately instruct an AI agent instance to perform voice playback by passing in the specified text content. You can optionally allow this playback to interrupt any currently playing audio. By default, interruption is allowed.'."\n" ."\n" .'**Note:**'."\n" ."\n" .'- The `InstanceId` must be valid and correspond to an existing agent instance.'."\n" ."\n" .'- The `Text` content must comply with specifications and must not contain sensitive or inappropriate information.'."\n" ."\n" .'- If you do not want the new playback to interrupt the current audio, you must explicitly set `EnableInterrupt` to `false`.', 'changeSet' => [ ['createdAt' => '2025-09-08T08:55:44.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendAIAgentSpeech'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SendAIAgentSpeech', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SendAIAgentText' => [ 'summary' => 'Sends a message as input to the large language model (LLM).', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '237311', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI agent instance.'."\n" ."\n" .'> InstanceId is a unique identifier that is returned when the AI agent is started. To start an AI agent, call [StartAIAgentInstance ](~~2846201~~)or [GenerateAIAgentCall](~~2846209~~).', 'type' => 'string', 'required' => true, 'example' => 'f27f9b9be28642a88e18****', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The input to the LLM.', 'type' => 'string', 'example' => 'Hello.', 'required' => true, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DB488837-3****'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB488837-3****\\"\\n}","type":"json"}]', 'title' => 'SendAIAgentText', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SendAIAgentText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SendLiveSnapshotJobCommand' => [ 'summary' => 'Sends a command to process a live stream snapshot job.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ 'name' => 'Command', 'in' => 'formData', 'schema' => [ 'description' => 'The operation command.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- stop'."\n" ."\n" .'- restart'."\n" ."\n" .'- start', 'enumValueTitles' => ['stop' => '', 'restart' => '', 'start' => ''], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'start', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ['errorCode' => 'JobLimitExceeded', 'errorMessage' => 'Job limit exceeded.', 'description' => ''], ['errorCode' => 'StreamNotFound', 'errorMessage' => 'No such stream.', 'description' => ''], ], 403 => [ ['errorCode' => 'UserDisable', 'errorMessage' => 'User is disable.', 'description' => ''], ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ['errorCode' => 'OperationDenied', 'errorMessage' => 'Your account has not enabled the ICE service.', 'description' => ''], ], [ ['errorCode' => 'JobNotFound', 'errorMessage' => 'No such job.', 'description' => ''], ], 409 => [ ['errorCode' => 'JobAlreadyStarted', 'errorMessage' => 'Job is already started.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'SendLiveSnapshotJobCommand', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendLiveSnapshotJobCommand'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SendLiveSnapshotJobCommand', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SendLiveTranscodeJobCommand' => [ 'summary' => 'Sends a command to process a live stream transcoding job.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the transcoding job.', 'type' => 'string', 'required' => true, 'enum' => [], 'title' => '', 'example' => '****20b48fb04483915d4f2cd8ac****', ], ], [ 'name' => 'Command', 'in' => 'query', 'schema' => [ 'description' => 'The operation command. Only the stop command is supported. This command is used to stop a transcoding job.', 'type' => 'string', 'required' => true, 'enum' => ['stop'], 'example' => 'stop', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'SendLiveTranscodeJobCommand', 'changeSet' => [ ['createdAt' => '2022-08-24T03:10:25.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendLiveTranscodeJobCommand'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SendLiveTranscodeJobCommand', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SendMessageChatText' => [ 'summary' => 'Sends a message to the client.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '237311', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the session.', 'type' => 'string', 'required' => true, 'example' => 'f27f9b9be28642a88e18****', 'title' => ''], ], [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI agent.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'ReceiverId', 'in' => 'query', 'schema' => ['description' => 'The ID of the user who receives the message. The ID can be up to 64 bytes in length and can contain letters and digits.', 'type' => 'string', 'required' => true, 'example' => '60000042053', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The type of the message. Valid values:'."\n" ."\n" .'- announcement: notification.'."\n" ."\n" .'- custom: custom message.', 'type' => 'string', 'required' => true, 'example' => 'announcement', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The content of the message.', 'type' => 'string', 'example' => 'Hello.', 'required' => true, 'title' => ''], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => ['description' => 'The mode of message sending. Valid values:'."\n" ."\n" .'- online'."\n" ."\n" .'- offline'."\n" ."\n" .'Default value: offline.', 'type' => 'string', 'required' => false, 'example' => 'online', 'title' => ''], ], [ 'name' => 'NeedArchiving', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to archive chat records. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'SendMessageChatText', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SendMessageChatText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SetAIAgentVoiceprint' => [ 'summary' => 'Registers a voiceprint.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ 'name' => 'VoiceprintId', 'in' => 'query', 'schema' => ['description' => 'A unique identifier for the voiceprint. Generate this ID based on your own business rules. Requirement: 1 to 127 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'vp_1699123456_8527', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The input file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Specifies the access type for the audio file. The system will verify file accessibility via HEAD or GET requests. Valid values:'."\n" ."\n" .'- url: An HTTP(S) link to the audio file.'."\n" ."\n" .'- oss: An OSS object. Supports the following formats:'."\n" ."\n" .' 1. OSS URI: oss\\://bucket-name/object-key'."\n" ."\n" .' Example: oss\\://my-bucket/audio/sample.wav'."\n" ."\n" .' 2. OSS public URL: http(s)://${bucket}.oss-${region}.aliyuncs.com/${object}'."\n" ."\n" .' Example: https\\://my-bucket.oss-cn-hangzhou.aliyuncs.com/audio/sample.wav'."\n" ."\n" .'> The OSS bucket must be in the same region as the service. Otherwise, the access fails.', 'type' => 'string', 'required' => false, 'example' => 'url', 'title' => ''], 'Data' => ['description' => 'The media access link.', 'type' => 'string', 'required' => false, 'example' => 'https://my-bucket.oss-cn-hangzhou.aliyuncs.com/audio/sample.wav', 'title' => ''], 'Format' => ['description' => 'The audio file format. Only WAV is supported.', 'type' => 'string', 'required' => false, 'example' => 'wav', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '550e8400********55440000'], 'VoiceprintId' => ['description' => 'The ID of the registered voiceprint.', 'type' => 'string', 'example' => 'vp_1699123456_8527', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"550e8400********55440000\\",\\n \\"VoiceprintId\\": \\"vp_1699123456_8527\\"\\n}","type":"json"}]', 'title' => 'SetAIAgentVoiceprint', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SetAIAgentVoiceprint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SetContentAnalyzeConfig' => [ 'summary' => 'Configures settings for Intelligent Content Analysis.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Auto', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically start Intelligent Content Analysis after a Media Asset is registered.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- true: Enable'."\n" ."\n" .'- false: Disable (Default)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'SaveType', 'in' => 'query', 'schema' => ['description' => 'The storage type for analysis results. This parameter applies only when Auto is set to true. Default: Empty.'."\n" ."\n" .'- TEXT: Label'."\n" ."\n" .'- FACE: Face'."\n" ."\n" .'- DNA: Similar Image'."\n" ."\n" .'You can specify multiple values separated by commas. If this parameter is empty, Intelligent Content Analysis results are not saved to any search library, and you cannot perform content searches.', 'type' => 'string', 'required' => false, 'example' => 'TEXT,FACE', 'title' => ''], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Intelligent Content Analysis Template. Each Template includes the following AI analysis features:'."\n" ."\n" .'- S00000101-100040: Text Recognition'."\n" ."\n" .'- S00000101-100060: Video Categorization and Face Recognition'."\n" ."\n" .'- S00000101-100070: Text Recognition, Video Categorization, and Face Recognition', 'type' => 'string', 'required' => false, 'example' => 'S00000101-100070', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of the response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '953CFD27-4A2C-54AD-857F-B79EF3A338E0'], 'Success' => ['description' => 'Indicates whether the configuration succeeded. Valid values:'."\n" ."\n" .'- true: Success'."\n" ."\n" .'- false: Failed', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"953CFD27-4A2C-54AD-857F-B79EF3A338E0\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Configure Intelligent Content Analysis', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetContentAnalyzeConfig'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:SetContentAnalyzeConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SetDefaultCustomTemplate' => [ 'summary' => 'Sets a custom template as the default template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****d80e4e4044975745c14b****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'SetDefaultCustomTemplate', 'changeSet' => [ ['createdAt' => '2022-07-11T09:38:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultCustomTemplate'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SetDefaultCustomTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SetDefaultStorageLocation' => [ 'summary' => 'Set the default storage path for temporary files. The default storage address is used by the ICE online editor and the integrated web SDK to store temporary files generated during video editing, such as audio files generated by Intelligent configurations. Setting a default storage address avoids inconveniencing users who would otherwise need to specify storage paths for various temporary resources during editing. If you integrate ICE editing capabilities through an API, you can flexibly specify the path in the API request, and this default path will not take effect.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'description' => 'Storage type:'."\n" ."\n" .'- **vod\\_oss\\_bucket**: VOD-managed bucket.
'."\n" .' Supports adding buckets managed by the VOD system or OSS buckets added within the VOD system. If no active buckets are available, you can add a new bucket in the ApsaraVideo VOD console. After activating ApsaraVideo VOD, the system assigns a storage address in each storage region. You must enable this address before use. For details, see [Manage Storage Buckets](~~86097~~).'."\n" ."\n" .'- **user\\_oss\\_bucket**: User private bucket. Before adding an Object Storage address, you must activate Object Storage Service (OSS) and create a bucket. For details, see [Create a Bucket in the Console](~~31885~~).', 'enumValueTitles' => ['user_oss_bucket' => '', 'vod_oss_bucket' => ''], 'type' => 'string', 'required' => false, 'example' => 'user_oss_bucket', 'title' => '', ], ], [ 'name' => 'Bucket', 'in' => 'query', 'schema' => ['description' => 'The name of the OSS bucket you created.', 'type' => 'string', 'required' => false, 'example' => 'oss-test-bucket', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => ['description' => '- When storageType is set to user\\_oss\\_bucket, temporary files are stored under this path. If path is empty or set to /, files are stored in the root directory.'."\n" ."\n" .'- This field does not take effect for VOD storage.', 'type' => 'string', 'required' => false, 'example' => 'ims/dir', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '******5A-CAAC-4850-A3AF-B74606******'], 'Success' => ['description' => 'Indicates whether the operation succeeded. Valid values: true: succeeded. false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******5A-CAAC-4850-A3AF-B74606******\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Set Default Storage Location ', 'description' => '- Intelligent Media Services supports storage in either Object Storage Service or ApsaraVideo VOD. Activate the corresponding service based on your required storage type. The differences between the two are as follows:'."\n" ."\n" .'- **ApsaraVideo VOD storage**: ApsaraVideo VOD provides an all-in-one audio and video solution, including video storage, media asset management, and CDN-based playback. When storing media assets in ApsaraVideo VOD, Intelligent Media Services enhances VOD capabilities, enabling rapid development and publishing of video applications using VOD-provided APIs.'."\n" ."\n" .'- **Object Storage**: Object Storage Service (OSS) is Alibaba Cloud’s secure, low-cost, highly durable, and scalable cloud storage service. You can leverage the combined capabilities of Intelligent Media Services and OSS to develop audio and video applications for diverse scenarios.'."\n" ."\n" .'- You can also configure the storage address in the console. For details, see [Configure Storage Address](~~609918~~).'."\n" ."\n" .'- Storage fees are billed through OSS or ApsaraVideo VOD based on your configured storage address. For details, see [Media Asset Storage Billing](~~440701~~).', 'changeSet' => [ ['createdAt' => '2021-05-25T03:33:13.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultStorageLocation'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:SetDefaultStorageLocation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SetEventCallback' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'CallbackType', 'in' => 'query', 'schema' => [ 'description' => 'The callback method. Valid values:'."\n" ."\n" .'- **HTTP**'."\n" ."\n" .'- **MNS**', 'enumValueTitles' => ['MNS' => 'MNS', 'HTTP' => 'HTTP'], 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => '', ], ], [ 'name' => 'CallbackQueueName', 'in' => 'query', 'schema' => ['description' => 'The name of the Simple Message Queue (SMQ) queue in the region. The name must start with ice-callback-.', 'type' => 'string', 'required' => false, 'example' => 'ice-callback-queue', 'title' => ''], ], [ 'name' => 'CallbackURL', 'in' => 'query', 'schema' => ['description' => 'The callback URL. This parameter is required if you set CallbackType to **HTTP**. The callback URL cannot exceed 256 bytes in length. You can specify only one callback URL.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.yyy/callback', 'title' => ''], ], [ 'name' => 'EventTypeList', 'in' => 'query', 'schema' => ['description' => 'The type of the callback event. You can specify multiple values separated with commas (,). ProduceMediaComplete: indicates that the editing and production task is complete.', 'type' => 'string', 'required' => false, 'example' => 'ProduceMediaComplete', 'title' => ''], ], [ 'name' => 'AuthSwitch', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable callback authentication. This parameter takes effect only if you set CallbackType to **HTTP**. Valid values:'."\n" ."\n" .'- **on**'."\n" ."\n" .'- **off**', 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => '', ], ], [ 'name' => 'AuthKey', 'in' => 'query', 'schema' => ['description' => 'The authentication key. The key can be up to 32 characters in length and must contain uppercase letters, lowercase letters, and digits. This parameter takes effect only if you set CallbackType to **HTTP**.', 'type' => 'string', 'required' => false, 'example' => 'TestKey001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the configuration was successful. Valid values: true and false.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'example' => '', ], ], ], 'title' => 'SetEventCallback', 'summary' => 'Configures a callback method for one or more events.', 'changeSet' => [ ['createdAt' => '2021-06-25T14:18:28.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetEventCallback'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:SetEventCallback', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'translator' => 'manual', ], 'SetNotifyConfig' => [ 'summary' => 'Enables or disables event notifications for an AI Agent and sets the Callback URL and the Event Types to subscribe to.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236010', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI Agent.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'EnableNotify', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable or disable event notifications.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'CallbackUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL for receiving event notifications. This is not set by default.', 'type' => 'string', 'required' => false, 'example' => 'http://customer.com/callback', 'title' => ''], ], [ 'name' => 'EventTypes', 'in' => 'query', 'schema' => [ 'description' => 'The event types. If you do not specify this parameter, all event types are subscribed to by default. Valid values:'."\n" ."\n" .'- agent\\_start'."\n" ."\n" .'- agent\\_stop'."\n" ."\n" .'- error', 'enumValueTitles' => ['agent_start' => 'agent\\_start', 'error' => 'error', 'agent_stop' => 'agent\\_stop'], 'type' => 'string', 'required' => false, 'example' => 'agent_start,agent_stop,error', 'title' => '', ], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'An authentication token for event callbacks. The service includes this token in the `Authorization` header of each callback request.', 'type' => 'string', 'required' => false, 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', 'title' => ''], ], [ 'name' => 'AudioOssPath', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'EnableAudioRecording', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', 'title' => 'SetNotifyConfig', 'description' => '## Description'."\n" ."\n" .'This operation configures event notification settings for an AI Agent instance. You can enable or disable event notifications, specify the Callback URL, and define the Event Types to subscribe to. You can also provide an Authentication Token for enhanced security. A successful request returns a unique Request ID for tracking and troubleshooting.', 'changeSet' => [ ['createdAt' => '2025-04-08T03:25:30.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SetNotifyConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SetYikeUserRole' => [ 'summary' => 'Sets a user role.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'YikeUserId', 'in' => 'query', 'schema' => ['description' => 'The sub-account user ID.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], ], [ 'name' => 'RoleName', 'in' => 'query', 'schema' => ['description' => 'The user role. Valid values:'."\n" ."\n" .'- SuperAdmin: Super Admin.'."\n" ."\n" .'- Admin: Admin.'."\n" ."\n" .'- RegularUser: Regular User.', 'type' => 'string', 'required' => false, 'example' => 'Admin', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'Result' => ['description' => 'Indicates whether the operation succeeded.'."\n" ."\n" .'- true: Success'."\n" ."\n" .'- false: Failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'SetYikeUserRole', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:SetYikeUserRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Result\\": true\\n}","type":"json"}]', 'translator' => 'machine', ], 'StartAIAgentInstance' => [ 'summary' => 'Start an AI agent instance configured in IMS.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236525', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The agent ID configured in the [IMS console](https://ims.console.aliyun.com/ai/robot/list).', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'RuntimeConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The configuration required for the agent at runtime.', 'required' => true, '$ref' => '#/components/schemas/AIAgentRuntimeConfig', 'title' => '', 'example' => ''], ], [ 'name' => 'AgentConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The agent template configuration. Values you provide merge with the template configuration set in the console. If you omit this parameter, the agent uses its default configuration from the console.'."\n" ."\n" .'> This field is compatible with TemplateConfig. Fields in AgentConfig take precedence. If TemplateConfig contains fields not defined in AgentConfig, those fields are used. Use AgentConfig instead of TemplateConfig.', '$ref' => '#/components/schemas/AIAgentConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'User-defined data.', 'type' => 'string', 'required' => false, 'example' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'A unique identifier for the chat session. This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => 'f213fbc005e4f309379701645f4****'."\n", 'title' => ''], ], [ 'name' => 'ChatSyncConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The chat history synchronization configuration.', 'type' => 'object', 'properties' => [ 'IMAIAgentId' => ['description' => 'The IM agent ID.', 'type' => 'string', 'required' => false, 'example' => '******005e4f309379701645f4****'."\n", 'title' => ''], 'ReceiverId' => ['description' => 'The receiver user ID.', 'type' => 'string', 'required' => false, 'example' => '4167626d312034b2b1c3b7f2f3e41884', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The agent template configuration. Values you provide merge with the template configuration set in the console. If you omit this parameter, the agent uses its default configuration from the console.'."\n" ."\n" .'> The agent template configuration. This field is deprecated. See the AgentConfig field.', 'deprecated' => true, '$ref' => '#/components/schemas/AIAgentTemplateConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], 'InstanceId' => ['description' => 'The unique ID of the agent instance.', 'type' => 'string', 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Start an Agent Instance', 'description' => 'You can use this API to start a configured AI agent instance and join it to a chat. Specify the agent ID (`AIAgentId`), runtime configuration (`RuntimeConfig`), and optionally a template configuration (`TemplateConfig`) and user-defined data (`UserData`). After the agent instance starts successfully, the API returns a unique `InstanceId` for tracking or further operations.', 'changeSet' => [ ['createdAt' => '2025-05-29T07:43:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-27T07:13:06.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-01-23T09:26:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartAIAgentInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:StartAIAgentInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"InstanceId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'StartAIAgentOutboundCall' => [ 'summary' => 'Initiates an AI agent outbound call from a specific caller number to a called number and returns the call\'s InstanceId.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236524', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The AI agent ID configured in the [IMS console](https://ims.console.aliyun.com/ai/robot/list).', 'type' => 'string', 'required' => true, 'example' => '***********e4f309379701645f4****', 'title' => ''], ], [ 'name' => 'CallerNumber', 'in' => 'query', 'schema' => ['description' => 'The caller number. Only numbers from mainland China are supported.', 'type' => 'string', 'required' => true, 'example' => '183*****333', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => true, 'example' => '173*****533', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The AI agent outbound call configuration.', '$ref' => '#/components/schemas/AIAgentOutboundCallConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"city":"Hangzhou"}', 'required' => false, 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'A unique identifier for the session. You can use this ID to store, query, and synchronize chat history across multiple calls. This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => 'f213fbc005e4f309379701645f4****'."\n", 'title' => ''], ], [ 'name' => 'ImsAIAgentFreeObCall', 'in' => 'query', 'schema' => ['description' => 'A reserved parameter.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The call instance ID.', 'type' => 'string', 'example' => '*********296014bb58670940*********', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '***********-4417-BDB2************'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"*********296014bb58670940*********\\",\\n \\"RequestId\\": \\"***********-4417-BDB2************\\"\\n}","type":"json"}]', 'title' => 'Start Agent Outbound Call', 'description' => 'Use this API to start a configured AI agent instance and place an outbound call to a specified called number. Upon successful startup, the API returns a unique `InstanceId` for tracking or subsequent operations. Each caller number supports **up to 15 concurrent calls**.', 'changeSet' => [ ['createdAt' => '2025-07-01T02:22:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:StartAIAgentOutboundCall', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'StartAIWorkflow' => [ 'summary' => 'Initiates a workflow task for automated media processing based on a workflow template.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'WorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workflow template.', 'type' => 'string', 'docRequired' => true, 'example' => '****3f44-f1f6-477e-9364-c5e6c49e****', 'title' => '', 'required' => true], ], [ 'name' => 'Inputs', 'in' => 'query', 'schema' => ['description' => 'A JSON string containing the specific input parameters, such as information about the media assets, standard live streams, or RTC streams.', 'type' => 'string', 'example' => '{'."\n" .' "live_url": {'."\n" .' "Url": "rtmp://test.com/test_app/test_stream?auth_key=test",'."\n" .' "MaxIdleTime": 20'."\n" .' },'."\n" .' "source_language_id": "es"'."\n" .'}', 'title' => '', 'required' => false], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'A user-defined parameter for passing custom metadata.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .'"url":"https://test.com"'."\n" .'}', 'title' => ''], ], [ 'name' => 'DispatchTag', 'in' => 'query', 'schema' => ['description' => 'The tag for the task.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'TaskId' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'example' => "\n" .'********-266c-4bb8-b20c-6faa********', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TaskId\\": \\"\\\\n********-266c-4bb8-b20c-6faa********\\"\\n}","type":"json"}]', 'title' => 'StartAIWorkflow', 'description' => '- You must specify a workflow template. To create one, go to the [Intelligent Media Services (IMS)](https://ims.console.aliyun.com/ai-workflow/template) console.', 'requestParamsDescription' => 'The structure and required fields for the Inputs parameter are dynamically configured within the start node of the specific workflow template being used. Examples of common use cases:'."\n" ."\n" .'- Live translation:'."\n" ."\n" .''."\n" ."\n" .'```'."\n" .'{'."\n" .' "live_url": {'."\n" .' "Url": "rtmp://test.com/test_app/test_stream?auth_key=test",'."\n" .' "MaxIdleTime": 20'."\n" .' },'."\n" .' "source_language_id": "es"'."\n" .'}'."\n" .'```'."\n" ."\n" .'- RTC subtitle translation:'."\n" ."\n" .''."\n" ."\n" .'```'."\n" .'{'."\n" .' "rtc": {'."\n" .' "AppId": "xxx",'."\n" .' "ChannelId": "rtcaitest1",'."\n" .' "UserId": "userA"'."\n" .' },'."\n" .' "source_language_id": "zh",'."\n" .' "push_app_id": "app_id",'."\n" .' "push_channel_id": "channel_id",'."\n" .' "push_uid": "user_id"'."\n" .'}'."\n" .'```'."\n" ."\n" .'- Media processing:'."\n" ."\n" .''."\n" ."\n" .'```'."\n" .'{'."\n" .' "TaskInput":{'."\n" .' "Type":"OSS",'."\n" .' "Media": "oss://sashimi-cn-shanghai/test/test.flv"'."\n" .' }'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:StartAIWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StartChannel' => [ 'summary' => 'Starts a channel.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'StartChannel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:StartChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StartMediaLiveChannel' => [ 'summary' => 'Starts a MediaLive channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'ChannelId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'StartMediaLiveChannel', 'description' => '- Starts a channel only when the channel is idle. You cannot start a channel repeatedly.'."\n" ."\n" .'## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud 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.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartMediaLiveChannel'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:StartMediaLiveChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StartRtcRobotInstance' => [ 'summary' => 'Starts an RTC interactive AI agent instance and joins an RTC call.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '228630', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'RobotId', 'in' => 'query', 'schema' => ['description' => 'The AI agent\'s unique identifier.', 'type' => 'string', 'required' => true, 'example' => 'ca28b08ad3464ebcb42e5c0f7c6d2e89', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The RTC channel\'s unique identifier.', 'type' => 'string', 'required' => true, 'example' => 'testId', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The AI agent\'s unique identifier within the channel.', 'type' => 'string', 'required' => true, 'example' => 'my-robot', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'User-defined information.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'AuthToken', 'in' => 'query', 'schema' => ['description' => 'The authentication token required to join the RTC call. You must generate this token using your RTC AppKey.', 'type' => 'string', 'required' => true, 'example' => '**********', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Specifies advanced call configurations that override the agent\'s default configurations. If you omit this parameter, the agent uses its default configurations.', 'type' => 'object', 'properties' => [ 'EnableVoiceInterrupt' => ['description' => 'Specifies whether to allow voice interrupt.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'Greeting' => ['description' => 'The greeting the AI agent speaks when a user joins the call.', 'type' => 'string', 'required' => false, 'example' => '你好，有什么可以帮助的吗？', 'title' => ''], 'VoiceId' => ['description' => 'The voice\'s unique identifier.', 'type' => 'string', 'required' => false, 'example' => 'zhixiaoxia', 'title' => ''], 'AsrMaxSilence' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'UserOnlineTimeout' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'UserOfflineTimeout' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'VoiceprintId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'UseVoiceprint' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'Volume' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance\'s unique identifier.', 'type' => 'string', 'example' => '727dc0e296014bb58670940a3da95592', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '11DE0AB3-603B-5055-8A72-9C424854F983'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"727dc0e296014bb58670940a3da95592\\",\\n \\"RequestId\\": \\"11DE0AB3-603B-5055-8A72-9C424854F983\\"\\n}","type":"json"}]', 'title' => 'Start RTC Interactive AI Agent Instance', 'changeSet' => [ ['createdAt' => '2024-11-20T02:59:05.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-05T02:08:36.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:StartRtcRobotInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'StartWorkflow' => [ 'summary' => 'By invoking the StartWorkflow API, you can submit a media workflow template task to implement an automated media processing flow based on the workflow template.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'WorkflowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workflow template. To view the template ID, log on to the [IMS console](https://ims.console.aliyun.com/settings/workflow/list) and choose Configurations > Workflow Template.', 'type' => 'string', 'docRequired' => true, 'example' => '******f0e54971ecbffd472190******', 'title' => '', 'required' => true], ], [ 'name' => 'TaskInput', 'in' => 'query', 'schema' => ['description' => 'The workflow input. Only media assets are supported.', 'type' => 'string', 'example' => '{'."\n" .'      "Type": "Media",'."\n" .'      "Media": "******30706071edbfe290b488******"'."\n" .'} or'."\n" .'{'."\n" .'      "Type": "OSS",'."\n" .'      "Media": "oss://bucket/path/to/video.mp4"'."\n" .'}', 'title' => '', 'required' => false], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data in the JSON format, which cannot be up to 512 bytes in length. You can specify a custom callback URL. For more information, see [Configure a callback upon editing completion](~~451631~~).', 'type' => 'string', 'example' => '{"NotifyAddress":"https://xx.xx.xxx"} or{"NotifyAddress":"ice-callback-demo"}', 'required' => false, 'title' => ''], ], [ 'name' => 'SkipInputVerification', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to skip verification of the input path supported by the pipeline. This parameter takes effect only when the pipeline input is an OSS file. We recommend that you do not skip this verification to avoid faults caused by incorrect paths. If this parameter is not specified, verification is performed by default. Valid values:'."\n" ."\n" .'- **true**: Skip verification'."\n" ."\n" .'- **false**: Do not skip verification', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******42-E8E1-4FBB-8E52-F4225C******', 'title' => ''], 'TaskId' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'example' => '******22dad741d086a50325f9******', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******42-E8E1-4FBB-8E52-F4225C******\\",\\n \\"TaskId\\": \\"******22dad741d086a50325f9******\\"\\n}","type":"json"}]', 'title' => 'Submit Flow Task', 'description' => '- Currently, only media assets from Intelligent Media Services or ApsaraVideo VOD are supported as workflow inputs.'."\n" ."\n" .'- When submitting a flow task, you must specify a workflow template. You can create a workflow template in the [Intelligent Media Services console](https://ims.console.aliyun.com/settings/workflow/list) or use a system preset workflow template.', 'requestParamsDescription' => '**Workflow Trigger Matching Rules**'."\n" ."\n" .'When an OSS file triggers a workflow, the system applies the following matching policy: using the path of the newly added file as the basis, it checks the location bound to the workflow. If the file path contains the string specified in the rule, the rule matches; otherwise, it does not match. For example, given the file path:
'."\n" .'`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/ No match'."\n" .'7. http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/ No match'."\n" .'8. http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/ No match'."\n" .'```'."\n" ."\n" .'> When creating a new media workflow, do not configure the input path of one workflow as a prefix of another workflow\'s input path. Otherwise, a single incremental file may trigger two workflow execution instances. For example, if two workflows have input paths configured as `test` and `test1` respectively, uploading a file to the `test1` folder also satisfies the `test` prefix condition, thereby triggering two workflow execution instances.'."\n" ."\n" .'**Matching File Name Extensions**'."\n" ."\n" .'Only multimedia files can trigger workflows. The Media Library service determines whether a file is multimedia based on its file name extension. A file either has no extension (i.e., the file name does not contain the extension separator “.”), or its extension must comply with the following rules:'."\n" ."\n" .'> For `.swf` files, screenshot and transcoding quality are not guaranteed.'."\n" ."\n" .'| Type | File Name 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 |', 'changeSet' => [ ['createdAt' => '2025-06-19T06:29:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-08T02:15:21.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartWorkflow'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:StartWorkflow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StopAIAgentInstance' => [ 'summary' => 'Stop an agent instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236519', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The agent instance ID.'."\n" ."\n" .'> The InstanceId is the unique ID returned after successfully starting an agent instance. For information about starting an agent, see [StartAIAgentInstance](~~2846201~~) and [GenerateAIAgentCall](~~2846209~~).', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data structure returned in a successful response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', 'title' => 'Stop Agent Instance', 'description' => '- **Feature description**: Stops and terminates a running agent instance and release the associated resources.'."\n" ."\n" .'- **Parameter notes**: You must provide the unique ID (InstanceId) of the instance to be stopped as a query parameter.'."\n" ."\n" .'- **Common scenarios**: When an agent is no longer needed for a call or job, you can invoke this API to end its execution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:StopAIAgentInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StopAIWorkflowTask' => [ 'summary' => 'Manually stops a workflow task.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceL4UDD6'], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'required' => false, 'example' => '********-266c-4bb8-b20c-6faa********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'TaskId' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'example' => '********-266c-4bb8-b20c-6faa********', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TaskId\\": \\"********-266c-4bb8-b20c-6faa********\\"\\n}","type":"json"}]', 'title' => 'StopAIWorkflowTask', 'description' => 'This operation is only used to stop workflow tasks in real-time scenarios such as live streaming and RTC. It cannot be used to stop tasks in offline scenarios.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:StopAIWorkflowTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StopChannel' => [ 'summary' => 'Stops a MediaWeaver channel.', 'description' => ' ', 'path' => '/', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '创建成功', 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'StopChannel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'ice:StopChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StopMediaLiveChannel' => [ 'summary' => 'Stops a MediaLive channel.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239700', 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ 'name' => 'ChannelId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', 'title' => 'StopMediaLiveChannel', 'description' => '## QPS limit'."\n" ."\n" .'This operation can be called up to 50 times per second for each Alibaba Cloud account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopMediaLiveChannel'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:StopMediaLiveChannel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'StopRtcRobotInstance' => [ 'summary' => 'Stop an RTC interactive AI agent instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '228874', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => '727dc0e296014bb58670940a3da95592', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AC84E5DD-AB56-56C0-A992-07ECB82008CA'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC84E5DD-AB56-56C0-A992-07ECB82008CA\\"\\n}","type":"json"}]', 'title' => 'Stop RTC Interactive AI Agent Instance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:StopRtcRobotInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SubYikeUserCredit' => [ 'summary' => 'Deducts credits from a sub-account.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ 'name' => 'YikeUserId', 'in' => 'query', 'schema' => ['description' => 'The user ID of the sub-account.', 'type' => 'string', 'required' => true, 'example' => 'id', 'title' => ''], ], [ 'name' => 'Credit', 'in' => 'query', 'schema' => ['description' => 'The amount of credit to deduct. The value must be greater than 0 and cannot exceed the credit balance of the sub-account.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], 'Result' => ['description' => 'Indicates whether the operation succeeded.'."\n" ."\n" .'- `true`: The operation succeeded.'."\n" ."\n" .'- `false`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if the operation fails. A possible value is:'."\n" ."\n" .'- `NOT_ENOUGH_ALLOCATE_CREDIT_QUOTA`: The sub-account\'s credit balance is insufficient.', 'type' => 'string', 'example' => 'NOT_ENOUGH_ALLOCATE_CREDIT_QUOTA', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'SubYikeUserCredit', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SubYikeUserCredit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Result\\": true,\\n \\"ErrorCode\\": \\"NOT_ENOUGH_ALLOCATE_CREDIT_QUOTA\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'SubmitAIAgentVideoAuditTask' => [ 'summary' => 'Submits a video to a specified AI agent for content moderation. This operation supports video input from OSS and delivers the results asynchronously via callbacks. You can define custom frame-capturing policies and moderation prompts.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '236524', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'AIAgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the AI agent.', 'type' => 'string', 'required' => true, 'example' => '*******3b3d94abda22******', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The details of the input file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'- OSS: an OSS object.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The OSS URL of the input file. Format:'."\n" ."\n" .'http(s)://{BucketName}.{Endpoint}/{ObjectName}', 'type' => 'string', 'required' => false, 'example' => 'http://my-bucket.oss-cn-shanghai.aliyuncs.com/object-id.mp4', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"Custom":"hello"}', 'required' => false, 'title' => ''], ], [ 'name' => 'CallbackConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Callback configurations.', 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'The URL for receiving callback notifications.', 'type' => 'string', 'required' => false, 'example' => 'https://yourcallback', 'title' => ''], 'Token' => ['description' => 'The authentication token for callback.', 'type' => 'string', 'required' => false, 'example' => 'Bearer Token', 'title' => ''], ], 'required' => false, 'example' => '{"Url":"https://yourcallback","Token":"yourtoken"}', 'title' => '', ], ], [ 'name' => 'AuditInterval', 'in' => 'query', 'schema' => ['description' => 'The interval, in milliseconds, at which to submit captured frames to the AI agent. Valid values: 0 to 5000. Default value: 3000. If it is set to 0, all captured frames are sent to the model in a single batch request. Otherwise, frames are sent sequentially with the specified interval between each request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000', 'title' => ''], ], [ 'name' => 'CapturePolicies', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'An array of frame-capturing policies. Each policy defines a set of frames to be analyzed and will generate a separate result from the model.', 'type' => 'array', 'items' => [ 'description' => 'A single policy.', 'type' => 'object', 'properties' => [ 'FrameCount' => ['description' => 'The number of frames to capture.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], 'StartTime' => ['description' => 'The timestamp in the video at which to start capturing frames. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Duration' => ['description' => 'The duration over which to capture the specified number of frames. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], 'Prompt' => ['description' => 'The text prompt to send to the MLLM along with the captured frames.', 'type' => 'string', 'required' => false, 'example' => '请分析视频中的场景', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '**********fb04483915d4f2**********', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '**********-586A-AC29-742247******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"**********fb04483915d4f2**********\\",\\n \\"RequestId\\": \\"**********-586A-AC29-742247******\\"\\n}","type":"json"}]', 'title' => 'SubmitAIAgentVideoAuditTask', 'description' => 'Call SubmitAIAgentVideoAuditTask to submit a video moderation task with configurations such as a video URL, frame-capturing policies, and review interval. The system returns a unique JobId for tracking. When the task is complete, the service will push the results, including the moderation status and AI-generated analysis, to the configured callback URL. Only OSS URLs are supported as input. The underlying multi-modal large language model (MLLM) only supports interaction via the non-streaming OpenAI protocol.', 'responseParamsDescription' => '### CallbackMessageFormat'."\n" ."\n" .'#### ParameterDescription'."\n" ."\n" .'| Parameter | Type | Description | Example value |'."\n" .'| ----------- | ----------- | ----------------------- | ----------------------------- |'."\n" .'| JobId | String | Task ID | *******bb940f584ccbef******** |'."\n" .'| Status | String | Task Status | Success/Fail |'."\n" .'| Results | Array | Processing result array | \\- |'."\n" .'| \\> | JSON Object | ReviewResult structure | \\- |'."\n" .'| \\>> Content | String | MLLM Returned result | These picturesReviewApproved! |'."\n" .'| UserData | String | User-defined data | {"businessId": "xxx"} |'."\n" .'| Message | String | Message | "Success" |'."\n" ."\n" .'#### Response example'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "JobId": "*******bb940f584ccbef********",'."\n" .' "Status": "Success",'."\n" .' "Results": ['."\n" .' {'."\n" .' "Content": "These picturesReviewApproved!"'."\n" .' }'."\n" .' ],'."\n" .' "UserData": "{\\"businessId\\": \\"xxx\\"}",'."\n" .' "Message": "Success"'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2025-06-20T02:49:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SubmitAIAgentVideoAuditTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'SubmitASRJob' => [ 'summary' => 'Transcribes speech from a media file and returns the text with corresponding start and end timestamps.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'InputFile', 'in' => 'query', 'schema' => ['description' => 'The input configuration. Specify either an OSS URL or a media ID from the media library.', 'type' => 'string', 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or ****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'User-defined settings in JSON format. Use this to pass business-related data, such as the operating environment or other job details.', 'type' => 'string', 'example' => '{'."\n" .' "user": "data",'."\n" .' "env": "prod"'."\n" .'}', 'title' => '', 'required' => false], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The job title. The maximum length is 128 bytes.', 'type' => 'string', 'example' => 'Test title', 'title' => '', 'required' => false], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The job description. The maximum length is 128 bytes.', 'type' => 'string', 'example' => 'Test description', 'title' => '', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the segment to be transcribed from the media file.', 'type' => 'string', 'example' => '00:00:00', 'title' => '', 'required' => false], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'The duration of the segment to transcribe.', 'type' => 'string', 'example' => '00:00:10', 'title' => '', 'required' => false], ], [ 'name' => 'EditingConfig', 'in' => 'query', 'schema' => ['description' => 'The configuration for speech-to-text conversion:'."\n" ."\n" .'- HotwordLibraryIdList: A list of custom vocabulary IDs. Only one custom vocabulary ID is currently supported. Future releases will support multiple IDs.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "HotwordLibraryIdList": "******2609a14f54a0636b7e16******"'."\n" .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'JobId' => ['description' => 'The ID of the intelligent job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'State' => ['description' => 'The job status. Valid values:'."\n" ."\n" .'- Created'."\n" ."\n" .'- Executing'."\n" ."\n" .'- Finished'."\n" ."\n" .'- Failed', 'type' => 'string', 'example' => 'Finished', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"State\\": \\"Finished\\"\\n}","type":"json"}]', 'title' => 'Submit an ASR intelligent subtitling Job ', 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a job, the API returns a job ID and processes the job in the background. The results are sent through a callback notification, or you can query the job status by calling the [GetSmartTaskResult](~~441172~~) operation.', 'responseParamsDescription' => 'To query the result of an ASR job, call the [GetSmartTaskResult](~~441172~~) operation with the job ID. A successful job returns a response similar to the following example.'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" .' "JobResult": {'."\n" .' "AiResult": "[{\\"content\\":\\"提起\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"现在可以说是红的发紫了\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"常常票价很高\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"但是一开手就被疯抢一空\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"还参加各种相声综艺节目点评新人表演演员已经\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" .' },'."\n" .' "State": "Finished",'."\n" .' "Output": "[{\\"content\\":\\"提起\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"现在的可以说是红的发紫了\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"常常票价很高\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"但是一开手就被疯抢一空\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"还参加各种相声综艺节目点评新人表演演员已经\\",\\"from\\":6.265,\\"to\\":10.33}]",'."\n" .' "JobId": "******042d5e4db6866f6289d1******",'."\n" .' "SmartJobInfo": {'."\n" .' "JobType": "ASR",'."\n" .' "ModifiedTime": "2022-01-21T06:15:08Z",'."\n" .' "UserId": 1234562230123456,'."\n" .' "CreateTime": "2022-01-21T06:15:02Z",'."\n" .' "Title": "default_title_2022-01-21T06:15:02Z",'."\n" .' "InputConfig": {'."\n" .' "JobParameters": "{\\"duration\\":\\"00:30:00\\",\\"start_time\\":\\"00:00:00\\",\\"request_params\\":\\"&enable_word_level_result=true\\"}",'."\n" .' "InputFile": "oss://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4"'."\n" .' }'."\n" .' }'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2025-02-07T03:31:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-04-07T06:10:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-04-06T06:05:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitASRJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:SubmitASRJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitAudioProduceJob' => [ 'summary' => 'This API converts text into a high-quality audio file of speech.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'EditingConfig', 'in' => 'query', 'schema' => ['description' => 'The audio production configuration:'."\n" ."\n" .'- `voice`: The [voice type](~~449563~~).'."\n" ."\n" .'- `customizedVoice`: The ID of the custom voice for voice cloning.'."\n" ."\n" .'- `format`: The output file format. Supported formats: `PCM`, `WAV`, and `MP3`.'."\n" ."\n" .'- `volume`: The volume. The value ranges from 0 to 100. Default: 50.'."\n" ."\n" .'- `speech_rate`: The speech rate. The value ranges from -500 to 500. Default: 0.'."\n" ."\n" .' - Values of -500, 0, and 500 correspond to 0.5x, 1.0x, and 2.0x speed, respectively.'."\n" ."\n" .' - Calculation method:'."\n" ."\n" .' - For a 0.8x speed multiplier: (1 - 1/0.8) / 0.002 = -125.'."\n" ."\n" .' - For a 1.2x speed multiplier: (1 - 1/1.2) / 0.001 = 166.'."\n" ."\n" .' - For speed multipliers less than 1, use a factor of 0.002.'."\n" ."\n" .' - For speed multipliers greater than 1, use a factor of 0.001.'."\n" ."\n" .'- `pitch_rate`: The pitch rate. The value ranges from -500 to 500. Default: 0.'."\n" ."\n\n" .' >'."\n" ."\n" .' If you provide both `voice` and `customizedVoice`, `customizedVoice` takes precedence.'."\n" ."\n" .' >', 'type' => 'string', 'required' => true, 'example' => '{"voice":"Siqi","format":"MP3","volume":50}', 'title' => ''], ], [ 'name' => 'OutputConfig', 'in' => 'query', 'schema' => ['description' => 'The audio output configuration.', 'type' => 'string', 'example' => 'For example, to store the output audio at http://my_bucket.oss-cn-shanghai.aliyuncs.com/target_audio.mp3, configure this parameter as:'."\n" .'{'."\n" .'      "bucket": "my_bucket",'."\n" .'      "object": "target_audio"'."\n" .'}', 'required' => true, 'title' => ''], ], [ 'name' => 'InputConfig', 'in' => 'query', 'schema' => ['description' => 'The text to synthesize. The maximum length is 10,000 characters. Supports [SSML](~~2672807~~).', 'type' => 'string', 'example' => 'Audio production task', 'required' => true, 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the job. If you do not provide a title, the system automatically generates one based on the current date.'."\n" ."\n" .'- Cannot exceed 128 bytes.'."\n" ."\n" .'- Must be UTF-8 encoded.', 'type' => 'string', 'example' => 'China Regional Daily News', 'title' => '', 'required' => false], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the job.'."\n" ."\n" .'- Cannot exceed 1,024 bytes.'."\n" ."\n" .'- Must be UTF-8 encoded.', 'type' => 'string', 'example' => 'Task description, max 1024 bytes, UTF-8 encoded', 'title' => '', 'required' => false], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'Custom settings in JSON format. The maximum length is 512 bytes. This parameter supports [custom callback address configuration](~~451631~~).', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}', 'title' => '', 'required' => false], ], [ 'name' => 'Overwrite', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to overwrite an existing OSS file.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'State' => ['description' => 'The job status.'."\n" ."\n" .'- Created'."\n" ."\n" .'- Executing'."\n" ."\n" .'- Finished'."\n" ."\n" .'- Failed', 'type' => 'string', 'example' => 'Created', 'title' => ''], 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'example' => '****2bcbfcfa30fccb36f72dca22****', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"State\\": \\"Created\\",\\n \\"MediaId\\": \\"****2bcbfcfa30fccb36f72dca22****\\"\\n}","type":"json"}]', 'title' => 'SubmitAudioProduceJob', 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a job, you receive a job ID, and the job is processed in the background. You can get the result through a callback notification or by querying the job status with the [GetSmartJobResult API](~~441172~~).', 'responseParamsDescription' => 'Use the job ID with the [GetSmartJobResult API](~~441172~~) to query detailed information about a text-to-speech job. The following example shows a sample response from the [GetSmartJobResult API](~~441172~~) for a successful job.'."\n" ."\n" .'> By default, the TTS engine segments text based on punctuation marks such as commas and periods.'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" .' "JobId": "******042d5e4db6866f6289d1******",'."\n" .' "State": "Finished",'."\n" .' "SmartJobInfo": {'."\n" .' "Title": "default_title_2022-01-21T06:15:07Z",'."\n" .' "JobType": "TextToSpeech",'."\n" .' "CreateTime": "2022-01-21T06:15:07Z",'."\n" .' "ModifiedTime": "2022-01-21T06:15:07Z",'."\n" .' "InputConfig": {'."\n" .' "InputFile": "Speaking of Guo Degang, he is extremely popular now. Tickets are often expensive but sell out instantly. He also participates in various crosstalk variety shows to comment on new performers."'."\n" .' },'."\n" .' "EditingConfig": "{\\"format\\":\\"MP3\\",\\"pitch_rate\\":0,\\"sample_rate\\":16000,\\"speech_rate\\":0,\\"voice\\":\\"Siqi\\",\\"volume\\":50}",'."\n" .' "OutputConfig": {'."\n" .' "Bucket": "your-bucket",'."\n" .' "Object": "your-audio"'."\n" .' }'."\n" .' },'."\n" .' "JobResult": {'."\n" .' "MediaId": "******bf47c94e82b3b2014361******",'."\n" .' "AiResult": "[{\\"text\\":\\"Speaking of Guo Degang,\\",\\"begin_time\\":0,\\"end_time\\":846},{\\"text\\":\\"he is extremely popular now.\\",\\"begin_time\\":846,\\"end_time\\":3386},{\\"text\\":\\"Tickets are often expensive\\",\\"begin_time\\":3386,\\"end_time\\":4402},{\\"text\\":\\"but sell out instantly.\\",\\"begin_time\\":4402,\\"end_time\\":6265},{\\"text\\":\\"He also participates in various crosstalk variety shows to comment on new performers.\\",\\"begin_time\\":6265,\\"end_time\\":10330}]"'."\n" .' }'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2023-11-15T15:21:55.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-04-16T13:16:33.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2021-04-16T13:16:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-04-16T13:16:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAudioProduceJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SubmitAudioProduceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitAvatarTrainingJob' => [ 'summary' => 'Use this operation to submit a new avatar training job or to resubmit a failed job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier for the avatar training job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned by the request.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The unique identifier for the avatar training job.', 'type' => 'string', 'example' => '****29faef8144638ba42eb8e037****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****29faef8144638ba42eb8e037****\\"\\n }\\n}","type":"json"}]', 'title' => 'SubmitAvatarTrainingJob', 'description' => 'This is an [asynchronous API](~~3027141~~). When you call this operation, it returns a JobId and queues the training job for background processing. The initial response confirms the job submission, not its completion. The final result is sent via a callback notification, or you can check the job\'s status by [querying the details of an avatar training job](~~2526661~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:SubmitAvatarTrainingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitAvatarVideoJob' => [ 'summary' => 'Renders an avatar video from text or an audio file.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InputConfig', 'in' => 'query', 'schema' => ['description' => 'Input can be text, an audio file from Object Storage Service (OSS), or a [media asset](). Only MP3 and WAV audio formats are supported.> The value of the `Text` parameter must contain at least five characters.>', 'type' => 'string', 'example' => '{"Text": "To be or not to be, that is the question."}', 'required' => false, 'title' => ''], ], [ 'name' => 'EditingConfig', 'in' => 'query', 'schema' => ['description' => 'The configurations for the avatar job, such as the avatar ID, voice, and speech rate.', 'type' => 'string', 'required' => false, 'example' => '{"AvatarId":"yunqiao"}', 'title' => ''], ], [ 'name' => 'OutputConfig', 'in' => 'query', 'schema' => ['description' => 'Specifies the output configuration, including the destination URL for the rendered video.', 'type' => 'string', 'required' => false, 'example' => '{"MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4"}', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the job. The title can be up to 128 bytes in length.', 'type' => 'string', 'example' => 'Test title', 'title' => '', 'required' => false], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the job. The description can be up to 128 bytes in length.', 'type' => 'string', 'example' => 'Test description', 'title' => '', 'required' => false], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'A user-defined JSON string for passing custom business information, such as environment details or job metadata.', 'type' => 'string', 'example' => '{"user":"data","env":"prod"}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'."\n"], 'JobId' => ['description' => 'The [smart job]() ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****'."\n", 'title' => ''], 'MediaId' => ['description' => 'The ID of the output video\'s [media asset]().', 'type' => 'string', 'example' => '******70dcc471edaf00e6f6f4******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\\\n\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\\\n\\",\\n \\"MediaId\\": \\"******70dcc471edaf00e6f6f4******\\"\\n}","type":"json"}]', 'title' => 'SubmitAvatarVideoJob', 'description' => '- This is an [asynchronous API](~~3027141~~). After you submit a job, the API returns a job ID and queues the job for background processing. The service delivers the final result through a [callback notification](~~3027141~~). You can also query the job status by calling the [GetSmartJobResult](~~441172~~) operation.'."\n" ."\n" .'- The input can be text or an audio file in MP3 or WAV format.'."\n" ."\n" .'- The output supports both MP4 and WebM formats. When the output format is MP4, the job produces a video of the avatar against a green screen and a separate [alpha mask video]() for post-production. We recommend this option. When the output format is WebM, the job produces a single video with a transparent [alpha channel](), which is suitable for front-end display. Rendering in WebM format is slower due to encoding complexity.'."\n" ."\n" .'- The output includes [sentence-level timestamps]() for the generated speech, useful for subsequent video editing.', 'requestParamsDescription' => '### InputConfig example'."\n" ."\n" .'Provide input as an audio file URL:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "InputFile": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp3"'."\n" .'}'."\n" .'```'."\n" ."\n" .'Provide input as text:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "Text": "The quick brown fox jumps over the lazy dog."'."\n" .'}'."\n" .'```'."\n" ."\n" .'Provide input as a MediaId:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "MediaId": "4aef0c80cc0071edbf92f6e7c44b6302"'."\n" .'}'."\n" .'```'."\n" ."\n" .'### EditingConfig example'."\n" ."\n" .'`AvatarId`: Required. The ID of the avatar. For a list of official avatars, see [Official avatars](https://help.aliyun.com/document_detail/2254005.html).
'."\n" .'`Voice`: Optional. The [voice](https://help.aliyun.com/document_detail/449563.html) for text-to-speech synthesis. This parameter is valid only when the input is text. For available voices, see [Intelligent Speech voices](https://help.aliyun.com/document_detail/449563.html).
'."\n" .'`CustomizedVoice`: Specifies a [custom voice]() created with [voice cloning](). Use this parameter instead of the `Voice` parameter.
'."\n" .'`LoopMotion`: Specifies whether the first and last frames of the video are identical. If set to `true`, the avatar\'s motion and expression loop seamlessly without a noticeable jump. Valid values are `true` and `false`. The default value is `false`.
'."\n" .'`SpeechRate`: The [speech rate](). This parameter is valid only when the input is text. Valid values range from -500 to 500. The default value is 0.
'."\n" .'`PitchRate`: The [pitch](). This parameter is valid only when the input is text. Valid values range from -500 to 500. The default value is 0.
'."\n" .'`Volume`: The [volume](). This parameter is valid only when the input is text. Valid values range from 0 to 100. The default value is 50.
'."\n" .'`BackgroundUrl`: Optional. The URL of the [background image](). If you do not specify this parameter, the background is black by default. Supported formats are JPG and PNG. The resolution must be 1080p and must match the orientation of the avatar (portrait or landscape).






'."\n" ."\n" .'```'."\n" .'{'."\n" .' "AvatarId": "xinxin-marketing_standing", '."\n" .' "BackgroundUrl": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.jpg",'."\n" .' "Voice" : "zhichu",'."\n" .' "LoopMotion": true,'."\n" .' "SpeechRate": 100,'."\n" .' "PitchRate": 10, '."\n" .' "Volume": 10 '."\n" .'}'."\n" .'```'."\n" ."\n" .'### OutputConfig example'."\n" ."\n" .'```'."\n" .'{'."\n" .' "MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4"'."\n" .'}'."\n" .'```', 'responseParamsDescription' => 'You can call the [GetSmartJobResult](https://help.aliyun.com/en/ims/developer-reference/api-ice-2020-11-09-getsmarthandlejob) operation to query the job status and results. The following code shows an example of a successful response for a completed job.'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId": "2014D1A8-4143-164F-94B4-32B8F39B706D",'."\n" .' "JobId": "d9367da8c7184ec7a3f24de530ac5b9a",'."\n" .' "State": "Finished",'."\n" .' "SmartJobInfo": {'."\n" .' "Title": "default_title_2023-03-28T13:37:47Z",'."\n" .' "EditingConfig": "null",'."\n" .' "JobType": "AvatarVideo",'."\n" .' "CreateTime": "2023-03-28T13:37:47Z",'."\n" .' "ModifiedTime": "2023-03-28T13:37:47Z",'."\n" .' "UserId": 1833202230108227,'."\n" .' "outputConfig": {'."\n" .' "mediaUrl": "https://oushu-test-shanghai.oss-cn-shanghai.aliyuncs.com/avatar/222.mp4"'."\n" .' }'."\n" .' },'."\n" .' "JobResult": {'."\n" .' "MediaId": "4aef0c80cc0071edbf92f6e7c44b6302",'."\n" .' "AiResult": "{\\"outputVideoUrl\\":\\"https://oushu-test-shanghai.oss-cn-shanghai.aliyuncs.com/avatar/222.mp4\\",\\"subtitleClips\\":\\"[{\\\\\\"from\\\\\\":0.0,\\\\\\"to\\\\\\":2.13,\\\\\\"content\\\\\\":\\\\\\"The quick brown fox jumps over the lazy dog.\\\\\\"}]\\"}"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'The following code shows the format of the `AiResult` parameter.
'."\n" .'`outputVideoUrl`: The URL of the output video file, which is in MP4 format.
'."\n" .'`subtitleClips`: The sentence-level timestamps for the subtitles.

'."\n" ."\n" .'```'."\n" .'{'."\n" .' "outputVideoUrl": "https://oushu-test-shanghai.oss-cn-shanghai.aliyuncs.com/avatar/222.mp4",'."\n" .' "subtitleClips": "[{\\"from\\":0.0,\\"to\\":2.13,\\"content\\":\\"The quick brown fox jumps over the lazy dog.\\"}]"'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAvatarVideoJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:SubmitAvatarVideoJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitBatchMediaProducingJob' => [ 'summary' => 'Intelligently edits and combines multiple video, audio, and image media assets to create videos in batches with a single API call.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '131231', 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-side token used to ensure request idempotence.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****12e8864746a0a398****'."\n"], ], [ 'name' => 'InputConfig', 'in' => 'formData', 'schema' => ['description' => 'The input configuration. For the structure definition, see [InputConfig](~~2692547#2faed1559549n~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "MediaGroupArray": [{'."\n" .' "GroupName": "MediaGroup1",'."\n" .' "MediaArray": ['."\n" .' "****9d46c886b45481030f6e****",'."\n" .' "****6c886b4549d481030f6e****" ]'."\n" .' }, {'."\n" .' "GroupName": "MediaGroup2",'."\n" .' "MediaArray": ['."\n" .' "****d46c886810b454930f6e****",'."\n" .' "****4549d886810b46c30f6e****" ]'."\n" .' }],'."\n" .' "TitleArray": ['."\n" .' "回龙观盒马鲜生开业啦",'."\n" .' "盒马鲜生开业啦" ],'."\n" .' "SpeechTextArray": ['."\n" .' "附近的商场新开了一家盒马鲜生，今天是第一天开业"'."\n" .' "商场里的人不少，零食、酒水都比较便宜大家也快来看看呀" ]'."\n" .'}'], ], [ 'name' => 'EditingConfig', 'in' => 'formData', 'schema' => ['description' => 'The editing configuration. For the structure definition, see [EditingConfig](~~2692547#1be9bba03b7qu~~).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "MediaConfig": {'."\n" .' "Volume": 0'."\n" .' },'."\n" .' "SpeechConfig": {'."\n" .' "Volume": 1'."\n" .' },'."\n" .' "BackgroundMusicConfig": {'."\n" .' "Volume": 0.3'."\n" .' }'."\n" .'}', 'title' => ''], ], [ 'name' => 'OutputConfig', 'in' => 'query', 'schema' => ['description' => 'The output configuration. For the structure definition, see [OutputConfig](~~2692547#447b928fcbuoa~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" .' "Count": 20,'."\n" .' "MaxDuration": 15,'."\n" .' "Width": 1080,'."\n" .' "Height": 1920,'."\n" .' "Video": {"Crf": 27}'."\n" .'}'], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'Custom business and callback configurations. For the structure definition, see [UserData configuration](~~357745#section-urj-v3f-0s1~~).', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}', 'title' => '', 'required' => false], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'schema' => ['description' => 'The template parameters. You can configure multiple templates for one-click smart video creation. The system randomly selects one template to apply. For more information, see [TemplateConfig parameters](https://help.aliyun.com/zh/ims/use-cases/batch-video-production-public-parameters?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_5.342860c5H30VVS\\&scm=20140722.H_2877814._.OR_help-T_cn~zh-V_1#32c3bea6182sy).', 'type' => 'string', 'required' => false, 'example' => '["****b4549d46c88681030f6e****","****549d46c88b4681030f6e****"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'], 'JobId' => ['description' => 'The ID of the batch job for one-click smart video creation.', 'type' => 'string', 'title' => '', 'example' => '****d80e4e4044975745c14b****'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', 'title' => 'Batch Intelligent One-click Video Production ', 'description' => ''."\n" ."\n" .'- To use the one-click smart video creation feature, you must first subscribe to the IMS Subscription Service. For more information, see [Subscription Billing](~~439260#3285adfad70dw~~).'."\n" ."\n" .''."\n" ."\n\n" .''."\n" ."\n" .'- For more information about billing for one-click smart video creation, see [One-click Video Creation](~~2840901~~).'."\n" ."\n" .''."\n" ."\n\n" .'- The one-click smart video creation feature is an [asynchronous API](~~3027141~~). When you submit a job, the system returns a job ID and queues the job for asynchronous processing. The system delivers the final result through a callback. You can also query the job status by calling the [Get Batch Media Production Job Information](~~2693269~~) operation.'."\n" ."\n" .'- The one-click smart video creation feature offers multiple solutions, including Script-based Automated Video Creation, AI-powered Image-Text Matching Video Creation (General), AI-powered Image-Text Matching Video Creation (Highlights), Sports Highlight Video Creation, and High-Energy Montage Video Creation. For more information about these features, see [One-click Video Creation](~~2689046~~).'."\n" ."\n" .'- Script-based Automated Video Creation and AI-powered Image-Text Matching Video Creation share the same API for submitting jobs. To learn how to differentiate between them using parameters, see [Parameter Differences for One-click Video Creation](~~2846101~~).'."\n" ."\n" .'- After you submit a batch job for one-click smart video creation, you can call [ListBatchMediaProducingJob](~~2803751~~) to retrieve a list of all matching jobs. Call [GetBatchMediaProducingJob](~~2693269~~) to get detailed information about a job, including its status, the generated media asset ID, and the media asset URL.', 'changeSet' => [ ['createdAt' => '2025-03-24T06:08:20.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitBatchMediaProducingJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:SubmitBatchMediaProducingJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitCopyrightExtractJob' => [ 'summary' => 'Submits a copyright watermark extraction job.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The video file for watermark extraction.'."\n" ."\n" .'> - The region of the Object Storage Service (OSS) file or media asset must match the region of the current Intelligent Media Service (IMS) instance.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. OSS: The URL of a file in Object Storage Service (OSS).'."\n" ."\n" .'2. Media: The ID of a media asset.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'Specifies the URL of an Object Storage Service (OSS) object or the ID of a media asset.'."\n" .'OSS URLs can be in the following formats:'."\n" ."\n" .'1\\. oss\\://bucket/object'."\n" ."\n" .'2\\. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object'."\n" ."\n" .'In these formats, `bucket` is the name of a bucket in the same region as your IMS instance, and `object` is the file path.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data. The maximum length is 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'The watermark job parameters, specified as a JSON string.'."\n" ."\n" .'- algoType: The algorithm type. Default value: v1. The extraction algorithm type must match the algorithm type used for embedding the watermark.'."\n" ."\n" .' - v1: The copyright extraction algorithm for long-form videos.'."\n" ."\n" .' - v2: The copyright extraction algorithm for short-form videos.', 'type' => 'string', 'required' => false, 'example' => '{"algoType":"v2"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c63****4d80648792021eff90', 'title' => ''], ], 'example' => '', ], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****'], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c63****4d80648792021eff90\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', 'title' => 'SubmitCopyrightExtractJob', 'description' => '- The digital watermark APIs are available only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" .'- This is an [asynchronous interface](~~3027141~~). After you submit a job, the service returns a job ID. The service then queues the job for asynchronous processing. You can get the final results through a [callback notification](~~3027141~~) or query the job status by calling the [QueryCopyrightExtractJob](~~2862132~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightExtractJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SubmitCopyrightExtractJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'SubmitCopyrightJob' => [ 'summary' => 'Submits a video copyright watermark job.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The input video file to be watermarked.'."\n" ."\n" .'> - The OSS object or media asset must be in the same region as the service call.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. `OSS`: The URL of an OSS object.'."\n" ."\n" .'2. `Media`: The media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The input file, specified as either an OSS URL or a media asset ID. The following formats are supported for OSS URLs:'."\n" ."\n" .'1\\. `oss://bucket/object`'."\n" ."\n" .'2\\. `http(s)://bucket.oss-[regionId].aliyuncs.com/object`'."\n" ."\n" .'In these formats, `bucket` specifies the name of an OSS bucket in the same region as the service, and `object` specifies the file path.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object', 'title' => ''], ], 'required' => true, 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"}', 'title' => '', ], ], [ 'name' => 'Output', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The location of the output file.'."\n" ."\n" .'> - The OSS bucket must be in the same region as the service call.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the output file. Valid value:'."\n" ."\n" .'1. `OSS`: The URL of an OSS object.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The OSS URL for the output file. The following formats are supported:'."\n" ."\n" .'1\\. `oss://bucket/object`'."\n" ."\n" .'2\\. `http(s)://bucket.oss-[regionId].aliyuncs.com/object`
In these formats, `bucket` specifies the name of an OSS bucket in the same region as the service, and `object` specifies the file path.
', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/output.mp4', 'title' => ''], ], 'required' => true, 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"}', 'title' => '', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => ['description' => 'The watermark content to embed.', 'type' => 'string', 'example' => 'Copyright watermark test', 'required' => true, 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the watermark in seconds. Defaults to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'TotalTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the watermark in seconds. If unspecified, the watermark is applied until the video ends.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => ['description' => 'The watermark level, which specifies the embedding channel. Valid values are 0, 1, and 2, which correspond to the U, UV, and YUV channels, respectively.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'A description of the watermark job.', 'type' => 'string', 'example' => 'Task description', 'required' => false, 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user data. The value can be up to 1,024 bytes in length.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => ['description' => 'The parameters for the watermark job, specified as a JSON string. The following parameter is supported:'."\n" ."\n" .'- `algoType`: The algorithm type. Defaults to `v1`.'."\n" ."\n" .' - `v1`: For videos 3 minutes or longer.'."\n" ."\n" .' - `v2`: For short videos.', 'type' => 'string', 'required' => false, 'example' => '{"algoType":"v2"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c63****f4d80648792021eff90', 'title' => ''], ], 'example' => '', ], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3'."\n"], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c63****f4d80648792021eff90\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"FA258E67-09B8-4EAA-8F33-BA567834A2C3\\\\n\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', 'title' => 'SubmitCopyrightJob', 'description' => '- By default, this operation supports only videos 3 minutes or longer. Submitting a job for a shorter video may fail or produce no output. To watermark shorter videos, use the `Params` parameter.'."\n" ."\n" .'- You can submit a watermark job for only one video per API call.'."\n" ."\n" .'- Currently, digital watermark-related APIs are available only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" .'- This is an [asynchronous interface](~~3027141~~). After you submit a job, the system returns a job ID and queues the job for background processing. Results are delivered via callback notification. Alternatively, you can call the [Query Video Copyright Job List](~~2862135~~) operation to check the job status.', 'changeSet' => [ ['createdAt' => '2025-05-14T03:05:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightJob'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SubmitCopyrightJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'SubmitCustomizedVoiceJob' => [ 'summary' => 'Submits a basic voice cloning job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'VoiceId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier for the voice.', 'type' => 'string', 'required' => true, 'maxLength' => 32, 'minLength' => 0, 'example' => 'xiaozhuan', 'title' => ''], ], [ 'name' => 'DemoAudioMediaURL', 'in' => 'query', 'schema' => ['description' => 'The OSS URL where the demo audio will be saved.'."\n" ."\n" .'- If specified, the service generates a demo audio file at the provided OSS URL after training completes.'."\n" ."\n" .'- >'."\n" ."\n" .' The URL must be a valid public address for an OSS object in your account.'."\n" ."\n" .' >', 'type' => 'string', 'required' => false, 'example' => 'https://your-bucket.oss-cn-shanghai.aliyuncs.com/demo.MP3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The container for the response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The unique identifier for the voice cloning job.', 'type' => 'string', 'example' => '****d718e2ff4f018ccf419a7b71****', 'title' => ''], 'VoiceId' => ['description' => 'The unique identifier for the voice.', 'type' => 'string', 'example' => 'xiaozhuan', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\",\\n \\"VoiceId\\": \\"xiaozhuan\\"\\n }\\n}","type":"json"}]', 'title' => 'SubmitCustomizedVoiceJob', 'description' => ''."\n" ."\n" .'- Billing for voice cloning is based on customization and usage. For more information, see [voice cloning pricing](~~2399891#section-gy3-80e-clt~~).'."\n" ."\n" .''."\n" ."\n\n" .'- When you submit a voice cloning job, the `VoiceId` must match the one provided during audio detection. The service uses this parameter to locate the staged audio for training.'."\n" ."\n" .'- While the job is training, you can call the [GetCustomizedVoiceJob - Query a voice clone job](~~2384473~~) operation to query the job status.'."\n" ."\n" .'- This is an [asynchronous API](~~3027141~~). After a job is submitted, the API immediately returns a `JobId` and queues the job for background processing. The result is delivered via a callback. Alternatively, you can poll for the job status by using the [Query a voice clone job](~~2384473~~) operation.', 'changeSet' => [ ['createdAt' => '2023-09-12T06:44:14.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCustomizedVoiceJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:SubmitCustomizedVoiceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitDNAJob' => [ 'summary' => 'Submits a DNA job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The input DNA file.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" ."\n" .'1. `OSS`: The input is an OSS file url.'."\n" ."\n" .'2. `Media`: The input is a media ID.', 'type' => 'string', 'required' => true, 'example' => 'Media', 'title' => ''], 'Media' => ['description' => 'The media ID or OSS file url of the input file.'."\n" ."\n" .'1\\. `oss://bucket/object`'."\n" ."\n" .'2\\. `http(s)://bucket.oss-[regionId].aliyuncs.com/object`'."\n" ."\n" .'In these formats, `bucket` is the name of an OSS bucket in the same region as your project, and `object` is the file path.', 'type' => 'string', 'required' => true, 'example' => '1b1b9cd148034739af413150fded****', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'PipelineId', 'in' => 'query', 'schema' => ['description' => 'The pipeline ID.', 'type' => 'string', 'required' => false, 'example' => '5246b8d12a62433ab77845074039****', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The DNA configuration in JSON format. If specified, these settings override the corresponding template parameters.', 'type' => 'string', 'required' => false, 'example' => '{"SaveType": "save","MediaType":"video"}', 'title' => ''], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => false, 'example' => 'S00000101-100060', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data. The maximum length is 128 bytes.', 'type' => 'string', 'required' => false, 'example' => 'userData', 'title' => ''], ], [ 'name' => 'PrimaryKey', 'in' => 'query', 'schema' => ['description' => 'The unique primary key for the video. You are responsible for ensuring its uniqueness.', 'type' => 'string', 'required' => true, 'example' => '3ca84a39a9024f19853b21be9cf9****', 'title' => ''], ], [ 'name' => 'DBId', 'in' => 'query', 'schema' => ['description' => 'The DNA library ID. To create a DNA library, see [CreateDNADB](~~479275~~).', 'type' => 'string', 'required' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], 'JobId' => ['description' => 'The ID of the DNA job. Save this ID for subsequent API calls.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","type":"json"}]', 'title' => 'SubmitDNAJob', 'description' => '- This is an [asynchronous API](~~3027141~~). After you submit a job, the system returns a job ID and queues the job for asynchronous execution in the background. You receive the final result in a [callback notification](~~3027141~~). You can also call the [ListDNAJobs](~~479279~~) operation to query the job status.'."\n" ."\n" .'- This operation is available in the following regions: China (Beijing), China (Hangzhou), and China (Shanghai).'."\n" ."\n" .'- Text-based DNA jobs are currently supported only in the China (Shanghai) region.', 'requestParamsDescription' => 'The `Config` parameter includes the `SaveType` and `MediaType` fields.'."\n" ."\n" .'`SaveType` specifies the storage policy. Valid values include:'."\n" ."\n" .'- **nosave**: Searches for duplicates in the DNA library but does not add the input file.'."\n" ."\n" .'- **save**: Adds the input file to the DNA library only if no duplicates are found.'."\n" ."\n" .'- **forcesave**: Adds the input file to the DNA library regardless of whether duplicates exist.'."\n" ."\n" .'- **onlysave**: Adds the input file to the DNA library without searching for duplicates.'."\n" ."\n" .'`MediaType` specifies the media type of the input file. Valid values include:'."\n" ."\n" .'- **video**: Video.'."\n" ."\n" .'- **audio**: Audio.'."\n" ."\n" .'- **image**: Image.'."\n" ."\n" .'- **text**: Long text.'."\n" ."\n" .'- **asr**: ASR-recognized text.', 'changeSet' => [ ['createdAt' => '2023-05-25T07:23:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDNAJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SubmitDNAJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitDynamicChartJob' => [ 'summary' => 'Submits a job to generate a dynamic chart video, such as a Line Chart, Pie Chart, or Bar Chart, from Excel data. You can customize chart elements like line colors and fonts.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'ChartType', 'in' => 'query', 'schema' => [ 'description' => 'The chart type to generate.', 'enumValueTitles' => ['Line' => ': A line chart.', 'Histogram' => ': A bar chart.', 'Pie' => ': A pie chart.'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Line', ], ], [ 'name' => 'Input', 'in' => 'query', 'schema' => ['description' => 'The input data configuration, which specifies the Excel file location.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{"XlsFile":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.xls"}'], ], [ 'name' => 'OutputConfig', 'in' => 'query', 'schema' => ['description' => 'The output video configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{"MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.mp4","Bitrate":2000,"Width":800,"Height":680}'], ], [ 'name' => 'ChartConfig', 'in' => 'query', 'schema' => ['description' => 'The overall configuration for the chart\'s appearance and timing.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"Style":"Normal","TitleStartTime":"3000","ChartStartTime":"3000","VideoDuration":"15000"}'], ], [ 'name' => 'ChartTitle', 'in' => 'query', 'schema' => ['description' => 'The chart title settings.', 'type' => 'string', 'example' => '{"Text":" primary title","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', 'title' => '', 'required' => false], ], [ 'name' => 'Subtitle', 'in' => 'query', 'schema' => ['description' => 'The subtitle settings.', 'type' => 'string', 'example' => '{"Text":"Subtitle","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', 'title' => '', 'required' => false], ], [ 'name' => 'Unit', 'in' => 'query', 'schema' => ['description' => 'The data unit label settings.', 'type' => 'string', 'example' => '{"Text":"Unit","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', 'title' => '', 'required' => false], ], [ 'name' => 'DataSource', 'in' => 'query', 'schema' => ['description' => 'The data source label settings.', 'type' => 'string', 'example' => '{"Text":"Data source","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', 'title' => '', 'required' => false], ], [ 'name' => 'Background', 'in' => 'query', 'schema' => ['description' => 'The settings for the chart background. You can specify a Background Color or a Background Image.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"Color":"#000000","ImageUrl":"http://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.jpg"}'], ], [ 'name' => 'AxisParams', 'in' => 'query', 'schema' => ['description' => 'The axis style settings. If `XAxisFontInterval` is not specified or is set to 0, the system automatically calculates the interval.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"FontFile":"Microsoft YaHei","XAxisFontSize":"30","YAxisFontSize":"30","XAxisFontInterval":"30","AxisColor":"30"}'], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The job title.', 'type' => 'string', 'example' => 'Task title', 'title' => '', 'required' => false], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The job description.', 'type' => 'string', 'example' => 'Task description', 'title' => '', 'required' => false], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The custom user data in JSON format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"user":"data"}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The Request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'JobId' => ['description' => 'The Job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', 'title' => 'SubmitDynamicChartJob', 'description' => 'This operation generates a dynamic chart video from Excel data. This feature is available only in the Shanghai Region.'."\n" ."\n" .'- Customize text elements including the Chart Title, Subtitle, Data Source, and Unit. You can also specify the Font and Font Size. For supported fonts, see the [Font List](~~449567~~).'."\n" ."\n" .'- Supports five built-in styles: Normal, Mystery, Lively, Business, and Green.'."\n" ."\n" .'- Set a custom Background Color or Background Image.'."\n" ."\n" .'- Configure output video properties such as Video Duration, Dimensions, and Bitrate.'."\n" ."\n" .'Examples:'."\n" ."\n" .'- Line Chart: [Excel Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/line.xlsx), [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/line.mp4).'."\n" ."\n" .'- Bar Chart: [Excel Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/histgram.xlsx), [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/histgram.mp4).'."\n" ."\n" .'- Pie Chart: [Excel Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/pie.xlsx), [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/pie.mp4).'."\n" ."\n" .'- Normal style: [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Normal.mp4).'."\n" ."\n" .'- Mystery style: [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Mystery.mp4).'."\n" ."\n" .'- Lively style: [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Lively.mp4).'."\n" ."\n" .'- Business style: [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Business.mp4).'."\n" ."\n" .'- Green style: [Result Sample](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Green.mp4).', 'responseParamsDescription' => 'After submitting the job, use the returned `JobId` to check its status by calling the [Get Smart Task Result Interface](~~441172~~). A successful job returns a response similar to the following example.'."\n" ."\n" .'```'."\n" .'{'."\n" .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" .' "JobResult": {'."\n" .' "MediaId": "******bf47c94e82b3b2014361******"'."\n" .' },'."\n" .' "State": "Finished",'."\n" .' "JobId": "******042d5e4db6866f6289d1******",'."\n" .' "SmartJobInfo": {'."\n" .' "JobType": "DynamicChart",'."\n" .' "ModifiedTime": "2022-01-21T07:02:02Z",'."\n" .' "UserId": 1234562230123456,'."\n" .' "CreateTime": "2022-01-21T07:02:02Z",'."\n" .' "Title": "Dynamic Chart Use Case 1",'."\n" .' "EditingConfig": "null"'."\n" .' }'."\n" .'}'."\n" .'```', 'changeSet' => [ ['createdAt' => '2021-12-21T15:43:32.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDynamicChartJob'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'ice:SubmitDynamicChartJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitDynamicImageJob' => [ 'summary' => 'Use this API to submit a task to generate a dynamic image.', 'methods' => ['get', 'post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The job name.', 'type' => 'string', 'required' => false, 'example' => 'SampleJob', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The job input.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the job input. Valid values:'."\n" ."\n" .'- `OSS`: An Object Storage Service (OSS) file URL.'."\n" ."\n" .'- `Media`: A media asset ID.', 'enumValueTitles' => ['Media' => 'A media asset ID.', 'OSS' => 'An OSS URL.'], 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => '', ], 'Media' => ['description' => 'The input media resource.'."\n" ."\n" .'- If `Type` is set to `OSS`, specify the OSS URL of the input file.'."\n" ."\n" .'- If `Type` is set to `Media`, specify the media asset ID.'."\n" ."\n" .'An OSS URL must be in one of the following formats:'."\n" ."\n" .'1. `oss://bucket/object`'."\n" ."\n" .'2. `http(s)://bucket.oss-[RegionId].aliyuncs.com/object`'."\n" ."\n" .'In these formats, `bucket` is the name of an OSS bucket in the same region as the current project, and `object` is the file path.'."\n" ."\n" .'> The specified OSS bucket must be registered in IMS [storage management](~~609918~~).', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object.mp4', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Output', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The job output.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the job output. Valid values:'."\n" ."\n" .'- `OSS`: The output is an OSS file.'."\n" ."\n" .'- `Media`: The output is a new media asset.', 'enumValueTitles' => ['Media' => 'A new media asset is created.', 'OSS' => 'An OSS file.'], 'type' => 'string', 'required' => true, 'example' => 'Media', 'title' => '', ], 'Media' => ['description' => 'The destination OSS URL for the output file. This parameter is required when `Type` is set to `OSS`. The URL must be in one of the following formats:'."\n" ."\n" .'- `oss://bucket/object`'."\n" ."\n" .'- `http(s)://bucket.oss-[regionId].aliyuncs.com/object`'."\n" ."\n" .'In these formats, `bucket` is the name of an OSS bucket in the same region as the current project, and `object` is the file path.'."\n" ."\n" .'> The specified OSS bucket must be registered in IMS [storage management](~~609918~~).', 'type' => 'string', 'required' => true, 'example' => '****96e8864746a0b6f3****', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The snapshot template configuration.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '****96e8864746a0b6f3****'."\n", 'title' => ''], 'OverwriteParams' => [ 'description' => 'The overwrite parameters.', 'type' => 'object', 'properties' => [ 'Format' => [ 'description' => 'The animated image format. Valid values:'."\n" ."\n" .'- `gif`'."\n" ."\n" .'- `webp`', 'enumValueTitles' => ['gif' => 'gif', 'webp' => 'webp'], 'type' => 'string', 'required' => false, 'example' => 'gif', 'title' => '', ], 'Width' => ['description' => 'The width of the output animated image. Valid range: \\[128, 4096].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''], 'Height' => ['description' => 'The height of the output animated image. Valid range: \\[128, 4096].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720', 'title' => ''], 'Fps' => ['description' => 'The frame rate. Valid range: \\[1, 60].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'title' => ''], 'ScanMode' => [ 'description' => 'The scan mode. Valid values:'."\n" ."\n" .'- **interlaced**: Interlaced scanning.'."\n" ."\n" .'- **progressive**: Progressive scanning. This is the default value.', 'enumValueTitles' => ['progressive' => 'Progressive scanning.', 'interlaced' => 'Interlaced scanning.'], 'type' => 'string', 'required' => false, 'example' => 'progressive', 'title' => '', ], 'LongShortMode' => [ 'description' => 'Specifies whether to enable adaptive orientation based on the long and short edges of the video. Valid values:'."\n" ."\n" .'- **true**: Enables adaptive orientation.'."\n" ."\n" .'- **false**: Disables adaptive orientation.'."\n" ."\n" .'Default value: **true**.'."\n" ."\n" .'> When enabled, this mode sets the output width to the source video\'s long edge and the output height to its short edge. For a portrait video, its height is treated as the long edge and its width as the short edge.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => '', ], 'TimeSpan' => [ 'title' => '', 'description' => 'Specifies the time range of the video to process for the animated image.', 'type' => 'object', 'properties' => [ 'Seek' => ['description' => 'The start time of the video segment to be processed.'."\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 or 32000.23', 'required' => false, 'title' => ''], 'Duration' => ['description' => 'The duration of the video segment to be processed.'."\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 or 32000.23', 'required' => false, 'title' => ''], 'End' => ['description' => 'The end time of the video segment to be processed. If this parameter is set, the `Duration` parameter is ignored.'."\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 or 32000.23', 'required' => false, 'title' => ''], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'ScheduleConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The scheduling configuration.', 'type' => 'object', 'properties' => [ 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'required' => false, 'example' => '****96e8864746a0b6f3****'."\n", 'title' => ''], 'Priority' => ['description' => 'The priority of the job. Valid range: \\[1, 10]. A higher value indicates a higher priority. Default value: 6.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user-defined data.', 'type' => 'string', 'required' => false, 'example' => '{"SampleKey": "SampleValue"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'JobId' => ['description' => 'The ID of the job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', 'title' => 'SubmitDynamicImageJob', 'description' => 'This is an [asynchronous interface](~~3027141~~). When you submit a task, you will immediately receive a task ID while the task is queued for asynchronous execution in the background. The final result is sent via a callback notification, or you can poll the task status by [querying the dynamic image task details](~~441199~~).', 'changeSet' => [ ['createdAt' => '2022-08-10T06:33:29.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDynamicImageJob'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'ice:SubmitDynamicImageJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitHighlightExtractionJob' => [ 'summary' => 'Submits a highlight extraction job.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token provided by the caller to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****12e8864746a0a398****'."\n"], ], [ 'name' => 'InputConfig', 'in' => 'formData', 'schema' => ['description' => 'The input configuration. For more information, see [InputConfig Parameter Description](~~2869391#e72301e3a74mk~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "MediaArray": [{'."\n" .' "MediaId": "ceb72f00e****1ef8216e7e6c64a6302"'."\n" .' }, {'."\n" .' "MediaId": "ce450c40e****1ef8216e7e6c64a6302"'."\n" .' }, {'."\n" .' "MediaId": "ce49a020e****1ef81c1e6f6d5686302"'."\n" .' }, {'."\n" .' "MediaId": "d047e120e****1ef81c1e6f6d5686302"'."\n" .' }, {'."\n" .' "MediaId": "cfe2ddc0e****1ef81c1e6f6d5686302"'."\n" .' }],'."\n" .' "Strategy": {'."\n" .' "Count": 5,'."\n" .' "ClipDuration": 15'."\n" .' }'."\n" .'}'], ], [ 'name' => 'OutputConfig', 'in' => 'query', 'schema' => ['description' => 'The output configuration. For more information, see [OutputConfig Parameter Description](~~2869391#cd08cbc516voq~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "NeedExport": true,'."\n" .' "OutputMediaTarget": "oss-object",'."\n" .' "Bucket": "test-bucket",'."\n" .' "ObjectKey": "path/to/test_{index}.mp4",'."\n" .' "Width": 1920,'."\n" .' "Height": 1080,'."\n" .' "ExportAsNewMedia": false'."\n" .'}'], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => ['description' => 'The user data and callback configuration. For details on the structure, see [UserData Configuration](~~357745#section-urj-v3f-0s1~~).', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'JobId' => ['description' => 'The ID of the highlight extraction job.', 'type' => 'string', 'title' => '', 'example' => '****cdb3e74639973036bc84****'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\"\\n}","type":"json"}]', 'title' => 'SubmitHighlightExtractionJob', 'description' => 'This is an [asynchronous API](~~3027141~~). When you submit a job, the API returns a job ID. The system then queues the job for background processing and sends the final result via a callback notification. You can also query the job status by calling the [Get Smart Task Result](~~441172~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'ice:SubmitHighlightExtractionJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitIProductionJob' => [ 'summary' => 'Use the `SubmitIProductionJob` operation to submit an intelligent production job.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the job, which can be up to 100 characters long.', 'type' => 'string', 'example' => 'Test task', 'required' => false, 'title' => ''], ], [ 'name' => 'FunctionName', 'in' => 'query', 'schema' => ['description' => 'The name of the algorithm function. Valid values:'."\n" ."\n" .'- **Cover**: Generates a smart cover.'."\n" ."\n" .'- **VideoClip**: Creates a video summary.'."\n" ."\n" .'- **VideoDelogo**: Removes logos from a video.'."\n" ."\n" .'- **VideoDetext**: Removes text from a video.'."\n" ."\n" .'- **CaptionExtraction**: Extracts captions from a video.'."\n" ."\n" .'- **VideoGreenScreenMatting**: Performs green screen keying for a video.'."\n" ."\n" .'- **FaceBeauty**: Applies beauty filters to faces in a video.'."\n" ."\n" .'- **VideoH2V**: Converts a horizontal video to a vertical video.'."\n" ."\n" .'- **MusicSegmentDetect**: Detects chorus segments in music.'."\n" ."\n" .'- **AudioBeatDetection**: Detects the beat of an audio track.'."\n" ."\n" .'- **AudioQualityAssessment**: Assesses audio quality.'."\n" ."\n" .'- **SpeechDenoise**: Reduces noise in speech audio.'."\n" ."\n" .'- **AudioMixing**: Mixes audio tracks.'."\n" ."\n" .'- **MusicDemix**: Separates vocals from accompaniment in music.', 'type' => 'string', 'required' => true, 'example' => 'Cover', 'title' => ''], ], [ 'name' => 'Input', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The input media asset. You can specify an OSS file or a media asset ID.'."\n" ."\n" .'The requirements for input files vary by algorithm function. For more information, see the supplementary instructions.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of input media. Valid values:'."\n" ."\n" .'- `OSS`: An OSS file path.'."\n" ."\n" .'- `Media`: A media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], 'Media' => ['description' => 'The OSS URL of the input file or the ID of the input media asset.'."\n" .'The OSS URL can be in one of the following formats:'."\n" ."\n" .'1. `oss:///