From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/ice/2020-11-09/api-docs.php | 111613 +++++++++++++----------------- 1 file changed, 48802 insertions(+), 62811 deletions(-) (limited to 'data/en_us/ice/2020-11-09') diff --git a/data/en_us/ice/2020-11-09/api-docs.php b/data/en_us/ice/2020-11-09/api-docs.php index 93d89fc..4be8c93 100644 --- a/data/en_us/ice/2020-11-09/api-docs.php +++ b/data/en_us/ice/2020-11-09/api-docs.php @@ -1,440 +1,188 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ICE', - 'version' => '2020-11-09', - ], + 'info' => ['style' => 'RPC', 'product' => 'ICE', 'version' => '2020-11-09'], 'directories' => [ [ - 'id' => 170098, - 'title' => 'Media asset upload', + 'children' => ['CreateUploadMedia', 'CreateUploadStream', 'RefreshUploadMedia', 'RegisterMediaStream', 'GetUrlUploadInfos', 'UploadMediaByURL', 'UploadStreamByURL'], 'type' => 'directory', - 'children' => [ - 'CreateUploadMedia', - 'CreateUploadStream', - 'RefreshUploadMedia', - 'RegisterMediaStream', - 'GetUrlUploadInfos', - 'UploadMediaByURL', - 'UploadStreamByURL', - ], + 'title' => 'Media upload', ], [ - 'id' => 170106, - 'title' => 'Media asset management', - 'type' => 'directory', 'children' => [ [ - 'id' => 186460, - 'title' => 'Media asset search', - 'type' => 'directory', 'children' => [ [ - 'id' => 277535, - 'title' => 'Stream media asset', + 'children' => ['CloseStreamToSearchLib', 'GetStreamTagList', 'CreateStreamToSearchLib', 'AddStreamTagToSearchLib'], 'type' => 'directory', - 'children' => [ - 'CloseStreamToSearchLib', - 'GetStreamTagList', - 'CreateStreamToSearchLib', - 'AddStreamTagToSearchLib', - ], + 'title' => 'Streaming media asset operations', ], [ - 'id' => 186506, - 'title' => 'Search library', + 'children' => ['CreateSearchLib', 'QuerySearchLib', 'ListSearchLib', 'AlterSearchLib', 'DropSearchLib'], 'type' => 'directory', - 'children' => [ - 'CreateSearchLib', - 'QuerySearchLib', - 'ListSearchLib', - 'AlterSearchLib', - 'DropSearchLib', - ], + 'title' => 'Search library management', ], [ - 'id' => 186510, - 'title' => 'Search index', + 'children' => ['CreateSearchIndex', 'AlterSearchIndex', 'QuerySearchIndex', 'DropSearchIndex'], 'type' => 'directory', - 'children' => [ - 'CreateSearchIndex', - 'AlterSearchIndex', - 'QuerySearchIndex', - 'DropSearchIndex', - ], + 'title' => 'Search index configuration management', ], [ - 'id' => 205155, - 'title' => 'Search index tasks', + 'children' => ['QueryMediaIndexJob', 'SearchIndexJobRerun'], 'type' => 'directory', - 'children' => [ - 'QueryMediaIndexJob', - 'SearchIndexJobRerun', - ], + 'title' => 'Search index task management', ], [ - 'id' => 205156, - 'title' => 'Media asset operation', + 'children' => ['InsertMediaToSearchLib', 'UpdateMediaToSearchLib', 'DeleteMediaFromSearchLib'], 'type' => 'directory', - 'children' => [ - 'InsertMediaToSearchLib', - 'UpdateMediaToSearchLib', - 'DeleteMediaFromSearchLib', - ], + 'title' => 'Media asset operations', ], [ - 'id' => 205157, - 'title' => 'Search', - 'type' => 'directory', 'children' => [ [ - 'id' => 205158, - 'title' => 'Basic search', + 'children' => ['SearchMedia', 'GetVideoList'], 'type' => 'directory', - 'children' => [ - 'SearchMedia', - 'GetVideoList', - ], + 'title' => 'Basic search', ], [ - 'id' => 205159, - 'title' => 'Face search', + 'children' => ['SearchMediaByFace', 'SearchMediaClipByFace'], 'type' => 'directory', - 'children' => [ - 'SearchMediaByFace', - 'SearchMediaClipByFace', - ], + 'title' => 'Face search', ], [ - 'id' => 205160, - 'title' => 'Label search', + 'children' => ['SearchMediaByAILabel'], 'type' => 'directory', - 'children' => [ - 'SearchMediaByAILabel', - ], + 'title' => 'Smart tag search', ], [ - 'id' => 205161, - 'title' => 'LLM search', + 'children' => ['SearchMediaByMultimodal', 'SearchMediaByHybrid'], 'type' => 'directory', - 'children' => [ - 'SearchMediaByMultimodal', - 'SearchMediaByHybrid', - ], + 'title' => 'Large model search', ], ], + 'type' => 'directory', + 'title' => 'Search features', ], ], + 'type' => 'directory', + 'title' => 'Media asset search', ], [ - 'id' => 137519, - 'title' => 'Media library', + 'children' => ['RegisterMediaInfo', 'GetMediaInfo', 'UpdateMediaInfo', 'DeleteMediaInfos', 'BatchGetMediaInfos', 'ListMediaBasicInfos', 'ListPublicMediaBasicInfos', 'ListAllPublicMediaTags', 'SubmitMediaAiAnalysisJob'], 'type' => 'directory', - 'children' => [ - 'RegisterMediaInfo', - 'GetMediaInfo', - 'UpdateMediaInfo', - 'DeleteMediaInfos', - 'BatchGetMediaInfos', - 'ListMediaBasicInfos', - 'ListPublicMediaBasicInfos', - 'ListAllPublicMediaTags', - 'SubmitMediaAiAnalysisJob', - ], + 'title' => 'Media asset library', ], [ - 'id' => 170110, - 'title' => 'Classification', + 'children' => ['GetCategories', 'UpdateCategory'], 'type' => 'directory', - 'children' => [ - 'AddCategory', - 'GetCategories', - 'UpdateCategory', - 'DeleteCategory', - ], + 'title' => 'Category management', ], [ - 'id' => 179222, - 'title' => 'Tag management', + 'children' => ['AddMediaMarks', 'GetMediaMarks', 'UpdateMediaMarks', 'DeleteMediaMarks', 'ListMediaMarks'], 'type' => 'directory', - 'children' => [ - 'AddMediaMarks', - 'GetMediaMarks', - 'UpdateMediaMarks', - 'DeleteMediaMarks', - 'ListMediaMarks', - ], + 'title' => 'Tag management', ], [ - 'id' => 357427, - 'title' => null, + 'children' => ['CreateIpcOrder', 'GetIpcDeviceInfo', 'QueryIpcQuota'], 'type' => 'directory', - 'children' => [ - 'CreateIpcOrder', - 'GetIpcDeviceInfo', - 'QueryIpcQuota', - ], + 'title' => 'IPC management', ], 'GetPlayInfo', 'DeletePlayInfo', ], + 'type' => 'directory', + 'title' => 'Media asset management', ], [ - 'id' => 174129, - 'title' => 'Media review', + 'children' => ['CreateAudit', 'SubmitMediaCensorJob', 'QueryMediaCensorJobDetail', 'QueryMediaCensorJobList'], 'type' => 'directory', - 'children' => [ - 'CreateAudit', - 'SubmitMediaCensorJob', - 'QueryMediaCensorJobDetail', - 'QueryMediaCensorJobList', - ], + 'title' => 'Media asset review', ], [ - 'id' => 170115, - 'title' => 'Configuration management', - 'type' => 'directory', 'children' => [ [ - 'id' => 170116, - 'title' => 'Templates', - 'type' => 'directory', - 'children' => [ - 'CreateCustomTemplate', - 'GetSystemTemplate', - 'GetCustomTemplate', - 'SetDefaultCustomTemplate', - 'UpdateCustomTemplate', - 'DeleteCustomTemplate', - 'ListSystemTemplates', - 'ListCustomTemplates', - ], - ], - [ - 'id' => 170125, - 'title' => 'Pipelines', + 'children' => ['GetSystemTemplate', 'SetDefaultCustomTemplate', 'UpdateCustomTemplate', 'ListSystemTemplates', 'ListCustomTemplates'], 'type' => 'directory', - 'children' => [ - 'CreatePipeline', - 'GetPipeline', - 'UpdatePipeline', - 'DeletePipeline', - 'ListPipelines', - ], + 'title' => 'Template management', ], ], + 'type' => 'directory', + 'title' => 'Configuration management', ], [ - 'id' => 170131, - 'title' => 'Media processing', - 'type' => 'directory', 'children' => [ [ - 'id' => 170132, - 'title' => 'Transcoding', + 'children' => ['SubmitMediaConvertJob', 'GetMediaConvertJob', 'ListMediaConvertJobs', 'SubmitTranscodeJob', 'GetTranscodeJob', 'ListTranscodeJobs', 'SubmitPackageJob', 'GetPackageJob', 'ListPackageJobs', 'GenerateKMSDataKey', 'DecryptKMSDataKey'], 'type' => 'directory', - 'children' => [ - 'SubmitTranscodeJob', - 'GetTranscodeJob', - 'ListTranscodeJobs', - 'SubmitPackageJob', - 'GetPackageJob', - 'ListPackageJobs', - 'GenerateKMSDataKey', - 'DecryptKMSDataKey', - ], + 'title' => 'Transcoding operations', ], [ - 'id' => 170136, - 'title' => 'Snapshot', + 'children' => ['SubmitSnapshotJob', 'SubmitDynamicImageJob', 'GetSnapshotUrls', 'GetSnapshotJob', 'GetDynamicImageJob', 'ListSnapshotJobs', 'ListDynamicImageJobs'], 'type' => 'directory', - 'children' => [ - 'SubmitSnapshotJob', - 'SubmitDynamicImageJob', - 'GetSnapshotUrls', - 'GetSnapshotJob', - 'GetDynamicImageJob', - 'ListSnapshotJobs', - 'ListDynamicImageJobs', - ], + 'title' => 'Snapshot operations', ], [ - 'id' => 170144, - 'title' => 'Media information', + 'children' => ['SubmitSyncMediaInfoJob', 'SubmitMediaInfoJob', 'GetMediaInfoJob', 'ListMediaInfoJobs'], 'type' => 'directory', - 'children' => [ - 'SubmitSyncMediaInfoJob', - 'SubmitMediaInfoJob', - 'GetMediaInfoJob', - 'ListMediaInfoJobs', - ], + 'title' => 'Media information operations', ], ], + 'type' => 'directory', + 'title' => 'Media processing', ], [ - 'id' => 171061, - 'title' => 'Real-time processing', - 'type' => 'directory', 'children' => [ [ - 'id' => 171331, - 'title' => 'Real-time media transcoding', + 'children' => ['CreateLiveTranscodeTemplate', 'GetLiveTranscodeTemplate', 'UpdateLiveTranscodeTemplate', 'DeleteLiveTranscodeTemplate', 'ListLiveTranscodeTemplates', 'SubmitLiveTranscodeJob', 'SendLiveTranscodeJobCommand', 'GetLiveTranscodeJob', 'UpdateLiveTranscodeJob', 'DeleteLiveTranscodeJob', 'ListLiveTranscodeJobs'], 'type' => 'directory', - 'children' => [ - 'CreateLiveTranscodeTemplate', - 'GetLiveTranscodeTemplate', - 'UpdateLiveTranscodeTemplate', - 'DeleteLiveTranscodeTemplate', - 'ListLiveTranscodeTemplates', - 'SubmitLiveTranscodeJob', - 'SendLiveTranscodeJobCommand', - 'GetLiveTranscodeJob', - 'UpdateLiveTranscodeJob', - 'DeleteLiveTranscodeJob', - 'ListLiveTranscodeJobs', - ], + 'title' => 'Real-time media transcoding', ], [ - 'id' => 171062, - 'title' => 'Real-time media recording', + 'children' => ['CreateLiveRecordTemplate', 'GetLiveRecordTemplate', 'UpdateLiveRecordTemplate', 'DeleteLiveRecordTemplate', 'ListLiveRecordTemplates', 'SubmitLiveRecordJob', 'GetLiveRecordJob', 'DeleteLiveRecordFiles', 'ListLiveRecordJobs', 'ListLiveRecordFiles'], 'type' => 'directory', - 'children' => [ - 'CreateLiveRecordTemplate', - 'GetLiveRecordTemplate', - 'UpdateLiveRecordTemplate', - 'DeleteLiveRecordTemplate', - 'ListLiveRecordTemplates', - 'SubmitLiveRecordJob', - 'GetLiveRecordJob', - 'DeleteLiveRecordFiles', - 'ListLiveRecordJobs', - 'ListLiveRecordFiles', - ], + 'title' => 'Real-time media recording', ], [ - 'id' => 171234, - 'title' => 'Real-time media screenshots', + 'children' => ['CreateLiveSnapshotTemplate', 'GetLiveSnapshotTemplate', 'UpdateLiveSnapshotTemplate', 'DeleteLiveSnapshotTemplate', 'ListLiveSnapshotTemplates', 'SubmitLiveSnapshotJob', 'SendLiveSnapshotJobCommand', 'GetLiveSnapshotJob', 'DeleteLiveSnapshotFiles', 'ListLiveSnapshotJobs', 'ListLiveSnapshotFiles'], 'type' => 'directory', - 'children' => [ - 'CreateLiveSnapshotTemplate', - 'GetLiveSnapshotTemplate', - 'UpdateLiveSnapshotTemplate', - 'DeleteLiveSnapshotTemplate', - 'ListLiveSnapshotTemplates', - 'SubmitLiveSnapshotJob', - 'SendLiveSnapshotJobCommand', - 'GetLiveSnapshotJob', - 'DeleteLiveSnapshotFiles', - 'ListLiveSnapshotJobs', - 'ListLiveSnapshotFiles', - ], + 'title' => 'Real-time media snapshot', ], ], + 'type' => 'directory', + 'title' => 'Real-time processing', ], [ - 'id' => 170149, - 'title' => 'Video production', - 'type' => 'directory', 'children' => [ [ - 'id' => 137503, - 'title' => 'Project management', - 'type' => 'directory', - 'children' => [ - 'CreateEditingProject', - 'GetEditingProject', - 'UpdateEditingProject', - 'DeleteEditingProjects', - 'ListEditingProjects', - 'AddEditingProjectMaterials', - 'GetEditingProjectMaterials', - 'DeleteEditingProjectMaterials', - 'GetLiveEditingIndexFile', - 'SubmitProjectExportJob', - 'GetProjectExportJob', - ], - ], - [ - 'id' => 137513, - 'title' => 'Video generation and editing', + 'children' => ['CreateEditingProject', 'GetEditingProject', 'UpdateEditingProject', 'DeleteEditingProjects', 'ListEditingProjects', 'AddEditingProjectMaterials', 'GetEditingProjectMaterials', 'DeleteEditingProjectMaterials', 'GetLiveEditingIndexFile', 'SubmitProjectExportJob', 'GetProjectExportJob'], 'type' => 'directory', - 'children' => [ - 'SubmitMediaProducingJob', - 'GetMediaProducingJob', - 'SubmitLiveEditingJob', - 'GetLiveEditingJob', - 'SubmitBatchMediaProducingJob', - 'GetBatchMediaProducingJob', - 'SubmitSportsHighlightsJob', - 'SubmitScreenMediaHighlightsJob', - 'ListMediaProducingJobs', - 'ListBatchMediaProducingJobs', - ], + 'title' => 'Cloud editing project management', ], [ - 'id' => 137528, - 'title' => 'Templates', + 'children' => ['SubmitMediaProducingJob', 'GetMediaProducingJob', 'SubmitLiveEditingJob', 'GetLiveEditingJob', 'SubmitBatchMediaProducingJob', 'GetBatchMediaProducingJob', 'SubmitSportsHighlightsJob', 'SubmitScreenMediaHighlightsJob', 'ListMediaProducingJobs', 'ListBatchMediaProducingJobs'], 'type' => 'directory', - 'children' => [ - 'AddTemplate', - 'GetTemplate', - 'UpdateTemplate', - 'DeleteTemplate', - 'ListTemplates', - 'GetTemplateMaterials', - 'GetTemplateParams', - ], + 'title' => 'Editing and production', ], [ - 'id' => 137534, - 'title' => 'Smart tasks', + 'children' => ['GetTemplateMaterials', 'GetTemplateParams'], 'type' => 'directory', + 'title' => 'Template factory', + ], + [ 'children' => [ [ - 'id' => 208842, - 'title' => 'Hotwords', + 'children' => ['DeleteHotwordLibrary', 'GetHotwordLibrary', 'ListHotwordLibraries', 'UpdateHotwordLibrary', 'CreateHotwordLibrary'], 'type' => 'directory', - 'children' => [ - 'DeleteHotwordLibrary', - 'GetHotwordLibrary', - 'ListHotwordLibraries', - 'UpdateHotwordLibrary', - 'CreateHotwordLibrary', - ], + 'title' => 'Hot word management', ], [ - 'id' => 185311, - 'title' => 'Avatar training', + 'children' => ['CreateAvatarTrainingJob', 'UpdateAvatarTrainingJob', 'SubmitAvatarTrainingJob', 'GetAvatarTrainingJob', 'DeleteAvatarTrainingJob', 'ListAvatarTrainingJobs', 'GetAvatar', 'ListAvatars'], 'type' => 'directory', - 'children' => [ - 'CreateAvatarTrainingJob', - 'UpdateAvatarTrainingJob', - 'SubmitAvatarTrainingJob', - 'GetAvatarTrainingJob', - 'DeleteAvatarTrainingJob', - 'ListAvatarTrainingJobs', - 'GetAvatar', - 'ListAvatars', - ], + 'title' => 'Digital human training', ], [ - 'id' => 183347, - 'title' => 'Voice clone', + 'children' => ['CreateCustomizedVoiceJob', 'GetDemonstrationForCustomizedVoiceJob', 'DetectAudioForCustomizedVoiceJob', 'SubmitCustomizedVoiceJob', 'SubmitStandardCustomizedVoiceJob', 'GetCustomizedVoiceJob', 'DeleteCustomizedVoiceJob', 'ListCustomizedVoiceJobs', 'GetCustomizedVoice', 'UpdateCustomizedVoice', 'ListCustomizedVoices'], 'type' => 'directory', - 'children' => [ - 'CreateCustomizedVoiceJob', - 'GetDemonstrationForCustomizedVoiceJob', - 'DetectAudioForCustomizedVoiceJob', - 'SubmitCustomizedVoiceJob', - 'SubmitStandardCustomizedVoiceJob', - 'GetCustomizedVoiceJob', - 'DeleteCustomizedVoiceJob', - 'ListCustomizedVoiceJobs', - 'GetCustomizedVoice', - 'UpdateCustomizedVoice', - 'ListCustomizedVoices', - ], + 'title' => 'Voice cloning', ], 'SubmitASRJob', 'SubmitAvatarVideoJob', @@ -449,382 +197,163 @@ 'ListSmartSysAvatarModels', 'ListSmartVoiceGroups', ], + 'type' => 'directory', + 'title' => 'Intelligent tasks', ], ], + 'type' => 'directory', + 'title' => 'Production', ], [ - 'id' => 194835, - 'title' => 'Real-time conversational AI', - 'type' => 'directory', 'children' => [ [ - 'id' => 196322, - 'title' => 'Agent management', + 'children' => ['StartAIAgentInstance', 'StopAIAgentInstance', 'UpdateAIAgentInstance', 'DescribeAIAgentInstance', 'ListAIAgentInstance', 'GetAIAgentConcurrency', 'SendAIAgentSpeech', 'TakeoverAIAgentCall', 'SendAIAgentDataChannelMessage', 'SendAIAgentText'], 'type' => 'directory', - 'children' => [ - 'StartAIAgentInstance', - 'StopAIAgentInstance', - 'UpdateAIAgentInstance', - 'DescribeAIAgentInstance', - 'ListAIAgentInstance', - 'SendAIAgentSpeech', - 'TakeoverAIAgentCall', - 'SendAIAgentDataChannelMessage', - 'SendAIAgentText', - ], + 'title' => 'Agent management', ], [ - 'id' => 196323, - 'title' => 'AICallKit integration', + 'children' => ['GenerateMessageChatToken', 'GenerateAIAgentCall', 'ListAIAgentDialogues', 'DeleteAIAgentDialogue', 'SendMessageChatText'], 'type' => 'directory', - 'children' => [ - 'GenerateMessageChatToken', - 'GenerateAIAgentCall', - 'ListAIAgentDialogues', - 'DeleteAIAgentDialogue', - 'SendMessageChatText', - ], + 'title' => 'AICallKit integration operations', ], [ - 'id' => 208799, - 'title' => 'Carrier line ', + 'children' => ['StartAIAgentOutboundCall', 'ListAIAgentPhoneNumber', 'ForwardAIAgentCall'], 'type' => 'directory', - 'children' => [ - 'StartAIAgentOutboundCall', - 'ListAIAgentPhoneNumber', - 'ForwardAIAgentCall', - ], + 'title' => 'Carrier line operations', ], [ - 'id' => 246577, - 'title' => 'Voiceprints ', + 'children' => ['SetAIAgentVoiceprint', 'ClearAIAgentVoiceprint', 'ListAIAgentVoiceprints'], 'type' => 'directory', - 'children' => [ - 'SetAIAgentVoiceprint', - 'ClearAIAgentVoiceprint', - 'ListAIAgentVoiceprints', - ], + 'title' => 'Voiceprint management', ], [ - 'id' => 208802, - 'title' => 'Offline task', + 'children' => ['SubmitAIAgentVideoAuditTask'], 'type' => 'directory', - 'children' => [ - 'SubmitAIAgentVideoAuditTask', - ], + 'title' => 'Offline tasks', ], [ - 'id' => 322101, - 'title' => 'RTOS License', + 'children' => ['GetAiRtcAuthCodeList', 'ActiveAiRtcLicense'], 'type' => 'directory', - 'children' => [ - 'GetAiRtcLicenseInfoList', - 'GetAiRtcAuthCodeList', - 'ActiveAiRtcLicense', - ], + 'title' => 'RTOS License', ], ], + 'type' => 'directory', + 'title' => 'Real-time conversational AI', ], [ - 'id' => 170150, - 'title' => 'Media AI', - 'type' => 'directory', 'children' => [ [ - 'id' => 178764, - 'title' => 'Smart tagging', - 'type' => 'directory', 'children' => [ [ - 'id' => 208941, - 'title' => 'Smart tagging task', + 'children' => ['SubmitVideoCognitionJob', 'QueryVideoCognitionJob'], 'type' => 'directory', - 'children' => [ - 'SubmitVideoCognitionJob', - 'QueryVideoCognitionJob', - 'QuerySmarttagJob', - 'SubmitSmarttagJob', - ], + 'title' => 'Task operations', ], [ - 'id' => 208942, - 'title' => 'Recognition entity', + 'children' => ['CreateRecognitionEntity', 'CreateRecognitionLib', 'CreateRecognitionSample', 'ListRecognitionSamples', 'DeleteRecognitionSample', 'ListRecognitionEntities', 'ListRecognitionLibs', 'DeleteRecognitionLib', 'DeleteRecognitionEntity'], 'type' => 'directory', - 'children' => [ - 'CreateRecognitionEntity', - 'CreateRecognitionLib', - 'CreateRecognitionSample', - 'ListRecognitionSamples', - 'DeleteRecognitionSample', - 'ListRecognitionEntities', - 'ListRecognitionLibs', - 'DeleteRecognitionLib', - 'DeleteRecognitionEntity', - ], + 'title' => 'Custom recognition entity operations', ], ], + 'type' => 'directory', + 'title' => 'Intelligent content understanding', ], [ - 'id' => 178765, - 'title' => 'Intelligent production', + 'children' => ['SubmitIProductionJob', 'QueryIProductionJob'], 'type' => 'directory', - 'children' => [ - 'SubmitIProductionJob', - 'QueryIProductionJob', - ], + 'title' => 'Intelligent production', ], [ - 'id' => 178766, - 'title' => 'Media fingerprinting', + 'children' => ['CreateDNADB', 'DeleteDNADB', 'ListDNADB', 'SubmitDNAJob', 'CancelDNAJob', 'DeleteDNAFiles', 'ListDNAFiles', 'QueryDNAJobList'], 'type' => 'directory', - 'children' => [ - 'CreateDNADB', - 'DeleteDNADB', - 'ListDNADB', - 'SubmitDNAJob', - 'CancelDNAJob', - 'DeleteDNAFiles', - 'ListDNAFiles', - 'QueryDNAJobList', - ], + 'title' => 'Media DNA', ], [ - 'id' => 199811, - 'title' => 'Digital watermarking ', + 'children' => ['SubmitCopyrightJob', 'QueryCopyrightJobList', 'SubmitCopyrightExtractJob', 'QueryCopyrightExtractJob', 'SubmitTraceAbJob', 'QueryTraceAbJobList', 'SubmitTraceM3u8Job', 'QueryTraceM3u8JobList', 'SubmitTraceExtractJob', 'QueryTraceExtractJob'], 'type' => 'directory', - 'children' => [ - 'SubmitCopyrightJob', - 'QueryCopyrightJobList', - 'SubmitCopyrightExtractJob', - 'QueryCopyrightExtractJob', - 'SubmitTraceAbJob', - 'QueryTraceAbJobList', - 'SubmitTraceM3u8Job', - 'QueryTraceM3u8JobList', - 'SubmitTraceExtractJob', - 'QueryTraceExtractJob', - ], + 'title' => 'Digital watermarking', ], ], + 'type' => 'directory', + 'title' => 'Media AI', ], [ - 'id' => 170153, - 'title' => 'Statistics', + 'children' => ['DescribeMeterImsMediaConvertUHDUsage', 'DescribeMeterImsMediaConvertUsage', 'DescribeMeterImsEditUsage', 'DescribeMeterImsSummary', 'DescribeMeterImsMpsAiUsage'], 'type' => 'directory', - 'children' => [ - 'DescribeMeterImsMediaConvertUHDUsage', - 'DescribeMeterImsMediaConvertUsage', - 'DescribeMeterImsEditUsage', - 'DescribeMeterImsSummary', - 'DescribeMeterImsMpsAiUsage', - ], + 'title' => 'Usage statistics', ], [ - 'id' => 137547, - 'title' => 'Global configuration', + 'children' => ['SetEventCallback', 'GetEventCallback'], 'type' => 'directory', - 'children' => [ - 'SetEventCallback', - 'GetEventCallback', - ], + 'title' => 'Global configuration', ], [ - 'id' => 178743, - 'title' => 'Workflow', + 'children' => ['StartWorkflow', 'GetWorkflowTask', 'ListWorkflowTasks', 'StartAIWorkflow', 'StopAIWorkflowTask', 'GetAIWorkflowTask'], 'type' => 'directory', - 'children' => [ - 'StartWorkflow', - 'GetWorkflowTask', - 'ListWorkflowTasks', - 'StartAIWorkflow', - 'StopAIWorkflowTask', - 'GetAIWorkflowTask', - ], + 'title' => 'Workflow', ], [ - 'id' => 201826, - 'title' => 'MediaService', - 'type' => 'directory', 'children' => [ [ - 'id' => 203088, - 'title' => 'MediaLive', + 'children' => ['CreateMediaLiveInputSecurityGroup', 'UpdateMediaLiveInputSecurityGroup', 'GetMediaLiveInputSecurityGroup', 'ListMediaLiveInputSecurityGroups', 'DeleteMediaLiveInputSecurityGroup', 'CreateMediaLiveInput', 'UpdateMediaLiveInput', 'GetMediaLiveInput', 'ListMediaLiveInputs', 'DeleteMediaLiveInput', 'CreateMediaLiveChannel', 'UpdateMediaLiveChannel', 'GetMediaLiveChannel', 'ListMediaLiveChannels', 'DeleteMediaLiveChannel', 'StartMediaLiveChannel', 'StopMediaLiveChannel'], 'type' => 'directory', - 'children' => [ - 'CreateMediaLiveInputSecurityGroup', - 'UpdateMediaLiveInputSecurityGroup', - 'GetMediaLiveInputSecurityGroup', - 'ListMediaLiveInputSecurityGroups', - 'DeleteMediaLiveInputSecurityGroup', - 'CreateMediaLiveInput', - 'UpdateMediaLiveInput', - 'GetMediaLiveInput', - 'ListMediaLiveInputs', - 'DeleteMediaLiveInput', - 'CreateMediaLiveChannel', - 'UpdateMediaLiveChannel', - 'GetMediaLiveChannel', - 'ListMediaLiveChannels', - 'DeleteMediaLiveChannel', - 'StartMediaLiveChannel', - 'StopMediaLiveChannel', - ], - ], - [ - 'id' => 202565, - 'title' => 'MediaConvert', - 'type' => 'directory', - 'children' => [ - 'SubmitMediaConvertJob', - 'GetMediaConvertJob', - 'ListMediaConvertJobs', - ], + 'title' => 'Live streaming', ], [ - 'id' => 201965, - 'title' => 'MediaConnect', - 'type' => 'directory', - 'children' => [ - 'GetMediaConnectAvailableRegion', - 'ForbidMediaConnectFlowOutput', - 'ResumeMediaConnectFlowOutput', - 'GetMediaConnectFlowAllOutputName', - 'CloseMediaConnectFlowFailover', - 'OpenMediaConnectFlowFailover', - 'UpdateMediaConnectFlowOutput', - 'GetMediaConnectFlowOutput', - 'DeleteMediaConnectFlowOutput', - 'AddMediaConnectFlowOutput', - 'DeleteMediaConnectFlowInput', - 'UpdateMediaConnectFlowInput', - 'GetMediaConnectFlowInput', - 'AddMediaConnectFlowInput', - 'DeleteMediaConnectFlow', - 'UpdateMediaConnectFlowStatus', - 'GetMediaConnectFlow', - 'CreateMediaConnectFlow', - ], - ], - [ - 'id' => 201860, - 'title' => 'MediaWeaver', + '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', - 'DeleteChannel', - 'UpdateSource', - 'StartChannel', - 'DeleteProgram', - 'DeleteSource', - 'StopChannel', - 'ListChannels', - 'ListPrograms', - 'GetSource', - 'CreateChannel', - 'ListSchedules', - 'ListSources', - 'ListAlerts', - 'GetChannel', - 'CreateProgram', - 'ListChannelAlerts', - 'CreateSource', - 'UpdateChannel', - ], - ], - [ - 'id' => 201734, - 'title' => 'MediaPackage', + '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' => [ [ - 'id' => 201892, - 'title' => 'VodPackage', + 'children' => ['CreateVodPackagingGroup', 'GetVodPackagingGroup', 'ListVodPackagingGroups', 'DeleteVodPackagingGroup', 'CreateVodPackagingConfiguration', 'GetVodPackagingConfiguration', 'ListVodPackagingConfigurations', 'DeleteVodPackagingConfiguration', 'CreateVodPackagingAsset', 'BatchCreateVodPackagingAsset', 'GetVodPackagingAsset', 'ListVodPackagingAssets', 'DeleteVodPackagingAsset'], 'type' => 'directory', - 'children' => [ - 'CreateVodPackagingGroup', - 'GetVodPackagingGroup', - 'ListVodPackagingGroups', - 'DeleteVodPackagingGroup', - 'CreateVodPackagingConfiguration', - 'GetVodPackagingConfiguration', - 'ListVodPackagingConfigurations', - 'DeleteVodPackagingConfiguration', - 'CreateVodPackagingAsset', - 'BatchCreateVodPackagingAsset', - 'GetVodPackagingAsset', - 'ListVodPackagingAssets', - 'DeleteVodPackagingAsset', - ], + 'title' => 'VOD packaging', ], [ - 'id' => 201735, - 'title' => 'LivePackage', + 'children' => ['CreateLivePackageChannelGroup', 'UpdateLivePackageChannelGroup', 'GetLivePackageChannelGroup', 'ListLivePackageChannelGroups', 'DeleteLivePackageChannelGroup', 'CreateLivePackageChannel', 'UpdateLivePackageChannel', 'UpdateLivePackageChannelCredentials', 'GetLivePackageChannel', 'ListLivePackageChannels', 'DeleteLivePackageChannel', 'CreateLivePackageOriginEndpoint', 'UpdateLivePackageOriginEndpoint', 'GetLivePackageOriginEndpoint', 'ListLivePackageOriginEndpoints', 'DeleteLivePackageOriginEndpoint'], 'type' => 'directory', - 'children' => [ - 'CreateLivePackageChannelGroup', - 'UpdateLivePackageChannelGroup', - 'GetLivePackageChannelGroup', - 'ListLivePackageChannelGroups', - 'DeleteLivePackageChannelGroup', - 'CreateLivePackageChannel', - 'UpdateLivePackageChannel', - 'UpdateLivePackageChannelCredentials', - 'GetLivePackageChannel', - 'ListLivePackageChannels', - 'DeleteLivePackageChannel', - 'CreateLivePackageOriginEndpoint', - 'UpdateLivePackageOriginEndpoint', - 'GetLivePackageOriginEndpoint', - 'ListLivePackageOriginEndpoints', - 'DeleteLivePackageOriginEndpoint', - ], + 'title' => 'Live packaging', ], ], + 'type' => 'directory', + 'title' => 'Media packaging', ], ], + 'type' => 'directory', + 'title' => 'Media services', ], [ - 'id' => 187656, - 'title' => 'Other', + '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', [ - 'id' => 193096, - 'title' => 'Full Set Configuration-deprecated', + 'children' => ['SetContentAnalyzeConfig', 'GetContentAnalyzeConfig', 'SetDefaultStorageLocation', 'GetDefaultStorageLocation'], 'type' => 'directory', - 'children' => [ - 'SetContentAnalyzeConfig', - 'GetContentAnalyzeConfig', - 'SetDefaultStorageLocation', - 'GetDefaultStorageLocation', - ], + 'title' => 'Global configuration--deprecated', ], 'DescribePlayList', [ - 'id' => 137497, - 'title' => 'Material Center', + 'children' => ['AddFavoritePublicMedia', 'CancelFavoritePublicMedia', 'GetPublicMediaInfo', 'SearchPublicMediaInfo'], 'type' => 'directory', - 'children' => [ - 'AddFavoritePublicMedia', - 'CancelFavoritePublicMedia', - 'GetPublicMediaInfo', - 'SearchPublicMediaInfo', - ], + 'title' => 'Material center', ], 'GetStorageList', 'SearchEditingProject', - 'SubmitDynamicChartJob', 'StopRtcRobotInstance', 'StartRtcRobotInstance', 'UpdateRtcRobotInstance', @@ -835,2967 +364,1859 @@ '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 template configuration of the AI agent.'."\n", - 'visibility' => 'Public', + 'description' => 'The parameters for the AI agent template.', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => '*******aaab****', - 'backendName' => 'appId', - ], - 'Greeting' => [ - 'description' => 'The welcome message that the agent says upon joining. Changes take effect in the next session. Default value: None.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'greeting', - ], - 'WakeUpQuery' => [ - 'description' => 'A command given to the agent before the call starts. The agent will respond to this query immediately after the call begins.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'wakeUpQuery', - ], - 'MaxIdleTime' => [ - 'description' => 'The maximum time the agent will wait for interaction before it hangs up. Unit: seconds. Default value: 600.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - 'backendName' => 'maxIdleTime', - ], - 'UserOnlineTimeout' => [ - 'description' => 'The timeout period for the agent to close the task if no user joins the channel. Unit: seconds. Default value: 60.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'backendName' => 'userOnlineTimeout', - ], - 'UserOfflineTimeout' => [ - 'description' => 'The timeout period for the agent to close the task after the user has left the channel. Unit: seconds. Default value: 5.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'userOfflineTimeout', - ], - 'EnablePushToTalk' => [ - 'description' => 'Specifies whether to enable the push-to-talk mode. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enablePushToTalk', - ], - 'GracefulShutdown' => [ - 'description' => 'Specifies whether to enable graceful shutdown. Default value: false.'."\n" - ."\n" - .'If enabled, when the agent is stopped, it will finish its current sentence before disconnecting (up to 10 seconds).'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false'."\n", - 'backendName' => 'gracefulShutdown', - ], - 'Volume' => [ - 'description' => 'The agent\'s speaking volume.'."\n" - ."\n" - .'* If this parameter is not specified, the adaptive volume mode is used by default.'."\n" - .'* To specify this parameter, enter a value between 0 and 400. Output volume = Workflow output volume × Volume/100. Example:'."\n" - ."\n" - .'1. If Volume is set to 0, the output is muted.'."\n" - .'2. If Volume is set to 100, the output volume is the original volume.'."\n" - .'3. If Volume is set to 200, the output volume is 2 times the original volume.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'volume', - ], - 'WorkflowOverrideParams' => [ - 'description' => 'The parameters to override the workflow configuration. Default value: None.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'workflowOverrideParams', - ], - 'AvatarUrl' => [ - 'description' => 'The URL for the agent\'s profile image in audio-only calls. Default value: None.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://example.com/a.jpg'."\n", - 'backendName' => 'avatarUrl', - ], - 'AvatarUrlType' => [ - 'description' => 'The type of the avatar URL. Default value: None.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'avatarUrlType', - ], - 'EnableIntelligentSegment' => [ - 'description' => 'If enabled, the system intelligently merges short, interim segments into a single sentence. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableIntelligentSegment', - ], + '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' => 'The configuration for Automatic Speech Recognition (ASR).'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'AsrMaxSilence' => [ - 'description' => 'The silence threshold for sentence segmentation. A pause longer than this value is considered a sentence break. Unit: milliseconds. Default value: 400. Valid values: 200 to 1200.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - 'backendName' => 'asrMaxSilence', - ], - 'AsrLanguageId' => [ - 'description' => 'The language ID for ASR. Valid values:'."\n" - ."\n" - .'* zh_mandarin: Chinese'."\n" - .'* en: English'."\n" - .'* zh_en: Chinese and English'."\n" - .'* es: Spanish'."\n" - .'* jp: Japanese'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh_mandarin', - 'backendName' => 'asrLanguageId', - ], - 'CustomParams' => [ - 'description' => 'Passthrough parameters for ASR.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mode=fast&sample=16000&format=wav', - 'backendName' => 'customParams', - ], - 'VadDuration' => [ - 'description' => 'The minimum duration for voice activity detection, in milliseconds. This parameter controls the sensitivity of interruptions, preventing the agent from cutting off user speech too early during short pauses. 0: Disables this feature. Valid values: 200 to 2000. Recommended: 200 to 500 ms, which typically corresponds to the length of 1 to 4 words. By default, this parameter is left empty, which indicates the feature is disabled.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'vadDuration', - ], + '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' => 'Hotwords for ASR to improve recognition accuracy. Maximum of 128 hotwords.'."\n", - 'visibility' => 'Public', + 'description' => 'A list of hotwords to improve ASR accuracy. You can specify a maximum of 128 hotwords.', 'type' => 'array', - 'items' => [ - 'description' => 'The hotword. Length: 1 to 10 characters.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'extendType' => 'true', - ], - 'backendName' => 'asrHotWords', - ], - 'VadLevel' => [ - 'description' => 'The voice activity detection (VAD) threshold for interruption. A higher value makes it harder to trigger interruptions. Valid values: 0 to 10. Default value: 1. The value of 0 specifies to disable the VAD feature.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'vadLevel', + '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' => ''], ], - 'backendName' => 'asrConfig', + 'title' => '', + 'example' => '', ], 'TtsConfig' => [ - 'description' => 'The configuration for Text-to-Speech (TTS).'."\n", - 'visibility' => 'Public', + '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' => 'The pronunciation rules, executed in order. Maximum of 20 rules.'."\n", - 'visibility' => 'Public', + 'description' => 'A list of TTS pronunciation rules, executed in order. You can specify a maximum of 20 rules.', 'type' => 'array', 'items' => [ - 'description' => 'The pronunciation rule.'."\n", - 'visibility' => 'Public', + 'description' => 'A TTS pronunciation rule.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of rule. Valid value:'."\n" - ."\n" - .'* replacement: replaces every occurrence of Word value with Pronunciation value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'replacement', - 'backendName' => 'type', - ], - 'Word' => [ - 'description' => 'The word to be replaced. The value supports up to 10 Chinese characters. Other characters, including spaces, are not supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'word', - ], - 'Pronunciation' => [ - 'description' => 'The target pronunciation. The value supports up to 10 Chinese characters. Other characters, including spaces, are not supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'pronunciation', - ], + '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' => ''], ], - 'extendType' => 'true', - ], - 'backendName' => 'pronunciationRules', - ], - 'VoiceIdList' => [ - 'description' => 'Available voices.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'The voice.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zhixiaoxia', - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'voiceIdList', - ], - 'VoiceId' => [ - 'description' => 'The voice ID. Changes take effect on the next sentence. If not set, the system uses the default voice ID specified in the agent template. This parameter takes effect only for the preset TTS model. Max length: 64 characters. Refer to [Intelligent voice samples](~~449563~~) for options.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'longcheng_v2'."\n" - ."\n", - 'backendName' => 'voiceId', - ], - 'Emotion' => [ - 'description' => 'Applies only to MiniMax models. Seven types of emotions are supported:'."\n" - ."\n" - .'* happy'."\n" - .'* sad'."\n" - .'* angry'."\n" - .'* fearful'."\n" - .'* disgusted'."\n" - .'* surprised'."\n" - .'* calm'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'happy', - 'backendName' => 'emotion', - ], - 'ModelId' => [ - 'description' => 'Applies only to MiniMax models. Valid values: speech-01-turbo and speech-02-turbo'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'speech-01-turbo', - 'backendName' => 'modelId', - ], - 'LanguageId' => [ - 'description' => 'Applies only to MiniMax models. By default, this parameter is left empty. This enhances speech recognition accuracy for specific languages and dialects. If the language type is unknown, set it to auto to have the model automatically detect it. Valid values:'."\n" - ."\n" - .'**Supported languages**'."\n" - ."\n" - .'* Chinese'."\n" - .'* Chinese,Yue'."\n" - .'* English'."\n" - .'* Arabic'."\n" - .'* Russian'."\n" - .'* Spanish'."\n" - .'* French'."\n" - .'* Portuguese'."\n" - .'* German'."\n" - .'* Turkish'."\n" - .'* Dutch'."\n" - .'* Ukrainian'."\n" - .'* Vietnamese'."\n" - .'* Indonesian'."\n" - .'* Japanese'."\n" - .'* Italian'."\n" - .'* Korean'."\n" - .'* Thai'."\n" - .'* Polish'."\n" - .'* Romanian'."\n" - .'* Greek'."\n" - .'* Czech'."\n" - .'* Finnish'."\n" - .'* Hindi'."\n" - .'* auto'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Chinese', - 'backendName' => 'languageId', - ], - 'SpeechRate' => [ - 'description' => 'Supports all platforms. For CosyVoice, the default value is 1.0. Valid values: 0.5 to 2.0. For MiniMax, the default value is 1.0. Valid values: 0.5 to 2.0.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.0', - 'backendName' => 'speechRate', + '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' => ''], ], - 'backendName' => 'ttsConfig', + 'title' => '', + 'example' => '', ], 'LlmConfig' => [ - 'description' => 'The configuration for the large language model (LLM).'."\n", - 'visibility' => 'Public', + 'description' => 'Configuration for the large language model (LLM).', 'type' => 'object', 'properties' => [ - 'FunctionMap' => [ - 'description' => 'Maps agent capabilities to LLM functions. Only supports function calling with custom LLMs that adhere to the OpenAI protocol.'."\n", - 'visibility' => 'Public', + 'LlmHistory' => [ + 'description' => 'The conversation history context for the LLM/MLLM.', 'type' => 'array', 'items' => [ - 'description' => 'A single mapping rule.'."\n", - 'visibility' => 'Public', + 'description' => 'A single conversational turn.', 'type' => 'object', 'properties' => [ - 'Function' => [ - 'description' => 'The name of the built-in agent capability. Only hangup is supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hangup', - 'backendName' => 'function', - ], - 'MatchFunction' => [ - 'description' => 'The corresponding user-defined function name in your LLM. When the LLM calls this function, it will trigger the mapped agent capability.[](~~2839094~~)'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hangup', - 'backendName' => 'matchFunction', - ], + '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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'functionMap', - ], - 'LlmHistoryLimit' => [ - 'description' => 'The maximum number of conversational turns to retain in the history. Default value: 10.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'llmHistoryLimit', - ], - 'LlmCompleteReply' => [ - 'description' => 'If true, the service sends the complete result from the LLM to the client in a single response after the generation process is finished.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'llmCompleteReply', + 'title' => '', + 'example' => '', ], - 'LlmHistory' => [ - 'description' => 'The LLM/MLLM conversation history context.'."\n", - 'visibility' => 'Public', + '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 session.'."\n", - 'visibility' => 'Public', + 'description' => 'A single mapping rule.', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'description' => 'The role of the participant in the conversation. Valid values:'."\n" - ."\n" - .'* user'."\n" - .'* assistant'."\n" - .'* system'."\n" - .'* function'."\n" - .'* plugin'."\n" - .'* tool'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user', - 'backendName' => 'role', - ], - 'Content' => [ - 'description' => 'The actual text content of the message for that role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'content', - ], + '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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'llmHistory', - ], - 'LlmSystemPrompt' => [ - 'description' => 'The system prompt for the LLM.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'llmSystemPrompt', - ], - 'OpenAIExtraQuery' => [ - 'description' => 'Additional query parameters to be sent to the OpenAI-protocol LLM, formatted as a URL query string (key=value pairs separated by &). All values must be strings.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'api-version=2024-02-01&api-key=sk-xxx', - 'backendName' => 'openAIExtraQuery', - ], - 'OutputMaxDelay' => [ - 'description' => 'The maximum time (in milliseconds) to buffer text before it is forcibly sent to the client. Valid values: \\[1000,10000]. A value of 0 or an empty string (default) disables this limit.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - 'backendName' => 'outputMaxDelay', - ], - 'BailianAppParams' => [ - 'description' => 'Alibaba Cloud Model Studio Application Center parameters in a JSON format. Reference: [Model Studio Application Center Parameter](~~2858132~~)'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'title' => '', 'example' => '', - 'backendName' => 'bailianAppParams', - ], - 'OutputMinLength' => [ - 'description' => 'The minimum number of characters that must be buffered before a text chunk is sent. Valid values: \\[0, 100]. A value of 0 or an empty string (default) disables this limit.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'outputMinLength', ], + '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'], ], - 'backendName' => 'llmConfig', + 'title' => '', + 'example' => '', ], 'AvatarConfig' => [ - 'description' => 'The avatar configuration. Only effective if the workflow includes an avatar node.'."\n", - 'visibility' => 'Public', + '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.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '5257', - 'backendName' => 'avatarId', - ], + 'AvatarId' => ['description' => 'The model ID of the avatar.', 'type' => 'string', 'example' => '5257', 'title' => ''], ], - 'backendName' => 'avatarConfig', + 'title' => '', + 'example' => '', ], 'InterruptConfig' => [ - 'description' => 'The configuration for the speech interruption strategy.'."\n", - 'visibility' => 'Public', + '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' => 'Words or phrases that will trigger an interruption.'."\n", - 'visibility' => 'Public', + 'description' => 'A list of specific words or phrases that trigger an interruption.', 'type' => 'array', - 'items' => [ - 'description' => 'A word or phrase that will trigger an interruption.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'extendType' => 'true', - ], - 'backendName' => 'interruptWords', - ], - 'EnableVoiceInterrupt' => [ - 'description' => 'Specifies whether to allow the user to interrupt the agent by speaking. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableVoiceInterrupt', + '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'], ], - 'backendName' => 'interruptConfig', + 'title' => '', + 'example' => '', ], 'VoiceprintConfig' => [ - 'description' => 'The configuration for voiceprint recognition.'."\n", - 'visibility' => 'Public', + 'description' => 'Configuration for voiceprint recognition.', 'type' => 'object', 'properties' => [ - 'VoiceprintId' => [ - 'description' => 'The unique ID of the voiceprint. Default value: None.[](~~2964738~~)'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zhixiaoxia', - 'backendName' => 'voiceprintId', - ], - 'UseVoiceprint' => [ - 'description' => 'Specifies whether to enable voiceprint recognition. Default value: false. You must specify a valid voiceprint ID when you enable voiceprint recognition.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'useVoiceprint', - ], + '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'], ], - 'backendName' => 'voiceprintConfig', + 'title' => '', + 'example' => '', ], 'TurnDetectionConfig' => [ - 'description' => 'The configuration for detecting the end of a user\'s conversational turn.'."\n", - 'visibility' => 'Public', + 'description' => 'Configuration for conversational turn detection.', 'type' => 'object', 'properties' => [ - 'SemanticWaitDuration' => [ - 'description' => 'Specifies how long to wait after a user stops speaking for the agent to decide if the turn is over. Unit: milliseconds. Default value: -1.'."\n" - ."\n" - .'* \\-1: AI decides an appropriate wait time automatically.'."\n" - .'* 0 to 10000: A custom wait time. Recommended: 0 to 1500 ms.'."\n" - ."\n" - .'> In Normal mode, this field is ignored.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - 'backendName' => 'semanticWaitDuration', - ], 'TurnEndWords' => [ - 'description' => 'Keywords that signify the end of the user\'s turn.'."\n", - 'visibility' => 'Public', + 'description' => 'A list of keywords used to determine the end of a user\'s conversational turn.', 'type' => 'array', - 'items' => [ - 'description' => 'A keyword that signifies the end of the user\'s turn.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'extendType' => 'true', - ], - 'backendName' => 'turnEndWords', - ], - 'Mode' => [ - 'description' => 'The mode of turn detection.'."\n" - ."\n" - .'* Normal: uses simple pause detection.'."\n" - .'* Semantic: uses AI to analyze context.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Semantic', - 'backendName' => 'mode', + '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'], ], - 'backendName' => 'turnDetectionConfig', - ], - 'ExperimentalConfig' => [ - 'description' => 'The parameters for experimental features. Contact support for details.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'experimentalConfig', + 'title' => '', + 'example' => '', ], + 'ExperimentalConfig' => ['description' => 'Parameters for experimental features. Contact support for assistance.', 'type' => 'string', 'example' => '""', 'title' => ''], 'VcrConfig' => [ - 'description' => 'Configuration for video content recognition. When enabled, the system sends callbacks to the client with details about content identified.'."\n", - 'visibility' => 'Public', + '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' => [ - 'PeopleCount' => [ - 'description' => 'Configuration for the people counting feature.'."\n", - 'visibility' => 'Public', + 'StillFrameMotion' => [ + 'description' => 'Configuration for still frame detection.', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'description' => 'Enables or disables the feature. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], + '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' => ''], ], - 'backendName' => 'peopleCount', + 'title' => '', + 'example' => '', ], - 'StillFrameMotion' => [ - 'description' => 'Configuration for detecting still frames.'."\n", - 'visibility' => 'Public', + 'InvalidFrameMotion' => [ + 'description' => 'Configuration for invalid frame detection.', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'description' => 'Enables or disables still frame detection. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], - 'CallbackDelay' => [ - 'description' => 'The delay in milliseconds before a still frame detection event is triggered. The callback is sent only after the video has been static for this duration. If not set, the value from the console configuration is used. Valid values: \\[200,5000].'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - 'backendName' => 'callbackDelay', - ], + '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' => ''], ], - 'backendName' => 'stillFrameMotion', + 'title' => '', + 'example' => '', ], - 'Equipment' => [ - 'description' => 'Configuration for device identification.'."\n", - 'visibility' => 'Public', + 'PeopleCount' => [ + 'description' => 'Configuration for the people counting feature.', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'description' => 'Enables or disables device identification. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], + 'Enabled' => ['description' => 'Specifies whether to enable people counting. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'backendName' => 'equipment', + 'title' => '', + 'example' => '', ], - 'HeadMotion' => [ - 'description' => 'Configuration for head motion detection.'."\n", - 'visibility' => 'Public', + 'Equipment' => [ + 'description' => 'Configuration for device identification.', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'description' => 'Enables or disables head motion detection. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], + 'Enabled' => ['description' => 'Specifies whether to enable device identification. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'backendName' => 'headMotion', + 'title' => '', + 'example' => '', ], - 'LookAway' => [ - 'description' => 'Configuration for detecting if the user is looking away from the screen.'."\n", - 'visibility' => 'Public', + 'HeadMotion' => [ + 'description' => 'Configuration for head motion detection.', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'description' => 'Enables or disables this feature. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', - ], + 'Enabled' => ['description' => 'Specifies whether to enable head motion detection. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'backendName' => 'lookAway', + 'title' => '', + 'example' => '', ], - 'InvalidFrameMotion' => [ - 'description' => 'Configuration for detecting invalid frames.'."\n", - 'visibility' => 'Public', + 'LookAway' => [ + 'description' => 'Configuration for look-away detection.', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'description' => 'Enables or disables invalid frame detection.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enabled', - ], - 'CallbackDelay' => [ - 'description' => 'The delay in milliseconds before an invalid frame detection event is triggered. The callback is sent only after the frame has been considered invalid for this duration. If not set, the value from the console configuration is used. Valid values: \\[200, 5000].'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - 'backendName' => 'callbackDelay', - ], + 'Enabled' => ['description' => 'Specifies whether to enable look-away detection. Default: `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'backendName' => 'invalidFrameMotion', + 'title' => '', + 'example' => '', ], ], - 'backendName' => 'vcrConfig', + 'title' => '', + 'example' => '', ], - 'OutboundCallConfig' => [ - 'visibility' => 'Private', + 'AmbientSoundConfig' => [ + 'description' => 'Configuration for ambient sound during the call.', 'type' => 'object', 'properties' => [ - 'SipDomain' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'sipDomain', - ], - 'Type' => [ - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'type', - ], + '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' => ''], ], - 'backendName' => 'outboundCallConfig', + 'title' => '', + 'example' => '', ], - 'InboundCallConfig' => [ - 'visibility' => 'Private', + 'AutoSpeechConfig' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'type', - ], - 'AuthUrl' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'authUrl', + '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' => '', ], - 'AuthToken' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'authToken', + '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' => '', ], ], - 'backendName' => 'inboundCallConfig', + 'description' => 'Configuration for the agent\'s automatic speech, including prompts for LLM latency and long periods of user silence.', + 'title' => '', + 'example' => '', ], - 'AmbientSoundConfig' => [ - 'description' => 'Configuration for the ambient sound played during the call.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => 'The ID of the ambient sound. This ID can be obtained from the advanced settings section of the agent configuration in the console.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'f67901c595834************', - 'backendName' => 'resourceId', + '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' => '', + ], ], - 'Volume' => [ - 'description' => 'The volume of the ambient sound. Valid values: \\[0, 100]. A value of 0 disables the ambient sound.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'backendName' => 'volume', + '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' => '', ], - 'backendName' => 'ambientSoundConfig', + 'description' => '>'."\n" + ."\n" + .'已废弃，请使用 BackChannelingConfigs'."\n" + ."\n" + .'>', + 'title' => '', + 'example' => '', + 'deprecated' => true, ], ], + 'title' => '', + 'example' => '', ], 'AIAgentOutboundCallConfig' => [ - 'description' => 'The template configuration of the AI agent.'."\n", - 'visibility' => 'Public', + 'description' => 'Parameters for the AI agent template.', 'type' => 'object', 'properties' => [ - 'Greeting' => [ - 'description' => 'The welcome message that the agent says upon joining. Changes take effect in the next session. Default value: None.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'greeting', - ], - 'EnableIntelligentSegment' => [ - 'description' => 'If enabled, the system intelligently merges short, interim segments into a single sentence. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableIntelligentSegment', - ], + '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 configuration for Automatic Speech Recognition (ASR).'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'AsrMaxSilence' => [ - 'description' => 'The silence threshold for sentence segmentation. A pause longer than this value is considered a sentence break. Unit: milliseconds. Default value: 400. Valid values: 200 to 1200.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - 'backendName' => 'asrMaxSilence', - ], - 'AsrLanguageId' => [ - 'description' => 'The language ID for ASR. Valid values:'."\n" - ."\n" - .'* zh_mandarin: Chinese'."\n" - .'* en: English'."\n" - .'* zh_en: Chinese and English'."\n" - .'* es: Spanish'."\n" - .'* jp: Japanese'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh_mandarin', - 'backendName' => 'asrLanguageId', - ], - 'CustomParams' => [ - 'description' => 'Passthrough parameters for ASR.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mode=fast&sample=16000&format=wav'."\n", - 'backendName' => 'customParams', - ], - 'VadDuration' => [ - 'description' => 'The minimum duration for voice activity detection, in milliseconds. This parameter controls the sensitivity of interruptions, preventing the agent from cutting off user speech too early during short pauses. 0: Disables this feature. Valid values: 200 to 2000. Recommended: 200 to 500 ms, which typically corresponds to the length of 1 to 4 words. By default, this parameter is left empty, which indicates the feature is disabled.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'backendName' => 'vadDuration', - ], + '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' => 'Hotwords for ASR to improve recognition accuracy. Maximum of 128 hotwords.'."\n", - 'visibility' => 'Public', + 'description' => 'The list of hotwords for ASR. You can specify a maximum of 128 hotwords in the list.', 'type' => 'array', - 'items' => [ - 'description' => 'The hotword. Length: 1 to 10 characters.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'extendType' => 'true', - ], - 'backendName' => 'asrHotWords', - ], - 'VadLevel' => [ - 'description' => 'The VAD threshold for interruption. A higher value makes it harder to trigger interruptions. Valid values: 0 to 10. Default value: 1. The value of 0 specifies to disable the VAD feature.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'vadLevel', + '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' => ''], ], - 'backendName' => 'asrConfig', + 'title' => '', + 'example' => '', ], 'LlmConfig' => [ - 'description' => 'The configuration for the large language model (LLM).'."\n", - 'visibility' => 'Public', + 'description' => 'The configurations of the large language model (LLM).', 'type' => 'object', 'properties' => [ - 'FunctionMap' => [ - 'description' => 'Maps agent capabilities to LLM functions. Only supports function calling with custom LLMs that adhere to the OpenAI protocol.'."\n", - 'visibility' => 'Public', + '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 mapping rule.'."\n", - 'visibility' => 'Public', + 'description' => 'A single conversational turn.', 'type' => 'object', 'properties' => [ - 'Function' => [ - 'description' => 'The name of the built-in agent capability. Only hangup is supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hangup', - 'backendName' => 'function', - ], - 'MatchFunction' => [ - 'description' => 'The corresponding user-defined function name in your LLM. When the LLM calls this function, it will trigger the mapped agent capability.[](~~2839094~~)'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hangup', - 'backendName' => 'matchFunction', - ], - ], - 'extendType' => 'true', - ], - 'backendName' => 'functionMap', - ], - 'LlmHistoryLimit' => [ - 'description' => 'The maximum number of conversational turns to retain in the history. Default value: 10.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'llmHistoryLimit', - ], - 'LlmCompleteReply' => [ - 'description' => 'If true, the service sends the complete result from the LLM to the client in a single response after the generation process is finished.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'llmCompleteReply', + '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' => '', ], - 'LlmHistory' => [ - 'description' => 'The LLM/MLLM conversation history context.'."\n", - 'visibility' => 'Public', + '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 session.'."\n", - 'visibility' => 'Public', + 'description' => 'A single mapping rule.', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'description' => 'The role of the participant in the conversation. Valid values:'."\n" - ."\n" - .'* user'."\n" - .'* assistant'."\n" - .'* system'."\n" - .'* function'."\n" - .'* plugin'."\n" - .'* tool'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user', - 'backendName' => 'role', - ], - 'Content' => [ - 'description' => 'The actual text content of the message for that role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'content', - ], + '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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'llmHistory', - ], - 'LlmSystemPrompt' => [ - 'description' => 'The system prompt for the LLM.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'llmSystemPrompt', - ], - 'OpenAIExtraQuery' => [ - 'description' => 'Additional query parameters to be sent to the OpenAI-protocol LLM, formatted as a URL query string (key=value pairs separated by &). All values must be strings.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'api-version=2024-02-01&api-key=sk-xxx', - 'backendName' => 'openAIExtraQuery', - ], - 'OutputMaxDelay' => [ - 'description' => 'The maximum time (in milliseconds) to buffer text before it is forcibly sent to the client. Valid values: \\[1000,10000]. A value of 0 or an empty string (default) disables this limit.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2000', - 'backendName' => 'outputMaxDelay', - ], - 'BailianAppParams' => [ - 'description' => 'Alibaba Cloud Model Studio Application Center parameters. Reference: [Model Studio Application Center Parameter](~~2858132~~)'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'title' => '', 'example' => '', - 'backendName' => 'bailianAppParams', - ], - 'OutputMinLength' => [ - 'description' => 'The minimum number of characters that must be buffered before a text chunk is sent. Valid values: \\[0, 100]. A value of 0 or an empty string (default) disables this limit.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'outputMinLength', ], + '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'], ], - 'backendName' => 'llmConfig', + 'title' => '', + 'example' => '', ], 'TtsConfig' => [ - 'description' => 'The configuration for Text-to-Speech (TTS).'."\n", - 'visibility' => 'Public', + '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 pronunciation rules, executed in order. Maximum of 20 rules.'."\n", - 'visibility' => 'Public', + '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 pronunciation rule.'."\n", - 'visibility' => 'Public', + 'description' => 'The TTS pronunciation rule.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of rule. Valid value:'."\n" - ."\n" - .'* replacement: replaces every occurrence of Word value with Pronunciation value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'replacement'."\n", - 'backendName' => 'type', - ], - 'Word' => [ - 'description' => 'The word to be replaced. The value supports up to 10 Chinese characters. Other characters, including spaces, are not supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'word', - ], - 'Pronunciation' => [ - 'description' => 'The target pronunciation. The value supports up to 10 Chinese characters. Other characters, including spaces, are not supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'pronunciation', - ], + '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' => ''], ], - 'extendType' => 'true', - ], - 'backendName' => 'pronunciationRules', - ], - 'VoiceIdList' => [ - 'description' => 'Available voices.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'The voice.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zhixiaoxia', - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'voiceIdList', - ], - 'VoiceId' => [ - 'description' => 'The voice ID. Changes take effect on the next sentence. If not set, the system uses the default voice ID specified in the agent template. This parameter takes effect only for the preset TTS model. Max length: 64 characters. Refer to [Intelligent voice samples](~~449563~~) for options.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'longcheng_v2', - 'backendName' => 'voiceId', - ], - 'Emotion' => [ - 'description' => 'Applies only to MiniMax models. Seven types of emotions are supported:'."\n" - ."\n" - .'* happy'."\n" - .'* sad'."\n" - .'* angry'."\n" - .'* fearful'."\n" - .'* disgusted'."\n" - .'* surprised'."\n" - .'* calm'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'happy', - 'backendName' => 'emotion', - ], - 'ModelId' => [ - 'description' => 'Applies only to MiniMax models. Valid values: speech-01-turbo and speech-02-turbo.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'speech-01-turbo', - 'backendName' => 'modelId', - ], - 'LanguageId' => [ - 'description' => 'Applies only to MiniMax models. By default, this parameter is left empty. This enhances speech recognition accuracy for specific languages and dialects. If the language type is unknown, set it to auto to have the model automatically detect it. Valid values:'."\n" - ."\n" - .'**Supported languages**'."\n" - ."\n" - .'* Chinese'."\n" - .'* Chinese,Yue'."\n" - .'* English'."\n" - .'* Arabic'."\n" - .'* Russian'."\n" - .'* Spanish'."\n" - .'* French'."\n" - .'* Portuguese'."\n" - .'* German'."\n" - .'* Turkish'."\n" - .'* Dutch'."\n" - .'* Ukrainian'."\n" - .'* Vietnamese'."\n" - .'* Indonesian'."\n" - .'* Japanese'."\n" - .'* Italian'."\n" - .'* Korean'."\n" - .'* Thai'."\n" - .'* Polish'."\n" - .'* Romanian'."\n" - .'* Greek'."\n" - .'* Czech'."\n" - .'* Finnish'."\n" - .'* Hindi'."\n" - .'* auto'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Chinese', - 'backendName' => 'languageId', - ], - 'SpeechRate' => [ - 'description' => 'Supports all models. For CosyVoice, the default value is 1.0. Valid values: 0.5 to 2.0. For MiniMax, the default value is 1.0. Valid values: 0.5 to 2.0.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '1.0', - 'backendName' => 'speechRate', + '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' => ''], ], - 'backendName' => 'ttsConfig', + 'title' => '', + 'example' => '', ], 'InterruptConfig' => [ - 'description' => 'The configuration for the speech interruption strategy.'."\n", - 'visibility' => 'Public', + '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' => 'Words or phrases that will trigger an interruption.'."\n", - 'visibility' => 'Public', + 'description' => 'The specific words or phrases that trigger a conversation interruption.', 'type' => 'array', - 'items' => [ - 'description' => 'A word or phrase that will trigger an interruption.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'extendType' => 'true', - ], - 'backendName' => 'interruptWords', - ], - 'EnableVoiceInterrupt' => [ - 'description' => 'Specifies whether to allow the user to interrupt the agent by speaking. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableVoiceInterrupt', + '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'], ], - 'backendName' => 'interruptConfig', + 'title' => '', + 'example' => '', ], 'TurnDetectionConfig' => [ - 'description' => 'The configuration for detecting the end of a user\'s conversational turn.'."\n", - 'visibility' => 'Public', + 'description' => 'The configurations for conversational turn detection.', 'type' => 'object', 'properties' => [ - 'SemanticWaitDuration' => [ - 'description' => 'Specifies how long to wait after a user stops speaking for the agent to decide if the turn is over. Unit: milliseconds. Default value: -1.'."\n" - ."\n" - .'* \\-1: AI decides an appropriate wait time automatically.'."\n" - .'* 0 to 10000: A custom wait time. Recommended: 0 to 1500 ms.'."\n" - ."\n" - .'Note: In Normal mode, this field is ignored.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - 'backendName' => 'semanticWaitDuration', - ], 'TurnEndWords' => [ - 'description' => 'Keywords that signify the end of the user\'s turn.'."\n", - 'visibility' => 'Public', + '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 signifies the end of the user\'s turn.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'extendType' => 'true', + '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' => '我挂了，再见'], ], - 'backendName' => 'turnEndWords', + 'description' => 'The configurations for inquiry broadcasts during prolonged user silence.', + 'title' => '', + 'example' => '', ], - 'Mode' => [ - 'description' => 'The mode of turn detection.'."\n" - ."\n" - .'* Normal: uses simple pause detection.'."\n" - .'* Semantic: uses AI to analyze context.'."\n" - ."\n" - .'Default value: Normal.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Semantic', - 'backendName' => 'mode', + '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' => '', ], ], - 'backendName' => 'turnDetectionConfig', - ], - 'GreetingDelay' => [ - 'description' => 'The delay before playing the welcome message. Unit: milliseconds. Valid values: 0 to 5000. Default value: 0.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'greetingDelay', + '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' => '', ], - 'AmbientSoundConfig' => [ - 'description' => 'Configuration for the ambient sound played during the call.'."\n", - 'visibility' => 'Public', + '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' => [ - 'ResourceId' => [ - 'description' => 'The ID of the ambient sound. This ID can be obtained from the advanced settings section of the agent configuration in the console.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'f67901c595834************'."\n", - 'backendName' => 'resourceId', + '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' => '', ], - 'Volume' => [ - 'description' => 'The volume of the ambient sound. Valid values: \\[0, 100]. A value of 0 disables the ambient sound.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50'."\n", - 'backendName' => 'volume', + ], + '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' => '', ], - 'backendName' => 'ambientSoundConfig', + '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' => 'A short description of struct', + 'title' => '', 'description' => 'The runtime configuration of the AI agent.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'VoiceChat' => [ + 'AvatarChat3D' => [ 'title' => '', - 'description' => 'The runtime parameters of the voice call.'."\n", - 'visibility' => 'Public', + 'description' => 'The runtime parameters of the avatar call.'."\n", 'type' => 'object', 'properties' => [ - 'AuthToken' => [ - 'title' => '', - 'description' => 'Required. The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', - 'backendName' => 'authToken', - ], - 'AgentUserId' => [ - 'title' => '', - 'description' => 'Required. The name of the agent in the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '877ae632caae49b1afc81c2e8194ffb4', - 'backendName' => 'agentUserId', - ], - 'ChannelId' => [ - 'title' => '', - 'description' => 'Required. The ID of the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '70f22d5784194938a7e387052f2b3208', - 'backendName' => 'channelId', - ], + '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, - 'backendName' => 'voiceChat', - ], - 'AuthToken' => [ - 'description' => 'The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', - 'backendName' => 'authToken', - ], - 'AgentUserId' => [ - 'description' => 'The name of the agent in the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '877ae632caae49b1afc81c2e8194ffb4', - 'backendName' => 'agentUserId', + 'example' => '', ], 'VisionChat' => [ 'description' => 'The runtime parameters of the vision call.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'AuthToken' => [ - 'description' => 'Required. The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', - 'backendName' => 'authToken', - ], - 'AgentUserId' => [ - 'description' => 'Required. The name of the agent in the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '877ae632caae49b1afc81c2e8194ffb4', - 'backendName' => 'agentUserId', - ], - 'ChannelId' => [ - 'description' => 'Required. The ID of the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '70f22d5784194938a7e387052f2b3208', - 'backendName' => 'channelId', - ], + '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, - 'backendName' => 'visionChat', - ], - 'ChannelId' => [ - 'description' => 'The ID of the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '70f22d5784194938a7e387052f2b3208'."\n", - 'backendName' => 'channelId', + 'title' => '', + 'example' => '', ], - 'AvatarChat3D' => [ + 'VoiceChat' => [ 'title' => '', - 'description' => 'The runtime parameters of the avatar call.'."\n", - 'visibility' => 'Public', + 'description' => 'The runtime parameters of the voice call.'."\n", 'type' => 'object', 'properties' => [ - 'AuthToken' => [ - 'title' => '', - 'description' => 'Required. The authentication token for the agent to join the channel. This must be generated using your AppKey.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', - 'backendName' => 'authToken', - ], - 'AgentUserId' => [ - 'title' => '', - 'description' => 'Required. The name of the agent in the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '877ae632caae49b1afc81c2e8194ffb4', - 'backendName' => 'agentUserId', - ], - 'ChannelId' => [ - 'title' => '', - 'description' => 'Required. The ID of the ARTC channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '70f22d5784194938a7e387052f2b3208', - 'backendName' => 'channelId', - ], + '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, - 'backendName' => 'avatarChat3D', + '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' => 'A short description of struct', - 'description' => 'The template parameters of the intelligent agent.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'Agent template parameters.', 'type' => 'object', 'properties' => [ - 'VoiceChat' => [ + 'AvatarChat3D' => [ 'title' => '', - 'description' => 'The voice call parameters.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'Greeting' => [ - 'title' => '', - 'description' => 'The greetings spoken by the intelligent agent when it joins the meeting. If you do not specify this parameter, the system uses the default greetings specified in the template of the intelligent agent. The value can be up to 128 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'greeting', - ], + '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' => '', - 'visibility' => 'Public', + 'description' => 'The LLM/MLLM conversation history.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user', - 'backendName' => 'role', - ], - 'Content' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'content', - ], + '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' => ''], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'llmHistory', - ], - 'UserOnlineTimeout' => [ - 'description' => 'The timeout period before the user joins the meeting. Unit: seconds. Default value: 60.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'backendName' => 'userOnlineTimeout', - ], - 'UserOfflineTimeout' => [ - 'description' => 'The timeout period after the user leaves the meeting. Unit: seconds. Default value: 5.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'userOfflineTimeout', - ], - 'WorkflowOverrideParams' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'workflowOverrideParams', - ], - 'EnableIntelligentSegment' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableIntelligentSegment', - ], - 'AvatarUrlType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'USER', - 'backendName' => 'avatarUrlType', - ], - 'BailianAppParams' => [ - 'description' => 'The parameters of the application center of Alibaba Cloud Model Studio. For more information about the parameter format, see [Parameters of the application center of Alibaba Cloud Model Studio](~~2858132~~).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'bailianAppParams', - ], - 'LlmHistoryLimit' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'llmHistoryLimit', - ], - 'AsrMaxSilence' => [ - 'description' => 'The threshold used to determine the end of a sentence. If the duration of silence exceeds this threshold, the system determines that a sentence ends. Unit: milliseconds. Default value: 400. Valid values: 200 to 1200.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - 'backendName' => 'asrMaxSilence', - ], - 'AvatarUrl' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://example.com/a.jpg', - 'backendName' => 'avatarUrl', - ], - 'WakeUpQuery' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'wakeUpQuery', - ], - 'AppId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'backendName' => 'appId', - ], - 'Volume' => [ - 'title' => '', - 'description' => 'The speech volume of the intelligent agent.'."\n" - ."\n" - .'* If this parameter is not specified, the adaptive volume mode recommended by Alibaba Cloud is used by default.'."\n" - .'* To specify this parameter, enter a value between 0 and 400. The output volume is calculated by using the following formula: Output volume = Voice output volume specified in the workflow × Volume/100. Example:'."\n" - ."\n" - .'1. If Volume is set to 0, the output volume is 0.'."\n" - .'2. If Volume is set to 100, the output volume is the voice output volume specified in the workflow.'."\n" - .'3. If Volume is set to 200, the output volume is twice the voice output volume specified in the workflow.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'volume', - ], - 'EnableVoiceInterrupt' => [ 'title' => '', - 'description' => 'Specifies whether the intelligent agent can be interrupted by voice. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableVoiceInterrupt', - ], - 'VoiceprintId' => [ - 'description' => 'The unique ID of the voiceprint. This parameter is empty by default.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'uniqueId', - 'backendName' => 'voiceprintId', + 'example' => '', ], - 'VoiceId' => [ + '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' => '', - 'description' => 'The voice ID of the intelligent agent. The modification takes effect in the next sentence. If you do not specify this parameter, the system uses the default voice ID specified in the template of the intelligent agent. This parameter takes effect only for the preset TTS model. The ID can be up to 64 characters in length. For more information about the available voices, visit [https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example](url).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zhixiaoxia', - 'backendName' => 'voiceId', - ], - 'UseVoiceprint' => [ - 'description' => 'Specifies whether to enable voiceprint recognition. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'useVoiceprint', - ], - 'MaxIdleTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - 'backendName' => 'maxIdleTime', + 'example' => '', ], - 'GracefulShutdown' => [ + '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' => '', - 'description' => 'Specifies whether the intelligent agent supports graceful shutdown. Default value: false.'."\n" - ."\n" - .'* Graceful shutdown: When the intelligent agent is stopped, it completes its current sentence before stopping. However, the intelligent agent can speak for 10 seconds at most.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'gracefulShutdown', - ], - 'EnablePushToTalk' => [ - 'description' => 'Specifies whether to enable the intercom mode. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enablePushToTalk', + 'example' => '', ], - ], - 'backendName' => 'voiceChat', - ], - 'MessageChat' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'object', - 'properties' => [ - 'AppId' => [ + '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' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'appId', + 'example' => '', ], ], - 'backendName' => 'messageChat', + 'example' => '', ], 'VisionChat' => [ - 'description' => 'The parameters of the visual intelligent agent.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'Greeting' => [ - 'description' => 'The greetings spoken by the intelligent agent when it joins the meeting. If you do not specify this parameter, the system uses the default greetings specified in the template of the intelligent agent. The value can be up to 128 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Good morning, my friend!'."\n", - 'backendName' => 'greeting', - ], + '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' => '', - 'visibility' => 'Public', + 'description' => 'The LLM/MLLM conversation history.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user', - 'backendName' => 'role', - ], - 'Content' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'content', - ], + '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' => ''], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'llmHistory', - ], - 'UserOnlineTimeout' => [ - 'description' => 'The timeout period before the user joins the meeting. Unit: seconds. Default value: 60.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'backendName' => 'userOnlineTimeout', - ], - 'UserOfflineTimeout' => [ - 'description' => 'The timeout period after the user leaves the meeting. Unit: seconds. Default value: 5.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'userOfflineTimeout', - ], - 'WorkflowOverrideParams' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'workflowOverrideParams', - ], - 'EnableIntelligentSegment' => [ - 'description' => 'Specifies whether to enable intelligent sentence segmentation. This feature intelligently combines the segments of a speech into a single sentence if brief pauses occur when users are speaking. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableIntelligentSegment', - ], - 'BailianAppParams' => [ - 'description' => 'The parameters of the application center of Alibaba Cloud Model Studio. For more information about the parameter format, see [Parameters of the application center of Alibaba Cloud Model Studio](~~2858132~~).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'bailianAppParams', - ], - 'LlmHistoryLimit' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'llmHistoryLimit', - ], - 'AsrMaxSilence' => [ - 'description' => 'The threshold used to determine the end of a sentence. If the duration of silence exceeds this threshold, the system determines that a sentence ends. Unit: milliseconds. Default value: 400. Valid values: 200 to 1200.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - 'backendName' => 'asrMaxSilence', - ], - 'WakeUpQuery' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'title' => '', 'example' => '', - 'backendName' => 'wakeUpQuery', - ], - 'AppId' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'backendName' => 'appId', - ], - 'Volume' => [ - 'description' => 'The speech volume of the intelligent agent.'."\n" - ."\n" - .'If this parameter is not specified, the adaptive volume mode recommended by Alibaba Cloud is used by default.'."\n" - ."\n" - .'To specify this parameter, enter a value between 0 and 400. The output volume is calculated by using the following formula: Output volume = Voice output volume specified in the workflow × Volume/100. Example:'."\n" - ."\n" - .'If Volume is set to 0, the output volume is 0.'."\n" - ."\n" - .'If Volume is set to 100, the output volume is the voice output volume specified in the workflow.'."\n" - ."\n" - .'If Volume is set to 200, the output volume is twice the voice output volume specified in the workflow.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'volume', - ], - 'EnableVoiceInterrupt' => [ - 'description' => 'Specifies whether the intelligent agent can be interrupted by voice. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableVoiceInterrupt', - ], - 'VoiceprintId' => [ - 'description' => 'The unique ID of the voiceprint. This parameter is empty by default.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'uniqueId', - 'backendName' => 'voiceprintId', - ], - 'VoiceId' => [ - 'description' => 'The voice ID of the intelligent agent. The modification takes effect in the next sentence. If you do not specify this parameter, the system uses the default voice ID specified in the template of the intelligent agent. This parameter takes effect only for the preset TTS model. The ID can be up to 64 characters in length. For more information about the available voices, visit [https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example](url).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zhixiaoxia', - 'backendName' => 'voiceId', - ], - 'UseVoiceprint' => [ - 'description' => 'Specifies whether to enable voiceprint recognition. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'useVoiceprint', ], - 'MaxIdleTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - 'backendName' => 'maxIdleTime', + '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' => '', ], - 'GracefulShutdown' => [ - 'description' => 'Specifies whether the intelligent agent supports graceful shutdown. Default value: false.'."\n" - ."\n" - .'Graceful shutdown: When the intelligent agent is stopped, it completes its current sentence before stopping. However, the intelligent agent can speak for 10 seconds at most.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'gracefulShutdown', + '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' => '', ], - 'EnablePushToTalk' => [ - 'description' => 'Specifies whether to enable the intercom mode. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enablePushToTalk', + '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' => '', ], ], - 'backendName' => 'visionChat', + 'title' => '', + 'example' => '', ], - 'AvatarChat3D' => [ + 'VoiceChat' => [ 'title' => '', - 'description' => 'The parameters of the 3D avatar.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'Greeting' => [ - 'title' => '', - 'description' => 'The greetings spoken by the intelligent agent when it joins the meeting. If you do not specify this parameter, the system uses the default greetings specified in the template of the intelligent agent. The greetings can be up to 128 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'greeting', - ], + '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' => '', - 'visibility' => 'Public', + 'description' => 'The LLM/MLLM conversation history.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Role' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user', - 'backendName' => 'role', - ], - 'Content' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'content', - ], + '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' => ''], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'llmHistory', - ], - 'UserOnlineTimeout' => [ - 'description' => 'The timeout period before the user joins the meeting. Unit: seconds. Default value: 60.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'backendName' => 'userOnlineTimeout', - ], - 'UserOfflineTimeout' => [ - 'description' => 'The timeout period after the user leaves the meeting. Unit: seconds. Default value: 5.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'userOfflineTimeout', - ], - 'WorkflowOverrideParams' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'workflowOverrideParams', - ], - 'EnableIntelligentSegment' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableIntelligentSegment', - ], - 'BailianAppParams' => [ - 'description' => 'The parameters of the application center of Alibaba Cloud Model Studio. For more information about the parameter format, see [Parameters of the application center of Alibaba Cloud Model Studio](~~2858132~~).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'bailianAppParams', - ], - 'LlmHistoryLimit' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'llmHistoryLimit', - ], - 'AsrMaxSilence' => [ - 'description' => 'The threshold used to determine the end of a sentence. If the duration of silence exceeds this threshold, the system determines that a sentence ends. Unit: milliseconds. Default value: 400. Valid values: 200 to 1200.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - 'backendName' => 'asrMaxSilence', - ], - 'WakeUpQuery' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'wakeUpQuery', - ], - 'AppId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'backendName' => 'appId', - ], - 'Volume' => [ - 'title' => '', - 'description' => 'The speech volume of the intelligent agent.'."\n" - ."\n" - .'* If this parameter is not specified, the adaptive volume mode recommended by Alibaba Cloud is used by default.'."\n" - .'* To specify this parameter, enter a value between 0 and 400. The output volume is calculated by using the following formula: Output volume = Voice output volume specified in the workflow × Volume/100. Example:'."\n" - ."\n" - .'1. If Volume is set to 0, the output volume is 0.'."\n" - .'2. If Volume is set to 100, the output volume is the voice output volume specified in the workflow.'."\n" - .'3. If Volume is set to 200, the output volume is twice the voice output volume specified in the workflow.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'volume', - ], - 'AvatarId' => [ 'title' => '', - 'description' => 'The ID of the avatar.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1231', - 'backendName' => 'avatarId', + 'example' => '', ], - 'EnableVoiceInterrupt' => [ + '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' => '', - 'description' => 'Specifies whether the intelligent agent can be interrupted by voice. Default value: true.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enableVoiceInterrupt', - ], - 'VoiceprintId' => [ - 'description' => 'The unique ID of the voiceprint. This parameter is empty by default.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'uniqueId', - 'backendName' => 'voiceprintId', + 'example' => '', ], - 'VoiceId' => [ + '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' => '', - 'description' => 'The voice ID of the intelligent agent. The modification takes effect in the next sentence. If you do not specify this parameter, the system uses the default voice ID specified in the template of the intelligent agent. This parameter takes effect only for the preset TTS model. The ID can be up to 64 characters in length. For more information about the available voices, visit [https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example](url).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zhixiaoxia', - 'backendName' => 'voiceId', - ], - 'UseVoiceprint' => [ - 'description' => 'Specifies whether to enable voiceprint recognition. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'useVoiceprint', - ], - 'MaxIdleTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - 'backendName' => 'maxIdleTime', + 'example' => '', ], - 'GracefulShutdown' => [ + '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' => '', - 'description' => 'Specifies whether the intelligent agent supports graceful shutdown. Default value: false.'."\n" - ."\n" - .'* Graceful shutdown: When the intelligent agent is stopped, it completes its current sentence before stopping. However, the intelligent agent can speak for 10 seconds at most.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'gracefulShutdown', - ], - 'EnablePushToTalk' => [ - 'description' => 'Specifies whether to enable the intercom mode. Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'enablePushToTalk', + 'example' => '', ], ], - 'backendName' => 'avatarChat3D', + 'example' => '', ], ], + 'example' => '', ], 'AiRtcAuthCodeDTO' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'Authorization code information.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'status', - ], - 'Type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'type', - ], - 'AuthCode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'iU1IeJech7***', - 'backendName' => 'authCode', - ], - 'ActivatedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-01-01 06:57:43', - 'backendName' => 'activatedTime', - ], - 'DeviceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'device-***', - 'backendName' => 'deviceId', - ], - 'CreationTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-12-23T13:33:49Z', - 'backendName' => 'creationTime', - ], - 'License' => [ - 'title' => 'license', - 'description' => 'license。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'a659a06659a***', - 'backendName' => 'license', - ], - 'ModificationTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-12-23T13:33:49Z', - 'backendName' => 'modificationTime', - ], - 'LicenseItemId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '11096067***', - 'backendName' => 'licenseItemId', - ], - ], + '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' => 'A short description of struct', + 'title' => '', 'description' => 'The license batch information.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'CreationTime' => [ - 'title' => '', - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2020-12-23T13:33:49Z', - 'backendName' => 'creationTime', - ], - 'ModificationTime' => [ - 'title' => '', - 'description' => 'The update time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2020-12-23T13:33:49Z', - 'backendName' => 'modificationTime', - ], - 'Type' => [ - 'title' => '', - 'description' => 'The license type. Valid values:'."\n" - ."\n" - .'* 1: Audio call'."\n" - .'* 2: Vision call'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'type', - ], - 'LicenseItemId' => [ - 'title' => '', - 'description' => 'The ID of the batch.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '17712***', - 'backendName' => 'licenseItemId', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The status of the batch. Valid values:'."\n" - ."\n" - .'* 1: Active'."\n" - .'* 2\\. Expired'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'status', - ], - 'ValidDays' => [ - 'title' => '', - 'description' => 'The validity period of the licenses in this batch, in days.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '365', - 'backendName' => 'validDays', - ], - 'ExpiredOn' => [ - 'title' => '', - 'description' => 'The expiration time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2021-12-23T13:33:49Z', - 'backendName' => 'expiredOn', - ], - 'BeginOn' => [ - 'title' => '', - 'description' => 'The time when the batch became active.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2020-12-23T13:33:49Z', - 'backendName' => 'beginOn', - ], - 'LicenseCount' => [ - 'title' => '', - 'description' => 'The total number of licenses contained within this batch.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - 'backendName' => 'licenseCount', - ], - 'AvailableCapacity' => [ - 'title' => '', - 'description' => 'The remaining usage capacity of the batch.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000000', - 'backendName' => 'availableCapacity', - ], - 'InstanceId' => [ - 'title' => '', - 'description' => 'The ID of the instance.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ice_CoverAILicense_public_cn***', - 'backendName' => 'instanceId', - ], - 'ContractNo' => [ - 'title' => '', - 'description' => 'The contract number.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '258396267390***', - 'backendName' => 'contractNo', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'FillerSourceName' => [ - 'description' => 'The source name of the filler slate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'fillerSourceName', - ], - 'FillerSourceLocationName' => [ - 'description' => 'The source location of the filler slate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'fillerSourcelocationName', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-01-15T03:44:16Z', - 'backendName' => 'gmtCreateUTC', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'ChannelTier' => [ - 'description' => 'The tier of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'basic', - 'backendName' => 'channelTierString', - ], - 'AccessToken' => [ - 'description' => 'The token for accessing the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxxxx', - 'backendName' => 'accessToken', - 'sensitive' => true, - ], - 'State' => [ - 'description' => 'The state of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'state', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-09-01T10:09Z', - 'backendName' => 'gmtModifiedUTC', - ], - 'Arn' => [ - 'description' => 'The ARN of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::channel/myChannel', - 'backendName' => 'arn', - ], - 'PlaybackMode' => [ - 'description' => 'The playback mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'loop', - 'backendName' => 'playbackModeString', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The output configuration.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ManifestName' => [ - 'description' => 'The manifest name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'index1', - 'backendName' => 'manifestName', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'Format' => [ - 'description' => 'The format.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hls', - 'backendName' => 'formatString', - ], - 'PlaybackUrl' => [ - 'description' => 'The playback URL.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://xxxxx.com/xxx.m3u8', - 'backendName' => 'playbackUrl', - ], - 'ManifestSettings' => [ - 'description' => 'The manifest settings.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"WindowDuration": 60,"AdMarkType":"Daterange"}', - 'backendName' => 'manifestSettings', - ], - 'SourceGroupName' => [ - 'description' => 'The name of the source group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'group1', - 'backendName' => 'sourcegroupName', - ], + '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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'outputDTOS', - ], - 'AccessPolicy' => [ - 'description' => 'Specifies whether to enable access control.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'accessPolicy', + 'title' => '', + 'example' => '', ], + 'AccessPolicy' => ['description' => 'Specifies whether to enable access control.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'ChannelAssemblyChannel' => [ 'description' => 'The MediaWeaver channel.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'FillerSourceName' => [ - 'description' => 'The source name of the filler slate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'fillerSourceName', - ], - 'FillerSourceLocationName' => [ - 'description' => 'The source location of the filler slate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'fillerSourcelocationName', - ], - 'GmtCreate' => [ - 'description' => 'The time when the channel was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-01-15T03:44:16Z'."\n", - 'backendName' => 'gmtCreateUTC', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'ChannelTier' => [ - 'description' => 'The tier of the channel. Valid values: basic and standard.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'basic', - 'backendName' => 'channelTierString', - ], - 'AccessToken' => [ - 'description' => 'The token for accessing the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxxxx', - 'backendName' => 'accessToken', - 'sensitive' => true, - ], - 'State' => [ - 'description' => 'The channel status. A value of 0 specifies stopped. A value of 1 specifies running.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'state', - ], - 'GmtModified' => [ - 'description' => 'The time when the channel was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-09-01T10:09Z'."\n", - 'backendName' => 'gmtModifiedUTC', - ], - 'Arn' => [ - 'description' => 'The ARN of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::channel/myChannel'."\n", - 'backendName' => 'arn', - ], - 'PlaybackMode' => [ - 'description' => 'The playback mode. Valid values: loop and linear.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'loop', - 'backendName' => 'playbackModeString', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The output.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ManifestName' => [ - 'description' => 'The name of the manifest file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'index1', - 'backendName' => 'manifestName', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'Format' => [ - 'description' => 'The streaming protocol. Only HTTP Live Streaming (HLS) is supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hls', - 'backendName' => 'formatString', - ], - 'PlaybackUrl' => [ - 'description' => 'The playback URL.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://xxxxx.com/xxx.m3u8'."\n", - 'backendName' => 'playbackUrl', - ], - 'ManifestSettings' => [ - 'description' => 'The manifest settings.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"WindowDuration": 60,"AdMarkType":"Daterange"}'."\n", - 'backendName' => 'manifestSettings', - ], - 'SourceGroupName' => [ - 'description' => 'The name of the source group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'group1', - 'backendName' => 'sourcegroupName', - ], + '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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'outputDTOS', - ], - 'AccessPolicy' => [ - 'description' => 'Specifies whether to enable access control.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'accessPolicy', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The time when the program was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-04-02T00:58:19Z'."\n", - 'backendName' => 'gmtCreateUTC', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'TimeSignalSettings' => [ - 'description' => 'The TimeSignal configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}'."\n", - 'backendName' => 'timeSignalConfig', - ], - 'OffsetMillis' => [ - 'description' => 'The position to insert the ad marker, as an offset relative to the beginning of the program. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - 'backendName' => 'offsetMillis', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], - 'SpliceInsertSettings' => [ - 'description' => 'The SpliceInsert configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", - 'backendName' => 'spliceInsertConfig', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyAdSource', - 'backendName' => 'sourceName', - ], - 'ProgramName' => [ - 'description' => 'The name of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'program_name'."\n", - 'backendName' => 'programName', - ], - 'MessageType' => [ - 'description' => 'The SCTE-35 message type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPLICE_INSERT', - 'backendName' => 'messageTypeString', - ], + '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' => ''], ], - 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'adBreakDTOs', - ], - 'SourceType' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vodSource', - 'backendName' => 'sourceTypeString', - ], - 'Transition' => [ - 'description' => 'The program transition method.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}'."\n", - 'backendName' => 'transition', - ], - 'GmtModified' => [ - 'description' => 'The time when the program was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-04-02T00:58:19Z'."\n", - 'backendName' => 'gmtModifiedUTC', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'sourceName', - ], - 'ClipRange' => [ - 'description' => 'Extracts a clip from the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}'."\n", - 'backendName' => 'clipRange', - ], - 'Arn' => [ - 'description' => 'The ARN of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::program/myChannel/MyProgram'."\n", - 'backendName' => 'arn', - ], - 'ProgramName' => [ - 'description' => 'The name of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'program1', - 'backendName' => 'programName', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'EntryType' => [ - 'description' => 'The entry type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'program', - 'backendName' => 'entryType', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation'."\n", - 'backendName' => 'sourceLocationName', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100000', - 'backendName' => 'offsetMillis', - ], - 'TimeSignalSettings' => [ - 'description' => 'The TimeSignal configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}'."\n", - 'backendName' => 'timeSignalSettings', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], - 'SpliceInsertSettings' => [ - 'description' => 'The SpliceInsert configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", - 'backendName' => 'spliceInsertSettings', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'sourceName', - ], - 'MessageType' => [ - 'description' => 'The SCTE-35 message type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPLICE_INSERT', - 'backendName' => 'messageType', - ], + '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' => ''], ], - 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'adBreaks', - ], - 'SourceType' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vodSource', - 'backendName' => 'sourceType', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'sourceName', - ], - 'ApproximateDurationSeconds' => [ - 'description' => 'The scheduled playback duration.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000', - 'backendName' => 'approximateDurationSeconds', - ], - 'ApproximateStartTime' => [ - 'description' => 'The scheduled start time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1989128002313', - 'backendName' => 'approximateStartTimeUTC', - ], - 'ProgramName' => [ - 'description' => 'The name of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'program1', - 'backendName' => 'programName', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The time when the source was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2022-10-20T07:15:51Z', - 'backendName' => 'gmtCreateUTC', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation'."\n", - 'backendName' => 'sourceLocationName', - ], - 'State' => [ - 'description' => 'The status of the source. 0: normal. 1: deleted.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'state', - ], - 'SourceType' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vodSource', - 'backendName' => 'sourceTypeString', - ], - 'GmtModified' => [ - 'description' => 'The time when the source was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-11-07T10:12:01Z'."\n", - 'backendName' => 'gmtModifiedUTC', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyVodSource'."\n", - 'backendName' => 'sourceName', - ], - 'HttpPackageConfigurations' => [ - 'description' => 'The source configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[{'."\n" - .' "sourceGroupName": "mySourceGroup-1",'."\n" - .' "relativePath": "group1/hls.m3u8",'."\n" - .' "packageType": "hls"'."\n" - .'}]', - 'backendName' => 'httpPackageConfigurations', - ], - 'Arn' => [ - 'description' => 'The ARN of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/mySource'."\n", - 'backendName' => 'arn', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The time when the source location was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-03-29T02:03:17Z', - 'backendName' => 'gmtCreateUTC', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation'."\n", - 'backendName' => 'sourceLocationName', - ], - 'State' => [ - 'description' => 'The status of the source location. 0: normal. 1: deleted.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'state', - ], - 'GmtModified' => [ - 'description' => 'The time when the source location was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-03-29T02:03:17Z'."\n", - 'backendName' => 'gmtModifiedUTC', - ], - 'SegmentDeliveryConfigurations' => [ - 'description' => 'The segment delivery server configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://segmentdelivery.com'."\n", - 'backendName' => 'segmentDeliveryUrl', - ], - 'BaseUrl' => [ - 'description' => 'The base URL of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://xxxx.com'."\n", - 'backendName' => 'baseUrl', - ], - 'Arn' => [ - 'description' => 'The ARN of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::sourcelocation/MySourceLocation'."\n", - 'backendName' => 'arn', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'TranspositionResultList' => [ 'description' => '* Predefined translation results for the hotword.'."\n" .'* This field is only used in translation-related scenarios.'."\n", - 'visibility' => 'Public', + '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' => [ - 'description' => 'Predefined translation for the hotword.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/TranspositionResult', + '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'], + ], ], - 'backendName' => 'transpositionResultList', + 'required' => false, ], - 'Language' => [ + ], + ], + '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' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'en', - 'backendName' => 'language', + 'example' => '', ], - 'Text' => [ + 'TemplateConfig' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hello', - 'backendName' => 'text', + 'example' => '', ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'backendName' => 'weight', + '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", - 'visibility' => 'Public', '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'segmentCount', - ], + '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", - 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'XML' => 'XML', - 'NONE' => 'NONE', - 'DATE_RANGE' => 'DATE_RANGE', - ], + 'enumValueTitles' => ['XML' => 'XML', 'NONE' => 'NONE', 'DATE_RANGE' => 'DATE_RANGE'], 'example' => 'NONE', - 'backendName' => 'adMarkers', - ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000000', - 'backendName' => 'minVideoBitrate', - ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'backendName' => 'minBufferTime', - ], - 'PresentationDelay' => [ - 'description' => 'The suggested presentation delay, in seconds. Valid values: 1 to 60. Default value: the duration of three segments.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - 'backendName' => 'presentationDelay', + '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", - 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'VIDEO_BITRATE_ASCENDING' => 'VIDEO_BITRATE_ASCENDING', - 'VIDEO_BITRATE_DESCENDING' => 'VIDEO_BITRATE_DESCENDING', - 'ORIGINAL' => 'ORIGINAL', - ], + 'enumValueTitles' => ['VIDEO_BITRATE_ASCENDING' => 'VIDEO_BITRATE_ASCENDING', 'VIDEO_BITRATE_DESCENDING' => 'VIDEO_BITRATE_DESCENDING', 'ORIGINAL' => 'ORIGINAL'], 'example' => 'ORIGINAL', - 'backendName' => 'streamOrder', - ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8000000', - 'backendName' => 'maxVideoBitrate', - ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'backendName' => 'dateTimeInterval', + '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", - 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'NUMBER_TIMELINE' => 'NUMBER_TIMELINE', - ], + 'enumValueTitles' => ['NUMBER_TIMELINE' => 'NUMBER_TIMELINE'], 'example' => 'NUMBER_TIMELINE', - 'backendName' => 'segmentTemplateFormat', - ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'backendName' => 'minUpdatePeriod', - ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'backendName' => 'manifestDuration', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'LiveManifestConfigs' => [ 'description' => 'Live stream manifest configuration. Only one configuration is supported.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Live stream manifest configuration.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/LiveManifestConfig', - ], - 'backendName' => 'liveManifestConfigs', - ], - 'UseAudioRenditionGroups' => [ + 'items' => ['description' => 'Live stream manifest configuration.'."\n", '$ref' => '#/components/schemas/LiveManifestConfig', 'title' => '', 'example' => ''], 'title' => '', - 'description' => 'Specifies whether to create separate audio rendition groups for TS segments.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'useAudioRenditionGroups', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'SystemIds' => [ @@ -3811,556 +2232,228 @@ .'* Apple FairPlay: 94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" .'* Google Widevine: edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'."\n" .'* Microsoft PlayReady: 9a04f079-9840-4286-ab92-e65be0885f95'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the DRM system.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '9a04f079-9840-4286-ab92-e65be0885f95', - 'extendType' => 'true', - ], - 'backendName' => 'systemIds', - ], - 'RotatePeriod' => [ - 'title' => '', - 'description' => 'The key rotation interval for DRM, in seconds. The default value of 0 disables key rotation.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'rotatePeriod', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'live-axb1-9dd2fa123', - 'backendName' => 'contentId', - ], - 'EncryptionMethod' => [ - 'title' => '', - 'description' => 'The encryption method. Valid value:'."\n" - ."\n" - .'* SAMPLE_AES'."\n" - ."\n" - .'If not specified, encryption is disabled.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SAMPLE_AES', - 'backendName' => 'encryptionMethod', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '00000000000000000000000000000000', - 'backendName' => 'iv', - ], - 'Url' => [ - 'title' => '', - 'description' => 'The URL of the DRM key provider.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://exampledrm.com/path?arg1=xxx', - 'backendName' => 'url', + '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'], ], - 'backendName' => 'drmConfig', - ], - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - 'backendName' => 'segmentDuration', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Codec' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'AAC', - 'backendName' => 'codec', - ], - 'Remove' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'remove', - ], - 'Bitrate' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '128', - 'backendName' => 'bitrate', - ], - 'Samplerate' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '44100', - 'backendName' => 'samplerate', - ], - 'Profile' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'aac_low', - 'backendName' => 'profile', - ], - 'Channels' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'channels', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the input file. If Output contains InputRef, use this name to reference the input file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'InputVideo', - 'backendName' => 'name', - ], - 'InputFile' => [ - 'title' => '', - 'description' => 'The input file.'."\n", - 'visibility' => 'Public', - 'backendName' => 'inputFile', - '$ref' => '#/components/schemas/MediaObject', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'OutputDetails' => [ - 'title' => '', - 'description' => 'An array containing the results for each output.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'Output details.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutputDetail', - ], - 'backendName' => 'outputDetails', - 'itemName' => 'outputDetail', - ], - 'RequestId' => [ - 'title' => '', - 'description' => 'The ID of the API request that created this task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '7B117AF5-2A1******', - 'backendName' => 'requestId', - ], - 'Message' => [ - 'title' => '', - 'description' => 'The reason for a failed task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The resource operated InputFile is bad'."\n", - 'backendName' => 'message', - ], - 'UserData' => [ - 'title' => '', - 'description' => 'The user-defined data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'userData', - ], - 'Percent' => [ - 'description' => 'The completion percentage of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'percent', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'JobName' => [ - 'description' => 'The task name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Name', - 'backendName' => 'jobName', - ], + 'JobName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'Name'], 'Outputs' => [ 'title' => '', 'description' => 'The output configurations.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The output configuration.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutput', - ], - 'backendName' => 'outputs', - 'itemName' => 'output', + 'items' => ['title' => '', 'description' => 'The output configuration.'."\n", '$ref' => '#/components/schemas/MediaConvertOutput'], ], 'OutputGroups' => [ 'title' => '', 'description' => 'Output groups.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'Output group configurations.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutputGroup', - ], - 'backendName' => 'outputGroups', - 'itemName' => 'group', + 'items' => ['title' => '', 'description' => 'Output group configurations.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputGroup'], ], 'Inputs' => [ 'title' => '', 'description' => 'Inputs.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'Input file configurations.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertInput', - ], - 'backendName' => 'inputs', - 'itemName' => 'input', + 'items' => ['title' => '', 'description' => 'Input file configurations.'."\n", '$ref' => '#/components/schemas/MediaConvertInput'], ], ], - 'backendName' => 'config', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2022-07-07T07:16:11Z', - 'backendName' => 'createTime', + '$ref' => '#/components/schemas/MediaConvertJobConfig', + 'example' => '', ], - 'Code' => [ - 'title' => '', - 'description' => 'An error code returned if the task failed.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'InvalidParameter.ResourceContentBad'."\n", - 'backendName' => 'code', + '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' => '', + 'title' => '转码输出组结果列表', 'description' => 'The details of the output groups.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The results for each output group.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', - ], - 'backendName' => 'outputGroupDetails', - 'itemName' => 'outputGroupDetail', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2022-07-07T07:16:11Z'."\n", - 'backendName' => 'finishTime', - ], - 'State' => [ - 'title' => '', - 'description' => 'The task status.'."\n" - ."\n" - .'* Inited: Initialized'."\n" - .'* Running'."\n" - .'* Complete'."\n" - .'* Error'."\n" - .'* Cancelled'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Finished', - 'backendName' => 'state', - ], - 'PipelineId' => [ - 'title' => '', - 'description' => 'The ID of the queue that processed the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - 'backendName' => 'pipelineId', - ], - 'ClientToken' => [ - 'title' => '', - 'description' => 'The idempotency key of the request for creating the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****12e8864746a0a398****', - 'backendName' => 'clientToken', - ], - 'TriggerSource' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'Console', - 'backendName' => 'triggerSource', - ], - 'JobId' => [ - 'title' => '', - 'description' => 'The ID of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - 'backendName' => 'jobId', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'JobName' => [ - 'description' => 'The task name.'."\n" - ."\n" - .'* Maximum length: 64 bytes.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Name', - 'backendName' => 'jobName', - ], + 'JobName' => ['description' => 'The task name.'."\n" + ."\n" + .'* Maximum length: 64 bytes.'."\n", 'type' => 'string', 'example' => 'Name', 'title' => ''], 'Inputs' => [ 'description' => 'Inputs.'."\n", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Input file configurations.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the input file. InputRef can reference it in the output configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'InputVideo'."\n", - 'backendName' => 'name', - ], + '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", - 'visibility' => 'Public', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OSS', - 'backendName' => 'type', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://bucket.loction.aliyuncs.com/path/to/video.mp4', - 'backendName' => 'media', - ], - 'Url' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'http://bucket.loction.aliyuncs.com/path/to/video.mp4'."\n", - 'backendName' => 'url', - ], - ], - 'backendName' => 'inputFile', - ], - ], - 'extendType' => 'true', - ], - 'backendName' => 'inputs', - ], - 'Outputs' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'output-video'."\n", - 'backendName' => 'name', - ], - 'TemplateId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****'."\n", - 'backendName' => 'templateId', - ], - 'OutputFile' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'enumValueTitles' => [ - 'Media' => 'Media', - 'OSS' => 'OSS', - ], - 'example' => 'OSS', - 'backendName' => 'type', - ], - 'Media' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - 'backendName' => 'media', - ], - 'Url' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4'."\n", - 'backendName' => 'url', - ], + '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' => ''], ], - 'backendName' => 'outputFile ', - ], - 'Priority' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - 'backendName' => 'priority ', - ], - 'Features' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'features', - ], - 'OverrideParams' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'overrideParams', + 'title' => '', + 'example' => '', ], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'outputs', + 'title' => '', + 'example' => '', ], 'OutputGroups' => [ 'description' => 'An array of output group configurations.'."\n", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Output group configurations.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the output group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hls-group'."\n", - 'backendName' => 'name', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Type' => [ @@ -4368,1753 +2461,780 @@ ."\n" .'* File: An individual file.'."\n" .'* Hls: HLS files for adaptive bitrate streaming.'."\n", - 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'File' => 'File', - 'Hls' => 'Hls', - ], + 'enumValueTitles' => ['File' => 'File', 'Hls' => 'Hls'], 'example' => 'Hls', - 'backendName' => 'type', + 'title' => '', ], 'OutputFileBase' => [ 'description' => 'The base output directory. All files generated by this OutputGroup are placed in this directory.'."\n", - 'visibility' => 'Public', '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OSS', - 'backendName' => 'type', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://bucket/path/to/dir', - 'backendName' => 'media', - ], - 'Url' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'oss://bucket/path/to/{MediaId}', - 'backendName' => 'url', - ], + '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' => ''], ], - 'backendName' => 'outputFileBase', - ], - 'ManifestName' => [ - 'description' => 'The name of the manifest file. This parameter is only applicable when Type is set to Hls or Dash.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'manifest', - 'backendName' => 'manifestName', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'InputRef' => [ - 'description' => 'References the Name of an input that contains the manifest to be extended.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Input-Manifest', - 'backendName' => 'inputRef', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Stream exclusion condition.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Language' => [ - 'description' => 'Excludes streams based on their Language field. It must conform to RFC 5646.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'en', - 'backendName' => 'language', - ], - 'Name' => [ - 'description' => 'Excludes streams based on their Name field.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'audio-1', - 'backendName' => 'name', - ], - 'Type' => [ - 'description' => 'Excludes streams based on their Type field.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Audio'."\n" - .'* Subtitle'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Audio', - 'backendName' => 'type', - ], + '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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'excludes', + 'title' => '', + 'example' => '', ], ], - 'backendName' => 'manifestExtend', + 'title' => '', + 'example' => '', ], ], - 'backendName' => 'groupConfig', + 'title' => '', + 'example' => '', ], 'Outputs' => [ 'description' => 'A list of individual output stream configurations. Each object in this array defines a specific rendition.'."\n", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Individual output stream configuration.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'A name to label this output. This is for identification purposes only and does not affect the filename.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'group-output'."\n", - 'backendName' => 'name', - ], - 'TemplateId' => [ - 'description' => 'The ID of the transcoding template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****'."\n", - 'backendName' => 'templateId', - ], - 'OutputFileName' => [ - 'description' => 'The filename for this output. It is used in conjunction with OutputFileBase from the GroupConfig.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '720p.mp4'."\n", - 'backendName' => 'outputFileName', - ], - 'Priority' => [ - 'description' => 'The priority of the task, from 1 to 10. A higher value indicates a higher priority. Default: 6.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - 'backendName' => 'priority', - ], - 'Features' => [ - 'description' => 'Additional feature parameters. See [MediaConvertJobFeature](~~2979993~~) for details.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'features', - ], - 'OverrideParams' => [ - 'description' => 'A JSON string of parameters to override the settings in the specified template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'overrideParams', - ], + '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", - 'visibility' => 'Public', '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hybrid', - 'backendName' => 'type', - ], - 'Bandwidth' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => '10000000', - 'backendName' => 'bandwidth', - ], - 'AudioGroup' => [ - 'description' => 'The audio group this video stream references. Effective when Type is video.'."\n" - ."\n" - .'Default value: audio.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'audio', - 'backendName' => 'audioGroup', - ], - 'SubtitleGroup' => [ - 'description' => 'The subtitle group this video or hybrid stream references. Effective when Type is video or hybrid.'."\n" - ."\n" - .'Default value: subtitle.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'subtitle', - 'backendName' => 'subtitleGroup', - ], - 'Name' => [ - 'description' => 'The NAME attribute for this stream in the HLS manifest. **Required** when Type is audio or subtitle.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'audio', - 'backendName' => 'name', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'audio', - 'backendName' => 'group', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh', - 'backendName' => 'language', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'false', - 'backendName' => 'isDefault', - ], - 'Forced' => [ - 'description' => 'Whether this stream must be played. Effective when Type is audio or subtitle.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - 'backendName' => 'forced', - ], - 'AutoSelect' => [ - 'description' => 'Whether this stream should be automatically selected by the player. Effective when Type is audio or subtitle.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - 'backendName' => 'autoSelect', - ], + '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' => ''], ], - 'backendName' => 'hlsGroupConfig', + 'title' => '', + 'example' => '', ], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'outputs', + 'title' => '', + 'example' => '', ], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'outputGroups', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'MediaConvertJobFeature' => [ - 'description' => 'Parameters for transcoding features.'."\n", - 'visibility' => 'Public', + 'description' => 'Parameters for transcoding features.', 'type' => 'object', 'properties' => [ 'Clip' => [ - 'description' => 'Configuration for clipping from the source video.'."\n", - 'visibility' => 'Public', + 'description' => 'Clip settings.', 'type' => 'object', 'properties' => [ 'TimeSpan' => [ - 'description' => 'The time range for the clip.'."\n", - 'visibility' => 'Public', + 'description' => 'The time span for the clip.', 'type' => 'object', 'properties' => [ - 'Duration' => [ - 'description' => 'The duration of the clip, starting from the Seek time. The default duration is from the Seek time to the end of the video. Duration and End are mutually exclusive. If End is set, Duration is ignored.'."\n" - ."\n" - .'* Format: hh:mm:ss\\[.SSS] or sssss\\[.SSS].'."\n" - .'* Valid values: \\[00:00:00.000,23:59:59.999] or \\[0.000,86399.999].'."\n" - .'* Example: 00:01:59.99 or 180.30.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '60.0', - 'backendName' => 'duration', - ], - 'End' => [ - 'description' => 'Specifies a duration to trim from the end of the video. Duration and End are mutually exclusive. If End is set, Duration is ignored.'."\n" - ."\n" - .'* Format: hh:mm:ss\\[.SSS] or sssss\\[.SSS].'."\n" - .'* Valid values: \\[00:00:00.000,23:59:59.999] or \\[0.000,86399.999].'."\n" - .'* Example: 00:01:59.99 or 180.30.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '50', - 'backendName' => 'end', - ], - 'Seek' => [ - 'description' => 'The start time of the clip. It defaults to the beginning of the video.'."\n" - ."\n" - .'* Format: hh:mm:ss\\[.SSS] or sssss\\[.SSS].'."\n" - .'* Valid values: \\[00:00:00.000,23:59:59.999] or \\[0.000,86399.999].'."\n" - .'* Example: 00:01:59.99 or 180.30.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '180.30', - 'backendName' => 'seek', - ], - ], - 'backendName' => 'timeSpan', - ], - 'ConfigToClipFirstPart' => [ - 'description' => 'Specifies the order of operations when concatenating multiple files and clipping.'."\n" - ."\n" - .'* true: Clips the first input file before it is concatenated.'."\n" - .'* false: Concatenates all input files first, then applies clipping.'."\n" - .'* Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'false', - 'backendName' => 'configToClipFirstPart', - ], - ], - 'backendName' => 'clip', - ], - 'Watermarks' => [ - 'description' => 'Image or text watermarks to add to the video. These parameters override the corresponding settings from a specified watermark template.'."\n" - ."\n" - .'* You can add up to four watermarks to a transcoding task.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'Configuration for a single watermark.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'FontColor' => [ - 'description' => 'The font color of the text watermark.'."\n" - ."\n" - .'* Default value: black.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'black', - 'backendName' => 'fontColor', - ], - 'BorderColor' => [ - 'description' => 'The color of the font border.'."\n" - ."\n" - .'* Default value: Black.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Black', - 'backendName' => 'borderColor', - ], - 'BorderWidth' => [ - 'description' => 'The width of the font border.'."\n" - ."\n" - .'* Unit: pixels.'."\n" - .'* Valid values: \\[0,4096].'."\n" - .'* Default value: 0.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'borderWidth', - ], - 'FontAlpha' => [ - 'description' => 'The font opacity.'."\n" - ."\n" - .'* Valid values: (0,1].'."\n" - .'* Default value: 1.0.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1.0', - 'backendName' => 'fontAlpha', - ], - 'Type' => [ - 'description' => 'The watermark type.'."\n" - ."\n" - .'* Text: a text watermark. In this case, you must specify the parameters related to the text watermark.'."\n" - .'* Image: an image watermark. In this case, you must specify the parameters related to the image watermark.'."\n" - ."\n" - .'If not specified, the type is inferred from the TemplateId.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Image', - 'backendName' => 'type', - ], - 'Adaptive' => [ - 'description' => 'Specifies if the font size adapts to the output resolution. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - .'* Default value: false.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - 'backendName' => 'adaptive', - ], - 'FontSize' => [ - 'description' => 'The font size of the text watermark.'."\n" - ."\n" - .'* Valid values: (4,120).'."\n" - .'* Default value: 16.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'fontSize', - ], - 'Content' => [ - 'description' => 'The text to be displayed as the watermark.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'TextWatarmark', - 'backendName' => 'content', - ], - 'X' => [ - 'description' => 'The horizontal offset of the image watermark relative to the output video. This parameter overrides the corresponding setting from a specified watermark template. The following value types are supported:'."\n" + '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" - .'* Integer: the pixel value of the horizontal offset.'."\n" + .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" - .' * Unit: pixels.'."\n" - .' * Valid values: \\[8,4096].'."\n" + .'- Value range: `[00:00:00.000, 23:59:59.999]` or `[0.000, 86399.999]`.'."\n" ."\n" - .'* Decimal: the ratio of the horizontal offset to the width of the output video.'."\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" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.08', - 'backendName' => 'x', - ], - 'FontName' => [ - 'description' => 'The font of the text watermark.'."\n" - ."\n" - .'* Default value: SimSum.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SimSum', - 'backendName' => 'fontName', - ], - 'Y' => [ - 'description' => 'The vertical offset of the image watermark relative to the output video. This parameter overrides the corresponding setting from a specified watermark template. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the vertical offset.'."\n" - ."\n" - .' * Unit: pixels.'."\n" - .' * Valid values: \\[8,4096].'."\n" - ."\n" - .'* Decimal: the ratio of the vertical offset to the height of the output video.'."\n" + .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.08', - 'backendName' => 'y', - ], - 'Height' => [ - 'description' => 'The height of the image watermark. This parameter overrides the corresponding setting from a specified watermark template. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the watermark height.'."\n" - ."\n" - .' *'."\n" - .' * Valid values: \\[8,4096].'."\n" - ."\n" - .'* Decimal: A decimal of the output video\'s height.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.1', - 'backendName' => 'height', - ], - 'Invisible' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'invisible', - ], - 'Width' => [ - 'description' => 'The width of the image watermark. This parameter overrides the corresponding setting from a specified watermark template. The following value types are supported:'."\n" + .'- Value range: `[00:00:00.000, 23:59:59.999]` or `[0.000, 86399.999]`.'."\n" ."\n" - .'* Integer: the pixel value of the watermark width.'."\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" - .' *'."\n" - .' * Valid values: \\[8,4096].'."\n" + .'- Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" ."\n" - .'* Decimal: A decimal of the output video\'s width.'."\n" + .'- Value range: `[00:00:00.000, 23:59:59.999]` or `[0.000, 86399.999]`.'."\n" ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.1', - 'backendName' => 'width', - ], - 'TemplateId' => [ - 'description' => 'The ID of the watermark template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '962e1332fa2d4e12bdfb76dd1402fcfa', - 'backendName' => 'templateId', + .'- 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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'watermarks', + 'title' => '', + 'example' => '', ], 'Metadata' => [ - 'description' => 'A map of key-value pairs to be embedded as container-level metadata in the output file. Provided as a JSON string. Example: {"key1":"value1","key2":"value2"}.'."\n" + '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" - .'* Max key length: 64 characters.'."\n" - .'* Max value length: 512 characters.'."\n" + .'- Maximum value length: 512 characters.'."\n" ."\n" - .'Max 4 key-value pairs.'."\n", - 'visibility' => 'Public', + .'You can add a maximum of four metadata key-value pairs.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The metadata of the vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"AIGC": "xxx"}', - ], - 'backendName' => 'metadata', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Subtitles' => [ 'description' => 'Subtitle stream configurations.'."\n", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Configuration for a single subtitle stream.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Codec' => [ - 'description' => 'The encoding format for the subtitle stream.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'VTT', - 'backendName' => 'codec', - ], + 'Codec' => ['description' => 'The encoding format for the subtitle stream.'."\n", 'type' => 'string', 'example' => 'VTT', 'title' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'subtitles', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'MediaConvertJobWithoutDetail' => [ 'description' => 'A summary of a MediaConvert task without detailed information.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '', - 'description' => 'The ID of the API request that created this task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - 'backendName' => 'requestId', - ], - 'Message' => [ - 'title' => '', - 'description' => 'The reason for a task failure.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The resource operated "%s" cannot be found', - 'backendName' => 'message', - ], - 'FinishTime' => [ - 'description' => 'The time the task finished processing, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-07T13:01:07Z', - 'backendName' => 'finishTime', - ], - 'UserData' => [ - 'title' => '', - 'description' => 'The user-defined data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"info": "xxx"}', - 'backendName' => 'userData', - ], + '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", - 'visibility' => 'Public', '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", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The output configuration.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutput', - ], - 'backendName' => 'outputs', - 'itemName' => 'output', - ], - 'JobName' => [ - 'description' => 'The task name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Name', - 'backendName' => 'jobName', + 'items' => ['title' => '', 'description' => 'The output configuration.'."\n", '$ref' => '#/components/schemas/MediaConvertOutput', 'example' => ''], + 'example' => '', ], 'OutputGroups' => [ 'title' => '', 'description' => 'The output groups.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The output group configuration.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutputGroup', - ], - 'backendName' => 'outputGroups', - 'itemName' => 'group', - ], - 'Inputs' => [ - 'title' => '', - 'description' => 'The input files for the task.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The input file for the task.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertInput', - ], - 'backendName' => 'inputs', - 'itemName' => 'input', + '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' => ''], ], - 'backendName' => 'config', - ], - 'State' => [ - 'title' => '', - 'description' => 'The status of the task.'."\n" - ."\n" - .'* Inited: The task is initialized.'."\n" - .'* Running'."\n" - .'* Complete'."\n" - .'* Error'."\n" - .'* Cancelled'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Inited', - 'backendName' => 'state', - ], - 'CreateTime' => [ - 'description' => 'The time the task was created, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-07T13:01:07Z'."\n", - 'backendName' => 'createTime', - ], - 'PipelineId' => [ - 'title' => '', - 'description' => 'The ID of the queue on which this task was processed.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '688c2a8bfa4e44ddbba0c8730db91b0c', - 'backendName' => 'pipelineId', - ], - 'ClientToken' => [ - 'title' => '', - 'description' => 'The idempotency token provided during the task creation request.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****12e8864746a0a398****', - 'backendName' => 'clientToken', - ], - 'TriggerSource' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'Console', - 'backendName' => 'triggerSource', - ], - 'Code' => [ - 'title' => '', - 'description' => 'The error code for a failed task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'InvalidParameter.ResourceNotFound', - 'backendName' => 'code', - ], - 'JobId' => [ - 'title' => '', - 'description' => 'The ID of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - 'backendName' => 'jobId', + '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' => '', - 'visibility' => 'Public', + 'description' => 'Packaging configuration.', 'type' => 'object', 'properties' => [ - 'Segment' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'segment', - '$ref' => '#/components/schemas/MediaConvertSegment', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'OutputFile' => [ - 'title' => '', - 'description' => 'The output file.'."\n", - 'visibility' => 'Public', - 'backendName' => 'outputFile', - '$ref' => '#/components/schemas/MediaObject', - ], - 'Priority' => [ - 'title' => '', - 'description' => 'The priority. Valid values: 1 to 10. A larger value indicates a higher priority. Default value: 6.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '10', - 'minimum' => '1', - 'example' => '6', - 'backendName' => 'priority', - ], - 'OverrideParams' => [ - 'description' => 'A JSON string containing parameters to overwrite the corresponding settings of the template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'overrideParams', - ], - 'Features' => [ - 'description' => 'The feature parameters.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'features', - ], - 'TemplateId' => [ - 'title' => '', - 'description' => 'The ID of the transcoding template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****', - 'backendName' => 'templateId', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the output.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'output-video', - 'backendName' => 'name', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Success', - 'backendName' => 'status', - ], - 'TaskId' => [ - 'title' => '', - 'description' => 'The task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '******4215e042b3966ca5441e******', - 'backendName' => 'taskId', - ], - 'Message' => [ - 'title' => '', - 'description' => 'The reason for a task failure.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The resource operated InputFile is bad'."\n", - 'backendName' => 'message', - ], - 'FinishTime' => [ - 'description' => 'The time the output task finished, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z)'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-07T13:01:07Z', - 'backendName' => 'finishTime', - ], - 'CreateTime' => [ - 'description' => 'The time the output task was created, in UTC format (*yyyy-MM-dd*T*HH:mm:ss*Z)'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-07T06:06:58Z', - 'backendName' => 'createTime', - ], - 'Code' => [ - 'title' => '', - 'description' => 'The error code for a failed task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'InvalidParameter.ResourceContentBad'."\n", - 'backendName' => 'code', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the output.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '720P-mp4', - 'backendName' => 'name', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'OutputFile' => [ 'description' => 'Details about the generated output file.'."\n", - 'visibility' => 'Public', '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OSS', - 'backendName' => 'type', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4'."\n", - 'backendName' => 'media', - ], - 'Url' => [ - 'description' => 'If Type is set to Media, this field provides the actual storage URL of the media asset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - 'backendName' => 'url', - ], + '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' => ''], ], - 'backendName' => 'outputFile', - ], - 'OutFileMeta' => [ - 'description' => 'The metadata of the audio and video streams.'."\n", - 'visibility' => 'Public', - 'backendName' => 'outFileMeta', - '$ref' => '#/components/schemas/MediaConvertOutputDetailFileMeta', + 'title' => '', + 'example' => '', ], + 'OutFileMeta' => ['description' => 'The metadata of the audio and video streams.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputDetailFileMeta', 'title' => '', 'example' => ''], ], - 'backendName' => 'result', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'VideoStreamInfoList' => [ + 'FileBasicInfo' => [ 'title' => '', - 'description' => 'The video stream information.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'The video stream metadata.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'Rotate' => [ - 'title' => '', - 'description' => 'The rotation angle applied to the video. Valid values: 0, 90, 180, and 270. Default value: 0.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'rotate', - ], - 'Codec_tag' => [ - 'title' => '', - 'description' => 'The tag of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0x001b', - 'backendName' => 'codec_tag', - ], - 'Sar' => [ - 'title' => '', - 'description' => 'The sample aspect ratio.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '478:477', - 'backendName' => 'sar', - ], - 'Start_time' => [ - 'title' => '', - 'description' => 'The start time of the stream.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1.473556', - 'backendName' => 'start_time', - ], - 'Fps' => [ - 'title' => '', - 'description' => 'The frame rate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '25.0', - 'backendName' => 'fps', - ], - 'Index' => [ - 'title' => '', - 'description' => 'The index of this stream within the file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'index', - ], - 'Duration' => [ - 'title' => '', - 'description' => 'The duration of the stream. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '403.039989', - 'backendName' => 'duration', - ], - 'Lang' => [ - 'title' => '', - 'description' => 'The language code for the stream.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn', - 'backendName' => 'lang', - ], - 'Codec_long_name' => [ - 'title' => '', - 'description' => 'The full name of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - 'backendName' => 'codec_long_name', - ], - 'PixFmt' => [ - 'title' => '', - 'description' => 'The pixel format.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'yuv420p', - 'backendName' => 'pixFmt', - ], - 'Bit_rate' => [ - 'title' => '', - 'description' => 'The bitrate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '888.563', - 'backendName' => 'bit_rate', - ], - 'Profile' => [ - 'title' => '', - 'description' => 'The codec profile.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'High', - 'backendName' => 'profile', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - 'backendName' => 'has_b_frames', - ], - 'Codec_time_base' => [ - 'description' => 'The time base used by the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1/50', - 'backendName' => 'codec_time_base', - ], - 'Dar' => [ - 'title' => '', - 'description' => 'The display aspect ratio.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '16:9', - 'backendName' => 'dar', - ], - 'Avg_fps' => [ - 'title' => '', - 'description' => 'The average frame rate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '25.0', - 'backendName' => 'avg_fps', - ], - 'Codec_tag_string' => [ - 'title' => '', - 'description' => 'The tag of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[27][0][0][0]', - 'backendName' => 'codec_tag_string', - ], - 'Codec_name' => [ - 'title' => '', - 'description' => 'The short name of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'h264', - 'backendName' => 'codec_name', - ], - 'Height' => [ - 'title' => '', - 'description' => 'The height of the video stream, in pixels.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '478', - 'backendName' => 'height', - ], - 'Level' => [ - 'title' => '', - 'description' => 'The codec level.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '31', - 'backendName' => 'level', - ], - 'Time_base' => [ - 'title' => '', - 'description' => 'The time base of the stream\'s presentation timestamps.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1/90000', - 'backendName' => 'time_base', - ], - 'Width' => [ - 'title' => '', - 'description' => 'The width of the video stream, in pixels.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '848', - 'backendName' => 'width', - ], - 'NumFrames' => [ - 'title' => '', - 'description' => 'The total number of frames.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10040', - 'backendName' => 'numFrames', - ], - ], - 'extendType' => 'true', + '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'], ], - 'backendName' => 'videoStreamInfoList', - 'itemName' => 'VideoStreamInfoList', + 'example' => '', ], 'AudioStreamInfoList' => [ 'title' => '', 'description' => 'The audio stream information.'."\n", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The audio stream metadata.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'CodecTag' => [ - 'title' => '', - 'description' => 'The tag of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0x000f', - 'backendName' => 'codecTag', - ], - 'CodecTimeBase' => [ - 'title' => '', - 'description' => 'The time base used by the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1/44100', - 'backendName' => 'codecTimeBase', - ], - 'ChannelLayout' => [ - 'title' => '', - 'description' => 'The layout of the audio channels.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'stereo', - 'backendName' => 'channelLayout', - ], - 'StartTime' => [ - 'title' => '', - 'description' => 'The start time of the stream. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1.473556', - 'backendName' => 'startTime', - ], - 'Index' => [ - 'title' => '', - 'description' => 'The index of this stream within the file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'index', - ], - 'Duration' => [ - 'title' => '', - 'description' => 'The duration of the stream. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '403.039989', - 'backendName' => 'duration', - ], - 'Lang' => [ - 'title' => '', - 'description' => 'The language code for the stream.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn', - 'backendName' => 'lang', - ], - 'SampleFmt' => [ - 'title' => '', - 'description' => 'The audio sample format.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'fltp', - 'backendName' => 'sampleFmt', - ], - 'CodecName' => [ - 'title' => '', - 'description' => 'The short name of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'aac', - 'backendName' => 'codecName', - ], - 'Bitrate' => [ - 'title' => '', - 'description' => 'The bitrate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.f', - 'backendName' => 'bitrate', - ], - 'Channels' => [ - 'title' => '', - 'description' => 'The number of audio channels.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - 'backendName' => 'channels', - ], - 'Timebase' => [ - 'title' => '', - 'description' => 'The time base of the stream\'s presentation timestamps.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1/90000', - 'backendName' => 'timebase', - ], - 'CodecTagString' => [ - 'title' => '', - 'description' => 'The tag of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[15][0][0][0]', - 'backendName' => 'codecTagString', - ], - 'SampleRate' => [ - 'title' => '', - 'description' => 'The sample rate. Unit: Hz.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '44100', - 'backendName' => 'sampleRate', - ], - 'CodecLongName' => [ - 'title' => '', - 'description' => 'The full name of the codec.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'AAC (Advanced Audio Coding)', - 'backendName' => 'codecLongName', - ], + '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'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'audioStreamInfoList', - 'itemName' => 'AudioStreamInfoList', + 'example' => '', ], - 'FileBasicInfo' => [ + 'VideoStreamInfoList' => [ 'title' => '', - 'description' => 'The basic information of the media file.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'FileUrl' => [ - 'title' => '', - 'description' => 'The URL of the file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', - 'backendName' => 'fileUrl', - ], - 'FileStatus' => [ - 'title' => '', - 'description' => 'The status of the file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normal', - 'backendName' => 'fileStatus', - ], - 'MediaId' => [ - 'title' => '', - 'description' => 'The ID of the media asset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '9066406c306771f0bfa35107e0c90102', - 'backendName' => 'mediaId', - ], - 'FileType' => [ - 'title' => '', - 'description' => 'Indicates if this is the source or a transcoded output. Valid values: source_file and transcode_file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'source_file', - 'backendName' => 'fileType', - ], - 'FileName' => [ - 'title' => '', - 'description' => 'The name of the file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'file.m3u8', - 'backendName' => 'fileName', - ], - 'Region' => [ - 'title' => '', - 'description' => 'The storage region of the file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-shanghai', - 'backendName' => 'region', - ], - 'FormatName' => [ - 'title' => '', - 'description' => 'The container format name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hls,applehttp', - 'backendName' => 'formatName', - ], - 'Duration' => [ - 'title' => '', - 'description' => 'The total duration of the media file. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '403.039999', - 'backendName' => 'duration', - ], - 'Height' => [ - 'title' => '', - 'description' => 'The height of the video, in pixels.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '478', - 'backendName' => 'height', - ], - 'Bitrate' => [ - 'title' => '', - 'description' => 'The video bitrate.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '888.563', - 'backendName' => 'bitrate', - ], - 'Width' => [ - 'title' => '', - 'description' => 'The width of the video, in pixels.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '848', - 'backendName' => 'width', - ], - 'FileSize' => [ - 'title' => '', - 'description' => 'The file size. Unit: bytes.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '31737', - 'backendName' => 'fileSize', + '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' => '', ], - 'backendName' => 'fileBasicInfo', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'MediaConvertOutputGroup' => [ 'description' => 'The output group configuration.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GroupConfig' => [ - 'title' => '', - 'description' => 'The output group configuration.'."\n", - 'visibility' => 'Public', - 'backendName' => 'groupConfig', - '$ref' => '#/components/schemas/MediaConvertOutputGroupConfig', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The configuration for a single output stream.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutputGroupOutput', - ], - 'backendName' => 'outputs', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the output group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hls-group', - 'backendName' => 'name', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'OutputFileBase' => [ - 'description' => 'The directory where all files for this output group are stored.'."\n", - 'visibility' => 'Public', - 'backendName' => 'outputFileBase', - '$ref' => '#/components/schemas/MediaObject', - ], - 'ManifestName' => [ - 'title' => '', - 'description' => 'The filename for the manifest. This parameter is only applicable when Type is set to Hls or Dash.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'manifest', - 'backendName' => 'manifestName', - ], - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Hls', - 'backendName' => 'type', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Success', - 'backendName' => 'status', - ], - 'TaskId' => [ - 'title' => '', - 'description' => 'The ID of the output group task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '******22dad741d086a50325f9******', - 'backendName' => 'taskId', - ], - 'Message' => [ - 'title' => '', - 'description' => 'The reason for a task failure.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'The resource operated "InputFile" is bad', - 'backendName' => 'message', - ], - 'FinishTime' => [ - 'description' => 'The end time of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-21T01:48:41Z'."\n", - 'backendName' => 'finishTime', - ], - 'CreateTime' => [ - 'description' => 'The time the task was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-03-21T01:48:41Z', - 'backendName' => 'createTime', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The output details.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MediaConvertOutputDetail', - ], - 'backendName' => 'outputs', - ], - 'Code' => [ - 'title' => '', - 'description' => 'The error code for the failed output group task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'InvalidParameter.ResourceContentBad', - 'backendName' => 'code', - ], - 'Name' => [ + 'items' => ['description' => 'The output details.'."\n", '$ref' => '#/components/schemas/MediaConvertOutputDetail', 'title' => '', 'example' => ''], 'title' => '', - 'description' => 'The name of the output group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'hls-group', - 'backendName' => 'name', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Priority' => [ - 'description' => 'The processing priority for this output. Valid values: 1 to 10. A higher value indicates higher priority. Default value: 6.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - 'backendName' => 'priority', - ], - 'OverrideParams' => [ - 'description' => 'A JSON string containing parameters to override the settings from the associated transcoding template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'overrideParams', - ], - 'Features' => [ - 'description' => 'The feature parameters.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'features', - ], - 'OutputFileName' => [ - 'description' => 'The filename for this output. This path is relative to OutputFileBase defined in MediaConvertOutputGroupConfig. The final output path is {OutputFileBase}/{OutputFileName}.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '720p.mp4', - 'backendName' => 'outputFileName', - ], - 'TemplateId' => [ - 'description' => 'The ID of the transcoding template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****'."\n", - 'backendName' => 'templateId', - ], - 'Name' => [ - 'description' => 'A name to label this output. This is for identification purposes only and does not affect the filename.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'group-output', - 'backendName' => 'name', - ], + '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' => '', + 'title' => '视频转码切片配置', 'description' => 'Segment configuration during transcoding.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ForceSegTime' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1,2', - 'backendName' => 'forceSegTime', - ], - 'Duration' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'duration', - ], - ], + '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' => '', + 'title' => '转码配置', 'description' => 'Transcoding configuration.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'IsCheckAudioBitrate' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'isCheckAudioBitrate', - ], - 'AdjDarMethod' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rescale', - 'backendName' => 'adjDarMethod', - ], - 'IsCheckAudioBitrateFail' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'isCheckAudioBitrateFail', - ], - 'IsCheckVideoBitrateFail' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'isCheckVideoBitrateFail', - ], - 'IsCheckReso' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'isCheckReso', - ], - 'IsCheckVideoBitrate' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'isCheckVideoBitrate', - ], - 'TransMode' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'onepass', - 'backendName' => 'transMode', - ], - 'IsCheckResoFail' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'isCheckResoFail', - ], - ], + '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' => '', + 'title' => '转码视频流配置', 'description' => 'The configuration of a transcoded output.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Bufsize' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - 'backendName' => 'bufsize', - ], - 'Qscale' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - 'backendName' => 'qscale', - ], - 'ScanMode' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'auto', - 'backendName' => 'scanMode', - ], + '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' => '', + '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" @@ -6122,274 +3242,219 @@ .'* 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", - 'visibility' => 'Public', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', - 'backendName' => 'longShortMode', - ], - 'Fps' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '25', - 'backendName' => 'fps', - ], - 'Gop' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '10s', - 'backendName' => 'gop', - ], - 'Remove' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'remove', - ], - 'Bitrate' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000', - 'backendName' => 'bitrate', - ], - 'Profile' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'high', - 'backendName' => 'profile', - ], - 'Crop' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1920:800:0:140', - 'backendName' => 'crop', - ], - 'Codec' => [ - 'title' => '', - 'description' => 'The video codec.'."\n" - ."\n" - .'* Valid values: H.264, H.265, AV1, GIF, and WEBP.'."\n" - .'* Default value: H.264.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'H.264', - 'backendName' => 'codec', - ], - 'Maxrate' => [ - 'title' => '', - 'description' => 'The maximum bitrate of the output.'."\n" - ."\n" - .'* Unit: Kbps.'."\n" - .'* Valid values: \\[10,50000].'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - 'backendName' => 'maxrate', - ], - 'Pad' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1920:1080:0:140', - 'backendName' => 'pad', - ], - 'MaxFps' => [ - 'title' => '', - 'description' => 'The maximum frame rate.'."\n", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '25', - 'backendName' => 'maxFps', - ], - 'Crf' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '23', - 'backendName' => 'crf', - ], - 'Height' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1080', - 'backendName' => 'height', - ], - 'Width' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1920', - 'backendName' => 'width', ], - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'LoudnessRangeTarget' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'backendName' => 'loudnessRangeTarget', - ], - 'TruePeak' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - 'backendName' => 'truePeak', - ], - 'IntegratedLoudnessTarget' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-6', - 'backendName' => 'integratedLoudnessTarget', - ], - 'Level' => [ - 'title' => '', - '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", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-20', - 'backendName' => 'level', - ], + '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' => '', + 'title' => '音量调整方式。'."\n" + .'● auto：自动调整。'."\n" + .'● dynamic：动态调整。'."\n" + .'● linear：线性调整。'."\n" + .'● 默认值：dynamic。', 'description' => 'The volume adjustment method. Valid values:'."\n" ."\n" .'* auto'."\n" @@ -6403,206 +3468,200 @@ .'*'."\n" .'*'."\n" .'*'."\n", - 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'adaptive' => 'adaptive', - 'auto' => 'auto', - 'linear' => 'linear', - 'dynamic' => 'dynamic', - ], + 'enumValueTitles' => ['adaptive' => 'adaptive', 'auto' => 'auto', 'linear' => 'linear', 'dynamic' => 'dynamic'], 'example' => 'linear', - 'backendName' => 'method', ], ], + 'title' => '', + 'example' => '', ], 'MediaObject' => [ 'title' => '', 'description' => 'The media file.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ + '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' => '', - '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OSS', - 'backendName' => 'type', + 'example' => '', ], - 'Media' => [ + 'TemplateConfig' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://bucket.loction.aliyuncs.com/path/to/video.mp4', - 'backendName' => 'media', + 'example' => '', ], - 'Url' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'url', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-04-02T00:58:19Z', - 'backendName' => 'gmtCreateUTC', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], + '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", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The ad break.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'TimeSignalSettings' => [ - 'description' => 'The TimeSignal configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}', - 'backendName' => 'timeSignalConfig', - ], - 'OffsetMillis' => [ - 'description' => 'The offset.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - 'backendName' => 'offsetMillis', - ], - 'ChannelName' => [ - 'description' => 'The name of the channel.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyChannel', - 'backendName' => 'channelName', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], - 'SpliceInsertSettings' => [ - 'description' => 'The SpliceInsert configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}', - 'backendName' => 'spliceInsertConfig', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyAdSource', - 'backendName' => 'sourceName', - ], - 'ProgramName' => [ - 'description' => 'The name of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'program_name', - 'backendName' => 'programName', - ], - 'MessageType' => [ - 'description' => 'MessageType'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPLICE_INSERT', - 'backendName' => 'messageTypeString', - ], + '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' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'adBreakDTOs', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vodSource', - 'backendName' => 'sourceTypeString', - ], - 'Transition' => [ - 'description' => 'The program transition method.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', - 'backendName' => 'transition', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-04-02T00:58:19Z'."\n", - 'backendName' => 'gmtModifiedUTC', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'sourceName', - ], - 'ClipRange' => [ - 'description' => 'The information about the clip.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}'."\n", - 'backendName' => 'clipRange', - ], - 'Arn' => [ - 'description' => 'The ARN of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::program/myChannel/MyProgram', - 'backendName' => 'arn', - ], - 'ProgramName' => [ - 'description' => 'The name of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'program1', - 'backendName' => 'programName', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'EntryType' => [ @@ -6612,463 +3671,263 @@ ."\n" .'* FillerSlate'."\n" .'* program'."\n", - 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'FillerSlate' => 'FillerSlate', - 'program' => 'program', - ], + 'enumValueTitles' => ['FillerSlate' => 'FillerSlate', 'program' => 'program'], 'example' => 'program', - 'backendName' => 'entryType', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', + 'title' => '', ], + 'SourceLocationName' => ['description' => 'The name of the source location.'."\n", 'type' => 'string', 'example' => 'MySourceLocation', 'title' => ''], 'AdBreaks' => [ 'description' => 'The information about ad breaks.'."\n", - 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'OffsetMillis' => [ - 'description' => 'The time offset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100000', - 'backendName' => 'offsetMillis', - ], - 'TimeSignalSettings' => [ - 'description' => 'The TimeSignal configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}', - 'backendName' => 'timeSignalSettings', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], - 'SpliceInsertSettings' => [ - 'description' => 'The SpliceInsert configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", - 'backendName' => 'spliceInsertSettings', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'sourceName', - ], - 'MessageType' => [ - 'description' => 'MessageType'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPLICE_INSERT', - 'backendName' => 'messageType', - ], + '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' => ''], ], - 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'adBreaks', - ], - 'SourceType' => [ - 'description' => 'The source type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vodSource', - 'backendName' => 'sourceType', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySource', - 'backendName' => 'sourceName', - ], - 'ApproximateDurationSeconds' => [ - 'description' => 'The scheduled playback duration.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000', - 'backendName' => 'approximateDurationSeconds', - ], - 'ApproximateStartTime' => [ - 'description' => 'The scheduled start time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1989128002313', - 'backendName' => 'approximateStartTimeUTC', - ], - 'ProgramName' => [ - 'description' => 'The name of the program.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'program1', - 'backendName' => 'programName', + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-11-07T10:12:01Z', - 'backendName' => 'gmtCreateUTC', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], - 'State' => [ - 'description' => 'The status of the source. 0: normal. 1: deleted.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'state', - ], - 'SourceType' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vodSource', - 'backendName' => 'sourceTypeString', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-11-07T10:12:01Z', - 'backendName' => 'gmtModifiedUTC', - ], - 'SourceName' => [ - 'description' => 'The name of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MyVodSource', - 'backendName' => 'sourceName', - ], - 'HttpPackageConfigurations' => [ - 'description' => 'The source configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[{'."\n" - .' "sourceGroupName": "mySourceGroup-1",'."\n" - .' "relativePath": "group1/hls.m3u8",'."\n" - .' "packageType": "hls"'."\n" - .'}]', - 'backendName' => 'httpPackageConfigurations', - ], - 'Arn' => [ - 'description' => 'The ARN of the source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/mySource', - 'backendName' => 'arn', - ], + '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", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-09-12T07:15:52Z', - 'backendName' => 'gmtCreateUTC', - ], - 'SourceLocationName' => [ - 'description' => 'The name of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MySourceLocation', - 'backendName' => 'sourceLocationName', - ], - 'State' => [ - 'description' => 'The status of the source location. 0: normal. 1: deleted.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'state', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-10-22T10:49:14Z', - 'backendName' => 'gmtModifiedUTC', - ], - 'SegmentDeliveryConfigurations' => [ - 'description' => 'The segment delivery server configurations.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://segmentdelivery.com', - 'backendName' => 'segmentDeliveryUrl', - ], - 'BaseUrl' => [ - 'description' => 'The base URL of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http://xxxx.com', - 'backendName' => 'baseUrl', - ], - 'Arn' => [ - 'description' => 'The ARN of the source location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::sourcelocation/MySourceLocation', - 'backendName' => 'arn', - ], + '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", - 'visibility' => 'Public', '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", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'translatedText', + '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'], + ], ], - 'TargetLanguage' => [ - 'title' => '', - 'description' => '* The target language of the translation.'."\n" - .'* This field is only used in translation-related scenarios.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'zh', - 'backendName' => 'targetLanguage', + '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' => [ - 'CreateUploadMedia' => [ - 'summary' => 'Obtains the upload URL and credential of a media asset and creates information about the media asset.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ActiveAiRtcLicense' => [ + 'summary' => 'Activates a specified license using the batch ID, authorization code, and device SN.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'LicenseItemId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID. Default value: app-1000000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-1000000', - ], + 'schema' => ['description' => 'The batch ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '17712***', 'title' => ''], ], [ - 'name' => 'EntityId', + 'name' => 'AuthCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The entity ID. You can call the CreateEntity operation to create an entity and specify a dynamic metadata structure.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9e177cac2fb44f8b8c67b199fcc7bffd', - ], + 'schema' => ['description' => 'The authorization code.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'iU1IeJech7***', 'title' => ''], ], [ - 'name' => 'FileInfo', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file information, which is in the JSON format and contains the following fields:'."\n" - ."\n" - .'* Type: required. The file type. Valid values: video, image, audio, text, and other.'."\n" - .'* Name: required. The file name without the extension.'."\n" - .'* Size: optional. The file size.'."\n" - .'* Ext: required. The file name extension.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"Type\\":\\"video\\",\\"Name\\":\\"test.mp4\\",\\"Size\\":108078336,\\"Ext\\":\\"mp4\\"}', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'device-***', 'title' => ''], ], - [ - 'name' => 'UserData', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The user data. The value must be a JSON string. You can configure settings such as message callbacks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + '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' => '', ], ], - [ - 'name' => 'UploadTargetConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The destination storage address.'."\n" - ."\n" - .'Set StorageType to oss.'."\n" - ."\n" - .'Set StorageLocation to an address in ApsaraVideo VOD. You cannot set this field to an OSS URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"StorageType\\":\\"oss\\",\\"StorageLocation\\":\\"outin-***.oss-cn-shanghai.aliyuncs.com\\"}', - ], + ], + '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' => [ [ - 'name' => 'MediaMetaData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata of the media asset, which is a JSON string that contains the following fields:'."\n" - ."\n" - .'Title: required.'."\n" - ."\n" - .'* The value can be up to 128 characters in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n" - ."\n" - .'Description: optional.'."\n" - ."\n" - .'* The value can be up to 1,024 characters in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n" - ."\n" - .'CateId: optional.'."\n" - ."\n" - .'Tags: optional.'."\n" - ."\n" - .'BusinessType: required. Valid values:'."\n" - ."\n" - .'* opening or ending if Type is set to video'."\n" - .'* default or cover if Type is set to image'."\n" - .'* subtitles or font if Type is set to text'."\n" - .'* watermark if Type is set to material'."\n" - .'* general CoverURL: optional.'."\n" - ."\n" - .'DynamicMetaData: The value is a string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"Title\\": \\"UploadTest\\", \\"Description\\": \\"UploadImageTest\\", \\"Tags\\": \\"tag1,tag2\\",\\"BusinessType\\":\\"cover\\"}', - ], - ], - [ - 'name' => 'PostProcessConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The postprocessing configurations. You can specify this parameter if Type is set to video or audio.'."\n" - ."\n" - .'Set ProcessType to Workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"ProcessType\\":\\"Workflow\\",\\"ProcessID\\":\\"74ba870f1a4873a3ba238e0bf6fa9***\\"}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'MediaURL' => [ - 'description' => 'The URL of the media asset.'."\n" - ."\n" - .'> If a domain name for Alibaba Cloud CDN (CDN) is specified, a CDN URL is returned. Otherwise, an OSS URL is returned. If the HTTP status code 403 is returned when you access the URL from your browser, the URL authentication feature of ApsaraVideo VOD is enabled. To resolve this issue, disable URL authentication or generate an authentication signature.'."\n", - 'type' => 'string', - 'example' => 'https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4', - ], - 'FileURL' => [ - 'description' => 'The OSS URL of the file. The URL does not contain the information used for authentication.'."\n", - 'type' => 'string', - 'example' => 'http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'eyJFbmRwb2ludCI6Imh0dHBzOi8vb3NzLWNuLXNoYW5naGFpLmFsaXl1bmNzLmNvbSIsIkJ1Y2tldCI6InN6aGQtdmlkZW8iLCJGaWxlTmFtZSI6InZvZC0yOTYzMWEvc3YvNTBmYTJlODQtMTgxMjdhZGRiMTcvNTBmYTJlODQtMTgxMjdhZGRiM***', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'eyJBY2Nlc3NLZXlJZCI6IkxUQUk0Rm53bTk1dHdxQjMxR3IzSE5hRCIsIkFjY2Vzc0tleVNlY3JldCI6Ik9lWllKR0dTMTlkNkZaM1E3UVpJQmdmSVdnM3BPaiIsIkV4cGlyYXRpb24iOiI***', - ], - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:ActiveAiRtcLicense', + '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"}]', - 'title' => 'CreateUploadMedia', - 'description' => '* You can call this operation to obtain the upload URLs and credentials of audio and video files. You can also call this operation to obtain the upload URLs and credentials of images and auxiliary media assets.'."\n" - .'* Obtaining an upload URL and credential is essential for Intelligent Media Services (IMS) and is required in each upload operation.'."\n" - .'* If the video upload credential expires, you can call the RefreshUploadMedia operation to obtain a new upload credential. The default validity period of a video upload credential is 3,000 seconds.'."\n" - .'* After you upload a media asset, you can configure a callback to receive upload event notifications or call the GetMediaInfo operation to determine whether the media asset is uploaded based on the returned status.'."\n" - .'* The MediaId parameter returned by this operation can be used for media asset lifecycle management or media processing.'."\n" - .'* You can call this operation to upload media assets only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media asset to your own OSS bucket, you can upload the file to your OSS bucket by using [OSS SDK](~~32006~~), and then call the [RegisterMediaInfo](~~441152~~) operation to register the file in the OSS bucket with the media asset library.'."\n" - .'* This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.', + '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', ], - 'CreateUploadStream' => [ - 'summary' => 'Obtains the upload URL and credential of a media stream.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddAdInsertion' => [ + 'summary' => 'Adds an ad insertion configuration.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7078,209 +3937,156 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ - 'name' => 'MediaId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'Definition', - 'in' => 'query', - 'schema' => [ - 'description' => 'The quality of the media stream. Valid values:'."\n" - ."\n" - .'* FD: low definition.'."\n" - .'* LD: standard definition.'."\n" - .'* SD: high definition.'."\n" - .'* HD: ultra-high definition.'."\n" - .'* OD: original quality.'."\n" - .'* 2K: 2K resolution.'."\n" - .'* 4K: 4K resolution.'."\n" - .'* SQ: standard sound quality.'."\n" - .'* HQ: high sound quality.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HD', - ], + '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' => 'FileExtension', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file name extension of the media stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MP4', - ], + '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' => 'HDRType', - 'in' => 'query', + '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' => 'The high dynamic range (HDR) format of the transcoded stream. Valid values:'."\n" - ."\n" - .'* HDR'."\n" - .'* HDR10'."\n" - .'* HLG'."\n" - .'* DolbyVision'."\n" - .'* HDRVivid'."\n" - .'* SDR+'."\n" + 'description' => 'Specifies whether to enable ad marker passthrough. Default value: OFF.'."\n" ."\n" - .'> '."\n" + .'Valid values:'."\n" ."\n" - .'* The value is not case-sensitive,'."\n" + .'- OFF: Disable.'."\n" ."\n" - .'* You can leave this parameter empty for non-HDR streams.'."\n", + .'- ON: Enable.', + 'enumValueTitles' => ['OFF' => '', 'ON' => ''], 'type' => 'string', 'required' => false, - 'example' => 'HDR10', + 'title' => '', + 'example' => 'ON', ], ], [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MessageCallback":{"CallbackURL":"http://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}', - ], + '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' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****c469e944b5a856828dc2****', - ], - 'FileURL' => [ - 'description' => 'The Object Storage Service (OSS) URL of the file. The URL does not contain the information used for authentication.'."\n", - 'type' => 'string', - 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'eyJFbmRwb2ludCI6Imh0dHBzOi8vb3NzLWNuLXNoYW5naGFpLmFsaXl1bmNzLmNvbSIsIkJ1Y2tldCI6InN6aGQtdmlkZW8iLCJGaWxlTmFtZSI6InZvZC0yOTYzMWEvc3YvNTBmYTJlODQtMTgxMjdhZGRiMTcvNTBmYTJlODQtMTgxMjdhZGRiM***', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'eyJBY2Nlc3NLZXlJZCI6IkxUQUk0Rm53bTk1dHdxQjMxR3IzSE5hRCIsIkFjY2Vzc0tleVNlY3JldCI6Ik9lWllKR0dTMTlkNkZaM1E3UVpJQmdmSVdnM3BPaiIsIkV4cGlyYXRpb24iOiI***', + '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' => '', ], ], ], - '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' => '* You can call this operation to upload only a local media stream. After the media stream is uploaded, it is associated with the specified media asset ID.'."\n" - .'* You can call this operation to 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" - .'* This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.', - ], - 'RefreshUploadMedia' => [ - 'summary' => 'Obtain a new upload credential for a media asset after its upload credential expires.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAdInsertion'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'MediaId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '411bed50018971edb60b0764a0ec6***', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => 'c2e77390f75271ec802f0674a2ce6***', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'eyJFbmRwb2ludCI6Imh0dHBzOi8vb3NzLWNuLXNoYW5naGFpLmFsaXl1bmNzLmNvbSIsIkJ1Y2tldCI6InN6aGQtdmlkZW8iLCJGaWxlTmFtZSI6InZvZC0yOTYzMWEvc3YvNTBmYTJlODQtMTgxMjdhZGRiMTcvNTBmYTJlODQtMTgxMjdhZGRiM***', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'eyJBY2Nlc3NLZXlJZCI6IkxUQUk0Rm53bTk1dHdxQjMxR3IzSE5hRCIsIkFjY2Vzc0tleVNlY3JldCI6Ik9lWllKR0dTMTlkNkZaM1E3UVpJQmdmSVdnM3BPaiIsIkV4cGlyYXRpb24iOiI***', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:AddAdInsertion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"c2e77390f75271ec802f0674a2ce6***\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', - 'title' => 'RefreshUploadMedia', - 'description' => 'You can also call this operation to overwrite media files. After you obtain the upload URL of a media file, you can upload the media file again without changing the audio or video ID.'."\n", + 'translator' => 'manual', ], - 'RegisterMediaStream' => [ - 'summary' => 'Registers a media stream.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddCategory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7292,667 +4098,778 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], + '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'MediaId', + 'name' => 'CateName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5e778ec0027b71ed80a8909598506***', - ], + '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' => 'UserData', + 'name' => 'ParentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MessageCallback":{"CallbackURL":"http://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}', - ], + 'schema' => ['description' => 'The ID of the parent category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'StreamTags', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '5e778ec0027b71ed80a8909598506302', + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"5e778ec0027b71ed80a8909598506302\\"\\n}","type":"json"}]', - 'title' => 'RegisterMediaStream', - 'description' => 'You can call this operation to register a media stream file in an Object Storage Service (OSS) bucket with Intelligent Media Services (IMS) and associate the media stream with the specified media asset ID.'."\n", - ], - 'GetUrlUploadInfos' => [ - 'summary' => 'Queries the information about URL-based upload jobs.', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobIds', + 'name' => 'ProjectId', '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" - .'* 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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'df2ac80b481346daa1db6a7c40edc7f8', - ], + 'schema' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '*****b2101cb318c*****'], ], [ - 'name' => 'UploadURLs', + 'name' => 'MaterialMaps', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://media.w3.org/2010/05/sintel/trailer.mp4', - ], + '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' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'NonExists' => [ - 'description' => 'The job IDs or upload URLs that do not exist.'."\n", + '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' => [ - '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.'."\n", - 'type' => 'string', - 'example' => '[\'e3e71ae8e4a46e4893d8cadce50c3bd0\']', + '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' => '', ], - 'URLUploadInfoList' => [ - 'description' => 'The details about URL-based upload jobs.'."\n", + 'LiveMaterials' => [ + 'description' => 'The materials associated with the live stream.', '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.'."\n", '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.'."\n", - 'type' => 'string', - 'example' => '2021-11-07T10:03:37Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the upload job failed.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the upload job failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2021-11-26 21:47:37', - ], - 'JobId' => [ - 'description' => 'The ID of the upload job.'."\n", - 'type' => 'string', - 'example' => '3829500c0fef429fa4ec1680b122d***', - ], - 'UserData' => [ - 'description' => 'The user data. The value is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}', - ], - 'UploadURL' => [ - 'description' => 'The upload URL of the source file.'."\n" - ."\n" - .'> A maximum of 100 URLs can be returned.'."\n", - 'type' => 'string', - 'example' => 'http://****.mp4', - ], - 'MediaId' => [ - 'description' => 'The ID of the uploaded media file.'."\n", - 'type' => 'string', - 'example' => '5014ca70f08171ecbf940764a0fd6***', - ], - 'FileSize' => [ - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '64610', - ], + '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' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'GetUrlUploadInfos', - 'description' => 'You can call this operation to 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.'."\n", + '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', ], - 'UploadMediaByURL' => [ - 'summary' => 'Uploads an audio or video file based on the URL of the source file. You can upload multiple media files at a time.', - 'methods' => [ - 'get', - 'post', + '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' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'UploadURLs', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the source file.'."\n" - ."\n" - .'* The URL must contain a file name extension, such as mp4 in `https://****.mp4`.'."\n" - ."\n" - .' * If the URL does not contain a file name extension, you can specify one by setting `FileExtension` in `UploadMetadata`.'."\n" - .' * If the URL contains a file name extension and `FileExtension` is also specified, the value of `FileExtension` prevails.'."\n" - ."\n" - .'* URL encoding is required. Separate multiple URLs with commas (,). You can specify a maximum of 20 URLs.'."\n" - ."\n" - .'* Special characters may cause upload failures. Therefore, you must encode URLs before you separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://diffurl.mp4', - ], + 'schema' => ['description' => 'Flow instance ID', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'InputProtocol', 'in' => 'query', 'schema' => [ - 'description' => 'The application ID.'."\n", + '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' => false, - 'example' => 'app-1000000', + 'required' => true, + 'example' => 'RTMP-PUSH', + 'title' => '', ], ], [ - 'name' => 'UserData', + 'name' => 'InputName', 'in' => 'query', - 'schema' => [ - 'description' => 'The user data. The value must be a JSON string. You can configure settings such as message callbacks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}', - ], + 'schema' => ['description' => 'Input name', 'type' => 'string', 'required' => true, 'example' => 'AliTestInput', 'title' => ''], ], [ - 'name' => 'UploadTargetConfig', + 'name' => 'MaxBitrate', 'in' => 'query', - 'schema' => [ - 'description' => 'The destination storage address.'."\n" - ."\n" - .'Set StorageType to oss.'."\n" - ."\n" - .'Set StorageLocation to an address in ApsaraVideo VOD. You cannot set this field to an OSS URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"StorageType":"oss","StorageLocation":"outin-***.oss-cn-shanghai.aliyuncs.com"}', - ], + 'schema' => ['description' => 'Maximum bitrate in bits per second (bps)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000000', 'title' => ''], ], [ - 'name' => 'MediaMetaData', + 'name' => 'Cidrs', 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata of the media file that you want to upload. The value must be a JSON string.'."\n" - ."\n" - .'* This parameter takes effect only if its value matches a URL that is specified in UploadURLs.'."\n" - .'* You must convert the JSON-formatted data, such as \\[UploadMetadata, UploadMetadata,…], into a JSON string.'."\n" - .'* For more information, see the "UploadMetadata" section of this topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]', - ], + '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' => 'PostProcessConfig', + 'name' => 'InputFromUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The postprocessing configurations. You can specify this parameter if Type is set to video or audio.'."\n" - ."\n" - .'Set ProcessType to Workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"ProcessType": "Workflow","ProcessID":"b72a06c6beeb4dcdb898feef067b1***"}', - ], + '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' => 'EntityId', + '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' => 'The entity ID. You can call the CreateEntity operation to create an entity and specify a dynamic metadata structure.'."\n", + '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' => 'd67281da3c8743b8823ad12976187***', + 'example' => '32', + 'title' => '', ], ], + [ + 'name' => 'WithInternalVip', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Response body', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****83B7-7F87-4792-BFE9-63CD2137****', - ], - 'UploadJobs' => [ - 'description' => 'The information about upload jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the upload job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the upload job.'."\n", - 'type' => 'string', - 'example' => '20ce1e05dba64576b96e9683879f0***', - ], - 'SourceURL' => [ - 'description' => 'The URL of the source file that is uploaded in the upload job.'."\n", - 'type' => 'string', - 'example' => 'http://example****.mp4'."\n", - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => 'f476988629f54a7b8a4ba90d1a6c7***', - ], - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"UploadJobs\\": [\\n {\\n \\"JobId\\": \\"20ce1e05dba64576b96e9683879f0***\\",\\n \\"SourceURL\\": \\"http://example****.mp4\\\\n\\",\\n \\"MediaId\\": \\"f476988629f54a7b8a4ba90d1a6c7***\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'UploadMediaByURL', - 'description' => '* If a callback is configured, you will receive an UploadByURLComplete event notification after the file is uploaded. You can query the upload status by calling the GetURLUploadInfos operation.'."\n" - .'* After a request is submitted, the upload job is queued as an asynchronous job in the cloud. You can query the status of the upload job based on information such as the URL and media asset ID that are returned in the event notification.'."\n" - .'* You can call this operation to upload media files that are not stored on a local server or device and must be uploaded by using URLs that are accessible over the Internet.'."\n" - .'* You can call this operation to upload media files only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media file to an OSS bucket, pull the file to a local directory, use [OSS SDK](~~32006~~) to upload the file to an OSS bucket, and then call the [RegisterMediaInfo](~~441152~~) operation to register the file in the OSS bucket with the media asset library.'."\n" - .'* This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.'."\n" - .'* You can call this operation to upload only audio and video files.', - 'requestParamsDescription' => '## UploadMetadata'."\n" + '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" - .'|Field|Type|Required|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|SourceURL|String|Yes|The URL of the source file that you want to upload.|'."\n" - .'|Title|String|Yes|The title of the media asset. The value can be up to 128 bytes in length. The value must be encoded in UTF-8.|'."\n" - .'|FileSize|String|No|The file size.|'."\n" - .'|Description|String|No|The description of the media asset. The value can be up to 1024 bytes in length. The value must be encoded in UTF-8.|'."\n" - .'|CoverURL|String|No|The URL of the custom video thumbnail.|'."\n" - .'|CateId|String|No|The category ID.|'."\n" - .'|Tags|String|No|The tags that you want to add to the media asset. Each tag can be up to 32 bytes in length. You can set a maximum of 16 tags. Separate multiple tags with commas (,). The value is encoded in UTF-8.|'."\n" - .'|WorkflowId|String|No|The workflow ID.|'."\n" - .'|FileExtension|String|No|The file name extension.|'."\n" - .'|DynamicMetaData|String|No|The dynamic metadata. Example: "{"Uploader": "xxx"}".|'."\n" - .'|EntityId|String|No|The entity ID.|'."\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" - .'**Note*** The values of fields, such as Title, Description, and Tags, in UploadMetadata cannot contain emojis.'."\n" + .'### Input type descriptions'."\n" ."\n" - .'* If a callback is configured, you can receive an UploadByURLComplete event notification when the media file is uploaded. You can also receive the FileUploadComplete and StreamTranscodeComplete event notifications.'."\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" - .'* If you upload multiple media files at a time, an event notification is sent for each media file when the media file is uploaded.', - ], - 'UploadStreamByURL' => [ - 'summary' => 'Uploads a media stream file based on the URL of the source file.', - 'methods' => [ - 'post', - 'get', + .'- 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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'StreamURL', + '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 URL of the transcoded stream file.'."\n" + 'description' => 'The output type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- RTMP-PUSH'."\n" ."\n" - .'If the URL of the transcoded stream requires authentication, you must specify the authentication parameters in the stream URL and make sure that the URL can be accessed over the Internet.'."\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' => false, - 'example' => 'https://example.com/sample-stream.mp4', + 'required' => true, + 'example' => 'RTMP-PULL', + 'title' => '', ], ], [ - 'name' => 'MediaId', + 'name' => 'OutputToUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '411bed50018971edb60b0764a0ec6***', - ], + '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' => 'Definition', + 'name' => 'OutputName', 'in' => 'query', - 'schema' => [ - 'description' => 'The quality of the media stream. Valid values:'."\n" - ."\n" - .'* FD: low definition.'."\n" - .'* LD: standard definition.'."\n" - .'* SD: high definition.'."\n" - .'* HD: ultra-high definition.'."\n" - .'* OD: original quality.'."\n" - .'* 2K: 2K resolution.'."\n" - .'* 4K: 4K resolution.'."\n" - .'* SQ: standard sound quality.'."\n" - .'* HQ: high sound quality.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HD', - ], + 'schema' => ['description' => 'The output name.', 'type' => 'string', 'required' => true, 'example' => 'AliTestOutput', 'title' => ''], ], [ - 'name' => 'FileExtension', + 'name' => 'Cidrs', 'in' => 'query', - 'schema' => [ - 'description' => 'The file name extension of the media stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mp4', - ], + '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' => 'HDRType', + 'name' => 'PlayerLimit', 'in' => 'query', - 'schema' => [ - 'description' => 'The high dynamic range (HDR) format of the transcoded stream. Valid values:'."\n" - ."\n" - .'* HDR'."\n" - .'* HDR10'."\n" - .'* HLG'."\n" - .'* DolbyVision'."\n" - .'* HDRVivid'."\n" - .'* SDR+'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The value is not case-sensitive,'."\n" - ."\n" - .'* You can leave this parameter empty for non-HDR streams.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HDR10', - ], + 'schema' => ['description' => 'The maximum number of viewers.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'PairInputName', 'in' => 'query', - 'schema' => [ - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MessageCallback":{"CallbackURL":"http://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}', - ], + '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' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******89-C21D-4B78-AE24-3788B8******', - ], - 'JobId' => [ - 'description' => 'The ID of the upload job.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '411bed50018971edb60b0764a0ec6***', - ], - 'FileURL' => [ - 'description' => 'The OSS URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', - ], - 'SourceURL' => [ - 'description' => 'The URL of the source file that is uploaded in the upload job.'."\n", - 'type' => 'string', - 'example' => 'https://example.com/sample-stream.mp4', + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******89-C21D-4B78-AE24-3788B8******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"MediaId\\": \\"411bed50018971edb60b0764a0ec6***\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4\\",\\n \\"SourceURL\\": \\"https://example.com/sample-stream.mp4\\"\\n}","type":"json"}]', - 'title' => 'UploadStreamByURL', - 'description' => '* You can call this operation to pull a media stream file based on a URL and upload the file. After the media stream file is uploaded, the media stream is associated with the specified media asset ID.'."\n" - .'* You can call this operation to upload media stream files only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media stream file to an OSS bucket, pull the file to a local directory, use [OSS SDK](~~32006~~) to upload the file to an OSS bucket, and then call the [RegisterMediaStream](~~440765~~) operation to associate the media stream with the specified media asset ID.'."\n" - .'* This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.', - ], - 'CloseStreamToSearchLib' => [ - 'summary' => 'Stops the tagging and analysis process for a live stream media asset.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Stream_xxx', - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name-1', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '53afdf003a2171ed9c6a16b5feac6402'], ], [ - 'name' => 'MediaId', + 'name' => 'MediaMarks', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The return code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****c469e944b5a856828dc2****'."\n", - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\\\n\\"\\n}","type":"json"}]', - 'title' => 'CloseStreamToSearchLib', - ], - 'GetStreamTagList' => [ - 'summary' => 'Retrieves tags of a live stream media asset.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -7964,190 +4881,301 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Stream_xxx', - ], + 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name-1', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******b48fb04483915d4f2cd8******', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'MsgBody', 'in' => 'query', + 'schema' => ['description' => 'The message body.', 'type' => 'string', 'required' => false, 'example' => '{"startTime":1657684600793,"endTime":1657684600793,"userData":"{}"}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-04-23T02:26:00Z', + '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' => [ [ - 'name' => 'EndTime', + '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 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.'."\n", + '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, - 'example' => '2017-12-22T08:00:00Z', ], ], [ - 'name' => 'PageNo', + '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 page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'PreviewMedia', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the template preview video.', 'type' => 'string', 'example' => '****01bf24bf41c78b2754cb3187****', 'title' => '', 'required' => false], ], [ - 'name' => 'SortBy', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The sorting order for the results. Valid values:'."\n" + '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" - .'* StartTime:Desc (default): Sort by creation time in descending order.'."\n" - .'* StartTime:Asc: Sort by creation time in ascending order.'."\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, - 'example' => 'StartTime:Asc', ], ], [ - 'name' => 'NextToken', + 'name' => 'Source', 'in' => 'query', 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", + '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, - 'example' => '****73f33c91-d59383e8280b****', ], ], + [ + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The return code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'NextToken' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '****73f33c91-d59383e8280b****', - ], - 'Total' => [ - 'description' => 'The total number of entries that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '163', - ], - 'StreamTagList' => [ - 'description' => 'The tag information.'."\n", - '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.'."\n", - 'type' => 'string', - 'example' => '2025-04-26T16:00:00Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2025-02-25T02:24:00Z', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '{"result":"xxx"}', - ], + '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' => '', ], - 'description' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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', - ], - 'CreateStreamToSearchLib' => [ - 'summary' => 'Registers a live stream as a media asset.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTemplate'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -8159,203 +5187,180 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Stream_xxx', - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'YikeUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name-1', - ], + 'schema' => ['description' => 'The user ID of the sub-account.', 'type' => 'string', 'required' => true, 'example' => 'id', 'title' => ''], ], [ - 'name' => 'Input', + 'name' => 'Credit', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the live stream to be ingested and analyzed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp://xxx', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: succeeded.'."\n" - .'* false: failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => '', ], ], ], - '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', - ], - 'AddStreamTagToSearchLib' => [ - 'summary' => 'Adds tags for a specific live stream media asset.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => 'AddYikeUserCredit', + 'summary' => 'Adds credits to a user account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Stream_xxx', - ], + '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' => 'Namespace', + 'name' => 'IndexType', 'in' => 'query', 'schema' => [ - 'description' => 'The namespace.'."\n", + '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' => false, - 'example' => 'name-1', + 'required' => true, + 'title' => '', + 'example' => 'mm', ], ], [ - 'name' => 'MediaId', + 'name' => 'IndexStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", + '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' => '******b48fb04483915d4f2cd8******', + 'example' => 'Active', + 'title' => '', ], ], [ - 'name' => 'MsgBody', + 'name' => 'IndexConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The message body.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"startTime":1657684600793,"endTime":1657684600793,"userData":"{}"}', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - '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" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The return code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'AddStreamTagToSearchLib', - ], - 'CreateSearchLib' => [ - 'summary' => 'Creates a search library to store media assets.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AlterSearchIndex'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -8364,200 +5369,182 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The name of the search library. The name can contain letters and digits and must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test1'], ], [ 'name' => 'SearchLibConfig', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库配置', - 'type' => 'string', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'SearchLibName' => [ - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], + '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', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\"\\n}","type":"json"}]', - 'title' => 'CreateSearchLib', - ], - 'QuerySearchLib' => [ - 'summary' => 'Queries the information about a search library.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AlterSearchLib', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'Assets', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '搜索库', - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1', + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The results of asset ingestion.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'SearchLibName' => [ - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'Status' => [ - 'description' => 'The status of the search library.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* normal'."\n" - .'* deleting'."\n" - .'* deleteFail', - 'type' => 'string', - 'enumValueTitles' => [ - 'normal' => 'normal', - 'deleting' => 'deleting', - 'deleteFail' => 'deleteFail', - ], - 'example' => 'normal', - ], - 'IndexInfo' => [ + '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' => [ - 'IndexType' => [ - 'type' => 'string', - ], - 'IndexStatus' => [ - 'type' => 'string', - ], - 'IndexReadiness' => [ - 'type' => 'string', - ], + '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' => '', ], - ], - 'SearchLibConfig' => [ - 'title' => '搜索库配置', - 'type' => 'string', + 'example' => '', ], ], + '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' => 'QuerySearchLib', - ], - 'ListSearchLib' => [ - 'summary' => 'Queries the information about search libraries.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -8566,230 +5553,447 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '237778', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'MediaIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'A comma-separated list of media asset IDs to query.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'AdditionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'SearchLibInfoList' => [ - 'description' => 'Information about search libraries.'."\n", + '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' => [ - 'description' => 'Information about search libraries.'."\n", 'type' => 'object', 'properties' => [ - 'SearchLibName' => [ - 'description' => 'The search library.'."\n", - 'type' => 'string', - 'example' => 'faceSearchLib', - ], - 'Status' => [ - 'description' => 'The status of the search library.'."\n" - ."\n" - .'* normal'."\n" - .'* deleting'."\n" - .'* deleteFail'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'normal' => 'normal', - 'deleting' => 'deleting', - 'deleteFail' => 'deleteFail', + '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' => 'normal', + 'example' => '', ], - 'IndexInfo' => [ - 'description' => '', + 'FileInfoList' => [ + 'title' => '', + 'description' => 'A list of basic file information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'IndexType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'face', + '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' => '', ], - 'IndexStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Active', + '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' => '', ], - 'IndexReadiness' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Normal', + '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' => '', ], - 'SearchLibConfig' => [ - 'title' => '搜索库配置', - 'type' => 'string', + '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' => '', ], - 'Total' => [ - 'description' => 'The total number of entries returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', + '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' => [ - 'returnType' => 'synchronous', + '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'], ], - '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' => 'ListSearchLib', - ], - 'AlterSearchLib' => [ - 'summary' => 'Modifies a search library.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetMediaInfos'], + ], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], - ], - [ - 'name' => 'SearchLibConfig', + 'name' => 'JobIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}', - ], + 'schema' => ['description' => 'A list of job IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'cec2c13da767c090,ca3d3c9737f04586', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'SearchLibName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test1', + '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', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\"\\n}","type":"json"}]', - 'title' => 'AlterSearchLib', - ], - 'DropSearchLib' => [ - 'summary' => 'Deletes a search library and all media assets in the library.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Batch retrieve AI application jobs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -8797,648 +6001,684 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], + ], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'MediaIds', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The media asset IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + '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' => '', ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', + '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' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'DropSearchLib', - ], - 'CreateSearchIndex' => [ - 'summary' => 'Creates a search index in a search library. Each search library can contain multiple indexes.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [], + 'title' => 'Batch Retrieve Media Asset Details ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The ID of the media fingerprint analysis job that you want to cancel.', 'type' => 'string', 'required' => true, 'example' => '2288c6ca184c0e47098a5b665e2a12****', 'title' => ''], ], - [ - 'name' => 'IndexType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '索引类别', - '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" - .'* 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.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'mm' => 'mm', - 'face' => 'face', - 'aiLabel' => 'aiLabel', + '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' => 'mm', + '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' => [ [ - 'name' => 'IndexStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Active' => 'Active', - 'Deactive' => 'Deactive', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CancelDNAJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'Active', ], ], + ], + 'translator' => 'manual', + ], + 'CancelFavoritePublicMedia' => [ + 'summary' => 'Removes all specified media assets from favorites based on the input mediaId list.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IndexConfig', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaIds', 'in' => 'query', - 'schema' => [ - 'title' => '索引配置', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + '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' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', + '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' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'CreateSearchIndex', - 'description' => 'The large visual model feature is still in the public preview phase. You can use this feature for free for 1,000 hours of videos.'."\n", - ], - 'AlterSearchIndex' => [ - 'summary' => 'Modifies search index information including index status and configurations.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelFavoritePublicMedia'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - '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" - .'* To query information about an existing search library, call the [QuerySearchLib](~~2584455~~) API operation.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The ID of the intelligent production job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ - 'name' => 'IndexType', + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => 'Idempotency parameter', 'type' => 'string', 'required' => false, 'example' => '****12e8864746a0a398****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '索引类别', - 'description' => 'The category of the index. Valid values:'."\n" - ."\n" - .'* mm: large visual model.'."\n" - .'* face: face recognition.'."\n" - .'* aiLabel: smart tagging.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'mm' => 'mm', - 'face' => 'face', - 'aiLabel' => 'aiLabel', + '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' => 'mm', + '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' => [ [ - 'name' => 'IndexStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the index. Valid values:'."\n" - ."\n" - .'* active (default): the index is enabled.'."\n" - .'* Deactive: the index is not enabled.'."\n" - ."\n" - .'> You must specify either IndexStatus or IndexConfig.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Active' => 'Active', - 'Deactive' => 'Deactive', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:CancelIProductionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'Active', ], ], + ], + 'translator' => 'manual', + ], + 'ClearAIAgentVoiceprint' => [ + 'summary' => 'Clears the voiceprint associated with a voiceprint ID.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'IndexConfig', + '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' => [ - 'title' => '索引配置', - 'description' => 'The configurations of the index.'."\n" - ."\n" - .'> You must specify either IndexStatus or IndexConfig.'."\n", + 'description' => 'The registration mode. The default is `Explicit`.', + 'enumValueTitles' => ['Explicit' => 'Explicit registration mode', 'Implicit' => 'Implicit registration mode'], 'type' => 'string', 'required' => false, - 'example' => '{}', + 'example' => 'Explicit', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], + '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', - ], - 'QuerySearchIndex' => [ - 'summary' => 'Queries the details of a search index.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => 'ClearAIAgentVoiceprint', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], + ], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - '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" - .'* To query information about an existing search library, call the [QuerySearchLib](~~2584455~~) API operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - ], - [ - 'name' => 'IndexType', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'title' => '索引类别', - 'description' => 'The category of the index. Valid values:'."\n" - ."\n" - .'* mm: large visual model.'."\n" - .'* face: face recognition.'."\n" - .'* aiLabel: smart tagging.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'mm' => 'mm', - ], - 'example' => 'mm', - ], + 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => false, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'SearchLibName' => [ - 'title' => '搜索库', - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'IndexType' => [ - 'title' => '索引类别', - 'description' => 'The category of the index. Valid values:'."\n" - ."\n" - .'* mm: large visual model.'."\n" - .'* face: face recognition.'."\n" - .'* aiLabel: smart tagging.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'mm' => 'mm', - 'face' => 'face', - 'aiLabel' => 'aiLabel', - ], - 'example' => 'mm', - ], - 'IndexStatus' => [ - 'description' => 'The state of the index. Valid values:'."\n" - ."\n" - .'* active: the index is enabled.'."\n" - .'* Deactive: the index is not enabled.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Active' => 'Active', - 'Deactive' => 'Deactive', - ], - 'example' => 'Active', - ], - 'MediaTotal' => [ - 'description' => 'The total number of media assets.'."\n", - 'type' => 'string', - 'example' => '12', - ], + '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\\": \\"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', - ], - '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', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], 'parameters' => [ [ 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - '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" - .'* To query information about an existing search library, call the [QuerySearchLib](~~2584455~~) API operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ - 'name' => 'IndexType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '索引类别', - 'description' => 'The category of the index. Valid values:'."\n" - ."\n" - .'* mm: large visual model.'."\n" - .'* face: face recognition.'."\n" - .'* aiLabel: smart tagging.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'mm' => 'mm', - ], - 'example' => 'mm', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + '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}","type":"json"}]', - 'title' => 'DropSearchIndex', - ], - 'QueryMediaIndexJob' => [ - 'summary' => 'Queries the indexing jobs enabled for a media asset.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The name of the search library. Default value: ims-default-search-lib.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - ], - [ - 'name' => 'MediaId', + 'name' => 'AuditContent', 'in' => 'query', - 'schema' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c2e77390f75271ec802f0674a2ce6***', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'IndexJobInfoList' => [ - 'description' => 'The indexing jobs enabled for the media asset.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The indexing job enabled for the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'GmtSubmit' => [ - 'description' => 'The time when the index job was submitted.'."\n", - 'type' => 'string', - 'example' => '2023-11-21 11:33:50', - ], - 'GmtFinish' => [ - 'description' => 'The end time of the indexing job.'."\n", - 'type' => 'string', - 'example' => '2023-11-21 11:33:51', - ], - 'IndexType' => [ - 'description' => 'The index type. Valid values:'."\n" - ."\n" - .'* mm: large visual model.'."\n" - .'* face: face recognition.'."\n" - .'* aiLabel: smart tagging.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'mm' => 'mm', - 'face' => 'face', - 'aiLabel' => 'aiLabel', - ], - 'example' => 'mm', - ], - 'Status' => [ - 'description' => 'The job status. Valid values:'."\n" - ."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Running' => 'Running', - 'Success' => 'Success', - 'Fail' => 'Fail', - ], - 'example' => 'Success', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', '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' => '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'], ], - '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', - ], - 'SearchIndexJobRerun' => [ - 'summary' => 'Re-analyzes the search index jobs of media assets. You can re-run the search index jobs of up to 20 media assets in each request.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudit'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -9446,3906 +6686,2557 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236859', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'AvatarName', 'in' => 'query', - 'schema' => [ - 'title' => '搜索库', - 'description' => 'The search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-1', - ], + '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' => 'MediaIds', + 'name' => 'AvatarDescription', 'in' => 'query', - 'schema' => [ - 'title' => '索引类别', - 'description' => 'The ID of the media asset. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', - ], + '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' => 'Task', + 'name' => 'AvatarType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the job. Separate multiple types with commas (,).'."\n" - ."\n" - .'* aiLabel: smart tagging.'."\n" - .'* face: face recognition.'."\n" - .'* mm: large visual model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AiLabel,Face,Mm', - ], + 'schema' => ['description' => 'The type of the digital human.', 'type' => 'string', 'required' => false, 'example' => '2DAvatar', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Thumbnail', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + '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 response data.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'MediaIdsNoExist' => [ - 'description' => 'The media asset IDs that do not exist.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '1c6ce34007d571ed94667630a6bc****', - ], - ], + 'JobId' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'example' => '****d718e2ff4f018ccf419a7b71****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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' => 'SearchIndexJobRerun', - ], - 'InsertMediaToSearchLib' => [ - 'summary' => 'Adds a media asset in a search library. Before you call this operation, you must create a search library.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAvatarTrainingJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the search library. Default value: ims-default-search-lib.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ - 'name' => 'MediaId', + 'name' => 'ChannelTier', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '411bed50018971edb60b0764a0ec6***', - ], + 'schema' => ['description' => 'The tier of the channel. Valid values: basic and standard.', 'type' => 'string', 'required' => true, 'example' => 'basic', 'title' => ''], ], [ - 'name' => 'MediaType', + 'name' => 'PlaybackMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the media asset. Valid values:'."\n" - ."\n" - .'* video (default)'."\n" - .'* image'."\n" - .'* audio'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'image' => 'image', - 'video' => 'video', - 'audio' => 'audio', - ], - 'example' => 'video', - ], + 'schema' => ['description' => 'The playback mode. Valid values: loop and linear.', 'type' => 'string', 'required' => true, 'example' => 'loop', 'title' => ''], ], [ - 'name' => 'Input', + 'name' => 'AccessPolicy', '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'http://example-test-****.mp4', - ], + 'schema' => ['description' => 'Specifies whether to enable access control.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'MsgBody', + 'name' => 'AccessToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The message body.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The token for accessing the channel.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''], ], [ - 'name' => 'ImagesInput', + 'name' => 'FillerSourceLocationName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The source location of the filler slate.', 'type' => 'string', 'required' => false, 'example' => 'MySourceLocation', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'FillerSourceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], + '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', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'InsertMediaToSearchLib', - ], - 'UpdateMediaToSearchLib' => [ - 'summary' => 'Updates the media asset information in a search library.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the search library. Default value: ims-default-search-lib.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'test-template', 'title' => ''], ], [ - 'name' => 'MediaId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****019b82e24b37a1c2958dec38****', - ], + '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' => 'MsgBody', + 'name' => 'Subtype', 'in' => 'query', - 'schema' => [ - 'description' => 'The message body.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{}', - ], + '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' => 'Namespace', + 'name' => 'TemplateConfig', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '******b48fb04483915d4f2cd8******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'UpdateMediaToSearchLib', - ], - 'DeleteMediaFromSearchLib' => [ - 'summary' => 'Deletes a specific media asset from a search library.', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomTemplate'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreateCustomTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', + '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' => 'SearchLibName', + 'name' => 'VoiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the search library. Default value: ims-default-search-lib.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + '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' => 'MediaId', + 'name' => 'VoiceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'MsgBody', + '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 message body.'."\n", + 'description' => 'The gender. Valid values:'."\n" + ."\n" + .'- female'."\n" + ."\n" + .'- male', 'type' => 'string', - 'required' => false, - 'example' => '{}', + 'required' => true, + 'enum' => ['female', 'male'], + 'example' => 'female', + 'title' => '', ], ], [ - 'name' => 'Namespace', + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '******b48fb04483915d4f2cd8******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', + '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 \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', - 'title' => 'DeleteMediaFromSearchLib', - ], - 'SearchMedia' => [ - 'summary' => 'Queries information about media assets based on the request parameters.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '140243', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Match', + '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 filter conditions. For more information about the parameter syntax'."\n" - .', see [Media asset search protocols](~~2584256~~).', - 'type' => 'string', - 'required' => false, + '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' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段和排序顺序。多个使用英文逗号（,）分隔', - 'description' => 'The sort field and order. Separate multiple parameters with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'utcCreate:Desc, utcModified:Desc', + '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' => [ [ - 'name' => 'PageNo', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'title' => '当前页码。默认值为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The title of the online editing project.', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '每页返回的数据条数。默认值为10，最大值为50', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The description of the online editing project.', 'type' => 'string', 'example' => 'Description', 'title' => '', 'required' => false], ], [ - 'name' => 'EntityId', + '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' => [ - 'title' => '实体Id', - 'description' => 'The ID of the entity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2d3bf1e35a1e42b5ab338d701efa7603', - ], + 'schema' => ['description' => 'The thumbnail URL of the online editing project.', 'type' => 'string', 'example' => 'https://example.com/example.png', 'title' => '', 'required' => false], ], [ - 'name' => 'ScrollToken', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination identifier. The value can be up to 32 characters in length. The first time you call this operation for each new search, you do not need to specify this parameter. The value of this parameter is returned each time data records that meet the specified filter condition are found. The value is used to record the current position of queried data. Record the returned parameter value and set this parameter according to the following requirements during the next search: If you need to traverse all data that meets the filter criteria, you must set the ScrollToken parameter. If the value of the PageNo parameter exceeds 200, we recommend that you set this parameter to optimize search performance. You can only page backward. You can page a maximum of 1,000 entries in an operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'F8C4F642184DBDA5D93907A70AAE****', - ], + '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' => 'SearchLibName', + '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 search library.'."\n", + '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' => 'test-1', + 'example' => 'Timeline', ], ], [ - 'name' => 'CustomFilters', + 'name' => 'MaterialMaps', 'in' => 'query', - 'schema' => [ - 'title' => '自定义过滤', - 'type' => 'string', - 'example' => '{}', - ], + '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' => 'Schema of Response', - 'description' => 'The response schema.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6F61C357-ACC0-57FB-876E-D58795335E59', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaInfoList' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that meet the requirements.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the media assets.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '3b187b3620c8490886cfc2a9578c3ce6', - ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'The basic information about the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '132bd600fc3c71ec99476732a78f6402', - ], - 'InputURL' => [ - 'title' => '待注册的媒资在相应系统中的地址', - 'description' => 'The address of the media asset that is waiting to be registered.'."\n", - 'type' => 'string', - 'example' => 'oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf84981650248140427', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'opening', - ], - 'Source' => [ - 'title' => '来源', - 'description' => 'The source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => 'The title of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => 'The description of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Category' => [ - 'title' => '分类', - 'description' => 'The category of the media asset.'."\n", - 'type' => 'string', - 'example' => 'image', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => 'The tags of the media asset.'."\n", - 'type' => 'string', - 'example' => 'tags,tags2'."\n", - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => 'The thumbnail URL of the media asset.'."\n", - 'type' => 'string', - 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f27b63_large_cover_url.jpg', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'userData', - ], - 'Snapshots' => [ - 'title' => '截图', - 'description' => 'The snapshots of the media asset.'."\n", - 'type' => 'string', - 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]', - ], - 'Status' => [ - 'title' => '资源状态', - 'description' => 'The state of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TranscodeStatus' => [ - 'title' => '转码状态', - 'description' => 'The transcoding status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-01T19:48Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => 'The time when the media asset was modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-01T19:48Z'."\n", - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => 'The time when the media asset was deleted.'."\n", - 'type' => 'string', - 'example' => '2020-12-01T19:48Z'."\n", - ], - 'SpriteImages' => [ - 'title' => '雪碧图', - 'description' => 'The image sprite of the media asset'."\n", - '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 ID of the category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '44', - ], - 'Biz' => [ - 'description' => 'The business to which the media asset belongs.'."\n", - 'type' => 'string', - 'example' => 'IMS', - ], - 'UploadSource' => [ - 'description' => 'The upload source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'CateName' => [ - 'description' => 'The name of the category.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ReferenceId' => [ - 'description' => 'The custom ID of the media asset. The ID is a string that contains 6 to 64 characters. Only letters, digits, hyphens (-), and underscores (\\_) are supported. Each custom ID is unique.'."\n", - 'type' => 'string', - 'example' => '123-123', - ], - 'Namespace' => [ - 'type' => 'string', - ], - 'VisionDescription' => [ - 'type' => 'string', - ], - 'StreamStatus' => [ - 'title' => '流状态', - 'type' => 'string', - 'example' => 'Active', - ], - ], - ], - 'FileInfoList' => [ - 'title' => 'FileInfos', - 'description' => 'The information about the files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '文件基础信息，包含时长，大小等', - 'description' => 'The basic information about the file, such as the duration and size.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => '164265080291300080527050.wav', - ], - 'FileStatus' => [ - 'title' => '文件状态', - 'description' => 'The status of the file.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'description' => 'The type of the file.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小（字节）', - 'description' => 'The size of the file in bytes.'."\n", - 'type' => 'string', - 'example' => '324784', - ], - 'FileUrl' => [ - 'title' => '文件oss地址', - 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", - 'type' => 'string', - 'example' => 'https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-18180984899.mp4', - ], - 'Region' => [ - 'title' => '文件存储区域', - 'description' => 'The region in which the file is stored.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'FormatName' => [ - 'title' => '封装格式', - 'description' => 'The encapsulation format of the file.'."\n", - 'type' => 'string', - 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration of the file.'."\n", - 'type' => 'string', - 'example' => '60.00000'."\n", - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate of the file.'."\n", - 'type' => 'string', - 'example' => '1912.13'."\n", - ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width of the file.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height of the file.'."\n", - 'type' => 'string', - 'example' => '480', - ], - 'CreateTime' => [ - 'description' => 'The time when the file was created.'."\n", - 'type' => 'string', - 'example' => '2022-05-30T02:02:17Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the file was last modified.'."\n", - 'type' => 'string', - 'example' => '2021-12-10T12:19Z', - ], - 'ImagesInput' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'AiData' => [ - 'description' => 'The details of the intelligent AI job.'."\n", - 'type' => 'object', - 'properties' => [ - 'AiLabelInfo' => [ - 'description' => 'The tags of the intelligent AI job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag of the intelligent AI job.'."\n", - 'type' => 'object', - 'properties' => [ - 'FaceId' => [ - 'description' => 'The face ID.'."\n", - 'type' => 'string', - 'example' => '5FE19530C7A422197535FE74F5DB2B9F', - ], - 'LabelType' => [ - 'description' => 'The type of the tag.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Source' => [ - 'description' => 'The source.'."\n", - 'type' => 'string', - 'example' => 'vision', - ], - 'Category' => [ - 'description' => 'The category.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'LabelName' => [ - 'description' => 'The name of the entity.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'LabelId' => [ - 'description' => 'The ID of the entity.'."\n", - 'type' => 'string', - 'example' => '10310250338', - ], - 'Occurrences' => [ - 'description' => 'The clips.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The clip.'."\n", - 'type' => 'object', - 'properties' => [ - 'Score' => [ - 'description' => 'The score.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.75287705', - ], - 'Image' => [ - 'description' => 'The optimal face image encoded in Base64.'."\n", - 'type' => 'string', - 'example' => '99C64F6287', - ], - 'TableBatchSeqId' => [ - 'description' => 'The sequence ID of the vector table.'."\n", - 'type' => 'string', - 'example' => '85010D1', - ], - 'clipId' => [ - 'description' => 'The ID of the clip.'."\n", - 'type' => 'string', - 'example' => '5FE19530C7A422197535FE74F5DB2B9F', - ], - 'From' => [ - 'description' => 'The start time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - 'To' => [ - 'description' => 'The end time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.5', - ], - 'FinegrainName' => [ - 'description' => 'The fine-grained name of the entity.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'FinegrainId' => [ - 'description' => 'The fine-grained ID of the entity.'."\n", - 'type' => 'string', - 'example' => '10310250338', - ], - 'Content' => [ - 'description' => 'The text content.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Tracks' => [ - 'description' => 'The track sequence.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The track.'."\n", - 'type' => 'object', - 'properties' => [ - 'Size' => [ - 'description' => 'The size of the bounding box.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '50.2', - ], - 'Position' => [ - 'description' => 'The coordinates of the bounding box.'."\n", - 'type' => 'string', - 'example' => '468.0;67.0;615.0;267.0', - ], - 'Timestamp' => [ - 'description' => 'The timestamp of the track.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'AsrInfo' => [ - 'description' => 'The information about audio files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The audio information.'."\n", - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - 'To' => [ - 'description' => 'The end time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.5', - ], - 'ClipId' => [ - 'description' => 'The ID of the clip.'."\n", - 'type' => 'string', - 'example' => '5FE19530C7A422197535FE74F5DB2B9F', - ], - 'Content' => [ - 'description' => 'The text content.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Timestamp' => [ - 'description' => 'The timestamp of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - ], - ], - ], - 'OcrInfo' => [ - 'description' => 'The subtitles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the subtitle.'."\n", - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - 'To' => [ - 'description' => 'The end time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.5', - ], - 'ClipId' => [ - 'description' => 'The ID of the clip.'."\n", - 'type' => 'string', - 'example' => '5FE19530C7A422197535FE74F5DB2B9F', - ], - 'Content' => [ - 'description' => 'The text content.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Timestamp' => [ - 'description' => 'The timestamp of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - ], - ], - ], - ], - ], - 'AiRoughData' => [ - 'description' => 'The description of the AI job.'."\n", - 'type' => 'object', - 'properties' => [ - 'SaveType' => [ - 'description' => 'The save type.'."\n", - 'type' => 'string', - 'example' => 'TEXT', - ], - 'Status' => [ - 'description' => 'The data status.'."\n", - 'type' => 'string', - 'example' => 'SaveSuccess', - ], - 'AiJobId' => [ - 'description' => 'The ID of the AI job.'."\n", - 'type' => 'string', - 'example' => 'cd35b0b0025f71edbfcb472190a9xxxx', - ], - 'Result' => [ - 'description' => 'The results of the AI job.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx.json', - ], - 'AiCategory' => [ - 'description' => 'TV Series'."\n", - 'type' => 'string', - 'example' => 'TV series'."\n", - ], - ], - ], - 'IndexStatusList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'IndexType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mm', - ], - 'IndexStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - ], - ], - ], - 'CustomFields' => [ - 'title' => '自定义过滤参数', - 'type' => 'string', - 'example' => '{}', - ], - ], + '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' => ''], ], - ], - 'ScrollToken' => [ - 'description' => 'The pagination identifier.'."\n", - 'type' => 'string', - 'example' => 'F8C4F642184DBDA5D93907A70AAE****', - ], - 'Total' => [ - 'description' => 'The total number of media assets that meet the conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '163', + 'title' => '', + 'example' => '', ], ], + '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\\": \\"智能横屏转竖屏\\",\\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\\": \\"子分类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\\": \\"物体\\",\\n \\"Source\\": \\"vision\\",\\n \\"Category\\": \\"交通工具\\",\\n \\"LabelName\\": \\"车\\",\\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\\": \\"车\\",\\n \\"FinegrainId\\": \\"10310250338\\",\\n \\"Content\\": \\"皮皮\\",\\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\\": \\"我是皮皮\\",\\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' => 'SearchMedia', - 'description' => 'If you have questions about how to use the media asset search feature in Intelligent Media Services (IMS), contact technical support in the DingTalk group (ID 30415005038).'."\n", - ], - 'GetVideoList' => [ - 'summary' => 'Queries information about video and audio files.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'CateId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '781111', - ], + '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' => 'Status', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '搜索结果中返回的媒资字段。 默认只返回基本媒资字段，可指定返回更多媒资字段', - '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" - .'* UploadFail: The video failed to be uploaded.'."\n" - .'* UploadSucc: The video is uploaded.'."\n" - .'* Transcoding: The video is being transcoded.'."\n" - .'* TranscodeFail: The video failed to be transcoded.'."\n" - .'* ProduceFail: The video failed to be produced.'."\n" - .'* Normal: The video is normal.'."\n" - .'* Uploading: The video is being uploaded.'."\n" - .'* Preparing: The file is being generated.'."\n" - .'* Blocked: The video is blocked.'."\n" - .'* checking: The video is being reviewed.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PrepareFail' => '', - 'UploadFail' => '', - 'UploadSucc' => '', - 'Transcoding' => '', - 'TranscodeFail' => '', - 'ProduceFail' => '', - 'Normal' => '', - 'Uploading' => '', - 'Preparing' => '', - 'Blocked' => '', - 'Checking' => '', - ], - 'example' => 'Uploading,Normal', - ], + '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' => 'StartTime', + 'name' => 'UsageScenario', 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-01-11T12:00:00Z', - ], + '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' => 'EndTime', + 'name' => 'Hotwords', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '实体Id', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-01-11T12:59:00Z', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段和排序顺序。多个使用英文逗号（,）分隔', - 'description' => 'The sorting method of the results. Valid values:'."\n" - ."\n" - .'* CreationTime:Desc (default): sorts results in reverse chronological order.'."\n" - .'* CreationTime:Asc: sorts results in chronological order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreationTime:Asc', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页码。默认值为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页返回的数据条数。默认值为10，最大值为50', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + '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' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Total' => [ - 'description' => 'The total number of audio and video files that meet the conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '163', - ], - 'MediaList' => [ - 'description' => 'The information about the audio and video files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the audio or video file.'."\n", - 'type' => 'object', - 'properties' => [ - 'StorageLocation' => [ - 'description' => 'The storage address.'."\n", - 'type' => 'string', - 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', - ], - 'Status' => [ - 'description' => 'The status of the video.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PrepareFail: The file is abnormal.'."\n" - .'* UploadFail: The video failed to be uploaded.'."\n" - .'* UploadSucc: The video is uploaded.'."\n" - .'* Transcoding: The video is being transcoded.'."\n" - .'* TranscodeFail: The video failed to be transcoded.'."\n" - .'* ProduceFail: The video failed to be produced.'."\n" - .'* Normal: The video is normal.'."\n" - .'* Uploading: The video is being uploaded.'."\n" - .'* Preparing: The file is being generated.'."\n" - .'* Blocked: The video is blocked.'."\n" - .'* checking: The video is being reviewed.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PrepareFail' => '', - 'UploadFail' => '', - 'UploadSucc' => '', - 'Transcoding' => '', - 'TranscodeFail' => '', - 'ProduceFail' => '', - 'Normal' => '', - 'Uploading' => '', - 'Preparing' => '', - 'Blocked' => '', - 'Checking' => '', - ], - 'example' => 'Normal', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2017-11-14T09:15:50Z', - ], - 'CateId' => [ - 'description' => 'The ID of the category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3679', - ], - 'MediaId' => [ - 'description' => 'The ID of the audio or video file.'."\n", - 'type' => 'string', - 'example' => '1c6ce34007d571ed94667630a6bc****', - ], - 'Tags' => [ - 'description' => 'The tags of the audio or video file.'."\n", - 'type' => 'string', - 'example' => '', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2017-11-14T09:16:50Z', - ], - 'CateName' => [ - 'description' => 'The name of the category.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => 'The description of the audio or video file.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AppId' => [ - 'description' => 'The ID of the application. Default value: app-1000000.'."\n", - 'type' => 'string', - 'example' => 'app-1000000', - ], - 'Size' => [ - 'description' => 'The size of the source file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10897890', - ], - 'CoverUrl' => [ - 'description' => 'The URL of the thumbnail.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', - ], - 'Duration' => [ - 'description' => 'The duration. Unit: seconds.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '135.6', - ], - 'Title' => [ - 'description' => 'The title of the audio or video file.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Snapshots' => [ - 'description' => 'The array of video snapshot URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The URL of the video snapshot.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', - ], - ], - ], - ], - ], + '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\\": \\"******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\\": \\"标签1, 标签2\\",\\n \\"ModificationTime\\": \\"2017-11-14T09:16:50Z\\",\\n \\"CateName\\": \\"分类1\\",\\n \\"Description\\": \\"阿里云VOD视频描述\\",\\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\\": \\"史上最牛音乐播放器\\",\\n \\"Snapshots\\": [\\n \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetVideoList', - 'description' => 'You can call this operation to query 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.'."\n", - ], - 'SearchMediaByFace' => [ - 'summary' => 'Queries the information about media assets that are related to a specific face.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'title' => '当前页码。默认值为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'example' => 'd123', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Capability', 'in' => 'query', 'schema' => [ - 'title' => '每页返回的数据条数。默认值为10，最大值为50', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', + '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' => '10', + 'example' => 'understand', + 'title' => '', ], ], [ - 'name' => 'EntityId', + 'name' => 'Period', 'in' => 'query', 'schema' => [ - 'title' => '实体Id', - 'description' => 'The ID of the entity.'."\n", + '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' => '2d3bf1e35a1e42b5ab338d701efa****', + 'example' => 'month', + 'title' => '', ], ], - [ - 'name' => 'PersonImageUrl', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The URL of the face image.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/input/huangxuan****.jpg', + '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' => [ [ - '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'zxtest-huangxuan-2023-3-7-V1', + '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' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ [ - 'name' => 'MediaType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the media asset. Valid values:'."\n" - ."\n" - .'* image'."\n" - .'* video'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'video', - ], + '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' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'CustomFilters', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义过滤', - 'type' => 'string', - 'example' => '{}', - ], + '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' => 'UtcCreate', + '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', - 'schema' => [ - 'title' => '时间', - 'type' => 'string', - 'example' => '{}', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7CA7D615-CFB1-5437-9A12-2D185C3EE6CB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaInfoList' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that meet the conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the media assets.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '3b187b3620c8490886cfc2a9578c****', + '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' => '', ], - 'Total' => [ - 'description' => 'The total number of data records that meet the specified filter condition.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '163', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', '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' => 'SearchMediaByFace', - 'description' => 'If you have questions about how to use the media asset search feature in Intelligent Media Services (IMS), contact technical support in the DingTalk group (ID 30415005038).'."\n", - ], - 'SearchMediaClipByFace' => [ - 'summary' => 'Queries the information about media asset clips that are related to a specific face based on the response to the SearchMediaByFace operation.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页码。默认值为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页返回的数据条数。默认值为10，最大值为50', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'EntityId', - 'in' => 'query', - 'schema' => [ - 'title' => '实体Id', - 'description' => 'The ID of the entity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2d3bf1e35a1e42b5ab338d701efa****', - ], + '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' => 'FaceSearchToken', + 'name' => 'ClientToken', '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'zxtest-huangxuan-2023-3-7-V1', - ], + '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' => 'MediaId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b187b3620c8490886cfc2a9578c****', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E44FFACD-9E90-555A-A09A-6FD3B7335E39', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaClipList' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media asset clips that meet the requirements.'."\n", - '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].'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.99041677', - ], - 'EntityId' => [ - 'description' => 'The ID of the entity, which is the same as the entity ID returned in tag analysis.'."\n", - 'type' => 'string', - 'example' => '1031025****', - ], - 'LabelName' => [ - 'description' => 'The name of the entity.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'OccurrencesInfos' => [ - 'title' => 'FileInfos', - 'description' => 'The information about clips related to the face.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of the clip. Unit: seconds. The value is of the Float type.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '61.066353', - ], - 'EndTime' => [ - 'description' => 'The end time of the clip. Unit: seconds. The value is of the Float type.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '69.06635', - ], - 'TrackData' => [ - 'description' => 'The information about the face in the clip.'."\n", - '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.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '62.03302', - ], - 'BoxPosition' => [ - 'description' => 'The coordinates of the face.'."\n", - 'type' => 'object', - 'properties' => [ - 'X' => [ - 'description' => 'The x-axis coordinate of the upper-left corner. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '517', - ], - 'Y' => [ - 'description' => 'The y-axis coordinate of the upper-left corner. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '409', - ], - 'W' => [ - 'description' => 'The width of the rectangle frame. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '128', - ], - 'H' => [ - 'description' => 'The height of the rectangle frame. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '168', - ], - ], - ], - ], - 'description' => '', - ], - ], - 'Expression' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - ], - 'Category' => [ - 'description' => 'The type of the character. Valid values: celebrity sensitive politician custom unknown'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'celebrity', - ], - ], - 'description' => '', + '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' => '', ], - 'Total' => [ - 'description' => 'The total number of media asset clips that meet the conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-426614174000', '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\\": \\"张三\\",\\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' => 'SearchMediaClipByFace', - 'description' => 'If you have questions about how to use the media asset search feature in Intelligent Media Services (IMS), contact technical support in the DingTalk group (ID 30415005038).'."\n", - ], - 'SearchMediaByAILabel' => [ - 'summary' => 'Queries media assets based on character names, subtitles, or AI categories.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '195892', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeCode' => '239771', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索库名称', - 'description' => 'The name of the search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-1', - ], + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ - 'name' => 'MediaType', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索结果中返回的媒资字段。 默认只返回基本媒资字段，可指定返回更多媒资字段', - 'description' => 'The type of the media assets. Valid values:'."\n" - ."\n" - .'* image'."\n" - .'* video'."\n" - .'* audio'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'image' => 'image', - 'video' => 'video', - 'audio' => 'audio', - ], - 'example' => 'video', - ], + 'name' => 'ChannelName', + 'in' => 'formData', + 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段和排序顺序。多个使用英文逗号（,）分隔', - 'description' => 'The sorting method of the results. Valid values:'."\n" - ."\n" - .'* CreationTime:Desc (default): sorts results in reverse chronological order.'."\n" - .'* CreationTime:Asc: sorts results in chronological order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreationTime:Desc'."\n", - ], + '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' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页码。默认值为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => ['description' => 'The distribution protocol.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'HLS'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页返回的数据条数。默认值为10，最大值为50', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'ManifestName', + 'in' => 'formData', + 'schema' => ['description' => 'The playlist name. Default value: manifest.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'manifest'], ], [ - 'name' => 'Text', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤条件', - 'description' => 'The content that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The endpoint description.', 'type' => 'string', 'example' => 'This is an origin endpoint.', '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" - .'* Ocr: queries media assets based on subtitles.'."\n" - .'* AiCategory: queries media assets based on AI categories.'."\n" - .'* FullSearch (default): queries all media assets.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PersonName' => 'PersonName', - 'AiCategory' => 'AiCategory', - 'FullSearch' => 'FullSearch', - 'Ocr' => 'Ocr', - ], - 'example' => 'Ocr', - ], + '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' => 'SpecificSearch', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query media asset clips. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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' => 'MediaId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset. This parameter is required if you want to query media asset clips.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****c469e944b5a856828dc2****'."\n", - ], + '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' => 'MatchingMode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'Namespace', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'CustomFilters', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义过滤', - 'type' => 'string', - 'example' => '{}', - ], - ], - [ - 'name' => 'UtcCreate', - 'in' => 'query', - 'schema' => [ - 'title' => '时间', - 'type' => 'string', - 'example' => '{}', - ], + 'name' => 'LivePackagingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'Live stream encapsulation configuration', '$ref' => '#/components/schemas/LivePackagingConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaList' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that contain the specified content.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'AiData' => [ - 'description' => 'The details of the AI job.'."\n", - 'type' => 'object', - 'properties' => [ - 'AiLabelInfo' => [ - 'description' => 'The tags of the AI job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the AI tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'FaceId' => [ - 'description' => 'The ID of the face.'."\n", - 'type' => 'string', - 'example' => '5FE19530C7A422197535FE74F5DB****'."\n", - ], - 'LabelType' => [ - 'description' => 'The type of the tag.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Source' => [ - 'description' => 'The source.'."\n", - 'type' => 'string', - 'example' => 'vision', - ], - 'Category' => [ - 'description' => 'The category.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'LabelName' => [ - 'description' => 'The name of the entity.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'LabelId' => [ - 'description' => 'The ID of the entity.'."\n", - 'type' => 'string', - 'example' => '103102503**', - ], - 'Occurrences' => [ - 'description' => 'The information about the clips.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the clip.'."\n", - 'type' => 'object', - 'properties' => [ - 'Score' => [ - 'description' => 'The score.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.75287705'."\n", - ], - 'Image' => [ - 'description' => 'The image that contains the most face information.'."\n", - 'type' => 'string', - 'example' => 'https://service-****-public.oss-cn-hangzhou.aliyuncs.com/1563457****438522/service-image/f788974f-9595-43b2-a478-7c7a1afb****.jpg', - ], - 'TableBatchSeqId' => [ - 'description' => 'The sequence ID of the vector table.'."\n", - 'type' => 'string', - 'example' => '85010D1**', - ], - 'ClipId' => [ - 'description' => 'The ID of the clip.'."\n", - 'type' => 'string', - 'example' => '158730355E4B82257D8AA1583A58****', - ], - 'From' => [ - 'description' => 'The start time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - 'To' => [ - 'description' => 'The end time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.5', - ], - 'FinegrainName' => [ - 'description' => 'The fine-grained name of the entity.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'FinegrainId' => [ - 'description' => 'The fine-grained ID of the entity.'."\n", - 'type' => 'string', - 'example' => '103102503**', - ], - 'Content' => [ - 'description' => 'The content of the text.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Tracks' => [ - 'description' => 'The tracks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The track.'."\n", - 'type' => 'object', - 'properties' => [ - 'Size' => [ - 'description' => 'The size of the bounding box.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '50', - ], - 'Position' => [ - 'description' => 'The coordinates of the bounding box.'."\n", - 'type' => 'string', - 'example' => '468.0;67.0;615.0;267.0', - ], - 'Timestamp' => [ - 'description' => 'The timestamp of the track.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'AsrInfo' => [ - 'description' => 'The information about audio files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the audio file.'."\n", - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - 'To' => [ - 'description' => 'The end time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.5', - ], - 'ClipId' => [ - 'description' => 'The ID of the clip.'."\n", - 'type' => 'string', - 'example' => '5FE19530C7A422197535FE74F5DB****', - ], - 'Content' => [ - 'description' => 'The content of the audio.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Timestamp' => [ - 'description' => 'The timestamp of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - ], - ], - ], - 'OcrInfo' => [ - 'description' => 'The information about subtitle files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the subtitle file.'."\n", - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - 'To' => [ - 'description' => 'The end time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.5', - ], - 'ClipId' => [ - 'description' => 'The ID of the clip.'."\n", - 'type' => 'string', - 'example' => '5FE19530C7A422197535FE74F5DB****'."\n", - ], - 'Content' => [ - 'description' => 'The content of the text.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Timestamp' => [ - 'description' => 'The timestamp of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.4', - ], - ], - ], - ], - ], - ], - 'StorageLocation' => [ - 'description' => 'The storage address.'."\n", - 'type' => 'string', - 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com'."\n", - ], - 'Status' => [ - 'description' => 'The status of the video.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PrepareFail'."\n" - .'* UploadFail'."\n" - .'* Init'."\n" - .'* UploadSucc'."\n" - .'* Transcoding'."\n" - .'* TranscodeFail'."\n" - .'* Deleted'."\n" - .'* Normal'."\n" - .'* Uploading'."\n" - .'* Preparing'."\n" - .'* Blocked'."\n" - .'* Checking'."\n", - 'type' => 'string', - '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', - ], - 'example' => 'Normal', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2017-11-14T09:15:50Z'."\n", - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2017-11-14T09:15:50Z'."\n", - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '1c6ce34007d571ed94667630a6bc****'."\n", - ], - 'Tags' => [ - 'description' => 'The tags of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => 'The description of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AppId' => [ - 'description' => 'The ID of the application. Default value: app-1000000.'."\n", - 'type' => 'string', - 'example' => 'app-1000000', - ], - 'Size' => [ - 'description' => 'The size of the source file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10897890', - ], - 'CoverUrl' => [ - 'description' => 'The URL of the thumbnail.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', - ], - 'Duration' => [ - 'description' => 'The duration. Unit: seconds.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '12.2', - ], - 'Title' => [ - 'description' => 'The title of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Snapshots' => [ - 'description' => 'The array of video snapshot URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The URL of the video snapshot.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', - ], - ], - ], + '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' => '', ], - 'Total' => [ - 'description' => 'The total number of audio and video files that meet the conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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\\": \\"物体\\",\\n \\"Source\\": \\"vision\\",\\n \\"Category\\": \\"交通工具\\",\\n \\"LabelName\\": \\"车\\",\\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\\": \\"车\\",\\n \\"FinegrainId\\": \\"103102503**\\",\\n \\"Content\\": \\"智能标签测试\\\\n\\",\\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\\": \\"皮皮\\",\\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\\": \\"标签1, 标签2\\\\n\\",\\n \\"Description\\": \\"阿里云VOD视频描述\\\\n\\",\\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\\": \\"史上最牛音乐播放器\\\\n\\",\\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' => 'SearchMediaByAILabel', - 'description' => 'You can call this operation to query media assets or media asset clips based on character names, subtitles, or AI categories.'."\n", - ], - 'SearchMediaByMultimodal' => [ - 'summary' => 'Queries media assets by using the large visual model. You can use natural language for the query.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SearchLibName', - 'in' => 'query', + 'name' => 'RecordFormat', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '搜索库', - 'description' => 'The search library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-1', + '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' => 'MediaType', - 'in' => 'query', + '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 type of the media assets.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* image'."\n" - .'* video (default)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'image' => 'image', - 'video' => 'video', + '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' => 'video', + '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' => [ [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页码。默认值为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + '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' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页返回的数据条数。默认值为10，最大值为50', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'Text', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索内容。', - 'description' => 'The content that you want to query. You can describe the content in natural language.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'CustomFilters', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义过滤', - 'type' => 'string', - 'example' => '{}', - ], + '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' => 'UtcCreate', - 'in' => 'query', - 'schema' => [ - 'title' => '时间', - 'type' => 'string', - 'example' => '{}', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MediaList' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that contain the specified content.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => 'a18936e0e28771edb59ae6f6f47a****', - ], - 'ClipInfo' => [ - 'description' => 'The information about the clip.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2', - ], - 'To' => [ - 'description' => 'The end time of the clip.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '4', - ], - 'Score' => [ - 'description' => 'The score.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.2', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - 'Total' => [ - 'description' => 'The total number of data records that meet the specified filter condition.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": \\"****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' => 'SearchMediaByMultimodal', - 'description' => 'If you have questions about how to use the media asset search feature in Intelligent Media Services (IMS), contact technical support in the DingTalk group (ID 30415005038).'."\n", - ], - 'SearchMediaByHybrid' => [ - 'summary' => 'Performs a hybrid search for media assets. This API combines multiple recall strategies, including tag-based text search and large language model (LLM) search. You can locate media assets using natural language descriptions.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '224461', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SearchLibName', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'title' => '搜索库', - 'description' => 'The name of the search library', + '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' => false, - 'example' => 'test-1', + 'required' => true, + 'enum' => ['normal', 'narrow-band', 'audio-only', 'origin'], + 'title' => '', + 'example' => 'normal', ], ], [ - 'name' => 'MediaType', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '搜索结果中返回的媒资类型。', - 'description' => 'The type of media assets. Valid values:'."\n" - .'- image'."\n" - .'- video', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'image' => 'image', - 'video' => 'video', - ], - 'example' => 'video', - ], + 'schema' => ['description' => 'The name of the template.', 'type' => 'string', 'required' => true, 'maxLength' => 20, 'minLength' => 1, 'example' => 'my template', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'TemplateConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '当前页码。默认值为1', - 'description' => 'The page number. Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', + '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, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '每页返回的数据条数。默认值为10，最大值为50', - 'description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + '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' => '', ], ], - [ - 'name' => 'Text', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索内容。', - 'description' => 'The natural language search query.', - 'type' => 'string', - 'required' => false, - 'example' => 'Two pandas are fighting', - ], + ], + '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' => [ [ - '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", + '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' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name-1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ [ - 'name' => 'CustomFilters', + 'name' => 'FlowName', 'in' => 'query', - 'schema' => [ - 'title' => '自定义过滤', - 'type' => 'string', - 'example' => '{}', - ], + 'schema' => ['description' => 'The flow name.', 'type' => 'string', 'required' => true, 'example' => 'AliTestFlow', 'title' => ''], ], [ - 'name' => 'UtcCreate', + 'name' => 'FlowRegion', 'in' => 'query', - 'schema' => [ - 'title' => '时间', - 'type' => 'string', - 'example' => '{}', - ], + 'schema' => ['description' => 'The region in which the flow resides.', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'a18936e0e28771edb59ae6f6f47a****', - ], - 'ClipInfo' => [ - 'description' => 'The information about the relevant clips.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the clip.'."\n", - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start time of the relevant clip.', - 'type' => 'number', - 'format' => 'double', - 'example' => '2', - ], - 'To' => [ - 'description' => 'The end time of the relevant clip.', - 'type' => 'number', - 'format' => 'double', - 'example' => '4', - ], - 'Score' => [ - 'description' => 'The relevance score of the clip for the query.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.99', - ], - ], - ], - ], - ], + 'Content' => [ + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'FlowId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Total' => [ - 'description' => 'The total number of media assets that match the search criteria.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], + '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', + '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'], ], - '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' => 'SearchMediaByHybrid', - ], - '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', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '6889', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'InputURL', - 'in' => 'query', + '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' => '媒资媒体url', - '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\\*\\*\\*\\*'."\n", - 'type' => 'string', + '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' => 'MediaType', - 'in' => 'query', + 'name' => 'OutputGroups', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset. Valid values:'."\n" - ."\n" - .'* image'."\n" - .'* video'."\n" - .'* audio'."\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. For more information'."\n" - .', see [File formats](https://help.aliyun.com/document_detail/466207.html).', - 'type' => 'string', - 'required' => false, - 'example' => 'video', + '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' => 'BusinessType', - 'in' => 'query', + 'name' => 'AudioSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset. Valid values:'."\n" - ."\n" - .'* subtitles'."\n" - .'* watermark'."\n" - .'* opening'."\n" - .'* ending'."\n" - .'* general'."\n", - 'type' => 'string', + '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' => 'opening', + 'example' => '', ], ], [ - 'name' => 'Title', - 'in' => 'query', + 'name' => 'VideoSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '标题', - '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" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', + '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' => 'defaultTitle', + 'example' => '', ], ], - [ - 'name' => 'Description', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '描述', - 'description' => 'The description of the media asset.'."\n" - ."\n" - .'* The value can be up to 1,024 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'defaultDescription', + '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' => [ [ - 'name' => 'MediaTags', - 'in' => 'query', - 'schema' => [ - 'title' => '标签,如果有多个标签用逗号隔开', - 'description' => 'The tags of the media asset.'."\n" - ."\n" - .'* Up to 16 tags are supported.'."\n" - .'* Separate multiple tags with commas (,).'."\n" - .'* Each tag can be up to 32 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tag1,tag2', + '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' => [ [ - 'name' => 'CoverURL', - 'in' => 'query', - 'schema' => [ - 'title' => '封面图，仅视频媒资有效', - 'description' => 'The thumbnail URL of the media asset.'."\n" - ."\n" - .'* The value can be up to 128 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '用户数据，最大1024字节', - 'description' => 'The user data. You can specify a custom callback URL. For more information ,see [Configure a callback upon editing completion](https://help.aliyun.com/document_detail/451631.html).'."\n" - ."\n" - .'* The value can be up to 1,024 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n" - .'* The value must be in the JSON format.', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'Overwrite', - 'in' => 'query', - 'schema' => [ - 'title' => '是否覆盖已有媒资', - '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.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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' => 'ClientToken', - 'in' => 'query', + 'name' => 'SecurityGroupIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '客户端token', - 'description' => 'The client token that is used to ensure the idempotence of the request. The value must be a UUID that contains 32 characters.'."\n", - 'type' => 'string', + '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' => '****0311a423d11a5f7dee713535****', + 'example' => '["G6G4X5T4SZYPSTT5"]', ], ], [ - 'name' => 'RegisterConfig', - 'in' => 'query', + 'name' => 'InputSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '注册媒资的配置', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "NeedSprite": "false"'."\n" - .'}', + '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' => '', ], ], - [ - 'name' => 'CateId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The category ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3048', + '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' => [ [ - 'name' => 'WorkflowId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******b4fb044839815d4f2cd8******', + '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' => '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123-123', - ], + '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' => 'SmartTagTemplateId', - 'in' => 'query', + 'name' => 'WhitelistRules', + 'in' => 'formData', + 'style' => 'json', '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" - .'* S00000103-000001: the system template that supports NLP for content recognition and all tagging capabilities.'."\n" - .'* S00000103-000002: the system template that supports all tagging capabilities 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. For more information about the billable items, see [Smart tagging](https://help.aliyun.com/zh/ims/media-ai-billing?spm=a2c4g.11186623.0.0.3147392dWwlSjL#p-k38-3rb-dug).', - 'type' => 'string', - 'required' => false, - 'example' => 'S00000101-300080', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******5A-CAAC-4850-A3AF-B74606******', - ], - 'MediaId' => [ - 'title' => 'ICE媒资ID', - 'description' => 'The ID of the media asset in IMS.'."\n", - 'type' => 'string', - 'example' => '******b48fb04483915d4f2cd8******', - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', + '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' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******5A-CAAC-4850-A3AF-B74606******\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******5A-CAAC-4850-A3AF-B74606******\\n ******b48fb04483915d4f2cd8******\\n","errorExample":""}]', - '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 operation at this time, you may fail to obtain the information about the media asset.'."\n", + 'translator' => 'manual', ], - 'GetMediaInfo' => [ - 'summary' => 'Queries information about a media asset based on the ID of the media asset in Intelligent Media Services (IMS) or the input URL of the media asset.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreatePipeline' => [ + 'summary' => 'Creates an ApsaraVideo Media Processing (MPS) queue.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '6890', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'MediaId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset in IMS. If this parameter is left empty, the InputURL parameter must be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'schema' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'required' => true, 'example' => 'test-pipeline', 'title' => ''], ], [ - 'name' => 'InputURL', + 'name' => 'Speed', 'in' => 'query', 'schema' => [ - 'description' => 'The input URL of the media asset in another service. The URL must be registered in the IMS content library and bound to the ID of the media asset in IMS.'."\n" + 'description' => 'The type of the MPS queue. Valid values:'."\n" ."\n" - .'* For a media asset from Object Storage Service (OSS), the URL may have one of the following formats:'."\n" + .'1. Standard: standard MPS queue.'."\n" ."\n" - .'http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or'."\n" + .'2. Boost: MPS queue with transcoding speed boosted.'."\n" ."\n" - .'oss://example-bucket/example.mp4. The second format indicates that the region in which the OSS bucket of the media asset resides is the same as the region in which OSS is activated.'."\n", + .'3. NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0.', + 'enumValueTitles' => ['Boost' => '', 'Standard' => '', 'NarrowBandHDV2' => ''], 'type' => 'string', - 'required' => false, - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + 'required' => true, + 'example' => 'Standard', + 'title' => '', ], ], [ - 'name' => 'OutputType', + 'name' => 'Priority', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the URL of the media asset to return in the response. Valid values:'."\n" - ."\n" - .'* oss (default): an OSS URL.'."\n" - .'* cdn: a CDN URL. A CDN URL is returned only if the media asset is imported from ApsaraVideo VOD and the relevant domain name is an accelerated domain name in ApsaraVideo VOD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cdn', - ], - ], - [ - 'name' => 'ReturnDetailedInfo', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return detailed information for specific media asset attributes. Supported attributes: AiRoughData.StandardSmartTagJob, which specifies whether to return detailed tag information if a tagging job has been submitted for the media asset. Valid values for the attribute:'."\n" - ."\n" - .'* false (default): The job result is returned as a URL.'."\n" - .'* true: The job result is returned as text.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"AiRoughData.StandardSmartTagJob": false} ', - ], - ], - [ - 'name' => 'AuthTimeout', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FDE2411-DB8D-4A9A-875B-275798F14A5E', - ], - 'MediaInfo' => [ - 'description' => 'The information about the media asset.'."\n", + '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' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", + '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' => '****20b48fb04483915d4f2cd8ac****', - ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'The basic information about the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'InputURL' => [ - 'title' => '待注册的媒资在相应系统中的地址', - 'description' => 'The input URL of the media asset in another service.'."\n", - 'type' => 'string', - 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'Source' => [ - 'title' => '来源', - 'description' => 'The source.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => 'The title.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => 'The content description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Category' => [ - 'title' => '分类', - 'description' => 'The category.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => 'The URL of the thumbnail.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'userDataTest', - ], - 'Snapshots' => [ - 'title' => '截图', - 'description' => 'The snapshots.'."\n", - 'type' => 'string', - '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' => [ - 'title' => '资源状态', - 'description' => 'The resource status.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:08Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => 'The time when the media asset was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => 'The time when the media asset was deleted.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:15Z', - ], - 'SpriteImages' => [ - 'title' => '雪碧图', - 'description' => 'The sprite.'."\n", - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3048', - ], - 'Biz' => [ - 'description' => 'The service to which the media asset belongs.'."\n", - 'type' => 'string', - 'example' => 'ICE', - ], - 'UploadSource' => [ - 'description' => 'The upload source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'CateName' => [ - 'description' => 'The category name.'."\n", - 'type' => 'string', - 'example' => 'cateName', - ], - 'ReferenceId' => [ - 'description' => 'The custom ID. The ID can be 6 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (\\_). The ID is unique among users.'."\n", - 'type' => 'string', - 'example' => '123-1234', - ], - ], - ], - 'FileInfoList' => [ - 'title' => 'FileInfos', - 'description' => 'The file information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '文件基础信息，包含时长，大小等', - 'description' => 'The basic information about the file, including the duration and size.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'example.mp4', - ], - 'FileStatus' => [ - 'title' => '文件状态', - 'description' => 'The file status.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小（字节）', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '30611502', - ], - 'FileUrl' => [ - 'title' => '文件oss地址', - 'description' => 'The OSS URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'Region' => [ - 'title' => '文件存储区域', - 'description' => 'The region in which the file is stored.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '封装格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '216.206667', - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '1132.68', - ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '960', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '540', - ], - 'CreateTime' => [ - 'description' => 'The time when the file was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:08Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the file was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - ], - ], - 'AudioStreamInfoList' => [ - 'title' => '音频流信息，一个媒资可能有多条音频流', - 'description' => 'The information about the audio tracks. A media asset may have multiple audio tracks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '音频流序号', - 'description' => 'The sequence number of the audio track.'."\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 of the codec.'."\n", - 'type' => 'string', - 'example' => '1/24000', - ], - 'CodecTagString' => [ - 'title' => '编码格式标记文本', - 'description' => 'The tag string of the codec.'."\n", - 'type' => 'string', - 'example' => 'mp4a', - ], - 'CodecTag' => [ - 'title' => '编码格式标记', - 'description' => 'The tag of the codec.'."\n", - 'type' => 'string', - 'example' => '0x6134706d', - ], - 'Profile' => [ - 'title' => '编码预置', - 'description' => 'The codec profile.'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'SampleFmt' => [ - 'title' => '采样格式', - 'description' => 'The sampling format.'."\n", - 'type' => 'string', - 'example' => 'fltp', - ], - 'SampleRate' => [ - 'title' => '采样率', - 'description' => 'The sampling rate.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'title' => '声道数', - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ChannelLayout' => [ - 'title' => '声道输出样式', - 'description' => 'The output layout of sound channels.'."\n", - 'type' => 'string', - 'example' => 'stereo', - ], - 'Timebase' => [ - 'title' => '时基', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/44100', - ], - 'StartTime' => [ - 'title' => '起始时间', - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '0.000000', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '16.200998', - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '127.794', - ], - 'Fps' => [ - 'title' => '音频帧率', - 'description' => 'The audio frame rate.'."\n", - 'type' => 'string', - 'example' => '8', - ], - 'NumFrames' => [ - 'title' => '总帧数', - 'description' => 'The number of frames.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Lang' => [ - 'title' => '语言', - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'und', - ], - ], - 'description' => '', - ], - ], - 'VideoStreamInfoList' => [ - 'title' => '视频流信息，一个媒资可能有多条视频流', - 'description' => 'The information about the video tracks. A media asset may have multiple video tracks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '视频流序号', - 'description' => 'The sequence number of the video track.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'CodecName' => [ - 'title' => '编码格式简述名', - 'description' => 'The short name of the codec.'."\n", - 'type' => 'string', - 'example' => 'h264', - ], - 'CodecLongName' => [ - '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', - ], - 'CodecTimeBase' => [ - 'title' => '编码时基', - 'description' => 'The time base of the codec.'."\n", - 'type' => 'string', - 'example' => '1/48', - ], - 'CodecTagString' => [ - 'title' => '编码格式标记文本', - 'description' => 'The tag string of the codec.'."\n", - 'type' => 'string', - 'example' => '[0][0][0][0]', - ], - 'CodecTag' => [ - 'title' => '编码格式标记', - 'description' => 'The tag of the codec.'."\n", - 'type' => 'string', - 'example' => '0x0000', - ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '960', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '540', - ], - 'HasBFrames' => [ - 'title' => '是否有B帧', - 'description' => 'Indicates whether the video track contains bidirectional frames (B-frames).'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Sar' => [ - 'title' => '编码信号分辨率比', - 'description' => 'The sample aspect ratio (SAR).'."\n", - 'type' => 'string', - 'example' => '0:1', - ], - 'Dar' => [ - 'title' => '编码显示分辨率比', - 'description' => 'The display aspect ratio (DAR).'."\n", - 'type' => 'string', - 'example' => '0:1', - ], - 'PixFmt' => [ - 'title' => '像素格式', - 'description' => 'The pixel format.'."\n", - 'type' => 'string', - 'example' => 'yuv420p', - ], - 'Level' => [ - 'title' => '编码等级', - 'description' => 'The codec level.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'Fps' => [ - 'title' => '视频帧率', - 'description' => 'The video frame rate.'."\n", - 'type' => 'string', - 'example' => '24.0', - ], - 'AvgFPS' => [ - 'title' => '平均帧率', - 'description' => 'The average video frame rate.'."\n", - 'type' => 'string', - 'example' => '24.0', - ], - 'Timebase' => [ - 'title' => '时基', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/12288', - ], - 'StartTime' => [ - 'title' => '起始时间', - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '0.081706', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '216.206706', - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '1001.594', - ], - 'NumFrames' => [ - 'title' => '总帧数', - 'description' => 'The number of frames.'."\n", - 'type' => 'string', - 'example' => '5184', - ], - 'Lang' => [ - 'title' => '语言', - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'und', - ], - 'Rotate' => [ - 'title' => '旋转', - 'description' => 'The rotation angle.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Nb_frames' => [ - 'title' => '总帧数', - 'description' => 'The total number of frames.'."\n", - 'type' => 'string', - 'example' => '5184', - ], - ], - 'description' => '', - ], - ], - 'SubtitleStreamInfoList' => [ - 'title' => '字幕流信息，一个媒资可能有多条字幕流', - 'description' => 'The information about the subtitle tracks. A media asset may have multiple subtitle tracks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '音频流序号', - 'description' => 'The sequence number of the subtitle track.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CodecName' => [ - 'title' => '编码格式简述名', - 'description' => 'The short name of the codec.'."\n", - 'type' => 'string', - 'example' => 'srt', - ], - 'CodecLongName' => [ - 'title' => '编码格式长述名', - 'description' => 'The full name of the codec.'."\n", - 'type' => 'string', - 'example' => 'SubRip Text', - ], - 'CodecTimeBase' => [ - 'title' => '编码时基', - 'description' => 'The time base of the codec.'."\n", - 'type' => 'string', - 'example' => '29.97', - ], - 'CodecTagString' => [ - 'title' => '编码格式标记文本', - 'description' => 'The tag string of the codec.'."\n", - 'type' => 'string', - 'example' => 'unicode', - ], - 'CodecTag' => [ - 'title' => '编码格式标记', - 'description' => 'The tag of the codec.'."\n", - 'type' => 'string', - 'example' => 'unicode', - ], - 'Timebase' => [ - 'title' => '时基', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'StartTime' => [ - 'title' => '起始时间', - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Lang' => [ - 'title' => '语言', - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'und', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], + 'example' => 'Standard', + 'title' => '', ], - 'AiRoughData' => [ - 'description' => 'The original AI analysis data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => 'The analysis result.'."\n", - 'type' => 'string', - 'example' => 'https://sample-bucket.cn-shanghai.aliyuncs.com/result.json', - ], - 'Status' => [ - 'description' => 'The analysis status. Valid values:'."\n" - ."\n" - .'* Analyzing'."\n" - .'* AnalyzeSuccess'."\n" - .'* AnalyzeFailed'."\n" - .'* Saving'."\n" - .'* SaveSuccess'."\n" - .'* SaveFailed'."\n" - .'* Deleting'."\n" - .'* DeleteSuccess'."\n" - .'* DeleteFailed'."\n", - 'type' => 'string', - 'example' => 'Analyzing', - ], - 'SaveType' => [ - 'description' => 'The storage type. This parameter indicates the library in which the analysis data is stored. Valid values:'."\n" - ."\n" - .'* TEXT: the text library.'."\n", - 'type' => 'string', - 'example' => 'TEXT', - ], - 'AiCategory' => [ - 'description' => 'The AI category. Valid values:'."\n" - ."\n" - .'* Life'."\n" - .'* Good-looking'."\n" - .'* Cute pets'."\n" - .'* News'."\n" - .'* Ads'."\n" - .'* Environmental resources'."\n" - .'* Automobile'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AiJobId' => [ - 'description' => 'The ID of the AI task.'."\n", - 'type' => 'string', - 'example' => '****483915d4f2cd8ac20b48fb04****', - ], - 'StandardSmartTagJob' => [ - 'description' => 'The information about the tagging job.'."\n", - 'type' => 'object', - 'properties' => [ - 'AiJobId' => [ - 'description' => 'The ID of the AI task.'."\n", - 'type' => 'string', - 'example' => '****483915d4f2cd8ac20b48fb04****', - ], - 'Status' => [ - 'description' => 'The analysis status. Valid values:'."\n" - ."\n" - .'* Analyzing'."\n" - .'* AnalyzeSuccess'."\n" - .'* AnalyzeFailed'."\n", - 'type' => 'string', - 'example' => 'Analyzing', - ], - 'ResultUrl' => [ - 'description' => 'The URL of the tagging result.'."\n", - 'type' => 'string', - 'example' => 'http://xx.oss-cn-shanghai.aliyuncs.com/result2.txt', - ], - 'Results' => [ - 'description' => 'The recognized tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the recognized tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The result data. The value is a JSON string. For information about the data structures of different data types, see [Description of the Results parameter](https://help.aliyun.com/zh/ims/developer-reference/api-ice-2020-11-09-querysmarttagjob?spm=a2c4g.11186623.0.0.521d48b7KfapOL#api-detail-40).', - 'type' => 'string', - 'example' => '{"autoChapters": [...]}', - ], - 'Type' => [ - 'description' => 'The tagging type. Valid values:'."\n" - ."\n" - .'* NLP: natural language processing (NLP)-based tagging'."\n", - 'type' => 'string', - 'example' => 'NLP', - ], - ], - ], - ], - ], - ], - ], + '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' => '[{"type":"json","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\\": \\"标题\\",\\n \\"Description\\": \\"描述\\",\\n \\"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}","errorExample":""},{"type":"xml","example":"\\n 2FDE2411-DB8D-4A9A-875B-275798F14A5E\\n \\n ****20b48fb04483915d4f2cd8ac****\\n \\n ****20b48fb04483915d4f2cd8ac****\\n https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\n video\\n general\\n oss\\n 标题\\n 描述\\n 分类\\n 标签,tag1\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n userDataTest\\n Normal\\n 2020-12-26T04:11:08Z\\n 2020-12-26T04:11:10Z\\n 2020-12-26T04:11:15Z\\n [{\\"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 3048\\n ICE\\n general\\n cateName\\n \\n \\n \\n example.mp4\\n Normal\\n source_file\\n 30611502\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n cn-shanghai\\n mov,mp4,m4a,3gp,3g2,mj2\\n 216.206667\\n 1132.68\\n 960\\n 540\\n 2020-12-26T04:11:08Z\\n 2020-12-26T04:11:10Z\\n \\n \\n 1\\n aac\\n AAC (Advanced Audio Coding)\\n 1/24000\\n mp4a\\n 0x6134706d\\n High\\n fltp\\n 44100\\n 2\\n stereo\\n 1/44100\\n 0.000000\\n 16.200998\\n 127.794\\n 8\\n 10\\n und\\n \\n \\n 0\\n h264\\n H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\n High\\n 1/48\\n [0][0][0][0]\\n 0x0000\\n 960\\n 540\\n 2\\n 0:1\\n 0:1\\n yuv420p\\n 30\\n 24.0\\n 24.0\\n 1/12288\\n 0.081706\\n 216.206706\\n 1001.594\\n 5184\\n und\\n 0\\n 5184\\n \\n \\n 1\\n srt\\n SubRip Text\\n 29.97\\n unicode\\n unicode\\n 30\\n 0\\n 1\\n und\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'GetMediaInfo', - 'description' => 'If the MediaId parameter is specified, the MediaId parameter is preferentially used for the query. If the MediaId parameter is left empty, the InputURL parameter must be specified.'."\n", - ], - 'UpdateMediaInfo' => [ - 'summary' => 'Updates information about a media asset based on the ID of the media asset in Intelligent Media Services (IMS) or the input URL of the media asset.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -13353,209 +9244,193 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'MediaId', + 'name' => 'ProgramName', 'in' => 'query', - 'schema' => [ - 'title' => '媒资Id', - 'description' => 'The ID of the media asset. If this parameter is left empty, you must specify the input URL of the media asset, which has been registered in the IMS content library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => true, 'example' => 'program1', 'title' => ''], ], [ - 'name' => 'InputURL', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'title' => '媒资媒体类型', - 'description' => 'The input URL of the media asset in another service. The URL must be bound to the ID of the media asset in IMS. The URL cannot be modified once registered.'."\n" - ."\n" - .'For a media asset from Object Storage Service (OSS), the URL may have one of the following formats:'."\n" - ."\n" - .'1\\. http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'."\n" - ."\n" - .'2\\. oss://example-bucket/example.mp4. This format indicates that the region in which the OSS bucket of the media asset resides is the same as the region in which OSS is activated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ - 'name' => 'BusinessType', + 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type. Valid values:'."\n" - ."\n" - .'* subtitles'."\n" - .'* watermark'."\n" - .'* opening'."\n" - .'* ending'."\n" - .'* general'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'video', - ], + 'schema' => ['description' => 'The source type of the program.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ - 'name' => 'Title', + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '标题', - 'description' => 'The title.'."\n" - ."\n" - .'* The value can be up to 128 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'defaultTitle', - ], + 'schema' => ['description' => 'The source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLcation', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'SourceName', 'in' => 'query', - 'schema' => [ - 'title' => '描述', - 'description' => 'The content description.'."\n" - ."\n" - .'* The value can be up to 1,024 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'defaultDescription', - ], + 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MySource', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'Transition', 'in' => 'query', - 'schema' => [ - 'title' => '分类', - 'description' => 'The category.'."\n" - ."\n" - .'* The value can be up to 64 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'defaultCategory', - ], + 'schema' => ['description' => 'The program transition method.', 'type' => 'string', 'required' => true, 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', 'title' => ''], ], [ - 'name' => 'MediaTags', + 'name' => 'ClipRange', 'in' => 'query', - 'schema' => [ - 'title' => '标签,如果有多个标签用逗号隔开', - 'description' => 'The tags.'."\n" - ."\n" - .'* Up to 16 tags are supported.'."\n" - .'* Separate multiple tags with commas (,).'."\n" - .'* Each tag can be up to 32 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'updateTags1,updateTags2', - ], + 'schema' => ['description' => 'Extracts a clip from the source.', 'type' => 'string', 'required' => false, 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}', 'title' => ''], ], [ - 'name' => 'CoverURL', + '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' => 'The URL of the thumbnail.'."\n" - ."\n" - .'* The value can be up to 128 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png', + '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' => [ [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '用户数据，最大1024字节', - 'description' => 'The user data. It can be up to 1,024 bytes in size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'userData', + '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' => [ [ - 'name' => 'AppendTags', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'title' => '是否以append的形式更新Tags字段', - 'description' => 'Specifies whether to append tags. Default value: false. Valid values:'."\n" - ."\n" - .'* true: updates the MediaTags parameter by appending new tags.'."\n" - .'* false: updates the MediaTags parameter by overwriting existing tags with new tags.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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' => 'CateId', + 'name' => 'LibId', 'in' => 'query', - 'schema' => [ - 'description' => 'The category ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3048', - ], + 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], [ - 'name' => 'ReferenceId', + 'name' => 'EntityName', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123-123', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'title' => 'ICE媒资ID', - 'description' => 'The ID of the media asset in IMS.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n ****20b48fb04483915d4f2cd8ac****\\n","errorExample":""}]', - 'title' => 'UpdateMediaInfo', - 'description' => 'If the MediaId parameter is specified, the MediaId parameter is preferentially used for the query. If the MediaId parameter is left empty, the InputURL parameter must be specified. The request ID and media asset ID are returned. You cannot modify the input URL of a media asset by specifying the ID of the media asset.'."\n", - ], - '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', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -13563,430 +9438,191 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], 'parameters' => [ [ - 'name' => 'MediaIds', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'title' => 'ICE 媒资ID', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****', - ], + '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' => 'InputURLs', + 'name' => 'LibName', 'in' => 'query', - 'schema' => [ - 'title' => '待注册的媒资在相应系统中的地址', - '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" - .'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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the recognition library. Max length: 64 bytes.', 'type' => 'string', 'example' => 'Landmark test library', 'required' => true, 'docRequired' => true, 'title' => ''], ], [ - 'name' => 'DeletePhysicalFiles', + 'name' => 'LibDescription', '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', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', - ], - 'IgnoredList' => [ - 'title' => '出现获取错误的ID或inputUr', - 'description' => 'The IDs or URLs of ignored media assets. An error occurred while obtaining such media assets.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID or URL of the ignored media asset. An error occurred while obtaining the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID or URL of the media asset that cannot be deleted.'."\n", - 'type' => 'string', - 'example' => '****15d4a4b0448391508f2cb486****'."\n", - ], - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"IgnoredList\\": [\\n \\"****20b48fb04483915d4f2cd8ac****\\"\\n ],\\n \\"ForbiddenList\\": [\\n \\"****15d4a4b0448391508f2cb486****\\\\n\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0622C702-41BE-467E-AF2E-883D4517962E\\n ****20b48fb04483915d4f2cd8ac****\\n","errorExample":""}]', - 'title' => 'DeleteMediaInfos', - ], - 'BatchGetMediaInfos' => [ - 'summary' => 'Queries the information about multiple media assets at a time based on media asset IDs.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'MediaIds', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the media assets that you want to query. Separate the IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', - ], + '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' => 'AdditionType', + 'name' => 'LibId', 'in' => 'query', - 'schema' => [ - 'description' => 'The additional information that you want to query about the media assets. By default, only BasicInfo is returned. The following additional information can be queried:'."\n" - ."\n" - .'\\- FileInfo'."\n" - ."\n" - .'\\- DynamicMetaData'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FileInfo,DynamicMetaData', - ], + 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], [ - 'name' => 'AuthTimeout', + 'name' => 'EntityId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaInfos' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The queried media assets.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '******c48fb37407365d4f2cd8******', - ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'The basic information of the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'MediaId'."\n", - 'type' => 'string', - 'example' => '******c48fb37407365d4f2cd8******', - ], - 'InputURL' => [ - 'title' => '待注册的媒资在相应系统中的地址', - 'description' => 'The URL of the media asset in another service.'."\n", - 'type' => 'string', - 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset. Valid values:'."\n" - ."\n" - .'\\- image'."\n" - ."\n" - .'\\- video'."\n" - ."\n" - .'\\- audio'."\n" - ."\n" - .'\\- text'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'Source' => [ - 'title' => '来源', - 'description' => 'The source of the media asset. Valid values:'."\n" - ."\n" - .'\\- oss'."\n" - ."\n" - .'\\- vod'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => 'The title of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => 'The description of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Category' => [ - 'title' => '分类', - 'description' => 'The category of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => 'The tags of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => 'The thumbnail URL of the media asset.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'userDataTest', - ], - 'Snapshots' => [ - 'title' => '截图', - 'description' => 'The snapshots of the media asset.'."\n", - 'type' => 'string', - 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]', - ], - 'Status' => [ - 'title' => '资源状态', - 'description' => 'The status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TranscodeStatus' => [ - 'title' => '转码状态', - 'description' => 'The transcoding status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => 'The time when the media asset was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:12Z', - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => 'The time when the media asset was deleted.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'SpriteImages' => [ - 'title' => '雪碧图', - 'description' => 'The sprite.'."\n", - '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' => [ - 'type' => 'string', - ], - ], - ], - 'FileInfoList' => [ - 'title' => 'FileInfos', - 'description' => 'FileInfos'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '文件基础信息，包含时长，大小等', - 'description' => 'The basic information of the file, including the duration and size.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'example', - ], - 'FileStatus' => [ - 'title' => '文件状态', - 'description' => 'The file status.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小（字节）', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '30611502', - ], - 'FileUrl' => [ - 'title' => '文件oss地址', - 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'Region' => [ - 'title' => '文件存储区域', - 'description' => 'The region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '封装格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '1132.68', - ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '1080', - ], - ], - ], - ], - 'description' => '', - ], - ], - 'MediaDynamicInfo' => [ - 'type' => 'object', - 'properties' => [ - 'DynamicMetaData' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - 'IgnoredList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + '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' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","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\\": \\"标题\\",\\n \\"Description\\": \\"描述\\",\\n \\"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\\": \\"[{\\\\\\"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-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\\": \\"\\"\\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 }\\n ],\\n \\"MediaDynamicInfo\\": {\\n \\"DynamicMetaData\\": {\\n \\"Data\\": \\"\\"\\n }\\n }\\n }\\n ],\\n \\"IgnoredList\\": [\\n \\"\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n \\n ******c48fb37407365d4f2cd8******\\n \\n ******c48fb37407365d4f2cd8******\\n https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\n video\\n general\\n oss\\n 标题\\n 描述\\n 分类\\n 标签,tag1\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n userDataTest\\n [{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"3\\",\\"iceJobId\\":\\"******f48f0e4154976b2b8c45******\\",\\"location\\":\\"oss-cn-beijing\\",\\"snapshotRegular\\":\\"example.jpg\\",\\"templateId\\":\\"******e6a6440b29eb60bd7c******\\"}]\\n Normal\\n Init\\n 2020-12-26T04:11:10Z\\n 2020-12-26T04:11:12Z\\n 2020-12-26T04:11:10Z\\n [{\\"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 \\n \\n example\\n Normal\\n source_file\\n 30611502\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n cn-shanghai\\n mov,mp4,m4a,3gp,3g2,mj2\\n 200\\n 1132.68\\n 1920\\n 1080\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'BatchGetMediaInfos', - ], - 'ListMediaBasicInfos' => [ - 'summary' => 'Queries the basic information of all media assets that meet the specified conditions.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -13995,1077 +9631,735 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '创建时间', - 'description' => 'The start time of utcCreated.'."\n" - ."\n" - .'\\- The value is the beginning of a left-open right-closed interval.'."\n" - ."\n" - .'\\- Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. For example, 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017 (UTC +8).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-12-20T12:00:00Z', - ], + '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' => 'EndTime', + 'name' => 'IndexType', 'in' => 'query', 'schema' => [ - 'title' => '结束时间', - 'description' => 'The end time of utcCreated.'."\n" + '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" - .'\\- The value is the end of the left-open right-closed interval.'."\n" + .'> This feature is in the public preview phase. You can use this feature for free for 1,000 hours of videos.'."\n" ."\n" - .'\\- Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. For example, 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017 (UTC +8).'."\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' => false, - 'example' => '2020-12-20T13:00:00Z', + 'required' => true, + 'title' => '', + 'example' => 'mm', ], ], [ - 'name' => 'MediaType', + 'name' => 'IndexStatus', 'in' => 'query', 'schema' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset. Valid values:'."\n" - ."\n" - .'\\- image'."\n" - ."\n" - .'\\- video'."\n" + 'description' => 'Index status. Default value is Active. Valid values:'."\n" ."\n" - .'\\- audio'."\n" + .'- Active: Activated.'."\n" ."\n" - .'\\- text'."\n", + .'- Deactive: Deactivated.', + 'enumValueTitles' => ['Active' => 'Active', 'Deactive' => 'Deactive'], 'type' => 'string', 'required' => false, - 'example' => 'video', + 'example' => 'Active', + 'title' => '', ], ], [ - 'name' => 'BusinessType', + 'name' => 'IndexConfig', 'in' => 'query', + 'schema' => ['description' => 'Index configuration', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '媒资业务类型', - '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'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'opening', + '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' => [ [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'title' => '来源', - 'description' => 'The source of the media asset. Valid values:'."\n" - ."\n" - .'\\- oss: Object Storage Service (OSS).'."\n" - ."\n" - .'\\- vod: ApsaraVideo VOD.'."\n" - ."\n" - .'\\- live: ApsaraVideo Live.'."\n" - ."\n" - .'\\- general: other sources. This is the default value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss', + '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' => [ [ - 'name' => 'Status', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '资源状态', - 'description' => 'The status of the 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 of the source file failed to be obtained.'."\n" - ."\n" - .'\\- Normal: The source file is ready.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + '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' => 'NextToken', + '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' => '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pSa1SQ0wCe5pzVrQ6mWZEw==', + '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' => [ [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The maximum number of entries to return.'."\n" - ."\n" - .'Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '5', - 'default' => '10', + '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' => [ [ - 'name' => 'SortBy', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '排序', - 'description' => 'The order of sorting by utcCreated. Default value: desc. Valid values:'."\n" - ."\n" - .'\\- desc'."\n" - ."\n" - .'\\- asc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ - 'name' => 'IncludeFileBasicInfo', + 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'title' => '返回值中是否包含文件基础信息', - 'description' => 'Specifies whether to return the basic information of the source file.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The source type. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ - 'name' => 'MediaId', + 'name' => 'SourceName', 'in' => 'query', - 'schema' => [ - 'title' => '媒资ID，单个媒资ID支持前缀匹配', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****019b82e24b37a1c2958dec38****', - ], + 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MyVodSource', 'title' => ''], ], [ - 'name' => 'AuthTimeout', + 'name' => 'HttpPackageConfigurations', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******B7-7F87-4792-BFE9-63CD21******', - ], - 'TotalCount' => [ - 'title' => '符合要求的媒资总数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'MediaInfos' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that meet the specified conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****019b82e24b37a1c2958dec38****', - ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'BasicInfo'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****019b82e24b37a1c2958dec38****', - ], - 'InputURL' => [ - 'title' => '待注册的媒资在相应系统中的地址', - 'description' => 'The URL of the media asset in another service.'."\n", - 'type' => 'string', - 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'opening', - ], - 'Source' => [ - 'title' => '来源', - 'description' => 'The source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => 'The title of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => 'The description of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Category' => [ - 'title' => '分类', - 'description' => 'The category of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => 'The tags of the media asset.'."\n", - 'type' => 'string', - 'example' => 'tags,tags2', - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => 'The thumbnail URL of the media asset.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'userData', - ], - 'Snapshots' => [ - 'title' => '截图', - 'description' => 'The snapshots of the media asset.'."\n", - 'type' => 'string', - 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]', - ], - 'Status' => [ - 'title' => '资源状态', - 'description' => 'The status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TranscodeStatus' => [ - 'title' => '转码状态', - 'description' => 'The transcoding status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:04Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => 'The time when the media asset was last modified.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:07Z', - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => 'The time when the media asset was deleted.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:07Z', - ], - 'SpriteImages' => [ - 'title' => '雪碧图', - 'description' => 'The sprite.'."\n", - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3049', - ], - 'Biz' => [ - 'description' => 'The service to which the media asset belongs.'."\n", - 'type' => 'string', - 'example' => 'ICE', - ], - 'UploadSource' => [ - 'description' => 'The upload source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'ReferenceId' => [ - 'description' => 'The custom ID of the media asset. The ID is a string that contains 6 to 64 characters. Only letters, digits, hyphens (-), and underscores (\\_) are supported. The ID is unique among users.'."\n", - 'type' => 'string', - 'example' => '123-123', - ], - ], - ], - 'FileInfoList' => [ - 'title' => 'FileInfos', - 'description' => 'FileInfos'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '文件基础信息，包含时长，大小等', - 'description' => 'The basic information of the file, including the duration and size.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'example.mp4', - ], - 'FileStatus' => [ - 'title' => '文件状态', - 'description' => 'The file status.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小（字节）', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '14340962', - ], - 'FileUrl' => [ - 'title' => '文件oss地址', - 'description' => 'The OSS URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'Region' => [ - 'title' => '文件存储区域', - 'description' => 'The region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '封装格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '60.00000', - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '1912.13', - ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '1280', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '720', - ], - 'CreateTime' => [ - 'description' => 'The time when the file was created.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:04Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the file was last modified.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:07Z', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - '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.'."\n", - 'type' => 'string', - 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', - ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned in the query.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'RequestId' => ['description' => '**Request ID**', 'type' => 'string', 'example' => 'xxx-xxxx-xxxxx-xxxx', 'title' => ''], + 'Source' => ['description' => 'The source information.', '$ref' => '#/components/schemas/ChannelAssemblySource', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","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\\": \\"title标题\\",\\n \\"Description\\": \\"desc 描述\\",\\n \\"Category\\": \\"分类 category\\",\\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}","errorExample":""},{"type":"xml","example":"\\n ******B7-7F87-4792-BFE9-63CD21******\\n 4\\n \\n ****019b82e24b37a1c2958dec38****\\n \\n ****019b82e24b37a1c2958dec38****\\n https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\n video\\n opening\\n oss\\n title标题\\n desc 描述\\n 分类 category\\n tags,tags2\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n userData\\n [{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"3\\",\\"iceJobId\\":\\"******f48f0e4154976b2b8c45******\\",\\"location\\":\\"oss-cn-beijing\\",\\"snapshotRegular\\":\\"example.jpg\\",\\"templateId\\":\\"******e6a6440b29eb60bd7c******\\"}]\\n Normal\\n Init\\n 2021-01-08T16:52:04Z\\n 2021-01-08T16:52:07Z\\n 2021-01-08T16:52:07Z\\n [{\\"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 3049\\n ICE\\n general\\n \\n \\n \\n example.mp4\\n Normal\\n source_file\\n 14340962\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n cn-shanghai\\n mov,mp4,m4a,3gp,3g2,mj2\\n 60.00000\\n 1912.13\\n 1280\\n 720\\n 2021-01-08T16:52:04Z\\n 2021-01-08T16:52:07Z\\n \\n \\n \\n 8EqYpQbZ6Eh7+Zz8DxVYoQ==\\n 2\\n","errorExample":""}]', - 'title' => 'ListMediaBasicInfos', - 'description' => 'If includeFileBasicInfo is set to true, the basic information, such as the duration and file size, of the source file is also returned. At most the first 100 entries that meet the specified conditions are returned. All media assets must exactly match all non-empty fields. The fields that support exact match include MediaType, Source, BusinessType, Category, and Status. If all information cannot be returned at a time, you can use NextToken to initiate a request to retrieve a new page of results.'."\n", - ], - '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', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'MediaTagId', + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '标签', - '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" - .' * sticker-bubble'."\n" - .' * sticker-cute'."\n" - .' * sticker-daily'."\n" - .' * sticker-expression'."\n" - .' * sticker-gif'."\n" - ."\n" - .'* Background music (BGM) tags:'."\n" - ."\n" - .' * bgm-romantic'."\n" - .' * bgm-cuisine'."\n" - .' * bgm-chinese-style'."\n" - .' * bgm-upbeat'."\n" - .' * bgm-dynamic'."\n" - .' * bgm-relaxing'."\n" - .' * bgm-quirky'."\n" - .' * bgm-beauty'."\n" - ."\n" - .'* Background image (BGI) tags:'."\n" - ."\n" - .' * bgi-grad'."\n" - .' * bgi-solid'."\n" - .' * bgi-pic'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ticker-atmosphere', - ], + 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourcelocation', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'BaseUrl', 'in' => 'query', - 'schema' => [ - 'title' => '下一次读取的位置', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pSa1SQ0wCe5pzVrQ6mWZEw==', - ], + 'schema' => ['description' => 'The protocol and hostname of the source location.', 'type' => 'string', 'required' => true, 'example' => 'http://xxx.com', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'EnableSegmentDelivery', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The maximum number of entries to return.'."\n" - ."\n" - .'Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '5', - 'default' => '10', - ], + 'schema' => ['description' => 'Specifies whether to use an independent domain name to access the segments.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'PageNo', + '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' => 'The page number. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', + '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' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', + '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' => 'IncludeFileBasicInfo', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '返回值中是否包含文件基础信息', - 'description' => 'Specifies whether to return the basic information of the media asset.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ - 'name' => 'BusinessType', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The business type of the media asset. Valid values:'."\n" - ."\n" - .'* sticker'."\n" - .'* bgm'."\n" - .'* bgi'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sticker', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******B7-7F87-4792-BFE9-63CD21******', - ], - 'TotalCount' => [ - 'title' => '符合要求的媒资总数', - 'description' => 'The total number of media assets that meet the specified conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'MediaInfos' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that meet the specified conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****019b82e24b37a1c2958dec38****', - ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'The basic information of the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****019b82e24b37a1c2958dec38****', - ], - 'InputURL' => [ - 'title' => '待注册的媒资在相应系统中的地址', - 'description' => 'The URL of the media asset in another service.'."\n", - 'type' => 'string', - 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'Source' => [ - 'title' => '来源', - 'description' => 'The source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => 'The title of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => 'The description of the media asset.'."\n", - 'type' => 'string', - 'example' => 'description', - ], - 'Category' => [ - 'title' => '分类', - 'description' => 'The category of the media asset.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => 'The tags of the media asset.'."\n", - 'type' => 'string', - 'example' => 'sticker-daily', - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => 'The thumbnail URL of the media asset.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'userData', - ], - 'Snapshots' => [ - 'title' => '截图', - 'description' => 'The snapshots of the media asset.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Status' => [ - 'title' => '资源状态', - 'description' => 'The status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TranscodeStatus' => [ - 'title' => '转码状态', - 'description' => 'The transcoding status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:04Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => 'The time when the media asset was last modified.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:04Z', - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => 'The time when the media asset was deleted.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:04Z', - ], - ], - ], - 'FileInfoList' => [ - 'title' => 'FileInfos', - 'description' => 'The file information of the media asset.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '文件基础信息，包含时长，大小等', - 'description' => 'The basic information of the file, such as the duration and size.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'example.mp4', - ], - 'FileStatus' => [ - 'title' => '文件状态', - 'description' => 'The file status.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小（字节）', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '338990717', - ], - 'FileUrl' => [ - 'title' => '文件oss地址', - 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'Region' => [ - 'title' => '文件存储区域', - 'description' => 'The region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '封装格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '10.040000', - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '270112.12', - ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '1080', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - '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.'."\n", - 'type' => 'string', - 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', - ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","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\\": \\"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}","errorExample":""},{"type":"xml","example":"\\n B45F83B7-7F87-4792-BFE9-63CD2137CAF0\\n 2\\n \\n ****019b82e24b37a1c2958dec38****\\n \\n ****019b82e24b37a1c2958dec38****\\n https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\n video\\n general\\n oss\\n title标题\\n description\\n video\\n sticker-daily\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n userData\\n null\\n Normal\\n Init\\n 2021-01-08T16:52:04Z\\n 2021-01-08T16:52:04Z\\n 2021-01-08T16:52:04Z\\n \\n \\n \\n example.mp4\\n Normal\\n source_file\\n 338990717\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n cn-shanghai\\n mov,mp4,m4a,3gp,3g2,mj2\\n 10.040000\\n 270112.12\\n 1920\\n 1080\\n \\n \\n \\n 8EqYpQbZ6Eh7+Zz8DxVYoQ==\\n 2\\n","errorExample":""}]', - 'title' => 'ListPublicMediaBasicInfos', - ], - 'ListAllPublicMediaTags' => [ - 'summary' => 'Queries a list of tags of media assets in the public media library.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + ], 'parameters' => [ [ - 'name' => 'BusinessType', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"sticker"', - ], + '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 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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Copyright_Music', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B45F83B7-7F87-4792-BFE9-63CD2137CAF0', - ], - 'MediaTagList' => [ - 'title' => '公共素材库标签列表', - 'description' => 'The tags of media assets in the public media library.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MediaTagId' => [ - 'title' => '素材标签id', - 'description' => 'The ID of the media tag.'."\n", - 'type' => 'string', - 'example' => 'sticker-gif', - ], - 'MediaTagNameChinese' => [ - 'title' => '素材标签中文名', - 'description' => 'The name of the media tag in Chinese.'."\n", - 'type' => 'string', - 'example' => 'Gif', - ], - 'MediaTagNameEnglish' => [ - 'title' => '素材标签英文名', - 'description' => 'The name of the material tag in English.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Options' => [ - 'description' => 'The options.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OptionId' => [ - 'description' => 'The option ID.'."\n", - 'type' => 'string', - 'example' => 'Angry', - ], - 'OptionEnglishName' => [ - 'description' => 'The option name in English.'."\n", - 'type' => 'string', - 'example' => 'Angry', - ], - 'OptionChineseName' => [ - 'description' => 'The option name in Chinese.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B45F83B7-7F87-4792-BFE9-63CD2137CAF0\\",\\n \\"MediaTagList\\": [\\n {\\n \\"MediaTagId\\": \\"sticker-gif\\",\\n \\"MediaTagNameChinese\\": \\"Gif\\",\\n \\"MediaTagNameEnglish\\": \\"动图\\",\\n \\"Options\\": [\\n {\\n \\"OptionId\\": \\"Angry\\",\\n \\"OptionEnglishName\\": \\"Angry\\",\\n \\"OptionChineseName\\": \\"愤怒\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B45F83B7-7F87-4792-BFE9-63CD2137CAF0\\n \\n sticker-gif\\n Gif\\n 动图\\n \\n","errorExample":""}]', - 'title' => 'ListAllPublicMediaTags', - ], - 'SubmitMediaAiAnalysisJob' => [ - 'summary' => 'Submits a structural analysis job for a media asset. For example, you can submit a job to analyze the speaker, translate the video, and obtain the paragraph summary.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '231064', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Input', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The media asset that you want to analyze. You can specify an Object Storage Service (OSS) URL, a media asset ID, or an external URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MediaType":"video","Media":"https://xxx.com/your_movie.mp4"}', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ - 'name' => 'AnalysisParams', + 'name' => 'Definition', 'in' => 'query', - 'schema' => [ - 'description' => 'The analysis parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":false,"translationEnabled":false}}', - ], + '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' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The user data.', 'type' => 'string', 'required' => false, 'example' => '{"MessageCallback":{"CallbackURL":"http://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '******b48fb04483915d4f2cd8******', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\"\\n}","type":"json"}]', - 'title' => 'SubmitMediaAiAnalysisJob', - ], - 'AddCategory' => [ - 'summary' => 'Creates a category.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUploadStream'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -15073,313 +10367,245 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice20UKYV'], + ], 'parameters' => [ [ - 'name' => 'CateName', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The category name.'."\n" - ."\n" - .'* The value can be up to 64 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], [ - 'name' => 'ParentId', + 'name' => 'AssetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the parent category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], + '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' => 'Type', + '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' => [ - 'description' => 'The type of the category. Valid values:'."\n" - ."\n" - .'* default: audio, video, and image files. This is the default value.'."\n" - .'* material: short video materials.'."\n", - 'type' => 'string', + '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' => 'default', + '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' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Category' => [ - 'description' => 'The information about the category.'."\n", - '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" - .'* **material**: short video materials.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'CateName' => [ - 'description' => 'The category name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CateId' => [ - 'description' => 'The ID of the created category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45', - ], - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], + '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' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"ParentId\\": -1,\\n \\"CateName\\": \\"分类1\\",\\n \\"CateId\\": 45,\\n \\"Level\\": 0\\n }\\n}","type":"json"}]', - 'title' => 'AddCategory', - 'description' => 'You can create at most three levels of categories. Each category level can contain a maximum of 100 subcategories.'."\n", - ], - 'GetCategories' => [ - 'summary' => 'Queries the information about a category and its subcategories.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice20UKYV'], + ], 'parameters' => [ [ - 'name' => 'CateId', + 'name' => 'GroupName', '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" - .'* View the value of CateId returned by the AddCategory operation that you called to create a category.'."\n" - .'* View the value of CateId returned by the GetCategories operation that you called to query a category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '33', - ], + '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' => 'PageNo', + 'name' => 'ConfigurationName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => 'SortBy', + 'name' => 'Description', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreationTime:Desc', - ], + 'schema' => ['description' => 'The description of the packaging configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'HLS 3s vod packaging'], ], [ - 'name' => 'Type', + 'name' => 'PackageConfig', 'in' => 'query', + 'style' => 'json', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'title' => '', + 'description' => 'The packaging configuration.', 'type' => 'object', 'properties' => [ - 'SubTotal' => [ - 'description' => 'The total number of subcategories.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Category' => [ - 'description' => 'The information about the category.'."\n", + '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' => [ - 'Type' => [ - 'description' => 'The type of the category. Valid values:'."\n" - ."\n" - .'* **default**: audio, video, and image files. This is the default value.'."\n" - .'* **material**: short video materials.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'CateName' => [ - 'description' => 'The category name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ParentId' => [ - 'description' => 'The ID of the parent category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'CateId' => [ - 'description' => 'The category ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '46', - ], - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + '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' => '', ], - 'SubCategories' => [ + 'DrmProvider' => [ + 'title' => '', + 'description' => 'The settings of digital rights management (DRM) encryption.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Category' => [ - 'description' => 'The subcategories in the category.'."\n", + '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 subcategory in the category.'."\n", - '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" - .'* **material**: short video materials.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'CateName' => [ - 'description' => 'The category name.'."\n" - ."\n" - .'* The value can be up to 64 bytes in length.'."\n" - .'* The value is encoded in UTF-8.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ParentId' => [ - 'description' => 'The ID of the parent category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '46', - ], - 'CateId' => [ - 'description' => 'The category ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '129', - ], - 'SubTotal' => [ - 'description' => 'The total number of subcategories.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], + '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' => '', ], ], - 'description' => '', + 'required' => false, + 'example' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubTotal\\": 100,\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"CateName\\": \\"一级分类\\",\\n \\"ParentId\\": -1,\\n \\"CateId\\": 46,\\n \\"Level\\": 0\\n },\\n \\"SubCategories\\": {\\n \\"Category\\": [\\n {\\n \\"Type\\": \\"default\\",\\n \\"CateName\\": \\"二级子分类\\",\\n \\"ParentId\\": 46,\\n \\"CateId\\": 129,\\n \\"SubTotal\\": 100,\\n \\"Level\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetCategories', - 'description' => 'You can call this operation to query the information about a category and its subcategories based on the category ID and category type.'."\n", - ], - 'UpdateCategory' => [ - 'summary' => 'Updates a category.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -15387,395 +10613,355 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice20UKYV'], + ], 'parameters' => [ [ - 'name' => 'CateName', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The category name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + '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' => 'CateId', + 'name' => 'Description', '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" - .'* View the value of CateId returned by the AddCategory operation that you called to create a category.'."\n" - .'* View the value of CateId returned by the GetCategories operation that you called to query a category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '43', - ], + 'schema' => ['description' => 'The packaging group description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod hls packaging'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The result of creating the packaging group.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\"\\n}","type":"json"}]', - 'title' => 'UpdateCategory', - 'description' => 'After you create a media asset category, you can call this operation to find the category based on the category ID and change the name of the category.'."\n", - ], - 'DeleteCategory' => [ - 'summary' => 'Deletes a media asset category.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'CateId', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], + ], + 'parameters' => [ + [ + 'name' => 'FileExt', '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" - .'* View the value of CateId returned by the AddCategory operation that you called to create a category.'."\n" - .'* View the value of CateId returned by the GetCategories operation that you called to query a category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '46', - ], + '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' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], + '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' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\"\\n}","type":"json"}]', - 'title' => 'DeleteCategory', - 'description' => 'This operation also deletes the subcategories, including the level-2 and level-3 categories, of the category.'."\n", - ], - 'AddMediaMarks' => [ - 'summary' => 'Adds marks for a media asset.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Obtain audio and video upload URL and credential ', + 'summary' => 'Obtains an upload credential for a Yike media asset.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], + ], 'parameters' => [ [ - 'name' => 'MediaId', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '53afdf003a2171ed9c6a16b5feac6402', - ], + 'schema' => ['description' => 'The title of the Yike production.', 'type' => 'string', 'required' => true, 'maxLength' => 50, 'pattern' => '^[^\';<>=|\\(\\)]+$', 'example' => 'title', 'title' => ''], ], [ - 'name' => 'MediaMarks', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'title' => '打标信息', - 'description' => 'The mark information. The value must be a JSONArray.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '581236', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', - ], - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '53afdf003a******6a16b5feac6402', - ], - 'MediaMarkIds' => [ - 'title' => '添加的标记Id', - 'description' => 'The IDs of the marks that are added.'."\n", - 'type' => 'string', - 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AddMediaMarksFailed', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + '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\\": \\"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.|', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"ProductionId\\": \\"ProductionId\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetMediaMarks' => [ - 'summary' => 'Queries the information about marks based on mark IDs.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateYikeUser' => [ + 'summary' => 'Creates a Yike user.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], + ], 'parameters' => [ [ - 'name' => 'MediaId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-az2gglkjauwnnhpq', 'title' => ''], ], [ - 'name' => 'MediaMarkIds', + 'name' => 'UserNamePrefix', 'in' => 'query', - 'schema' => [ - 'description' => 'The mark ID. You can specify multiple mark IDs separated with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'MediaMarks' => [ - 'title' => 'MediaMarks', - 'description' => 'The queried marks.'."\n" - ."\n" - .'* The value is in the JSONArray format.'."\n", - 'type' => 'string', + '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' => '', ], ], ], - '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\\\\\\": \\\\\\"上线\\\\\\"\\\\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.|', - ], - 'UpdateMediaMarks' => [ - 'summary' => 'Modifies the marks of a media asset.', - 'methods' => [ - 'get', - 'post', + 'title' => 'CreateYikeUser', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], + ], 'parameters' => [ [ - 'name' => 'MediaId', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '53afdf003a******6a16b5feac6402', - ], + 'schema' => ['description' => 'The workspace title.', 'type' => 'string', 'required' => true, 'maxLength' => 50, 'pattern' => '^[^\';<>=|\\(\\)]+$', 'example' => 'title', 'title' => ''], ], [ - 'name' => 'MediaMarks', + 'name' => 'UserCountLimit', 'in' => 'query', - 'schema' => [ - 'title' => '打标信息', - 'description' => 'The marks of the media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '53afdf003a******6a16b5feac6402', - ], - 'MediaMarkIds' => [ - 'title' => '添加的标记Id', - 'description' => 'The IDs of the successfully modified marks.'."\n", - 'type' => 'string', - 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], - 500 => [ - [ - 'errorCode' => 'UpdateMediaMarksFailed', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + '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\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"53afdf003a******6a16b5feac6402\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', - 'title' => 'UpdateMediaMarks', - '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.|', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"WorkspaceId\\": \\"llm-zna577pdximvztk5\\",\\n \\"ProductionId\\": \\"ProductionId\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'DeleteMediaMarks' => [ - 'summary' => 'Deletes the marks of a media asset.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DecryptKMSDataKey' => [ + 'summary' => 'Decrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15786,70 +10972,61 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'MediaId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****c469e944b5a856828dc2****', - ], - ], - [ - 'name' => 'MediaMarkIds', + 'name' => 'CiphertextBlob', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', - ], + 'schema' => ['description' => 'The ciphertext that you want to decrypt.', 'type' => 'string', 'required' => true, 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****019b82e24b37a1c2958dec38****', - ], - 'MediaMarkIds' => [ - 'title' => 'MediaMarkIds', - 'description' => 'The IDs of the deleted marks separated with commas (,).'."\n", - 'type' => 'string', - 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', + '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 \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', - 'title' => 'DeleteMediaMarks', - ], - 'ListMediaMarks' => [ - 'summary' => 'Queries a list of marks of a media asset.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -15857,81 +11034,71 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235498', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], 'parameters' => [ [ - 'name' => 'MediaId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '411bed50018971edb60b0764a0ec6***', - ], + 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => '6d594e7f55624c47a48789******', 'title' => ''], ], [ - 'name' => 'MediaMarkIds', + 'name' => 'DialogueId', 'in' => 'query', - 'schema' => [ - 'description' => 'The mark ID. You can specify multiple IDs separated with commas (,). This parameter is discontinued.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '******b48fb04483915d4f2cd8******', - ], - 'MediaMarks' => [ - 'title' => 'MediaMarks', - 'description' => 'The marks of the media asset, in the JSONArray format.'."\n", - 'type' => 'string', - 'example' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7B117AF5-2A1******'], ], + '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\\\\\\": \\\\\\"上线\\\\\\"\\\\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.|', - ], - 'CreateIpcOrder' => [ - 'summary' => 'Creates an IPC order. The purchased capacity is shared at the account level.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'https', + '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' => [], @@ -15940,238 +11107,325 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd123', + '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' => [ [ - 'name' => 'Capability', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'understand-reid-search' => 'understand-reid-search', - 'search' => 'search', - 'understand-search' => 'understand-search', - 'understand' => 'understand', - 'understand-reid' => 'understand-reid', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteAdInsertion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'understand', ], ], + ], + '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' => [ [ - 'name' => 'Period', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'month' => 'month', - 'year' => 'year', - 'quarter' => 'quarter', - ], - 'example' => 'month', - ], + 'schema' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'PurchaseStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', + '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\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"PurchaseStatus\\": \\"Success\\"\\n}","type":"json"}]', - 'title' => 'CreateIpcOrder', - ], - 'GetIpcDeviceInfo' => [ - 'summary' => 'Retrieves information about IPC devices.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'DeviceId', + '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd123', + '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' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2017-01-11T12:00:00Z', + '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' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2017-02-11T12:00:00Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'Capability', + 'name' => 'ChannelName', 'in' => 'query', + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'understand', + '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' => [ [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + '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' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the custom template.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'DeviceInfos' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd123', - ], - 'Capability' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'understand', - ], - 'ExpireTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2017-02-11T12:00:00Z', - ], - ], - ], - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '78', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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"}]', - 'title' => 'GetIpcDeviceInfo', - ], - 'QueryIpcQuota' => [ - 'summary' => 'Queries the usage for the IPC service.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomTemplate'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -16179,559 +11433,265 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceJQ6U8A', - ], - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2025-05-08T08:52:00Z', - ], + 'schema' => ['description' => 'The ID of the human voice cloning job.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2025-05-09T08:52:00Z', + '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' => [ [ - 'name' => 'Capability', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'understand', + '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' => [ [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'DBId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'IpcQuotaInfos' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Capability' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'understand', - ], - 'DateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-12-21T16:00:00Z', - ], - 'MaxQuota' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ConsumedQuota' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - ], - ], - ], - 'Total' => [ - 'description' => '', - 'type' => 'string', - 'example' => '39', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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"}]', - 'title' => 'QueryIpcQuota', - ], - 'GetPlayInfo' => [ - 'summary' => 'Queries the playback URL of a video or audio file by its ID. You can use the playback URL to play the audio or video in ApsaraVideo Player SDK (for URL-based playback) or a third-party player.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDNADB'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFUMQ35', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'MediaId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n" - ."\n" - .'> You must specify at least one of the MediaId and InputURL parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86434e152b7d4f20be480574439fe***', - ], - ], - [ - 'name' => 'InputURL', + 'name' => 'DBId', 'in' => 'query', - 'schema' => [ - 'description' => 'The input URL that you specified for the media asset when you registered the media asset. For more information, see [RegisterMediaInfo](~~441152~~).'."\n" - ."\n" - .'> You must specify at least one of the MediaId and InputURL parameters.', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'AuthTimeout', + 'name' => 'PrimaryKeys', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + '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' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaBase' => [ - 'description' => 'The information about the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2021-09-22T10:07:31+08:00', - ], - 'Status' => [ - 'description' => 'The resource status. 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 of the source file failed to be obtained.'."\n" - ."\n" - .'Normal: The source file is ready.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'MediaId' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '2eea77a61c7b4ddd95bec34a6f65b***', - ], - 'CoverURL' => [ - 'description' => 'The URL of the thumbnail.'."\n", - 'type' => 'string', - 'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/cover/281c64d6-b5fb-4c57-97cd-84da56a8b151_large_cover_url.jpg', - ], - 'Title' => [ - 'description' => 'The title.'."\n", - 'type' => 'string', - 'example' => 'testTitle', - ], - 'MediaType' => [ - 'description' => 'The type of the media asset. Valid values:'."\n" - ."\n" - .'video audio'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'MediaTags' => [ - 'description' => 'The tags.'."\n" - ."\n" - .'* Up to 16 tags are supported.'."\n" - .'* Multiple tags are separated by commas (,).'."\n" - .'* Each tag can be up to 32 bytes in length.'."\n" - .'* The value is encoded in UTF-8.'."\n", - 'type' => 'string', - 'example' => 'test,ccc', - ], - 'CateId' => [ - '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" - .'* View the value of the CateId parameter returned by the AddCategory operation that you called to create a category.'."\n" - .'* View the value of the CateId parameter returned by the GetCategories operation that you called to query a category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4220', - ], - 'Description' => [ - 'description' => 'The content description.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - ], - ], - 'PlayInfoList' => [ - 'description' => 'The information about the audio or video stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The audio or video details.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the media stream 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.'."\n", - 'type' => 'string', - 'example' => '2022-05-10T02:28:49Z', - ], - 'Status' => [ - 'description' => 'The status of the media stream. Valid values:'."\n" - ."\n" - .'* **Normal**'."\n" - .'* **Invisible**'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'NarrowBandType' => [ - 'description' => 'The type of Narrowband HD™ transcoding. Valid values:'."\n" - ."\n" - .'* **0**: standard transcoding'."\n" - .'* **1.0**: Narrowband HD™ 1.0 transcoding'."\n" - .'* **2.0**: Narrowband HD™ 2.0 transcoding'."\n" - ."\n" - .'This parameter is returned only when a definition that is available in the built-in Narrowband HD™ 1.0 transcoding template is specified. For more information, see the [Definition parameter in TranscodeTemplate](~~52839~~) table.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Height' => [ - 'description' => 'The height of the media stream. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1080', - ], - 'Bitrate' => [ - 'description' => 'The bitrate of the media stream. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'ModificationTime' => [ - 'description' => 'The time when the media stream was updated. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-05-13T11:39:41.714+08:00', - ], - 'WatermarkId' => [ - 'description' => 'The ID of the watermark that is associated with the media stream.'."\n", - 'type' => 'string', - 'example' => '5bed88672b1e2520ead228935ed51***', - ], - 'Encrypt' => [ - 'description' => 'Indicates whether the media stream is encrypted. Valid values:'."\n" - ."\n" - .'* **0**: The media stream is not encrypted.'."\n" - .'* **1**: The media stream is encrypted.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Definition' => [ - 'description' => 'The quality of the media stream. Valid values:'."\n" - ."\n" - .'* **FD**: low definition'."\n" - .'* **LD**: standard definition'."\n" - .'* **SD**: high definition'."\n" - .'* **HD**: ultra-high definition'."\n" - .'* **OD**: original definition'."\n" - .'* **2K**'."\n" - .'* **4K**'."\n" - .'* **SQ**: standard sound quality'."\n" - .'* **HQ**: high sound quality'."\n" - .'* **AUTO**: adaptive bitrate'."\n", - 'type' => 'string', - 'example' => 'HD', - ], - 'EncryptType' => [ - 'description' => 'The encryption type of the media stream. Valid values:'."\n" - ."\n" - .'* **AliyunVoDEncryption**: Alibaba Cloud proprietary cryptography'."\n" - .'* **HLSEncryption**: HTTP Live Streaming (HLS) encryption'."\n" - ."\n" - .'> If the encryption type is AliyunVoDEncryption, only ApsaraVideo Player SDK can be used to play videos.'."\n", - 'type' => 'string', - 'example' => 'AliyunVoDEncryption', - ], - 'StreamType' => [ - 'description' => 'The type of the media stream. If the media stream is a video stream, the value is **video**. If the media stream is an audio-only stream, the value is **audio**.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'Size' => [ - 'description' => 'The size of the media stream. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '418112', - ], - 'Width' => [ - 'description' => 'The width of the media stream. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'Fps' => [ - 'description' => 'The frame rate of the media stream. Unit: frames per second (FPS).'."\n", - 'type' => 'string', - 'example' => '25', - ], - 'Duration' => [ - 'description' => 'The duration of the media stream. Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '9.0464', - ], - 'PlayURL' => [ - 'description' => 'The playback URL of the media stream.'."\n", - 'type' => 'string', - 'example' => 'https://***.aliyuncdn.com/sv/756bee1-17f980f0945/756bee1-17f980f0945.mp4', - ], - 'Format' => [ - 'description' => 'The format of the media stream.'."\n" - ."\n" - .'* If the media asset is a video file, the valid values are **mp4** and **m3u8**.'."\n" - .'* If the media asset is an audio-only file, the value is **mp3**.'."\n", - 'type' => 'string', - 'example' => 'mp4', - ], - 'HDRType' => [ - 'title' => '视频流HDR类型', - 'description' => 'The high dynamic range (HDR) type of the media stream. Valid values:'."\n" - ."\n" - .'* HDR'."\n" - .'* HDR10'."\n" - .'* HLG'."\n" - .'* DolbyVision'."\n" - .'* HDRVivid'."\n" - .'* SDR+'."\n", - 'type' => 'string', - 'example' => 'HDR', - ], - 'BitDepth' => [ - 'title' => '颜色位深', - 'description' => 'The color depth.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'FileURL' => [ - 'description' => 'The OSS URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/43a68ee9-181809b6aba/43a68ee9-181809b6aba.mpeg', - ], - 'TransTemplateType' => [ - 'description' => 'The type of the transcoding template. Valid values:'."\n" - ."\n" - .'* Normal: standard transcoding'."\n" - .'* AudioTranscode: audio transcoding'."\n" - .'* Remux: container format conversion'."\n" - .'* NarrowBandV1: Narrowband HD™ 1.0'."\n" - .'* NarrowBandV2: Narrowband HD™ 2.0'."\n" - .'* UHD: audio and video enhancement (ultra-high definition)'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'StreamTags' => [ - 'description' => 'The tags of the media stream, which are used to identify the transcoding type.'."\n", - 'type' => 'string', - 'example' => '"{\\"ims.audioServiceType\\": \\"AudioEnhancement\\"}"', - ], - 'JobId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => '36c9d38e70bf43ed9f7f8f48d6356***', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'GetPlayInfo', - 'description' => 'You use the ID of a video or audio file to query the playback URL of the file. Then, you can use the playback URL to play the audio or video in ApsaraVideo Player SDK (for URL-based playback) or a third-party player.'."\n", - ], - 'DeletePlayInfo' => [ - 'summary' => 'Deletes media streams such as video streams and audio streams.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'MediaId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1d3518e0027d71ed80cd909598416303', - ], + 'schema' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '*****fb2101cb318*****'], ], [ - 'name' => 'FileURLs', + 'name' => 'MaterialIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the media stream file that you want to delete. Separate multiple URLs with commas (,).'."\n", - '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', - ], + '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' => 'DeletePhysicalFiles', + 'name' => 'MaterialType', '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', - ], + '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' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The URL of the ignored media stream. An error occurred while obtaining the media stream.'."\n", - '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", - ], - ], - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The URL of the media stream that cannot be deleted.'."\n", - '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", - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******36-3C1E-4417-BDB2-1E034F******'], ], + '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', - 'description' => 'You can call this operation to delete multiple media streams at a time.'."\n", - ], - 'CreateAudit' => [ - 'summary' => 'Submits manual review results for media assets.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -16739,69 +11699,56 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AuditContent', + 'name' => 'ProjectIds', '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.'."\n", - '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" - .']', - ], + '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' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****25818875-5F78-4AF6-D7393642CA58****'], ], + '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.|', - ], - 'SubmitMediaCensorJob' => [ - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -16810,1622 +11757,618 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The template ID. If this parameter is not specified, the default template is used for moderation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S00000001-100060', - ], - ], - [ - 'name' => 'CoverImages', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Object Storage Service (OSS) objects that are used as the thumbnails. Specify the thumbnails in a JSON array. A maximum of five thumbnails are supported.'."\n" - ."\n" - .'> If this parameter is specified, the system checks the thumbnails specified by this parameter instead of the thumbnails of the input file specified by **Media**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg","RoleArn":"acs:ram::1997018457688683:role/AliyunICEDefaultRole"}]', - ], - ], - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'description' => 'The video title, which can be up to 64 bytes in length.'."\n" - ."\n" - .'> If this parameter is specified, the system checks the title specified by this parameter instead of the title of the input file specified by Media.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Hello World', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The video description, which can be up to 128 bytes in length.'."\n" - ."\n" - .'> If this parameter is specified, the system checks the description specified by this parameter instead of the description of the input file specified by Media.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example description', - ], - ], - [ - 'name' => 'Barrages', + 'name' => 'HotwordLibraryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The live comments of the video.'."\n" - ."\n" - .'> If this parameter is specified, the system checks the live comments specified by this parameter instead of the live comments of the input file specified by Media.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello world', - ], + 'schema' => ['description' => 'The ID of the hotword library that you want to delete.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => '', 'required' => false], ], - [ - 'name' => 'Output', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The output snapshots. The moderation job generates output snapshots and the result JSON file in the path corresponding to the input file.'."\n" - ."\n" - .'* File name format of output snapshots: oss://bucket/snapshot-{Count}.jpg. In the path, bucket indicates an OSS bucket that resides in the same region as the current project, and {Count} is the sequence number of the snapshot.'."\n" - .'* The detailed moderation results are stored in the {jobId}.output file in the same OSS folder as the output snapshots. For more information about the parameters in the output file, see [Output parameters of media moderation jobs](~~609211~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'oss://sashimi-cn-shanghai/censor/snapshot-{Count}.jpg', + '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' => [ [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data, which can be up to 128 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UserDatatestid-001-****', + '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' => [ [ - 'name' => 'NotifyUrl', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The callback URL. Simple Message Queue (SMQ, formerly MNS) and HTTP callbacks are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mns://125340688170****.oss-cn-shanghai.aliyuncs.com/queues/example-pipeline', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239701', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ [ - 'name' => 'Input', + 'name' => 'GroupName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the file to be moderated.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'OSS: OSS object.'."\n" - ."\n" - .'Media: media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Media', - ], - 'Media' => [ - 'description' => 'The input file. The file can be an OSS object or a media asset. You can specify the path of an OSS object 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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1b1b9cd148034739af413150fded****', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ - 'name' => 'ScheduleConfig', + 'name' => 'ChannelName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The scheduling configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is submitted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5246b8d12a62433ab77845074039****', - ], - 'Priority' => [ - 'description' => 'The job priority. A larger value indicates a higher priority. Valid values: 1 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], - 'JobId' => [ - 'description' => 'The ID of the content moderation job. We recommend that you save this ID for subsequent calls of other operations.'."\n", - 'type' => 'string', - 'example' => '88c6ca184c0e47098a5b665e2****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","type":"json"}]', - 'title' => 'SubmitMediaCensorJob', - 'summary' => 'Submits a content moderation job.', - 'description' => 'The job that you submit by calling this operation is run in asynchronous mode. The job is added to an ApsaraVideo Media Processing (MPS) queue to be scheduled and run. You can call the [QueryMediaCensorJobDetail](~~444847~~) operation or configure an asynchronous notification to obtain the job results.'."\n", - ], - 'QueryMediaCensorJobDetail' => [ - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'get', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238118', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'GroupName', '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2288c6ca184c0e47098a5b665e2a12****', - ], + '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' => [ [ - 'name' => 'NextPageToken', + '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' => [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + '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' => [ [ - 'name' => 'MaximumPageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RecordIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Default value: **30**.'."\n" - .'* Valid values: **1 to 300**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', + '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' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA', - ], - 'MediaCensorJobDetail' => [ - 'description' => 'The results of the content moderation job.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the content moderation job was created.'."\n", - 'type' => 'string', - 'example' => '2018-09-13T16:32:24Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the content moderation job was complete.'."\n", - 'type' => 'string', - 'example' => '2018-09-13T16:38:24Z', - ], - 'Suggestion' => [ - 'description' => 'The overall result of the content moderation job. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\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.'."\n", - 'type' => 'string', - 'example' => 'block', - ], - 'CoverImageCensorResults' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CoverImageCensorResult' => [ - 'description' => 'The moderation results of thumbnails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Object' => [ - 'description' => 'The Object Storage Service (OSS) object that is used as the thumbnail.'."\n", - 'type' => 'string', - 'example' => 'test/ai/censor/v2/vme-****.jpg', - ], - 'Location' => [ - 'description' => 'The OSS region in which the thumbnail resides.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Bucket' => [ - 'description' => 'The OSS bucket in which the thumbnail is stored.'."\n", - 'type' => 'string', - 'example' => 'bucket-out-test-****', - ], - 'Results' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Result' => [ - 'description' => 'The moderation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed moderation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'pass', - ], - 'Label' => [ - 'description' => 'The label of the moderation result.'."\n" - ."\n" - .'* Valid values in the pornographic content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **sexy**: sexy content.'."\n" - .' * **porn**: pornographic content.'."\n" - ."\n" - .'* Valid values in the terrorist content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **bloody**: bloody content.'."\n" - .' * **explosion**: explosion and smoke.'."\n" - .' * **outfit**: special costume.'."\n" - .' * **logo**: special logo.'."\n" - .' * **weapon**: weapon.'."\n" - .' * **politics**: political content.'."\n" - .' * **violence**: violence.'."\n" - .' * **crowd**: crowd.'."\n" - .' * **parade**: parade.'."\n" - .' * **carcrash**: car accident.'."\n" - .' * **flag**: flag.'."\n" - .' * **location**: landmark.'."\n" - .' * **others**: other content.'."\n" - ."\n" - .'* Valid values in the ad moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **ad**: other ads.'."\n" - .' * **politics**: political content in text.'."\n" - .' * **porn**: pornographic content in text.'."\n" - .' * **abuse**: abuse in text.'."\n" - .' * **terrorism**: terrorist content in text.'."\n" - .' * **contraband**: prohibited content in text.'."\n" - .' * **spam**: spam in text.'."\n" - .' * **npx**: illegal ad.'."\n" - .' * **qrcode**: QR code.'."\n" - .' * **programCode**: mini program code.'."\n" - ."\n" - .'* Valid values in the undesirable scene moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **meaningless**: meaningless content, such as a black or white screen.'."\n" - .' * **PIP**: picture-in-picture.'."\n" - .' * **smoking**: smoking.'."\n" - .' * **drivelive**: live broadcasting in a running vehicle.'."\n" - ."\n" - .'* Valid values in the logo moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **TV**: controlled logo.'."\n" - .' * **trademark**: trademark.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. Valid values:'."\n" - ."\n" - .'* **porn**: pornographic content moderation.'."\n" - .'* **terrorism**: terrorist content moderation.'."\n" - .'* **ad**: ad moderation.'."\n" - .'* **live**: undesirable scene moderation.'."\n" - .'* **logo**: logo moderation.'."\n", - 'type' => 'string', - 'example' => 'Antispam', - ], - 'Rate' => [ - 'description' => 'The score. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'State' => [ - 'description' => 'The job state.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'TitleCensorResult' => [ - 'description' => 'The moderation results of titles.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'block', - ], - 'Label' => [ - 'description' => 'The label of the moderation result. Valid values:'."\n" - ."\n" - .'* **normal**: normal content.'."\n" - .'* **spam**: spam.'."\n" - .'* **ad**: ads.'."\n" - .'* **abuse**: abuse content.'."\n" - .'* **flood**: excessive junk content.'."\n" - .'* **contraband**: prohibited content.'."\n" - .'* **meaningless**: meaningless content.'."\n", - 'type' => 'string', - 'example' => 'meaningless', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. The value is **antispam**.'."\n", - 'type' => 'string', - 'example' => 'antispam', - ], - 'Rate' => [ - 'description' => 'The score.'."\n", - 'type' => 'string', - 'example' => '99.91', - ], - ], - ], - 'Message' => [ - 'description' => 'The error message returned if the job failed. This parameter is not returned if the job is successful.'."\n", - 'type' => 'string', - 'example' => 'The resource operated cannot be found', - ], - 'Input' => [ - 'description' => 'The information about the job input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Object' => [ - 'description' => 'The name of the OSS object that is used as the input file.'."\n", - 'type' => 'string', - 'example' => 'test/ai/censor/test-****.mp4', - ], - 'Location' => [ - 'description' => 'The OSS region in which the input file resides.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Bucket' => [ - 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", - 'type' => 'string', - 'example' => 'bucket-test-in-****', - ], - ], - ], - 'BarrageCensorResult' => [ - 'description' => 'The moderation results of live comments.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'pass', - ], - 'Label' => [ - 'description' => 'The label of the moderation result. Valid values:'."\n" - ."\n" - .'* **normal**: normal content.'."\n" - .'* **spam**: spam.'."\n" - .'* **ad**: ads.'."\n" - .'* **abuse**: abuse content.'."\n" - .'* **flood**: excessive junk content.'."\n" - .'* **contraband**: prohibited content.'."\n" - .'* **meaningless**: meaningless content.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. The value is **antispam**.'."\n", - 'type' => 'string', - 'example' => 'antispam', - ], - 'Rate' => [ - 'description' => 'The score.'."\n", - 'type' => 'string', - 'example' => '99.91', - ], - ], - ], - 'DescCensorResult' => [ - 'description' => 'The moderation results of descriptions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'review', - ], - 'Label' => [ - 'description' => 'The label of the moderation result. Valid values:'."\n" - ."\n" - .'* **normal**: normal content.'."\n" - .'* **spam**: spam.'."\n" - .'* **ad**: ads.'."\n" - .'* **abuse**: abuse content.'."\n" - .'* **flood**: excessive junk content.'."\n" - .'* **contraband**: prohibited content.'."\n" - .'* **meaningless**: meaningless content.'."\n", - 'type' => 'string', - 'example' => 'terrorism', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. The value is **antispam**.'."\n", - 'type' => 'string', - 'example' => 'antispam', - ], - 'Rate' => [ - 'description' => 'The score.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - 'VideoCensorConfig' => [ - 'description' => 'The video moderation configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'OutputFile' => [ - 'description' => 'The information about output snapshots.'."\n", - '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.'."\n", - 'type' => 'string', - 'example' => 'output{Count}.jpg', - ], - 'Location' => [ - 'description' => 'The OSS region in which the output snapshot resides.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Bucket' => [ - 'description' => 'The OSS bucket in which the output snapshot is stored.'."\n", - 'type' => 'string', - 'example' => 'test-bucket-****', - ], - ], - ], - '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" - .'* **false**: The video content does not need to be moderated.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'BizType' => [ - 'description' => 'The custom business type. Default value: common.'."\n", - 'type' => 'string', - 'example' => 'common', - ], - ], - ], - 'JobId' => [ - 'description' => 'The ID of the content moderation job.'."\n", - 'type' => 'string', - 'example' => 'f8f166eea7a44e9bb0a4aecf9543****', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => 'example userdata ****', - ], - 'Code' => [ - 'description' => 'The error code returned if the job failed. This parameter is not returned if the job is successful.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter.ResourceNotFound', - ], - 'VensorCensorResult' => [ - 'description' => 'The moderation results of videos.'."\n", - 'type' => 'object', - 'properties' => [ - 'VideoTimelines' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'VideoTimeline' => [ - 'description' => 'The moderation results that are sorted in ascending order by time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => 'The position in the video. Format: `hh:mm:ss[.SSS]`.'."\n", - 'type' => 'string', - 'example' => '00:02:59.999', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'output{Count}.jpg', - ], - 'CensorResults' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CensorResult' => [ - 'description' => 'The moderation results that include information such as labels and scores.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'block', - ], - 'Label' => [ - 'description' => 'The label of the moderation result.'."\n" - ."\n" - .'* Valid values in the pornographic content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **sexy**: sexy content.'."\n" - .' * **porn**: pornographic content.'."\n" - ."\n" - .'* Valid values in the terrorist content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **bloody**: bloody content.'."\n" - .' * **explosion**: explosion and smoke.'."\n" - .' * **outfit**: special costume.'."\n" - .' * **logo**: special logo.'."\n" - .' * **weapon**: weapon.'."\n" - .' * **politics**: political content.'."\n" - .' * **violence**: violence.'."\n" - .' * **crowd**: crowd.'."\n" - .' * **parade**: parade.'."\n" - .' * **carcrash**: car accident.'."\n" - .' * **flag**: flag.'."\n" - .' * **location**: landmark.'."\n" - .' * **others**: other content.'."\n" - ."\n" - .'* Valid values in the ad moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **ad**: other ads.'."\n" - .' * **politics**: political content in text.'."\n" - .' * **porn**: pornographic content in text.'."\n" - .' * **abuse**: abuse in text.'."\n" - .' * **terrorism**: terrorist content in text.'."\n" - .' * **contraband**: prohibited content in text.'."\n" - .' * **spam**: spam in text.'."\n" - .' * **npx**: illegal ad.'."\n" - .' * **qrcode**: QR code.'."\n" - .' * **programCode**: mini program code.'."\n" - ."\n" - .'* Valid values in the undesirable scene moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **meaningless**: meaningless content, such as a black or white screen.'."\n" - .' * **PIP**: picture-in-picture.'."\n" - .' * **smoking**: smoking.'."\n" - .' * **drivelive**: live broadcasting in a running vehicle.'."\n" - ."\n" - .'* Valid values in the logo moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **TV**: controlled logo.'."\n" - .' * **trademark**: trademark.'."\n", - 'type' => 'string', - 'example' => 'flood', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. Valid values:'."\n" - ."\n" - .'* **porn**: pornographic content moderation.'."\n" - .'* **terrorism**: terrorist content moderation.'."\n" - .'* **ad**: ad moderation.'."\n" - .'* **live**: undesirable scene moderation.'."\n" - .'* **logo**: logo moderation.'."\n", - 'type' => 'string', - 'example' => 'porn', - ], - 'Rate' => [ - 'description' => 'The score.'."\n", - 'type' => 'string', - 'example' => '99.99', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'NextPageToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'ea04afcca7cd4e80b9ece8fbb251****', - ], - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed moderation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'review', - ], - 'Label' => [ - 'description' => 'The label of the moderation result.'."\n" - ."\n" - .'* Valid values in the pornographic content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **sexy**: sexy content.'."\n" - .' * **porn**: pornographic content.'."\n" - ."\n" - .'* Valid values in the terrorist content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **bloody**: bloody content.'."\n" - .' * **explosion**: explosion and smoke.'."\n" - .' * **outfit**: special costume.'."\n" - .' * **logo**: special logo.'."\n" - .' * **weapon**: weapon.'."\n" - .' * **politics**: political content.'."\n" - .' * **violence**: violence.'."\n" - .' * **crowd**: crowd.'."\n" - .' * **parade**: parade.'."\n" - .' * **carcrash**: car accident.'."\n" - .' * **flag**: flag.'."\n" - .' * **location**: landmark.'."\n" - .' * **others**: other content.'."\n" - ."\n" - .'* Valid values in the ad moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **ad**: other ads.'."\n" - .' * **politics**: political content in text.'."\n" - .' * **porn**: pornographic content in text.'."\n" - .' * **abuse**: abuse in text.'."\n" - .' * **terrorism**: terrorist content in text.'."\n" - .' * **contraband**: prohibited content in text.'."\n" - .' * **spam**: spam in text.'."\n" - .' * **npx**: illegal ad.'."\n" - .' * **qrcode**: QR code.'."\n" - .' * **programCode**: mini program code.'."\n" - ."\n" - .'* Valid values in the undesirable scene moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **meaningless**: meaningless content, such as a black or white screen.'."\n" - .' * **PIP**: picture-in-picture.'."\n" - .' * **smoking**: smoking.'."\n" - .' * **drivelive**: live broadcasting in a running vehicle.'."\n" - ."\n" - .'* Valid values in the logo moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **TV**: controlled logo.'."\n" - .' * **trademark**: trademark.'."\n", - 'type' => 'string', - 'example' => 'meaningless', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. Valid values:'."\n" - ."\n" - .'* **porn**: pornographic content moderation.'."\n" - .'* **terrorism**: terrorist content moderation.'."\n" - .'* **ad**: ad moderation.'."\n" - .'* **live**: undesirable scene moderation.'."\n" - .'* **logo**: logo moderation.'."\n", - 'type' => 'string', - 'example' => 'terrorism', - ], - 'Rate' => [ - 'description' => 'The score.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], - ], - 'PipelineId' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', + '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\\": \\"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"}]', - '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. You can call this operation again to query the remaining moderation results of the video.'."\n", - ], - 'QueryMediaCensorJobList' => [ - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobIds', + 'name' => 'TemplateId', '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 (,).'."\n", + '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', - 'required' => false, - 'example' => 'fa9c34be3bcf42919ac4d1775239****,78dc866518b843259669df58ed30****', + 'deprecated' => false, + 'required' => true, + 'pattern' => '', + 'readOnly' => true, + 'default' => '', + 'title' => '', + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b7****', ], ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '79aff3eee82242e092899db5f669', + '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' => [ [ - 'name' => 'MaximumPageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Default value: **30**.'."\n" - .'* Valid values: **1 to 300**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', + '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' => [ [ - 'name' => 'State', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceP3TB74'], + ], + 'parameters' => [ + [ + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the jobs that you want to query. Valid values:'."\n" - ."\n" - .'* **All**: all jobs.'."\n" - .'* **Queuing**: the jobs that are waiting in the queue.'."\n" - .'* **Analysing**: the jobs that are in progress.'."\n" - .'* **Fail**: failed jobs.'."\n" - .'* **Success**: successful jobs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'All', - 'default' => 'All', - ], + 'schema' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ - 'name' => 'StartOfJobCreatedTimeRange', + 'name' => 'CreateTimestampList', 'in' => 'query', + 'style' => 'json', '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" - .'* Format: yyyy-MM-ddTHH:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-22T03:48:05Z'."\n", + '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' => 'EndOfJobCreatedTimeRange', + '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' => [ - '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" - .'* Format: yyyy-MM-ddTHH:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-14T02:16:07Z'."\n", + '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' => ''], + ], [ - 'name' => 'PipelineId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the jobs were submitted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****'."\n", + ['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' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'MediaCensorJobList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MediaCensorJob' => [ - 'description' => 'The queried content moderation jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the content moderation job.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the content moderation job was created.'."\n", - 'type' => 'string', - 'example' => '2021-11-04T07:25:48Z'."\n", - ], - 'FinishTime' => [ - 'description' => 'The time when the content moderation job was complete.'."\n", - 'type' => 'string', - 'example' => '2021-11-04T07:25:50Z'."\n", - ], - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'pass', - ], - 'CoverImageCensorResults' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CoverImageCensorResult' => [ - 'description' => 'The moderation results of thumbnails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed moderation result of the thumbnail.'."\n", - 'type' => 'object', - 'properties' => [ - 'Object' => [ - 'description' => 'The Object Storage Service (OSS) object that is used as the thumbnail.'."\n", - 'type' => 'string', - 'example' => 'test/ai/censor/v2/vme-****.jpg'."\n", - ], - 'Location' => [ - 'description' => 'The OSS region in which the thumbnail resides.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Bucket' => [ - 'description' => 'The OSS bucket in which the thumbnail is stored.'."\n", - 'type' => 'string', - 'example' => 'example-Bucket-****'."\n", - ], - 'Results' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Result' => [ - 'description' => 'The moderation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed moderation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The overall result of the moderation job. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\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.'."\n", - 'type' => 'string', - 'example' => 'pass', - ], - '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" - .' * **sexy**: sexy content.'."\n" - .' * **porn**: pornographic content.'."\n" - ."\n" - .'* Valid values in the terrorist content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **bloody**: bloody content.'."\n" - .' * **explosion**: explosion and smoke.'."\n" - .' * **outfit**: special costume.'."\n" - .' * **logo**: special logo.'."\n" - .' * **weapon**: weapon.'."\n" - .' * **politics**: political content.'."\n" - .' * **violence**: violence.'."\n" - .' * **crowd**: crowd.'."\n" - .' * **parade**: parade.'."\n" - .' * **carcrash**: car accident.'."\n" - .' * **flag**: flag.'."\n" - .' * **location**: landmark.'."\n" - .' * **others**: other content.'."\n" - ."\n" - .'* Valid values in the ad moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **ad**: other ads.'."\n" - .' * **politics**: political content in text.'."\n" - .' * **porn**: pornographic content in text.'."\n" - .' * **abuse**: abuse in text.'."\n" - .' * **terrorism**: terrorist content in text.'."\n" - .' * **contraband**: prohibited content in text.'."\n" - .' * **spam**: spam in text.'."\n" - .' * **npx**: illegal ad.'."\n" - .' * **qrcode**: QR code.'."\n" - .' * **programCode**: mini program code.'."\n" - ."\n" - .'* Valid values in the undesirable scene moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **meaningless**: meaningless content, such as a black or white screen.'."\n" - .' * **PIP**: picture-in-picture.'."\n" - .' * **smoking**: smoking.'."\n" - .' * **drivelive**: live streaming in a running vehicle.'."\n" - ."\n" - .'* Valid values in the logo moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **TV**: controlled logo.'."\n" - .' * **trademark**: trademark.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. Valid values:'."\n" - ."\n" - .'* **porn**: pornographic content moderation.'."\n" - .'* **terrorism**: terrorist content moderation.'."\n" - .'* **ad**: ad moderation.'."\n" - .'* **live**: undesirable scene moderation.'."\n" - .'* **logo**: logo moderation.'."\n", - 'type' => 'string', - 'example' => 'live', - ], - 'Rate' => [ - 'description' => 'The score. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'State' => [ - 'description' => 'The job state.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'TitleCensorResult' => [ - 'description' => 'The moderation results of titles.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'block', - ], - 'Label' => [ - 'description' => 'The label of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" - ."\n" - .'* **normal**: normal content.'."\n" - .'* **spam**: spam.'."\n" - .'* **ad**: ads.'."\n" - .'* **abuse**: abuse content.'."\n" - .'* **flood**: excessive junk content.'."\n" - .'* **contraband**: prohibited content.'."\n" - .'* **meaningless**: meaningless content.'."\n", - 'type' => 'string', - 'example' => 'meaningless', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. The value is **antispam**.'."\n", - 'type' => 'string', - 'example' => 'antispam', - ], - 'Rate' => [ - 'description' => 'The score. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - 'Message' => [ - 'description' => 'The error message returned if the job failed. This parameter is not returned if the job is successful.'."\n", - 'type' => 'string', - 'example' => 'The resource operated cannot be found', - ], - 'Input' => [ - 'description' => 'The information about the job input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Object' => [ - 'description' => 'The name of the OSS object that is used as the input file.'."\n", - 'type' => 'string', - 'example' => 'test/ai/censor/test-****.mp4', - ], - 'Location' => [ - 'description' => 'The OSS region in which the input file resides.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai'."\n", - ], - 'Bucket' => [ - 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", - 'type' => 'string', - 'example' => 'bucket-test-in-****', - ], - ], - ], - 'BarrageCensorResult' => [ - 'description' => 'The moderation results of live comments.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'pass', - ], - 'Label' => [ - 'description' => 'The label of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" - ."\n" - .'* **normal**: normal content.'."\n" - .'* **spam**: spam.'."\n" - .'* **ad**: ads.'."\n" - .'* **abuse**: abuse content.'."\n" - .'* **flood**: excessive junk content.'."\n" - .'* **contraband**: prohibited content.'."\n" - .'* **meaningless**: meaningless content.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. The value is **antispam**.'."\n", - 'type' => 'string', - 'example' => 'antispam', - ], - 'Rate' => [ - 'description' => 'The score. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '99.91', - ], - ], - ], - 'DescCensorResult' => [ - 'description' => 'The moderation results of descriptions.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'pass', - ], - 'Label' => [ - 'description' => 'The label of the moderation result. Separate multiple labels with commas (,). Valid values:'."\n" - ."\n" - .'* **normal**: normal content.'."\n" - .'* **spam**: spam.'."\n" - .'* **ad**: ads.'."\n" - .'* **abuse**: abuse content.'."\n" - .'* **flood**: excessive junk content.'."\n" - .'* **contraband**: prohibited content.'."\n" - .'* **meaningless**: meaningless content.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. The value is **antispam**.'."\n", - 'type' => 'string', - 'example' => 'antispam', - ], - 'Rate' => [ - 'description' => 'The score. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - 'VideoCensorConfig' => [ - 'description' => 'The video moderation configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'OutputFile' => [ - 'description' => 'The information about output snapshots.'."\n", - '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.'."\n", - 'type' => 'string', - 'example' => 'output{Count}.jpg', - ], - 'Location' => [ - 'description' => 'The ID of the region in which the output snapshot resides.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai'."\n", - ], - 'Bucket' => [ - 'description' => 'The OSS bucket in which the output snapshot is stored.'."\n", - 'type' => 'string', - 'example' => 'test-bucket-****'."\n", - ], - ], - ], - '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" - .'* **false**: The video content does not need to be moderated.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'common', - ], - ], - ], - 'JobId' => [ - 'description' => 'The ID of the content moderation job.'."\n", - 'type' => 'string', - 'example' => 'f8f166eea7a44e9bb0a4aecf9543', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => 'example userdata ****'."\n", - ], - 'Code' => [ - 'description' => 'The error code returned if the job failed. This parameter is not returned if the job is successful.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter.ResourceNotFound', - ], - 'VensorCensorResult' => [ - 'description' => 'The moderation results of videos.'."\n", - 'type' => 'object', - 'properties' => [ - 'VideoTimelines' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'VideoTimeline' => [ - 'description' => 'The moderation results that are sorted in ascending order by time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed moderation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => 'The position in the video. Format: `hh:mm:ss[.SSS]`.'."\n", - 'type' => 'string', - 'example' => '00:02:59.999', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'output{Count}.jpg', - ], - 'CensorResults' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CensorResult' => [ - 'description' => 'The moderation results that include information such as labels and scores.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed moderation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'block', - ], - '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" - .' * **sexy**: sexy content.'."\n" - .' * **porn**: pornographic content.'."\n" - ."\n" - .'* Valid values in the terrorist content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **bloody**: bloody content.'."\n" - .' * **explosion**: explosion and smoke.'."\n" - .' * **outfit**: special costume.'."\n" - .' * **logo**: special logo.'."\n" - .' * **weapon**: weapon.'."\n" - .' * **politics**: political content.'."\n" - .' * **violence**: violence.'."\n" - .' * **crowd**: crowd.'."\n" - .' * **parade**: parade.'."\n" - .' * **carcrash**: car accident.'."\n" - .' * **flag**: flag.'."\n" - .' * **location**: landmark.'."\n" - .' * **others**: other content.'."\n" - ."\n" - .'* Valid values in the ad moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **ad**: other ads.'."\n" - .' * **politics**: political content in text.'."\n" - .' * **porn**: pornographic content in text.'."\n" - .' * **abuse**: abuse in text.'."\n" - .' * **terrorism**: terrorist content in text.'."\n" - .' * **contraband**: prohibited content in text.'."\n" - .' * **spam**: spam in text.'."\n" - .' * **npx**: illegal ad.'."\n" - .' * **qrcode**: QR code.'."\n" - .' * **programCode**: mini program code.'."\n" - ."\n" - .'* Valid values in the undesirable scene moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **meaningless**: meaningless content, such as a black or white screen.'."\n" - .' * **PIP**: picture-in-picture.'."\n" - .' * **smoking**: smoking.'."\n" - .' * **drivelive**: live streaming in a running vehicle.'."\n" - ."\n" - .'* Valid values in the logo moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **TV**: controlled logo.'."\n" - .' * **trademark**: trademark.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. Valid values:'."\n" - ."\n" - .'* **porn**: pornographic content moderation.'."\n" - .'* **terrorism**: terrorist content moderation.'."\n" - .'* **ad**: ad moderation.'."\n" - .'* **live**: undesirable scene moderation.'."\n" - .'* **logo**: logo moderation.'."\n", - 'type' => 'string', - 'example' => 'porn', - ], - 'Rate' => [ - 'description' => 'The score. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'NextPageToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'ea04afcca7cd4e80b9ece8fbb251', - ], - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detailed moderation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Suggestion' => [ - 'description' => 'The recommended subsequent operation. Valid values:'."\n" - ."\n" - .'* **pass**: The content passes the moderation.'."\n" - .'* **review**: The content needs to be manually reviewed.'."\n" - .'* **block**: The content needs to be blocked.'."\n", - 'type' => 'string', - 'example' => 'pass', - ], - '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" - .' * **sexy**: sexy content.'."\n" - .' * **porn**: pornographic content.'."\n" - ."\n" - .'* Valid values in the terrorist content moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **bloody**: bloody content.'."\n" - .' * **explosion**: explosion and smoke.'."\n" - .' * **outfit**: special costume.'."\n" - .' * **logo**: special logo.'."\n" - .' * **weapon**: weapon.'."\n" - .' * **politics**: political content.'."\n" - .' * **violence**: violence.'."\n" - .' * **crowd**: crowd.'."\n" - .' * **parade**: parade.'."\n" - .' * **carcrash**: car accident.'."\n" - .' * **flag**: flag.'."\n" - .' * **location**: landmark.'."\n" - .' * **others**: other content.'."\n" - ."\n" - .'* Valid values in the ad moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **ad**: other ads.'."\n" - .' * **politics**: political content in text.'."\n" - .' * **porn**: pornographic content in text.'."\n" - .' * **abuse**: abuse in text.'."\n" - .' * **terrorism**: terrorist content in text.'."\n" - .' * **contraband**: prohibited content in text.'."\n" - .' * **spam**: spam in text.'."\n" - .' * **npx**: illegal ad.'."\n" - .' * **qrcode**: QR code.'."\n" - .' * **programCode**: mini program code.'."\n" - ."\n" - .'* Valid values in the undesirable scene moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **meaningless**: meaningless content, such as a black or white screen.'."\n" - .' * **PIP**: picture-in-picture.'."\n" - .' * **smoking**: smoking.'."\n" - .' * **drivelive**: live streaming in a running vehicle.'."\n" - ."\n" - .'* Valid values in the logo moderation scenario:'."\n" - ."\n" - .' * **normal**: normal content.'."\n" - .' * **TV**: controlled logo.'."\n" - .' * **trademark**: trademark.'."\n", - 'type' => 'string', - 'example' => 'meaningless', - ], - 'Scene' => [ - 'description' => 'The moderation scenario. Valid values:'."\n" - ."\n" - .'* **porn**: pornographic content moderation.'."\n" - .'* **terrorism**: terrorist content moderation.'."\n" - .'* **ad**: ad moderation.'."\n" - .'* **live**: undesirable scene moderation.'."\n" - .'* **logo**: logo moderation.'."\n", - 'type' => 'string', - 'example' => 'ad', - ], - 'Rate' => [ - 'description' => 'The score. Valid values: 0 to 100.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], - ], - 'PipelineId' => [ - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****'."\n", - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B'."\n", - ], - '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.'."\n", - 'type' => 'string', - 'example' => '9b1a42bc6e8d46e6a1383b7e7f01****'."\n", - ], - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '78dc866518b843259669df58ed30****'."\n", - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], + 'example' => '', ], ], ], - '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"}]', - 'title' => 'QueryMediaCensorJobList', - 'summary' => 'Queries a list of content moderation jobs.', - 'description' => 'You can call this operation to query only the content moderation jobs within the most recent three months.'."\n", - ], - 'CreateCustomTemplate' => [ - 'summary' => 'Creates a custom media processing template.', - 'methods' => [ - 'post', - 'get', + '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' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -18436,193 +12379,66 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-template', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'title' => '模板类型。', - 'description' => 'The template type. Valid values:'."\n" - ."\n" - .'* 1: transcoding template.'."\n" - .'* 2: snapshot template.'."\n" - .'* 3: animated image template.'."\n" - .'* 4\\. image watermark template.'."\n" - .'* 5: text watermark template.'."\n" - .'* 6: subtitle template.'."\n" - .'* 7: AI-assisted content moderation template.'."\n" - .'* 8: AI-assisted intelligent thumbnail template.'."\n" - .'* 9: AI-assisted intelligent erasure template.'."\n" - .'* 10: AI-assisted media fingerprint analysis template.'."\n" - .'* 11: AI-assisted smart tagging template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Subtype', - 'in' => 'query', - 'schema' => [ - 'title' => '模板子类型。', - 'description' => 'The template subtype.'."\n" - ."\n" - .'Valid values for transcoding templates:'."\n" - ."\n" - .'* 1 (Normal): regular template.'."\n" - .'* 2 (AudioTranscode): audio transcoding template.'."\n" - .'* 3 (Remux): container format conversion template.'."\n" - .'* 4 (NarrowBandV1): Narrowband HD 1.0 template.'."\n" - .'* 5 (NarrowBandV2): Narrowband HD 2.0 template.'."\n" - ."\n" - .'Valid values for snapshot templates:'."\n" - ."\n" - .'* 1 (Normal): regular template.'."\n" - .'* 2 (Sprite): sprite template.'."\n" - .'* 3 (WebVtt): WebVTT template.'."\n" - ."\n" - .'Valid values for AI-assisted content moderation templates:'."\n" - ."\n" - .'* 1 (Video): video moderation template.'."\n" - .'* 2 (Audio): audio moderation template.'."\n" - .'* 3 (Image): image moderation template.'."\n" - ."\n" - .'Valid values for AI-assisted intelligent erasure templates.'."\n" - ."\n" - .'* 1 (VideoDelogo): logo erasure template.'."\n" - .'* 2 (VideoDetext): subtitle erasure template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'TemplateConfig', + 'name' => 'JobId', 'in' => 'query', 'schema' => [ - 'title' => '模板参数', - 'description' => 'The template configurations. For more information, see [Template parameters](~~448291~~).'."\n", + 'description' => 'The ID of the transcoding job.', 'type' => 'string', 'required' => true, - 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}', + 'enum' => [], + 'title' => '', + 'example' => '****20b48fb04483915d4f2cd8ac****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'CustomTemplate' => [ - 'title' => '模板信息', - 'description' => 'The template information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => 'test-template', - ], - 'Type' => [ - 'title' => '模板类型ID', - 'description' => 'The type ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TypeName' => [ - 'title' => '模板类型名称', - 'description' => 'The type name of the template.'."\n", - 'type' => 'string', - 'example' => 'TranscodeTemplate', - ], - 'Subtype' => [ - 'title' => '模板子类型名称', - 'description' => 'The subtype name of the template.'."\n", - 'type' => 'string', - 'example' => 'Remux', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'IsDefault' => [ - 'title' => '是否默认模板', - 'description' => 'Indicates whether the template is the default template.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TemplateConfig' => [ - 'title' => '模板参数', - 'description' => 'The template configurations.'."\n", - 'type' => 'string', - 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}', - ], - 'CreateTime' => [ - 'title' => '模板创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-04-19T02:04:31Z', - ], - 'ModifiedTime' => [ - 'title' => '模板修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-04-19T02:04:31Z', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], + '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', - ], - 'GetSystemTemplate' => [ - 'summary' => 'Queries the information about a system template.', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ @@ -18630,443 +12446,362 @@ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", + '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, - 'example' => 'S00000001-100060', + 'enum' => [], + 'title' => '', + 'example' => '****d80e4e4044975745c14b****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'SystemTemplate' => [ - 'title' => '模板信息', - 'description' => 'The template information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => 'S00000001-100060', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => 'M3U8-2K', - ], - 'Type' => [ - 'title' => '模板类型ID', - 'description' => 'The type ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TypeName' => [ - 'title' => '模板类型名称', - 'description' => 'The type name of the template.'."\n", - 'type' => 'string', - 'example' => 'TranscodeTemplate', - ], - 'Subtype' => [ - 'title' => '模板子类型ID', - 'description' => 'The subtype ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SubtypeName' => [ - 'title' => '模板子类型名称', - 'description' => 'The subtype name of the template.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TemplateConfig' => [ - 'title' => '模板参数', - 'description' => 'The template parameters.'."\n", - 'type' => 'string', - '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}}', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], + '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', - ], - 'GetCustomTemplate' => [ - 'summary' => 'Queries the information about a custom template.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceEO4QPO', - ], + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the template type that is used to query the default template. This parameter is required if TemplateId is not specified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Subtype', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The template subtype.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'CustomTemplate' => [ - 'title' => '模板信息', - 'description' => 'The template information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '测试转码模板', - ], - 'Type' => [ - 'title' => '模板类型ID', - 'description' => 'The type ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TypeName' => [ - 'title' => '模板类型名称', - 'description' => 'The type name of the template.'."\n", - 'type' => 'string', - 'example' => 'SnapshotTemplate', - ], - 'Subtype' => [ - 'title' => '模板子类型ID', - 'description' => 'The subtype ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SubtypeName' => [ - 'title' => '模板子类型名称', - 'description' => 'The subtype name of the template.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'IsDefault' => [ - 'title' => '是否默认模板', - 'description' => 'Indicates whether the template is the default template.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TemplateConfig' => [ - 'title' => '模板参数', - 'description' => 'The template parameters.'."\n", - 'type' => 'string', - 'example' => '{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}', - ], - 'CreateTime' => [ - 'title' => '模板创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-01T10:00:00Z', - ], - 'ModifiedTime' => [ - 'title' => '模板修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-01-01T11:00:00Z'."\n", - ], - 'FrontendHint' => [ - 'type' => 'object', - 'properties' => [ - 'TranscodeTemplateHint' => [ - 'type' => 'object', - 'properties' => [ - 'BitrateControlType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"CustomTemplate\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateName\\": \\"测试截图模板\\",\\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"}]', - 'title' => 'GetCustomTemplate', - 'description' => 'You can call this operation to query the information about a template with the ID specified by the TemplateId parameter. You can also query the information about the default template. If TemplateId is specified, other parameters are ignored and the template whose ID is specified is queried. If TemplateId is not specified, the default template is queried based on other parameters. In this case, Type is required.'."\n" - ."\n" - .'Template types:'."\n" - ."\n" - .'1. 1: transcoding template.'."\n" - .'2. 2: snapshot template.'."\n" - .'3. 3: animated image template.'."\n" - .'4. 4\\. image watermark template.'."\n" - .'5. 5: text watermark template.'."\n" - .'6. 6: subtitle template.'."\n" - .'7. 7: AI-assisted content moderation template.'."\n" - .'8. 8: AI-assisted intelligent thumbnail template.'."\n" - .'9. 9: AI-assisted intelligent erasure template.'."\n" - ."\n" - .'Subtypes of transcoding templates:'."\n" - ."\n" - .'1. 1 (Normal): regular template.'."\n" - .'2. 2 (AudioTranscode): audio transcoding template.'."\n" - .'3. 3 (Remux): container format conversion template.'."\n" - .'4. 4 (NarrowBandV1): Narrowband HD 1.0 template.'."\n" - .'5. 5 (NarrowBandV2): Narrowband HD 2.0 template.'."\n" - ."\n" - .'Subtypes of snapshot templates:'."\n" - ."\n" - .'1. 1 (Normal): regular template.'."\n" - .'2. 2 (Sprite): sprite template.'."\n" - .'3. 3 (WebVtt): WebVTT template.'."\n" - ."\n" - .'Subtypes of AI-assisted content moderation templates:'."\n" - ."\n" - .'1. 1 (Video): video moderation template.'."\n" - .'2. 2 (Audio): audio moderation template.'."\n" - .'3. 3 (Image): image moderation template.'."\n" + '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" - .'Subtypes of AI-assisted intelligent erasure templates:'."\n" + .'- When a flow is deleted, its source and outputs are also deleted.'."\n" ."\n" - .'1. 1 (VideoDelogo): logo erasure template.'."\n" - .'2. 2 (VideoDetext): subtitle erasure template.'."\n", - ], - 'SetDefaultCustomTemplate' => [ - 'summary' => 'Sets a custom template as the default template.', - 'methods' => [ - 'post', - 'get', + .'- 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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****d80e4e4044975745c14b****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'SetDefaultCustomTemplate', - ], - 'UpdateCustomTemplate' => [ - 'summary' => 'Updates a custom template.', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], + 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ - 'name' => 'Name', + '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 template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-template', + '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' => [ [ - 'name' => 'TemplateConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '模板参数', - 'description' => 'The [template parameters](~~448291~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"param": "sample"}', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateCustomTemplate', - ], - 'DeleteCustomTemplate' => [ - 'summary' => 'Deletes a custom template.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -19077,563 +12812,414 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'MediaIds', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The ID of the custom template.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => '', ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + '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\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteCustomTemplate', - ], - 'ListSystemTemplates' => [ - 'summary' => 'Queries a list of system templates.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceHPAMBQ', - ], + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'title' => '模板类型。逗号分隔', - 'description' => 'The template type. Separate multiple types with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1,2', - ], - ], - [ - 'name' => 'Subtype', - 'in' => 'query', - 'schema' => [ - 'title' => '模板子类型ID', - 'description' => 'The subtype ID of the template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], - [ - 'name' => 'Name', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SampleTemplate', + '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' => '', ], ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****', - ], + ], + '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' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '模板状态：Normal正常，Invisible不可见，ALL全部', - 'description' => 'The template state. Valid values: Normal, Invisible, and All.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', + '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' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页数目', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page. Default value: 20 Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'InputId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Total' => [ - 'title' => '模板总数', - 'description' => 'The total number of templates.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'SystemTemplateList' => [ - 'title' => '模板信息列表', - 'description' => 'The queried templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the system template.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => 'S00000001-000000', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => 'FLV-COPY', - ], - 'Type' => [ - 'title' => '模板类型ID', - 'description' => 'The type ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TypeName' => [ - 'title' => '模板类型名称', - 'description' => 'The type name of the template.'."\n", - 'type' => 'string', - 'example' => 'TranscodeTemplate', - ], - 'Subtype' => [ - 'title' => '模板子类型ID', - 'description' => 'The subtype ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SubtypeName' => [ - 'title' => '模板子类型名称', - 'description' => 'The subtype name of the template.'."\n", - 'type' => 'string', - 'example' => 'Remux', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TemplateConfig' => [ - 'title' => '模板参数', - 'description' => 'The template parameters.'."\n", - 'type' => 'string', - 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], + 'example' => '', ], ], ], - '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"}]', - 'title' => 'ListSystemTemplates', - 'description' => 'Template types:'."\n" - ."\n" - .'1. 1: transcoding template.'."\n" - .'2. 2: snapshot template.'."\n" - .'3. 3: animated image template.'."\n" - .'4. 4\\. image watermark template.'."\n" - .'5. 5: text watermark template.'."\n" - .'6. 6: subtitle template.'."\n" - .'7. 7: AI-assisted content moderation template.'."\n" - .'8. 8: AI-assisted intelligent thumbnail template.'."\n" - .'9. 9: AI-assisted intelligent erasure template.'."\n" - ."\n" - .'Subtypes of transcoding templates:'."\n" - ."\n" - .'1. 1 (Normal): regular template.'."\n" - .'2. 2 (AudioTranscode): audio transcoding template.'."\n" - .'3. 3 (Remux): container format conversion template.'."\n" - .'4. 4 (NarrowBandV1): Narrowband HD 1.0 template.'."\n" - .'5. 5 (NarrowBandV2): Narrowband HD 2.0 template.'."\n" - ."\n" - .'Subtypes of snapshot templates:'."\n" - ."\n" - .'1. 1 (Normal): regular template.'."\n" - .'2. 2 (Sprite): sprite template.'."\n" - .'3. 3 (WebVtt): WebVTT template.'."\n" - ."\n" - .'Subtypes of AI-assisted content moderation templates:'."\n" - ."\n" - .'1. 1 (Video): video moderation template.'."\n" - .'2. 2 (Audio): audio moderation template.'."\n" - .'3. 3 (Image): image moderation template.'."\n" + '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" - .'Subtypes of AI-assisted intelligent erasure templates:'."\n" + .'## QPS limit'."\n" ."\n" - .'1. 1 (VideoDelogo): logo erasure template.'."\n" - .'2. 2 (VideoDetext): subtitle erasure template.'."\n", - ], - 'ListCustomTemplates' => [ - 'summary' => 'Queries a list of custom templates.', - 'methods' => [ - 'post', - 'get', + .'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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceEO4QPO', - ], + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', + 'name' => 'SecurityGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模板类型。逗号分隔', - 'description' => 'The template type. Valid values:'."\n" - ."\n" - .'* 1: transcoding template.'."\n" - .'* 2: snapshot template.'."\n" - .'* 3: animated image template.'."\n" - .'* 4\\. image watermark template.'."\n" - .'* 5: text watermark template.'."\n" - .'* 6: subtitle template.'."\n" - .'* 7: AI-assisted content moderation template.'."\n" - .'* 8: AI-assisted intelligent thumbnail template.'."\n" - .'* 9: AI-assisted intelligent erasure template.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', + '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' => [ [ - 'name' => 'Subtype', - 'in' => 'query', - 'schema' => [ - 'title' => '模板子类型ID', - 'description' => 'The subtype ID of the template.'."\n" - ."\n" - .'* Valid values for transcoding templates:'."\n" - ."\n" - .' * 1 (Normal): regular template.'."\n" - .' * 2 (AudioTranscode): audio transcoding template.'."\n" - .' * 3 (Remux): container format conversion template.'."\n" - .' * 4 (NarrowBandV1): Narrowband HD 1.0 template.'."\n" - .' * 5 (NarrowBandV2): Narrowband HD 2.0 template.'."\n" - ."\n" - .'* Valid values for snapshot templates:'."\n" - ."\n" - .' * 1 (Normal): regular template.'."\n" - .' * 2 (Sprite): sprite template.'."\n" - .' * 3 (WebVtt): WebVTT template.'."\n" - ."\n" - .'* Valid values for AI-assisted content moderation templates:'."\n" - ."\n" - .' * 1 (Video): video moderation template.'."\n" - .' * 2 (Audio): audio moderation template.'."\n" - .' * 3 (Image): image moderation template.'."\n" - ."\n" - .'* Valid values for AI-assisted intelligent erasure templates:'."\n" - ."\n" - .' * 1 (VideoDelogo): logo erasure template.'."\n" - .' * 2 (VideoDetext): subtitle erasure template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', + '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' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-template', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '****c469e944b5a856828dc2****', 'title' => ''], ], [ - 'name' => 'PageNumber', + '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 page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + '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' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + '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' => [ [ - 'name' => 'OrderBy', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PipelineId', 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序：CreateTimeDesc 和 CreateTimeAsc', - 'description' => 'The order in which the entries are sorted. Valid values:'."\n" - ."\n" - .'* CreateTimeDesc: sorted by creation time in descending order.'."\n" - .'* CreateTimeAsc: sorted by creation time in ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CreateTimeDesc', - ], + 'schema' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Total' => [ - 'title' => '模板总数', - 'description' => 'The total number of templates.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'CustomTemplateList' => [ - 'title' => '模板信息列表', - 'description' => 'The queried templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the custom template.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => 'test-template', - ], - 'Type' => [ - 'title' => '模板类型ID', - 'description' => 'The type ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TypeName' => [ - 'title' => '模板类型名称', - 'description' => 'The type name of the template.'."\n", - 'type' => 'string', - 'example' => 'TranscodeTemplate', - ], - 'Subtype' => [ - 'title' => '模板子类型ID', - 'description' => 'The subtype ID of the template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'SubtypeName' => [ - 'title' => '模板子类型名称', - 'description' => 'The subtype name of the template.'."\n", - 'type' => 'string', - 'example' => 'AudioTranscode', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Normal' => 'Normal', - ], - 'example' => 'Normal', - ], - 'IsDefault' => [ - 'title' => '是否默认模板', - 'description' => 'Indicates whether the template is the default template.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], - 'TemplateConfig' => [ - 'title' => '模板参数', - 'description' => 'The template parameters.'."\n", - 'type' => 'string', - 'example' => '{"Container":{"Format":"mp3"},"Audio":{"Codec":"mp3","Bitrate":"64","Samplerate":"22050","Channels":"2"}}', - ], - 'CreateTime' => [ - 'title' => '模板创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'ModifiedTime' => [ - 'title' => '模板修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'FrontendHint' => [ - 'type' => 'object', - 'properties' => [ - 'TranscodeTemplateHint' => [ - 'type' => 'object', - 'properties' => [ - 'BitrateControlType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], + '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 \\"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"}]', - 'title' => 'ListCustomTemplates', - ], - 'CreatePipeline' => [ - 'summary' => 'Creates an ApsaraVideo Media Processing (MPS) queue.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -19641,273 +13227,154 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'title' => '管道名称', - 'description' => 'The name of the MPS queue.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-pipeline', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '1d3518e0027d71ed80cd909598416303', 'title' => ''], ], [ - 'name' => 'Speed', + 'name' => 'FileURLs', 'in' => 'query', - 'schema' => [ - 'title' => '管道类型。', - 'description' => 'The type of the MPS queue. Valid values:'."\n" - ."\n" - .'1. Standard: standard MPS queue.'."\n" - .'2. Boost: MPS queue with transcoding speed boosted.'."\n" - .'3. NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Boost' => '', - 'Standard' => '', - 'NarrowBandHDV2' => '', - ], - 'example' => 'Standard', - ], + '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' => 'Priority', + 'name' => 'DeletePhysicalFiles', 'in' => 'query', - 'schema' => [ - 'title' => '优先级，1-10，默认6。数值越大，优先级越高', - 'description' => 'The priority. Default value: 6. Valid values: 1 to 10. A greater value specifies a higher priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => '', ], - 'Pipeline' => [ - 'title' => '管道信息', - 'description' => 'The information about the MPS queue.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道Id', - 'description' => 'The ID of the MPS queue.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Name' => [ - 'title' => '管道名称', - 'description' => 'The name of the MPS queue.'."\n", - 'type' => 'string', - 'example' => 'test-pipeline', - ], - 'Speed' => [ - 'title' => '管道类型', - 'description' => 'The type of the MPS queue.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Boost: MPS queue with transcoding speed boosted.'."\n" - .'* Standard: standard MPS queue.'."\n" - .'* NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Boost' => '', - 'Standard' => '', - 'NarrowBandHDV2' => '', - ], - 'example' => 'Standard', - ], - 'Priority' => [ - 'title' => '管道优先级', - 'description' => 'The priority of the MPS queue.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Status' => [ - 'title' => '管道状态', - 'description' => 'The state of the MPS queue.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Active'."\n" - .'* Paused'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Active' => '', - 'Paused' => '', - ], - 'example' => 'Active', - ], - 'CreateTime' => [ - 'title' => '模板创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'ModifiedTime' => [ - 'title' => '模板修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - ], + '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 \\"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', - ], - 'GetPipeline' => [ - 'summary' => 'Queries the information about an ApsaraVideo Media Processing (MPS) queue.', - 'methods' => [ - 'get', - 'post', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'PipelineId', + 'name' => 'ProgramName', 'in' => 'query', - 'schema' => [ - 'title' => '管道ID', - 'description' => 'The ID of the MPS queue.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Pipeline' => [ - 'title' => '管道信息', - 'description' => 'The information about the MPS queue.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道Id', - 'description' => 'The ID of the MPS queue.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Name' => [ - 'title' => '管道名称', - 'description' => 'The name of the MPS queue.'."\n", - 'type' => 'string', - 'example' => 'test-pipeline', - ], - 'Speed' => [ - 'title' => '管道类型', - 'description' => 'The type of the MPS queue.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Standard: standard MPS queue.'."\n" - .'* Boost: MPS queue with transcoding speed boosted.'."\n" - .'* NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Speed' => '', - 'Boost' => '', - 'NarrowBandHDV2' => '', - ], - 'example' => 'Standard', - ], - 'Priority' => [ - 'title' => '管道优先级', - 'description' => 'The priority of the MPS queue. Valid values: 1 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Status' => [ - 'title' => '管道状态', - 'description' => 'The state of the MPS queue.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Active'."\n" - .'* Paused'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Active' => '', - 'Paused' => '', - ], - 'example' => 'Active', - ], - 'CreateTime' => [ - 'title' => '模板创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'ModifiedTime' => [ - 'title' => '模板修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - ], - ], + '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' => '', ], ], ], - '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', - ], - 'UpdatePipeline' => [ - 'summary' => 'Updates the information about an ApsaraVideo Media Processing (MPS) queue.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteProgram', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -19915,99 +13382,172 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], 'parameters' => [ [ - 'name' => 'PipelineId', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'title' => '管道ID', - 'description' => 'The ID of the MPS queue.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****d80e4e4044975745c14b****', - ], + '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' => 'Name', + 'name' => 'LibId', 'in' => 'query', - 'schema' => [ - 'title' => '管道名称', - 'description' => 'The name of the MPS queue.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-pipeline', - ], + 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*************24b47865c6**************', 'title' => ''], ], [ - 'name' => 'Status', + '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' => [ - 'title' => '管道状态。', - 'description' => 'The state of the MPS queue.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Active'."\n" - .'* Paused'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Active' => '', - 'Paused' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], - 'example' => 'Paused', + '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' => [ [ - 'name' => 'Priority', - 'in' => 'query', - 'schema' => [ - 'title' => '优先级', - 'description' => 'The priority of the MPS queue. Valid values: 1 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdatePipeline', - ], - 'DeletePipeline' => [ - 'summary' => 'Deletes an ApsaraVideo Media Processing (MPS) queue.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -20015,6119 +13555,1042 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], 'parameters' => [ [ - 'name' => 'PipelineId', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'title' => '管道ID', - 'description' => 'The ID of the MPS queue.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeletePipeline', - ], - 'ListPipelines' => [ - 'summary' => 'Queries a list of ApsaraVideo Media Processing (MPS) queues.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Speed', + '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 type of the MPS queue.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Boost: MPS queue with transcoding speed boosted.'."\n" - .'* Standard: standard MPS queue.'."\n" - .'* NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Boost' => '', - 'Standard' => '', - 'NarrowBandHDV2' => '', + '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' => '*'], ], - 'example' => 'Standard', ], ], ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'PipelineList' => [ - 'description' => 'The queried MPS queues.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the MPS queue.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道Id', - 'description' => 'The ID of the MPS queue.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Name' => [ - 'title' => '管道名称', - 'description' => 'The name of the MPS queue.'."\n", - 'type' => 'string', - 'example' => 'test-pipeline', - ], - 'Speed' => [ - 'title' => '管道类型', - 'description' => 'The type of the MPS queue.'."\n", - 'type' => 'string', - 'example' => 'Standard', - ], - 'Priority' => [ - 'title' => '管道优先级', - 'description' => 'The priority of the MPS queue.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Status' => [ - 'title' => '管道状态', - 'description' => 'The state of the MPS queue.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Active'."\n" - .'* Paused'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Active' => '', - 'Paused' => '', - ], - 'example' => 'Active', - ], - 'CreateTime' => [ - 'title' => '模板创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'ModifiedTime' => [ - 'title' => '模板修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - ], - ], - ], + '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' => '', ], ], ], - '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', - ], - 'SubmitTranscodeJob' => [ - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteSource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '任务名字。', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'job-name', - ], + 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ - 'name' => 'InputGroup', + 'name' => 'SoftDelete', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'Specifies whether to use delete markers.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => '任务输入组 (目前只支持一个)。', - 'description' => 'The input group of the job. An input of a single file indicates a transcoding job. An input of multiple files indicates an audio and video stream merge job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the Intelligent Media Services (IMS) console.'."\n" - ."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'InputUrl' => [ - 'title' => '输入流路径： 仅当 type 为 Media 是才生效，让用户可以选择该媒资下的特定文件作为输入。 - 系统会检查该媒资下是否存在这个 inputUrl。', - 'description' => 'The URL of the input stream.'."\n" - ."\n" - .'* This parameter takes effect only when Type is set to Media. You can select a specific file within the media asset as an input.'."\n" - .'* The system checks whether the input URL exists within the media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - 'required' => true, + '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' => '*'], ], - 'required' => true, - 'example' => 'job-name', ], ], + ], + 'translator' => 'manual', + ], + 'DeleteTemplate' => [ + 'summary' => 'Deletes templates.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OutputGroup', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateIds', 'in' => 'query', - 'style' => 'json', + '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 output group of the job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出媒体配置', - 'description' => 'The output file configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the IMS console.'."\n" - ."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'OutputUrl' => [ - 'title' => '输入流路径： 仅当 Type 为 Media时才生效，让用户可以选择该媒资下特定文件作为输出。 支持的占位符： - {MediaId}：媒资ID。 - {JobId}：转码子任务ID。 - {ExtName}：文件后缀，取转码模板的输出格式。 - {DestMd5}：转码输出文件的MD5值。 说明： 1、该参数必须包含{MediaId} 和 {JobId} 两个占位符。 2、输出的Bucket与MediaId所在Bucket相同。', - 'description' => 'The URL of the output stream.\\'."\n" - .'This parameter takes effect only when Type is set to Media. You can select a specific file within the media asset as an output.\\'."\n" - .'Supported placeholders:'."\n" - ."\n" - .'* {MediaId}: the ID of the media asset.'."\n" - .'* {JobId}: the ID of the transcoding subjob.'."\n" - .'* {MediaBucket}: the bucket to which the media asset belongs.'."\n" - .'* {ExtName}: the file suffix, which uses the output format of the transcoding template.'."\n" - .'* {DestMd5}: the MD5 value of the transcoded output file.\\'."\n" - .' Notes:'."\n" - ."\n" - .'1. This parameter must contain the {MediaId} and {JobId} placeholders.'."\n" - .'2. The output bucket is the same as the bucket to which the media asset belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4', - ], - ], - 'required' => true, - ], - 'ProcessConfig' => [ - 'title' => '任务处理配置', - 'description' => 'The job processing configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Transcode' => [ - 'title' => '转码配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Video' => [ - 'title' => 'video 设置', - 'description' => 'The video settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '编码格式', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'H.264', - ], - 'Profile' => [ - 'title' => '编码级别。'."\n" - .' 支持baseline、main、high。'."\n" - .' baseline：针对移动设备。'."\n" - .' main：针对标准分辨率设备。'."\n" - .' high：针对高分辨率设备。'."\n" - .' 默认值：high。', - 'description' => 'The encoding profile. Valid values: baseline, main, and high.'."\n" - ."\n" - .'* baseline: applicable to mobile devices.'."\n" - .'* main: applicable to standard-definition devices.'."\n" - .'* high: applicable to high-definition devices.'."\n" - ."\n" - .'Default value: high.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Main', - ], - 'Bitrate' => [ - 'title' => '视频平均码率。'."\n" - .' 取值范围：[10，50000]。'."\n" - .' 单位：Kbps。', - 'description' => 'The average video bitrate. Valid values: \\[10,50000]. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3000', - ], - 'Crf' => [ - 'title' => '码率-质量控制因子。'."\n" - .' 取值范围：[0，51]。'."\n" - .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" - .' 如果设置了Crf，则Bitrate的设置失效。', - 'description' => 'The constant rate factor (CRF). Valid values: \\[0,51]. Default value: 23 if the encoding format is H.264, or 26 if the encoding format is H.265.'."\n" - ."\n" - .'> If this parameter is specified, the setting of the bitrate becomes invalid.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '23', - ], - 'Width' => [ - 'title' => '宽。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始宽度。', - 'description' => 'The width of the video. Valid values: \\[128,4096]. Unit: pixels. Default value: the original width of the video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始高度。', - 'description' => 'The height of the video. Valid values: \\[128,4096]. Unit: pixels. Default value: the original height of the video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1080', - ], - 'Fps' => [ - 'title' => '帧率。'."\n" - .' 取值范围：(0,60]。'."\n" - .' 当输入文件帧率超过60时取60。'."\n" - .' 默认值：取输入文件帧率', - 'description' => 'The frame rate. Valid values:(0,60]. Default value: the frame rate of the input file.'."\n" - ."\n" - .'> The value is 60 if the frame rate of the input file exceeds 60.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '25', - ], - 'Gop' => [ - 'title' => '关键帧间最大帧数。'."\n" - .' 取值范围：[1，1080000]。'."\n" - .' 默认值：250。', - 'description' => 'The maximum number of frames between keyframes. Valid values: \\[1,1080000]. Default value: 250.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '250', - ], - 'Preset' => [ - 'title' => '视频算法器预置。只有H264支持该参数。'."\n" - .'支持veryfast、fast、medium、slow、slower。'."\n" - .'默认值：medium。', - 'description' => 'The preset video algorithm. This parameter takes effect only if the encoding format is H.264. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'medium', - ], - 'ScanMode' => [ - 'title' => '扫描模式。'."\n" - .'支持interlaced、progressive。', - 'description' => 'The scan mode. Valid values: interlaced and progressive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'progressive', - ], - 'PixFmt' => [ - 'title' => '视频颜色格式。'."\n" - .' 范围：yuv420p，yuvj420p等标准颜色格式。', - 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'yuv420p', - ], - 'Remove' => [ - 'title' => '是否去掉视频', - 'description' => 'Specifies whether to remove the video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'Crop' => [ - 'title' => '视频画面裁切'."\n" - .' 支持2种方式。'."\n" - .' 自动检测黑边并裁切，设置为“border”'."\n" - .' 自定义裁切，参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The method of video cropping. Valid values:'."\n" - ."\n" - .'* border: automatically detects and removes black bars.'."\n" - .'* A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1280:800:0:140', - ], - 'Pad' => [ - 'title' => '视频贴黑边'."\n" - .' 参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The black bars added to the video. Format: width:height:left:top. Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1280:800:0:140', - ], - 'LongShortMode' => [ - 'title' => '是否开启横竖屏自适应（即：长短边模式）', - 'description' => 'Specifies whether to enable the auto-rotate screen feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'Bufsize' => [ - 'title' => '缓冲区大小'."\n" - .' 值范围：[1000，128000]'."\n" - .' 默认值：6000'."\n" - .' 单位：Kb', - 'description' => 'The buffer size. Valid values: \\[1000,128000]. Default value: 6000. Unit: KB.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6000', - ], - 'Maxrate' => [ - 'title' => '视频码率峰值'."\n" - .' 值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum bitrate of the video. Valid values: \\[10,50000]. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9000', - ], - 'AbrMax' => [ - 'title' => 'abr 最大码率(只有窄高1有效)'."\n" - .'值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum adaptive bitrate (ABR). This parameter takes effect only for Narrowband HD 1.0. Valid values: \\[10,50000]. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6000', - ], - ], - 'required' => false, - ], - 'Audio' => [ - 'title' => 'audio 设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" - .' 默认值：AAC', - 'description' => 'The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAC', - ], - 'Profile' => [ - 'title' => '音频编码预置。'."\n" - .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', - 'description' => 'The audio codec profile. If the Codec parameter is set to AAC, the valid values are aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aac_low', - ], - 'Samplerate' => [ - 'title' => '采样率。'."\n" - .' 默认值：44100'."\n" - .' 支持22050、32000、44100、48000、96000，'."\n" - .' 单位：Hz', - 'description' => 'The sampling rate. Valid values: 22050, 32000, 44100, 48000, and 96000. Default value: 44100. Unit: Hz.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '44100', - ], - 'Bitrate' => [ - 'title' => '输出文件的音频码率。'."\n" - .' 值范围：[8，1000]'."\n" - .' 单位：Kbps'."\n" - .' 默认值：128', - 'description' => 'The audio bitrate of the output file. Valid values: \\[8,1000]. Unit: Kbit/s. Default value: 128.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '128', - ], - 'Channels' => [ - 'title' => '声道数。'."\n" - .' 默认值：2', - 'description' => 'The number of sound channels. Default value: 2.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'Remove' => [ - 'title' => '是否删除音频流。', - 'description' => 'Specifies whether to delete the audio stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'Volume' => [ - 'title' => '音量控制', - 'description' => 'The volume configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => '音量调整方式', - 'description' => 'The volume adjustment method. Valid values:'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'auto', - ], - 'IntegratedLoudnessTarget' => [ - 'title' => '目标音量', - 'description' => 'The output volume.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-6', - ], - 'TruePeak' => [ - 'title' => '最大峰值', - 'description' => 'The peak volume.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-1', - ], - 'LoudnessRangeTarget' => [ - 'title' => '音量范围', - 'description' => 'The volume range.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Container' => [ - 'title' => '封装格式设置', - 'description' => 'The encapsulation format settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '容器格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mp4', - ], - ], - 'required' => false, - ], - 'MuxConfig' => [ - 'title' => '封装设置', - 'description' => 'The encapsulation settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Segment' => [ - 'title' => '切片设置', - 'description' => 'The segment settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Duration' => [ - 'title' => '切片时长', - 'description' => 'The segment length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'ForceSegTime' => [ - 'title' => '强制切片时间点', - 'description' => 'The forced segmentation point in time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2,3', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'TransConfig' => [ - 'description' => 'The conditional transcoding configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'TransMode' => [ - 'description' => 'The video transcoding mode. Valid values:'."\n" - ."\n" - .'* onepass: You can set this parameter to onepass if the Bitrate parameter is set to ABR. The encoding speed of this mode is faster than that of the twopass mode.'."\n" - .'* twopass: You can set this parameter to twopass if the Bitrate parameter is set to VBR. The encoding speed of this mode is slower than that of the onepass mode.'."\n" - .'* CBR: the constant bitrate mode.'."\n" - ."\n" - .'Default value: onepass.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'onepass', - ], - 'IsCheckReso' => [ - 'description' => 'Specifies whether to check the video resolution. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the width or height of the input video is less than that of the output video, the resolution of the input video is used for transcoding.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'IsCheckResoFail' => [ - 'description' => 'Specifies whether to check the video resolution. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the width or height of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'IsCheckVideoBitrate' => [ - 'description' => 'Specifies whether to check the video bitrate. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input video is less than that of the output video, the bitrate of the input video is used for transcoding.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'IsCheckVideoBitrateFail' => [ - 'description' => 'Specifies whether to check the video bitrate. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'IsCheckAudioBitrate' => [ - 'description' => 'Specifies whether to check the audio bitrate. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input audio is less than that of the output audio, the bitrate of the input audio is used for transcoding.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value:'."\n" - ."\n" - .'* If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" - .'* If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'IsCheckAudioBitrateFail' => [ - 'description' => 'Specifies whether to check the audio bitrate. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input audio is less than that of the output audio, the transcoding job fails.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'AdjDarMethod' => [ - 'description' => 'The method that is used to adjust 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" - ."\n" - .'Default value: none.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'none', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], - 'ImageWatermarks' => [ - 'title' => '图片水印配置', - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Width' => [ - 'title' => '输出视频上水印图片宽。'."\n" - .'值有两种形式：'."\n" - ."\n" - .'- 整数型代水印图片宽的像素值。'."\n" - .' - 范围：[8,4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', - 'description' => 'The width of the watermark in the output video. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the watermark width.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the watermark width to the width of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '32', - ], - 'Height' => [ - 'title' => '输出视频上水印图片高。'."\n" - .'值有两种形式：'."\n" - ."\n" - .'- 整数型代水印图片高的像素值。'."\n" - .' - 范围：[8,4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表相对输出视频分辨率高的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', - 'description' => 'The height of the watermark image in the output video. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the watermark height.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the watermark height to the height of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '32', - ], - 'Dx' => [ - 'title' => '水印图片相对输出视频的水平偏移量。'."\n" - .'默认值：0'."\n" - ."\n" - .'值有两种形式：'."\n" - .'- 整数型代表偏移像素。'."\n" - .' - 范围：[8，4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', - 'description' => 'The horizontal offset of the watermark relative to the output video. Default value: 0.'."\n" - ."\n" - .'The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the horizontal offset.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the horizontal offset to the width of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'Dy' => [ - 'title' => '水印图片相对输出视频的垂直偏移量。'."\n" - .'默认值：0'."\n" - ."\n" - .'值有两种形式：'."\n" - .'- 整数型代表偏移像素。'."\n" - .' - 范围[8，4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', - 'description' => 'The vertical offset of the watermark relative to the output video. Default value: 0.'."\n" - ."\n" - .'The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the horizontal offset.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the vertical offset to the height of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'ReferPos' => [ - 'title' => '水印的位置。'."\n" - .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" - .'- 默认值：TopRight', - 'description' => 'The position of the watermark.'."\n" - ."\n" - .'* Valid values: TopRight, TopLeft, BottomRight, and BottomLeft.'."\n" - .'* Default value: TopRight.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TopLeft', - ], - 'Timeline' => [ - 'title' => '动态水印，显示时间设置。', - 'description' => 'The time settings of the dynamic watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'title' => '水印开始出现时间。'."\n" - .'- 单位：秒'."\n" - .'- 取值范围：数字'."\n" - .'- 默认值：0', - 'description' => 'The beginning of the time range in which the watermark is displayed.'."\n" - ."\n" - .'* Unit: seconds.'."\n" - .'* Value values: integers.'."\n" - .'* Default value: 0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:05', - ], - 'Duration' => [ - 'title' => '水印持续时间。'."\n" - .'- 取值范围：[数字，ToEND]'."\n" - .'- 默认值：ToEND', - 'description' => 'The time range in which the watermark is displayed.'."\n" - ."\n" - .'* Valid values: integers and ToEND.'."\n" - .'* Default value: ToEND.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ToEND', - ], - ], - 'required' => false, - ], - 'File' => [ - 'title' => '水印图片文件。', - 'description' => 'The watermark image file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TextWatermarks' => [ - 'title' => '文字水印配置', - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', - 'description' => 'The watermark text. Base64 encoding is not required. The string must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '测试水印', - ], - 'FontName' => [ - 'title' => '字体。默认：SimSun。', - 'description' => 'The font of the text. Default value: SimSun.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SimSun', - ], - 'FontColor' => [ - 'title' => '颜色。', - 'description' => 'The color of the text.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '#006400', - ], - 'FontAlpha' => [ - 'title' => '字体透明度。'."\n" - .'- 范围：(0, 1]'."\n" - .'- 默认：1.0', - 'description' => 'The transparency of the text.'."\n" - ."\n" - .'* Valid values: (0,1].'."\n" - .'* Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], - 'Top' => [ - 'title' => '文本上边距。'."\n" - .'- 默认：0'."\n" - .'- 范围：[0,4096]'."\n", - 'description' => 'The top margin of the text.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: \\[0,4096].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'Left' => [ - 'title' => '文本左边距。'."\n" - .'- 默认：0'."\n" - .'- 范围：[0,4096]', - 'description' => 'The left margin of the text watermark.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: \\[0,4096].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'FontSize' => [ - 'title' => '字体大小。'."\n" - .'- 默认值：16'."\n" - .'- 范围：(4, 120)', - 'description' => 'The size of the text.'."\n" - ."\n" - .'* Default value: 16.'."\n" - .'* Valid values: (4,120).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - ], - 'BorderWidth' => [ - 'title' => '描边宽度。'."\n" - .'- 默认：0'."\n" - .'- 范围：(0,4096]', - 'description' => 'The outline width of the text watermark.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: (0,4096].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'BorderColor' => [ - 'title' => '描边颜色。'."\n" - .'默认：Black'."\n" - .'更多取值请参见BorderColor。', - 'description' => 'The outline color of the text watermark. Default value: black. For more information, see BorderColor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '#006400', - ], - 'Adaptive' => [ - 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', - 'description' => 'Specifies whether to the font size based on the output video dimensions. true / false, default: false'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Subtitles' => [ - 'title' => '字幕压制配置', - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '字幕文件格式。', - 'description' => 'The format of the subtitle file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vtt', - ], - 'CharEnc' => [ - 'title' => '文件 encoding 格式。', - 'description' => 'The file encoding format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UTF-8', - ], - 'File' => [ - 'title' => '字幕文件。', - 'description' => 'The subtitle file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Encryption' => [ - 'title' => '加密配置。', - 'description' => 'The encryption settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'EncryptType' => [ - 'title' => '加密类型。', - 'description' => 'Specifies the encryption type. Valid values:'."\n" - ."\n" - .'* PrivateEncryption: Alibaba Cloud proprietary cryptography'."\n" - .'* HLSEncryption: HTTP Live Streaming (HLS) encryption'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PrivateEncryption', - ], - 'CipherText' => [ - 'title' => '标准加密的密钥密文。', - 'description' => 'The ciphertext of HTTP Live Streaming (HLS) encryption.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MTYi00NDU0LTg5O****', - ], - 'DecryptKeyUri' => [ - 'title' => '标准加密的解密服务地址。', - 'description' => 'The address of the decryption service for HLS encryption.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', - ], - 'KeyServiceType' => [ - 'title' => '密钥服务类型。目前仅支持KMS和Base64', - 'description' => 'The key service type for HLS encryption. Valid values:'."\n" - ."\n" - .'* KMS'."\n" - .'* Base64'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KMS', - ], - ], - 'required' => false, - ], - 'CombineConfigs' => [ - 'title' => '多输入合流配置', - 'description' => 'The multi-input stream merge configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The stream merge configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'AudioIndex' => [ - 'title' => '音频流Index', - 'description' => 'The audio stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'VideoIndex' => [ - 'title' => '视频流Index', - 'description' => 'The video stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'Start' => [ - 'title' => '输入流的开始时间。 默认为0', - 'description' => 'The start time of the input stream. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.0', - ], - 'Duration' => [ - 'title' => '输入流的持续时间。 默认为视频时长。', - 'description' => 'The duration of the input stream. The default value is the duration of the video.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '20.0', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - 'required' => true, + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], - 'required' => true, - 'example' => 'user-data', + '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' => [ [ - 'name' => 'UserData', + '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 custom settings. The value must be in the JSON format and can be up to 512 bytes in length. You can specify a [custom callback URL](~~451631~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user-data', + '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' => [ [ - 'name' => 'ScheduleConfig', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice20UKYV'], + ], + 'parameters' => [ + [ + 'name' => 'ConfigurationName', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The name of the packaging configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hls_3s'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '任务调度信息。', - 'description' => 'The scheduling information about the job.'."\n", + 'title' => '', + 'description' => 'The result of deletion.', 'type' => 'object', 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], - 'required' => false, - 'example' => 'job-name', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => 'DeleteVodPackagingConfiguration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ClientToken', + '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' => '幂等性校验Key。', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****', + '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' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'TranscodeParentJob' => [ - 'title' => 'TranscodeParentJobWithSubJobDTO', - 'description' => 'TranscodeParentJobWithSubJobDTO'."\n", - 'type' => 'object', - 'properties' => [ - 'TranscodeJobList' => [ - 'title' => '子任务列表', - 'description' => 'The list of subjobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the subjobs.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '任务创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'Name' => [ - 'title' => '任务名', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'transcode-job', - ], - 'ParentJobId' => [ - 'title' => '主任务 ID', - 'description' => 'The main job ID.'."\n", - 'type' => 'string', - 'example' => '8b2198504dd340b7b3c9842a74fc9baa', - ], - 'JobId' => [ - 'title' => '子任务 ID', - 'description' => 'The subjob ID.'."\n", - 'type' => 'string', - 'example' => '7d6a7e0d4db2457a8d45ff5d43e1bf0a', - ], - 'JobIndex' => [ - 'title' => '子任务在整个任务中的索引号', - 'description' => 'The index number of the subjob in the entire job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'InputGroup' => [ - 'title' => '任务输入组 (目前只支持单个输入)', - 'description' => 'The input group of the job. An input of a single file indicates a transcoding job. An input of multiple files indicates an audio and video stream merge job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the job input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'InputUrl' => [ - 'description' => 'The URL of the input stream:'."\n" - ."\n" - .'* This parameter takes effect only when Type is set to Media. You can select a specific file within the media asset as an input.'."\n" - .'* The system checks whether the input URL exists within the media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4'."\n", - ], - ], - ], - ], - 'ProcessConfig' => [ - 'title' => '转码处理配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Transcode' => [ - 'title' => '转码配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Video' => [ - 'title' => 'video 设置', - 'description' => 'The video settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '编码格式', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264', - ], - 'Profile' => [ - 'title' => '编码级别。'."\n" - .' 支持baseline、main、high。'."\n" - .' baseline：针对移动设备。'."\n" - .' main：针对标准分辨率设备。'."\n" - .' high：针对高分辨率设备。'."\n" - .' 默认值：high。', - 'description' => 'The encoding profile. Valid values: baseline, main, and high.'."\n" - ."\n" - .'* baseline: applicable to mobile devices.'."\n" - .'* main: applicable to standard-definition devices.'."\n" - .'* high: applicable to high-definition devices.'."\n" - ."\n" - .'Default value: high.'."\n", - 'type' => 'string', - 'example' => 'Main', - ], - 'Bitrate' => [ - 'title' => '视频平均码率。'."\n" - .' 取值范围：[10，50000]。'."\n" - .' 单位：Kbps。', - 'description' => 'The average bitrate of the video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '3000', - ], - 'Crf' => [ - 'title' => '码率-质量控制因子。'."\n" - .' 取值范围：[0，51]。'."\n" - .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" - .' 如果设置了Crf，则Bitrate的设置失效。', - 'description' => 'The constant rate factor.'."\n" - ."\n" - .'* Valid values: \\[0,51].'."\n" - .'* Default value: 23 if the encoding format is H.264, or Default value when the Codec parameter is set to H.265: 26.'."\n" - ."\n" - .'If this parameter is specified, the value of Bitrate becomes invalid.'."\n", - 'type' => 'string', - 'example' => '23', - ], - 'Width' => [ - 'title' => '宽。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始宽度。', - 'description' => 'The width of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the width of the input video.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始高度。', - 'description' => 'The height of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the height of the input video.'."\n", - 'type' => 'string', - 'example' => '1080', - ], - 'Fps' => [ - 'title' => '帧率。'."\n" - .' 取值范围：(0,60]。'."\n" - .' 当输入文件帧率超过60时取60。'."\n" - .' 默认值：取输入文件帧率', - 'description' => 'The frame rate.'."\n" - ."\n" - .'* Valid values: (0,60].'."\n" - .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" - .'* Default value: the frame rate of the input video.'."\n", - 'type' => 'string', - 'example' => '25', - ], - 'Gop' => [ - 'title' => '关键帧间最大帧数。'."\n" - .' 取值范围：[1，1080000]。'."\n" - .' 默认值：250。', - 'description' => 'The maximum number of frames between two keyframes.'."\n" - ."\n" - .'* Valid values: \\[1,1080000].'."\n" - .'* Default value: 250.'."\n", - 'type' => 'string', - 'example' => '250', - ], - 'Preset' => [ - 'title' => '视频算法器预置。只有H264支持该参数。'."\n" - .'支持veryfast、fast、medium、slow、slower。'."\n" - .'默认值：medium。', - 'description' => 'The preset video algorithm. This parameter takes effect only if the encoding format is H.264. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.'."\n", - 'type' => 'string', - 'example' => 'medium', - ], - 'ScanMode' => [ - 'title' => '扫描模式。'."\n" - .'支持interlaced、progressive。', - 'description' => 'The scan mode. Valid values: interlaced and progressive.'."\n", - 'type' => 'string', - 'example' => 'progressive', - ], - 'PixFmt' => [ - 'title' => '视频颜色格式。'."\n" - .' 范围：yuv420p，yuvj420p等标准颜色格式。', - 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", - 'type' => 'string', - 'example' => 'yuv420p', - ], - 'Remove' => [ - 'title' => '是否去掉视频', - 'description' => 'Specifies whether to remove the video.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Crop' => [ - 'title' => '视频画面裁切'."\n" - .' 支持2种方式。'."\n" - .' 自动检测黑边并裁切，设置为“border”'."\n" - .' 自定义裁切，参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The method of video cropping. Valid values:'."\n" - ."\n" - .'* border: automatically detects and removes black bars.'."\n" - .'* A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'Pad' => [ - 'title' => '视频贴黑边'."\n" - .' 参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The black bars added to the video.'."\n" - ."\n" - .'* Format: width:height:left:top.'."\n" - .'* Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'LongShortMode' => [ - 'title' => '是否开启横竖屏自适应（即：长短边模式）', - 'description' => 'Specifies whether to enable the auto-rotate screen feature.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Bufsize' => [ - 'title' => '缓冲区大小'."\n" - .' 值范围：[1000，128000]'."\n" - .' 默认值：6000'."\n" - .' 单位：Kb', - 'description' => 'The buffer size.'."\n" - ."\n" - .'* Valid values: \\[1000,128000].'."\n" - .'* Default value: 6000.'."\n" - .'* Unit: KB.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - 'Maxrate' => [ - 'title' => '视频码率峰值'."\n" - .' 值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum bitrate of the output video. Valid values: \\[10,50000]. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '9000', - ], - 'AbrMax' => [ - 'title' => 'abr 最大码率(只有窄高1有效)'."\n" - .'值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum ABR. This parameter takes effect only for Narrowband HD 1.0. Valid values: \\[10,50000]. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - ], - ], - 'Audio' => [ - 'title' => 'audio 设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" - .' 默认值：AAC', - 'description' => 'The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.'."\n", - 'type' => 'string', - 'example' => 'AAC', - ], - 'Profile' => [ - 'title' => '音频编码预置。'."\n" - .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', - 'description' => 'The audio codec profile. If the Codec parameter is set to AAC, the valid values are aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", - 'type' => 'string', - 'example' => 'aac_low', - ], - 'Samplerate' => [ - 'title' => '采样率。'."\n" - .' 默认值：44100'."\n" - .' 支持22050、32000、44100、48000、96000，'."\n" - .' 单位：Hz', - 'description' => 'The sampling rate.'."\n" - ."\n" - .'* Default value: 44100.'."\n" - .'* Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" - .'* Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Bitrate' => [ - 'title' => '输出文件的音频码率。'."\n" - .' 值范围：[8，1000]'."\n" - .' 单位：Kbps'."\n" - .' 默认值：128', - 'description' => 'The audio bitrate of the output file.'."\n" - ."\n" - .'* Valid values: \\[8,1000].'."\n" - .'* Unit: Kbit/s.'."\n" - .'* Default value: 128.'."\n", - 'type' => 'string', - 'example' => '128', - ], - 'Channels' => [ - 'title' => '声道数。'."\n" - .' 默认值：2', - 'description' => 'The number of sound channels. Default value: 2.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Remove' => [ - 'title' => '是否删除音频流。', - 'description' => 'Specifies whether to delete the audio stream.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Volume' => [ - 'title' => '音量控制', - 'description' => 'The volume configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => '音量调整方式', - 'description' => 'The volume adjustment method. Valid values:'."\n", - 'type' => 'string', - 'example' => 'auto', - ], - 'IntegratedLoudnessTarget' => [ - 'title' => '目标音量', - 'description' => 'The output volume.'."\n", - 'type' => 'string', - 'example' => '-6', - ], - 'TruePeak' => [ - 'title' => '最大峰值', - 'description' => 'The peak volume.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'LoudnessRangeTarget' => [ - 'title' => '音量范围', - 'description' => 'The volume range.'."\n", - 'type' => 'string', - 'example' => '8', - ], - ], - ], - ], - ], - 'Container' => [ - 'title' => '封装格式设置', - 'description' => 'The encapsulation format settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '容器格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mp4', - ], - ], - ], - 'MuxConfig' => [ - 'title' => '封装设置', - 'description' => 'The encapsulation settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Segment' => [ - 'title' => '切片设置', - 'description' => 'The segment settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Duration' => [ - 'title' => '切片时长', - 'description' => 'The segment length.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ForceSegTime' => [ - 'title' => '强制切片时间点', - 'description' => 'The forced segmentation point in time.'."\n", - 'type' => 'string', - 'example' => '2,3', - ], - ], - ], - ], - ], - 'TransConfig' => [ - 'description' => 'The conditional transcoding configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'TransMode' => [ - 'description' => 'The video transcoding mode. Valid values:'."\n" - ."\n" - .'* onepass: You can set this parameter to onepass if the Bitrate parameter is set to ABR. This is the default value. The encoding speed of this mode is faster than that of the twopass mode.'."\n" - .'* twopass: You can set this parameter to twopass if the Bitrate parameter is set to VBR. The encoding speed of this mode is slower than that of the onepass mode.'."\n" - .'* CBR: the constant bitrate mode.'."\n", - 'type' => 'string', - 'example' => 'onepass', - ], - 'IsCheckReso' => [ - 'description' => 'Specifies whether to check the video resolution. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the width or height of the input video is less than that of the output video, the resolution of the input video is used for transcoding.'."\n" - .'* false: does not check the video resolution. This is the default value.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckResoFail' => [ - 'description' => 'Specifies whether to check the video resolution. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the width or height of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false: does not check the video resolution. This is the default value.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrate' => [ - 'description' => 'Specifies whether to check the video bitrate. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input video is less than that of the output video, the bitrate of the input video is used for transcoding.'."\n" - .'* false: does not check the video resolution. This is the default value.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrateFail' => [ - 'description' => 'Specifies whether to check the video bitrate. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false: does not check the video resolution. This is the default value.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrate' => [ - 'description' => 'Specifies whether to check the audio bitrate. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input audio is less than that of the output audio, the bitrate of the input audio is used for transcoding.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default values:'."\n" - ."\n" - .'* If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" - .'* If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrateFail' => [ - 'description' => 'Specifies whether to check the audio bitrate. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input audio is less than that of the output audio, the transcoding job fails.'."\n" - .'* false: does not check the video resolution. This is the default value.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'AdjDarMethod' => [ - 'description' => 'The method that is used to adjust 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" - ."\n" - .'Default value: none.'."\n", - 'type' => 'string', - 'example' => 'none', - ], - ], - ], - ], - ], - ], - ], - 'ImageWatermarks' => [ - 'title' => '图片水印配置', - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Width' => [ - 'title' => '输出视频上水印图片宽。'."\n" - .'值有两种形式：'."\n" - ."\n" - .'- 整数型代水印图片宽的像素值。'."\n" - .' - 范围：[8,4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', - 'description' => 'The width of the watermark in the output video. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the watermark width.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the watermark width to the width of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Height' => [ - 'title' => '输出视频上水印图片高。'."\n" - .'值有两种形式：'."\n" - ."\n" - .'- 整数型代水印图片高的像素值。'."\n" - .' - 范围：[8,4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表相对输出视频分辨率高的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', - 'description' => 'The height of the watermark image in the output video. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the watermark height.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the watermark height to the height of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Dx' => [ - 'title' => '水印图片相对输出视频的水平偏移量。'."\n" - .'默认值：0'."\n" - ."\n" - .'值有两种形式：'."\n" - .'- 整数型代表偏移像素。'."\n" - .' - 范围：[8，4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', - 'description' => 'The horizontal offset of the watermark relative to the output video. Default value: 0.'."\n" - ."\n" - .'The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the horizontal offset.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the horizontal offset to the width of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Dy' => [ - 'title' => '水印图片相对输出视频的垂直偏移量。'."\n" - .'默认值：0'."\n" - ."\n" - .'值有两种形式：'."\n" - .'- 整数型代表偏移像素。'."\n" - .' - 范围[8，4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', - 'description' => 'The vertical offset of the watermark relative to the output video. Default value: 0.'."\n" - ."\n" - .'The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the horizontal offset.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the vertical offset to the height of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ReferPos' => [ - 'title' => '水印的位置。'."\n" - .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" - .'- 默认值：TopRight', - 'description' => 'The position of the watermark.'."\n" - ."\n" - .'* Valid values: TopRight, TopLeft, BottomRight, and BottomLeft.'."\n" - .'* Default value: TopRight.'."\n", - 'type' => 'string', - 'example' => 'TopLeft', - ], - 'Timeline' => [ - 'title' => '动态水印，显示时间设置。', - 'description' => 'The time settings of the dynamic watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'title' => '水印开始出现时间。'."\n" - .'- 单位：秒'."\n" - .'- 取值范围：数字'."\n" - .'- 默认值：0', - 'description' => 'The beginning of the time range in which the watermark is displayed.'."\n" - ."\n" - .'* Unit: seconds.'."\n" - .'* Value values: integers.'."\n" - .'* Default value: 0.'."\n", - 'type' => 'string', - 'example' => '00:00:05', - ], - 'Duration' => [ - 'title' => '水印持续时间。'."\n" - .'- 取值范围：[数字，ToEND]'."\n" - .'- 默认值：ToEND', - 'description' => 'The time range in which the watermark is displayed.'."\n" - ."\n" - .'* Valid values: integers and ToEND.'."\n" - .'* Default value: ToEND.'."\n", - 'type' => 'string', - 'example' => 'ToEND', - ], - ], - ], - 'File' => [ - 'title' => '水印图片文件。', - 'description' => 'The watermark image file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'TextWatermarks' => [ - 'title' => '文字水印配置', - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', - 'description' => 'The watermark text. Base64 encoding is not required. The string must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'example' => '测试水印', - ], - 'FontName' => [ - 'title' => '字体。默认：SimSun。', - 'description' => 'The font of the text. Default value: SimSun.'."\n", - 'type' => 'string', - 'example' => 'SimSun', - ], - 'FontColor' => [ - 'title' => '颜色。', - 'description' => 'The color of the text.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'FontAlpha' => [ - 'title' => '字体透明度。'."\n" - .'- 范围：(0, 1]'."\n" - .'- 默认：1.0', - 'description' => 'The transparency of the text.'."\n" - ."\n" - .'* Valid values: (0,1].'."\n" - .'* Default value: 1.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'Top' => [ - 'title' => '文本上边距。'."\n" - .'- 默认：0'."\n" - .'- 范围：[0,4096]'."\n", - 'description' => 'The top margin of the text.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: \\[0,4096].'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Left' => [ - 'title' => '文本左边距。'."\n" - .'- 默认：0'."\n" - .'- 范围：[0,4096]', - 'description' => 'The left margin of the text watermark.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: \\[0,4096].'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'FontSize' => [ - 'title' => '字体大小。'."\n" - .'- 默认值：16'."\n" - .'- 范围：(4, 120)', - 'description' => 'The size of the text.'."\n" - ."\n" - .'* Default value: 16.'."\n" - .'* Valid values: (4,120).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'BorderWidth' => [ - 'title' => '描边宽度。'."\n" - .'- 默认：0'."\n" - .'- 范围：(0,4096]', - 'description' => 'The outline width of the text watermark.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: (0,4096].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BorderColor' => [ - 'title' => '描边颜色。'."\n" - .'默认：Black'."\n" - .'更多取值请参见BorderColor。', - 'description' => 'The outline color of the text watermark. Default value: black. For more information, see BorderColor.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'Adaptive' => [ - 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', - 'description' => 'Specifies whether to the font size based on the output video dimensions. true / false, default: false'."\n", - 'type' => 'string', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - 'Subtitles' => [ - 'title' => '字幕压制配置', - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '字幕文件格式。', - 'description' => 'The format of the subtitle file.'."\n", - 'type' => 'string', - 'example' => 'vtt', - ], - 'CharEnc' => [ - 'title' => '文件 encoding 格式。', - 'description' => 'The file encoding format.'."\n", - 'type' => 'string', - 'example' => 'UTF-8', - ], - 'File' => [ - 'title' => '字幕文件。', - 'description' => 'The subtitle file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'Encryption' => [ - 'title' => '加密配置。', - 'description' => 'The encryption settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'EncryptType' => [ - 'title' => '加密类型。', - 'description' => 'Specifies the encryption type.'."\n", - 'type' => 'string', - 'example' => 'PrivateEncryption', - ], - 'CipherText' => [ - 'title' => '标准加密的密钥密文。', - 'description' => 'The ciphertext of HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'MTYi00NDU0LTg5O****', - ], - 'DecryptKeyUri' => [ - 'title' => '标准加密的解密服务地址。', - 'description' => 'The address of the decryption service for HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', - ], - 'KeyServiceType' => [ - 'title' => '密钥服务类型。目前仅支持KMS和Base64', - 'description' => 'The type of the key service. Valid values: KMS and Base64.'."\n", - 'type' => 'string', - 'example' => 'KMS', - ], - ], - ], - 'CombineConfigs' => [ - 'title' => '多输入合流配置', - 'description' => 'The multi-input stream merge configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The stream merge configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'AudioIndex' => [ - 'title' => '音频流Index', - 'description' => 'The audio stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'VideoIndex' => [ - 'title' => '视频流Index', - 'description' => 'The video stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'Start' => [ - 'title' => '输入流的开始时间。 默认为0', - 'description' => 'The start time of the input stream. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Duration' => [ - 'title' => '输入流的持续时间。 默认为视频时长。', - 'description' => 'The duration of the input stream. The default value is the duration of the video.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '20.0', - ], - ], - ], - ], - ], - ], - 'Output' => [ - 'title' => '输出媒体配置', - 'description' => 'The output file configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'OutputUrl' => [ - 'description' => 'The URL of the output stream.\\'."\n" - .'This parameter takes effect only when Type is set to Media. You can select a specific file within the media asset as an output.\\'."\n" - .'Supported placeholders:'."\n" - ."\n" - .'* {MediaId}: the ID of the media asset.'."\n" - .'* {JobId}: the ID of the transcoding subjob.'."\n" - .'* {MediaBucket}: the bucket to which the media asset belongs.'."\n" - .'* {ExtName}: the file suffix, which uses the output format of the transcoding template.'."\n" - .'* {DestMd5}: the MD5 value of the transcoded output file.\\'."\n" - .' Notes:'."\n" - ."\n" - .'1. This parameter must contain the {MediaId} and {JobId} placeholders.'."\n" - .'2. The output bucket is the same as the bucket to which the media asset belongs.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4'."\n", - ], - ], - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '任务调度信息', - 'description' => 'The scheduling information about the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'Status' => [ - 'title' => '转码任务任务状态 - Init: 已提交, Processing: 转码中, Success: 转码成功, Fail: 转码失败, Deleted: 已删除', - 'description' => 'The state of the transcoding job. Valid values:'."\n" - ."\n" - .'* Init: The job is submitted.'."\n" - .'* Processing: The job is in progress.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n" - .'* Deleted: The job is deleted.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'OutFileMeta' => [ - 'title' => '任务生成视频 Media 信息', - 'description' => 'The media information about the video generated by the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '基础文件信息', - 'description' => 'The basic file information.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资 ID。', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '73e07de0f77171eca3fc7035d0b26402', - ], - 'FileName' => [ - 'title' => '文件名。', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'file.m3u8', - ], - 'FileStatus' => [ - 'title' => '文件状态。', - 'description' => 'The state of the file.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型。取值: source_file, transcode_file', - 'description' => 'The file type. Valid values: source_file and transcode_file.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小。单位：Byte。', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '31737', - ], - 'FileUrl' => [ - 'title' => '文件 URL。', - '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 region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '视频格式名称。', - 'description' => 'The name of the video format.'."\n", - 'type' => 'string', - 'example' => 'hls,applehttp', - ], - 'Duration' => [ - 'title' => '视频时长（单位: 秒）。', - 'description' => 'The duration of the video. 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 output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - ], - ], - 'AudioStreamInfoList' => [ - 'title' => '音频流信息', - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CodecName' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'CodecLongName' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'AAC (Advanced Audio Coding)', - ], - 'CodecTimeBase' => [ - 'title' => '编码器时间基。', - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/44100', - ], - 'CodecTagString' => [ - 'title' => '编码器标签名。', - 'description' => 'The name of the encoder tag.'."\n", - 'type' => 'string', - 'example' => '[15][0][0][0]', - ], - 'CodecTag' => [ - 'title' => '编码器标签。', - 'description' => 'The encoder tag.'."\n", - 'type' => 'string', - 'example' => '0x000f', - ], - 'SampleFmt' => [ - 'title' => '采样格式。', - 'description' => 'The sample format.'."\n", - 'type' => 'string', - 'example' => 'fltp', - ], - 'SampleRate' => [ - 'title' => '采样率（单位: Hz）。', - 'description' => 'The sampling rate. Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'title' => '声道数。', - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ChannelLayout' => [ - 'title' => '声道布局。', - 'description' => 'The sound channel layout.'."\n", - 'type' => 'string', - 'example' => 'stereo', - ], - 'Timebase' => [ - 'title' => '时间基。', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/90000', - ], - 'StartTime' => [ - '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', - ], - 'Bitrate' => [ - 'title' => '码率。', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '0.f', - ], - 'Lang' => [ - 'title' => '语言。', - 'description' => 'The language of the stream.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - ], - ], - ], - 'VideoStreamInfoList' => [ - 'title' => '视频流信息', - 'description' => 'The information about the video stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the video stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Codec_name' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'h264', - ], - 'Codec_long_name' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - ], - 'Profile' => [ - 'title' => '编码器预设。', - 'description' => 'The encoder profile.'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'Codec_time_base' => [ - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/50', - ], - 'Codec_tag_string' => [ - 'title' => '编码格式标记文本。', - 'description' => 'The tag string of the encoding format.'."\n", - 'type' => 'string', - 'example' => '[27][0][0][0]', - ], - 'Codec_tag' => [ - 'title' => '编码格式标记。', - 'description' => 'The tag of the encoding format.'."\n", - 'type' => 'string', - 'example' => '0x001b', - ], - 'Width' => [ - 'title' => '宽。', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - 'Has_b_frames' => [ - 'title' => '是否有B帧。'."\n" - .'取值: '."\n" - .'- 0: 没有 B 帧, '."\n" - .'- 1: 有一个 B 帧, '."\n" - .'- 2: 有多个连续 B 帧。', - 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). Valid values:'."\n" - ."\n" - .'* 0: The stream contains no B-frames.'."\n" - .'* 1: The stream contains one B-frame.'."\n" - .'* 2: The stream contains multiple consecutive B-frames.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Sar' => [ - 'title' => '采集点数宽高比。', - 'description' => 'The aspect ratio of the area from which the sampling points are collected.'."\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.'."\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 of the stream.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - 'Rotate' => [ - 'title' => '视频画面旋转角度。'."\n" - .'取值 0, 90, 180, 270。'."\n" - .'默认值 0', - 'description' => 'The rotation angle of the video image. Valid values: 0, 90, 180, and 270. Default value: 0.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - ], - ], - 'SubmitResultJson' => [ - 'title' => '任务提交结果', - 'description' => 'The job submission result.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'SubmitTime' => [ - 'title' => '任务提交时间', - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务结束时间', - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'RequestId' => [ - 'title' => '提交任务时请求 ID', - 'description' => 'The ID of the request that submitted the job.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - ], - ], - ], - 'CreateTime' => [ - 'title' => '任务创建时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'Name' => [ - 'title' => '任务名。', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'transcode-job', - ], - 'RequestId' => [ - 'title' => '提交任务时请求 ID。', - 'description' => 'The ID of the request that submitted the job.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'ParentJobId' => [ - 'title' => '主任务 ID。', - 'description' => 'The main job ID.'."\n", - 'type' => 'string', - 'example' => '8b2198504dd340b7b3c9842a74fc9baa', - ], - 'JobCount' => [ - 'title' => '子任务数量。', - 'description' => 'The number of subjobs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'title' => '任务状态。 Success: 所有子任务完成后，有一个子任务则为成功, Fail: 所有子任务失败', - 'description' => 'The state of the job. Success: At least one of the subjobs is successful. Fail: All subjobs failed.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'TriggerSource' => [ - 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', - 'description' => 'The source of the job. Valid values: API, WorkFlow, and Console.'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'Percent' => [ - 'title' => '任务完成百分比。', - 'description' => 'The completion percentage of the job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SubmitTime' => [ - 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'InputGroup' => [ - 'title' => '任务输入组 (目前只支持单个输入)。', - 'description' => 'The input group of the job. An input of a single file indicates a transcoding job. An input of multiple files indicates an audio and video stream merge job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the job input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - 'OutputGroup' => [ - 'title' => '任务输出组。', - 'description' => 'The output group of the job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出媒体配置', - 'description' => 'The output file configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - 'ProcessConfig' => [ - 'title' => '任务处理配置', - 'description' => 'The job processing configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Transcode' => [ - 'title' => '转码配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Video' => [ - 'title' => 'video 设置', - 'description' => 'The video settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '编码格式', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264', - ], - 'Profile' => [ - 'title' => '编码级别。'."\n" - .' 支持baseline、main、high。'."\n" - .' baseline：针对移动设备。'."\n" - .' main：针对标准分辨率设备。'."\n" - .' high：针对高分辨率设备。'."\n" - .' 默认值：high。', - 'description' => 'The encoding profile. Valid values: baseline, main, and high.'."\n" - ."\n" - .'* baseline: applicable to mobile devices.'."\n" - .'* main: applicable to standard-definition devices.'."\n" - .'* high: applicable to high-definition devices.'."\n" - ."\n" - .'Default value: high.'."\n", - 'type' => 'string', - 'example' => 'Main', - ], - 'Bitrate' => [ - 'title' => '视频平均码率。'."\n" - .' 取值范围：[10，50000]。'."\n" - .' 单位：Kbps。', - 'description' => 'The average bitrate of the video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '3000', - ], - 'Crf' => [ - 'title' => '码率-质量控制因子。'."\n" - .' 取值范围：[0，51]。'."\n" - .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" - .' 如果设置了Crf，则Bitrate的设置失效。', - 'description' => 'The constant rate factor.'."\n" - ."\n" - .'* Valid values: \\[0,51].'."\n" - .'* Default value: 23 if the encoding format is H.264, or Default value when the Codec parameter is set to H.265: 26.'."\n" - ."\n" - .'If this parameter is specified, the value of Bitrate becomes invalid.'."\n", - 'type' => 'string', - 'example' => '23', - ], - 'Width' => [ - 'title' => '宽。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始宽度。', - 'description' => 'The width of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the width of the input video.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始高度。', - 'description' => 'The height of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the height of the input video.'."\n", - 'type' => 'string', - 'example' => '1080', - ], - 'Fps' => [ - 'title' => '帧率。'."\n" - .' 取值范围：(0,60]。'."\n" - .' 当输入文件帧率超过60时取60。'."\n" - .' 默认值：取输入文件帧率', - 'description' => 'The frame rate.'."\n" - ."\n" - .'* Valid values: (0,60].'."\n" - .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" - .'* Default value: the frame rate of the input video.'."\n", - 'type' => 'string', - 'example' => '25', - ], - 'Gop' => [ - 'title' => '关键帧间最大帧数。'."\n" - .' 取值范围：[1，1080000]。'."\n" - .' 默认值：250。', - 'description' => 'The maximum number of frames between two keyframes.'."\n" - ."\n" - .'* Valid values: \\[1,1080000].'."\n" - .'* Default value: 250.'."\n", - 'type' => 'string', - 'example' => '250', - ], - 'Preset' => [ - 'title' => '视频算法器预置。只有H264支持该参数。'."\n" - .'支持veryfast、fast、medium、slow、slower。'."\n" - .'默认值：medium。', - 'description' => 'The preset video algorithm. This parameter takes effect only if the encoding format is H.264. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.'."\n", - 'type' => 'string', - 'example' => 'medium', - ], - 'ScanMode' => [ - 'title' => '扫描模式。'."\n" - .'支持interlaced、progressive。', - 'description' => 'The scan mode. Valid values: interlaced and progressive.'."\n", - 'type' => 'string', - 'example' => 'progressive', - ], - 'PixFmt' => [ - 'title' => '视频颜色格式。'."\n" - .' 范围：yuv420p，yuvj420p等标准颜色格式。', - 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", - 'type' => 'string', - 'example' => 'yuv420p', - ], - 'Remove' => [ - 'title' => '是否去掉视频', - 'description' => 'Specifies whether to remove the video.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Crop' => [ - 'title' => '视频画面裁切'."\n" - .' 支持2种方式。'."\n" - .' 自动检测黑边并裁切，设置为“border”'."\n" - .' 自定义裁切，参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The method of video cropping. Valid values:'."\n" - ."\n" - .'* border: automatically detects and removes black bars.'."\n" - .'* A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'Pad' => [ - 'title' => '视频贴黑边'."\n" - .' 参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The black bars added to the video.'."\n" - ."\n" - .'* Format: width:height:left:top.'."\n" - .'* Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'LongShortMode' => [ - 'title' => '是否开启横竖屏自适应（即：长短边模式）', - 'description' => 'Specifies whether to enable the auto-rotate screen feature.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Bufsize' => [ - 'title' => '缓冲区大小'."\n" - .' 值范围：[1000，128000]'."\n" - .' 默认值：6000'."\n" - .' 单位：Kb', - 'description' => 'The buffer size.'."\n" - ."\n" - .'* Valid values: \\[1000,128000].'."\n" - .'* Default value: 6000.'."\n" - .'* Unit: KB.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - 'Maxrate' => [ - 'title' => '视频码率峰值'."\n" - .' 值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum bitrate of the output video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '9000', - ], - 'AbrMax' => [ - 'title' => 'abr 最大码率(只有窄高1有效)'."\n" - .'值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum ABR. This parameter takes effect only for Narrowband HD 1.0.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - ], - ], - 'Audio' => [ - 'title' => 'audio 设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" - .' 默认值：AAC', - 'description' => 'The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.'."\n", - 'type' => 'string', - 'example' => 'AAC', - ], - 'Profile' => [ - 'title' => '音频编码预置。'."\n" - .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', - 'description' => 'The audio codec profile. If the Codec parameter is set to AAC, the valid values are aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", - 'type' => 'string', - 'example' => 'aac_low', - ], - 'Samplerate' => [ - 'title' => '采样率。'."\n" - .' 默认值：44100'."\n" - .' 支持22050、32000、44100、48000、96000，'."\n" - .' 单位：Hz', - 'description' => 'The sampling rate.'."\n" - ."\n" - .'* Valid values: 22050, 32000, 44100, 48000, and 96000. Default value: 44100.'."\n" - .'* Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Bitrate' => [ - 'title' => '输出文件的音频码率。'."\n" - .' 值范围：[8，1000]'."\n" - .' 单位：Kbps'."\n" - .' 默认值：128', - 'description' => 'The audio bitrate of the output file.'."\n" - ."\n" - .'* Valid values: \\[8,1000].'."\n" - .'* Unit: Kbit/s.'."\n" - .'* Default value: 128.'."\n", - 'type' => 'string', - 'example' => '128', - ], - 'Channels' => [ - 'title' => '声道数。'."\n" - .' 默认值：2', - 'description' => 'The number of sound channels. Default value: 2.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Remove' => [ - 'title' => '是否删除音频流。', - 'description' => 'Specifies whether to delete the audio stream.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Volume' => [ - 'title' => '音量控制', - 'description' => 'The volume configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => '音量调整方式', - 'description' => 'The volume adjustment method. Valid values:'."\n", - 'type' => 'string', - 'example' => 'auto', - ], - 'IntegratedLoudnessTarget' => [ - 'title' => '目标音量', - 'description' => 'The output volume.'."\n", - 'type' => 'string', - 'example' => '-6', - ], - 'TruePeak' => [ - 'title' => '最大峰值', - 'description' => 'The peak volume.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'LoudnessRangeTarget' => [ - 'title' => '音量范围', - 'description' => 'The volume range.'."\n", - 'type' => 'string', - 'example' => '8', - ], - ], - ], - ], - ], - 'Container' => [ - 'title' => '封装格式设置', - 'description' => 'The encapsulation format settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '容器格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mp4', - ], - ], - ], - 'MuxConfig' => [ - 'title' => '封装设置', - 'description' => 'The encapsulation settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Segment' => [ - 'title' => '切片设置', - 'description' => 'The segment settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Duration' => [ - 'title' => '切片时长', - 'description' => 'The segment length.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ForceSegTime' => [ - 'title' => '强制切片时间点', - 'description' => 'The forced segmentation point in time.'."\n", - 'type' => 'string', - 'example' => '2,3', - ], - ], - ], - ], - ], - 'TransConfig' => [ - 'description' => 'The conditional transcoding configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'TransMode' => [ - 'description' => 'The video transcoding mode. Valid values:'."\n" - ."\n" - .'* onepass: You can set this parameter to onepass if the Bitrate parameter is set to ABR. The encoding speed of this mode is faster than that of the twopass mode.'."\n" - .'* twopass: You can set this parameter to twopass if the Bitrate parameter is set to VBR. The encoding speed of this mode is slower than that of the onepass mode.'."\n" - .'* CBR: the constant bitrate mode.'."\n" - ."\n" - .'Default value: onepass.'."\n", - 'type' => 'string', - 'example' => 'onepass', - ], - 'IsCheckReso' => [ - 'description' => 'Specifies whether to check the video resolution. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the width or height of the input video is less than that of the output video, the resolution of the input video is used for transcoding.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckResoFail' => [ - 'description' => 'Specifies whether to check the video resolution. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the width or height of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrate' => [ - 'description' => 'Specifies whether to check the video bitrate. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input video is less than that of the output video, the bitrate of the input video is used for transcoding.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrateFail' => [ - 'description' => 'Specifies whether to check the video bitrate. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrate' => [ - 'description' => 'Specifies whether to check the audio bitrate. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input audio is less than that of the output audio, the bitrate of the input audio is used for transcoding.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value:'."\n" - ."\n" - .'* If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" - .'* If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrateFail' => [ - 'description' => 'Specifies whether to check the audio bitrate. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true: checks the video resolution. If the bitrate of the input audio is less than that of the output audio, the transcoding job fails.'."\n" - .'* false: does not check the video resolution.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'AdjDarMethod' => [ - 'description' => 'The method that is used to adjust 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" - ."\n" - .'Default value: none.'."\n", - 'type' => 'string', - 'example' => 'none', - ], - ], - ], - ], - ], - ], - ], - 'ImageWatermarks' => [ - 'title' => '图片水印配置', - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Width' => [ - 'title' => '输出视频上水印图片宽。'."\n" - .'值有两种形式：'."\n" - ."\n" - .'- 整数型代水印图片宽的像素值。'."\n" - .' - 范围：[8,4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', - 'description' => 'The width of the watermark in the output video. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the watermark width.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the watermark width to the width of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Height' => [ - 'title' => '输出视频上水印图片高。'."\n" - .'值有两种形式：'."\n" - ."\n" - .'- 整数型代水印图片高的像素值。'."\n" - .' - 范围：[8,4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表相对输出视频分辨率高的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', - 'description' => 'The height of the watermark image in the output video. The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the watermark height.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the watermark height to the height of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Dx' => [ - 'title' => '水印图片相对输出视频的水平偏移量。'."\n" - .'默认值：0'."\n" - ."\n" - .'值有两种形式：'."\n" - .'- 整数型代表偏移像素。'."\n" - .' - 范围：[8，4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', - 'description' => 'The horizontal offset of the watermark relative to the output video. Default value: 0.'."\n" - ."\n" - .'The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the horizontal offset.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the horizontal offset to the width of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Dy' => [ - 'title' => '水印图片相对输出视频的垂直偏移量。'."\n" - .'默认值：0'."\n" - ."\n" - .'值有两种形式：'."\n" - .'- 整数型代表偏移像素。'."\n" - .' - 范围[8，4096]'."\n" - .' - 单位：px'."\n" - .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" - .' - 范围：(0，1)'."\n" - .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', - 'description' => 'The vertical offset of the watermark relative to the output video. Default value: 0.'."\n" - ."\n" - .'The following value types are supported:'."\n" - ."\n" - .'* Integer: the pixel value of the horizontal offset.'."\n" - ."\n" - .' * Valid values: \\[8,4096].'."\n" - .' * Unit: pixels.'."\n" - ."\n" - .'* Decimal: the ratio of the vertical offset to the height of the output video.'."\n" - ."\n" - .' * Valid values: (0,1).'."\n" - .' * The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ReferPos' => [ - 'title' => '水印的位置。'."\n" - .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" - .'- 默认值：TopRight', - 'description' => 'The position of the watermark.'."\n" - ."\n" - .'* Valid values: TopRight, TopLeft, BottomRight, and BottomLeft.'."\n" - .'* Default value: TopRight.'."\n", - 'type' => 'string', - 'example' => 'TopLeft', - ], - 'Timeline' => [ - 'title' => '动态水印，显示时间设置。', - 'description' => 'The time settings of the dynamic watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'title' => '水印开始出现时间。'."\n" - .'- 单位：秒'."\n" - .'- 取值范围：数字'."\n" - .'- 默认值：0', - 'description' => 'The beginning of the time range in which the watermark is displayed.'."\n" - ."\n" - .'* Unit: seconds.'."\n" - .'* Value values: integers.'."\n" - .'* Default value: 0.'."\n", - 'type' => 'string', - 'example' => '00:00:05', - ], - 'Duration' => [ - 'title' => '水印持续时间。'."\n" - .'- 取值范围：[数字，ToEND]'."\n" - .'- 默认值：ToEND', - 'description' => 'The time range in which the watermark is displayed.'."\n" - ."\n" - .'* Valid values: integers and ToEND.'."\n" - .'* Default value: ToEND.'."\n", - 'type' => 'string', - 'example' => 'ToEND', - ], - ], - ], - 'File' => [ - 'title' => '水印图片文件。', - 'description' => 'The watermark image file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'TextWatermarks' => [ - 'title' => '文字水印配置', - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', - 'description' => 'The watermark text. Base64 encoding is not required. The string must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'example' => '测试水印', - ], - 'FontName' => [ - 'title' => '字体。默认：SimSun。', - 'description' => 'The font of the text. Default value: SimSun.'."\n", - 'type' => 'string', - 'example' => 'SimSun', - ], - 'FontColor' => [ - 'title' => '颜色。', - 'description' => 'The color of the text.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'FontAlpha' => [ - 'title' => '字体透明度。'."\n" - .'- 范围：(0, 1]'."\n" - .'- 默认：1.0', - 'description' => 'The transparency of the text.'."\n" - ."\n" - .'* Valid values: (0,1].'."\n" - .'* Default value: 1.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'Top' => [ - 'title' => '文本上边距。'."\n" - .'- 默认：0'."\n" - .'- 范围：[0,4096]'."\n", - 'description' => 'The top margin of the text.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: \\[0,4096].'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Left' => [ - 'title' => '文本左边距。'."\n" - .'- 默认：0'."\n" - .'- 范围：[0,4096]', - 'description' => 'The left margin of the text watermark.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: \\[0,4096].'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'FontSize' => [ - 'title' => '字体大小。'."\n" - .'- 默认值：16'."\n" - .'- 范围：(4, 120)', - 'description' => 'The size of the text.'."\n" - ."\n" - .'* Default value: 16.'."\n" - .'* Valid values: (4,120).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'BorderWidth' => [ - 'title' => '描边宽度。'."\n" - .'- 默认：0'."\n" - .'- 范围：(0,4096]', - 'description' => 'The outline width of the text watermark.'."\n" - ."\n" - .'* Default value: 0.'."\n" - .'* Valid values: (0,4096].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BorderColor' => [ - 'title' => '描边颜色。'."\n" - .'默认：Black'."\n" - .'更多取值请参见BorderColor。', - 'description' => 'The outline color of the text watermark. Default value: black. For more information, see BorderColor.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'Adaptive' => [ - 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', - 'description' => 'Specifies whether to the font size based on the output video dimensions.'."\n" - ."\n" - .'* true: false'."\n" - .'* default: false'."\n", - 'type' => 'string', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - 'Subtitles' => [ - 'title' => '字幕压制配置', - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '字幕文件格式。', - 'description' => 'The format of the subtitle file.'."\n", - 'type' => 'string', - 'example' => 'vtt', - ], - 'CharEnc' => [ - 'title' => '文件 encoding 格式。', - 'description' => 'The file encoding format.'."\n", - 'type' => 'string', - 'example' => 'UTF-8', - ], - 'File' => [ - 'title' => '字幕文件。', - 'description' => 'The subtitle file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object. If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported. If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'Encryption' => [ - 'title' => '加密配置。', - 'description' => 'The encryption settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'EncryptType' => [ - 'title' => '加密类型。', - 'description' => 'Specifies the encryption type.'."\n", - 'type' => 'string', - 'example' => 'PrivateEncryption', - ], - 'CipherText' => [ - 'title' => '标准加密的密钥密文。', - 'description' => 'The ciphertext of HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'MTYi00NDU0LTg5O****', - ], - 'DecryptKeyUri' => [ - 'title' => '标准加密的解密服务地址。', - 'description' => 'The address of the decryption service for HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', - ], - 'KeyServiceType' => [ - 'title' => '密钥服务类型。目前仅支持KMS和Base64', - 'description' => 'The type of the key service. Valid values: KMS and Base64.'."\n", - 'type' => 'string', - 'example' => 'KMS', - ], - ], - ], - 'CombineConfigs' => [ - 'title' => '多输入合流配置', - 'description' => 'The multi-input stream merge configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The multi-input stream merge configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'AudioIndex' => [ - 'title' => '音频流Index', - 'description' => 'The audio stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'VideoIndex' => [ - 'title' => '视频流Index', - 'description' => 'The video stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'Start' => [ - 'title' => '输入流的开始时间。 默认为0', - 'description' => 'The start time of the input stream. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Duration' => [ - 'title' => '输入流的持续时间。 默认为视频时长。', - 'description' => 'The duration of the input stream. The default value is the duration of the video.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '20.0', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'UserData' => [ - 'title' => '用户数据。', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '任务调度配置。', - 'description' => 'The scheduling configuration of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\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 ],\\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\\": \\"测试水印\\",\\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 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ]\\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\\": \\"73e07de0f77171eca3fc7035d0b26402\\",\\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 },\\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\\": \\"测试水印\\",\\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 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 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' => 'SubmitTranscodeJob', - 'summary' => 'Submits a transcoding job.', - ], - 'GetTranscodeJob' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ParentJobId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务 ID', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9EDC30DC-0050-5459-B788-F761B2BE359B', - ], - 'TranscodeParentJob' => [ - 'title' => 'TranscodeParentJobWithSubJobDTO', - 'description' => 'TranscodeParentJobWithSubJobDTO'."\n", - 'type' => 'object', - 'properties' => [ - 'TranscodeJobList' => [ - 'title' => '子任务列表', - 'description' => 'The list of subjobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subjob.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '任务创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'Name' => [ - 'title' => '任务名', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'transcode-job', - ], - 'ParentJobId' => [ - 'title' => '主任务 ID', - 'description' => 'The main job ID.'."\n", - 'type' => 'string', - 'example' => '8b2198504dd340b7b3c9842a74fc9baa', - ], - 'JobId' => [ - 'title' => '子任务 ID', - 'description' => 'The subjob ID.'."\n", - 'type' => 'string', - 'example' => '7d6a7e0d4db2457a8d45ff5d43e1bf0a', - ], - 'JobIndex' => [ - 'title' => '子任务在整个任务中的索引号', - 'description' => 'The index number of the subjob in the entire job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'InputGroup' => [ - 'title' => '任务输入组。单输入时为转码任务，多输入时为合流任务。', - 'description' => 'The input group of the job. An input of a single file indicates a transcoding job. An input of multiple files indicates an audio and video stream merge job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the job input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'InputUrl' => [ - 'description' => 'The URL of the media asset. This parameter is specified only when the media asset is transcoded.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - 'ProcessConfig' => [ - 'title' => '转码处理配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Transcode' => [ - 'title' => '转码配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Video' => [ - 'title' => 'video 设置', - 'description' => 'The video settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '编码格式', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264', - ], - 'Profile' => [ - 'title' => '编码级别。'."\n" - .' 支持baseline、main、high。'."\n" - .' baseline：针对移动设备。'."\n" - .' main：针对标准分辨率设备。'."\n" - .' high：针对高分辨率设备。'."\n" - .' 默认值：high。', - 'description' => 'The encoding profile. Valid values: baseline, main, and high.'."\n" - ."\n" - .'* baseline: applicable to mobile devices.'."\n" - .'* main: applicable to standard-definition devices.'."\n" - .'* high: applicable to high-definition devices.'."\n" - ."\n" - .'Default value: high.'."\n", - 'type' => 'string', - 'example' => 'Main', - ], - 'Bitrate' => [ - 'title' => '视频平均码率。'."\n" - .' 取值范围：[10，50000]。'."\n" - .' 单位：Kbps。', - 'description' => 'The average bitrate of the video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '3000', - ], - 'Crf' => [ - 'title' => '码率-质量控制因子。'."\n" - .' 取值范围：[0，51]。'."\n" - .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" - .' 如果设置了Crf，则Bitrate的设置失效。', - 'description' => 'The constant rate factor.'."\n" - ."\n" - .'* Valid values: \\[0,51].'."\n" - .'* Default value: 23 if the encoding format is H.264, or 26 if the encoding format is H.265.'."\n" - ."\n" - .'If this parameter is specified, the value of Bitrate becomes invalid.'."\n", - 'type' => 'string', - 'example' => '23', - ], - 'Width' => [ - 'title' => '宽。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始宽度。', - 'description' => 'The width of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - ."\n" - .'Default value: the width of the input video.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始高度。', - 'description' => 'The height of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - ."\n" - .'Default value: the height of the input video.'."\n", - 'type' => 'string', - 'example' => '1080', - ], - 'Fps' => [ - 'title' => '帧率。'."\n" - .' 取值范围：(0,60]。'."\n" - .' 当输入文件帧率超过60时取60。'."\n" - .' 默认值：取输入文件帧率', - 'description' => 'The frame rate.'."\n" - ."\n" - .'* Valid values: (0,60]. The value is 60 if the frame rate of the input video exceeds 60.'."\n" - .'* Default value: the frame rate of the input video.'."\n", - 'type' => 'string', - 'example' => '25', - ], - 'Gop' => [ - 'title' => '关键帧间最大帧数。'."\n" - .' 取值范围：[1，1080000]。'."\n" - .' 默认值：250。', - 'description' => 'The maximum number of frames between two keyframes.'."\n" - ."\n" - .'* Valid values: \\[1,1080000].'."\n" - .'* Default value: 250.'."\n", - 'type' => 'string', - 'example' => '250', - ], - 'Preset' => [ - 'title' => '视频算法器预置。只有H264支持该参数。'."\n" - .'支持veryfast、fast、medium、slow、slower。'."\n" - .'默认值：medium。', - 'description' => 'The preset video algorithm. This parameter takes effect only if the encoding format is H.264. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.'."\n", - 'type' => 'string', - 'example' => 'medium', - ], - 'ScanMode' => [ - 'title' => '扫描模式。'."\n" - .'支持interlaced、progressive。', - 'description' => 'The scan mode. Valid values: interlaced and progressive.'."\n", - 'type' => 'string', - 'example' => 'progressive', - ], - 'PixFmt' => [ - 'title' => '视频颜色格式。'."\n" - .' 范围：yuv420p，yuvj420p等标准颜色格式。', - 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", - 'type' => 'string', - 'example' => 'yuv420p', - ], - 'Remove' => [ - 'title' => '是否去掉视频', - 'description' => 'Indicates whether the video was removed.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Crop' => [ - 'title' => '视频画面裁切'."\n" - .' 支持2种方式。'."\n" - .' 自动检测黑边并裁切，设置为“border”'."\n" - .' 自定义裁切，参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The method of video cropping. Valid values:'."\n" - ."\n" - .'* border: automatically detects and removes black bars.'."\n" - .'* A value in the width:height:left:top format: crops the videos based on the custom settings.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'Pad' => [ - 'title' => '视频贴黑边'."\n" - .' 参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The black bars added to the video. Format: width:height:left:top.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'LongShortMode' => [ - 'title' => '是否开启横竖屏自适应（即：长短边模式）', - 'description' => 'Indicates whether the auto-rotate screen feature is enabled.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Bufsize' => [ - 'title' => '缓冲区大小'."\n" - .' 值范围：[1000，128000]'."\n" - .' 默认值：6000'."\n" - .' 单位：Kb', - 'description' => 'The buffer size.'."\n" - ."\n" - .'* Valid values: \\[1000,128000].'."\n" - .'* Default value: 6000.'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - 'Maxrate' => [ - 'title' => '视频码率峰值'."\n" - .' 值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum bitrate of the output video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '9000', - ], - 'AbrMax' => [ - 'title' => 'abr 最大码率(只有窄高1有效)'."\n" - .'值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum adaptive bitrate (ABR). This parameter takes effect only for Narrowband HD 1.0.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - ], - ], - 'Audio' => [ - 'title' => 'audio 设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" - .' 默认值：AAC', - 'description' => 'The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.'."\n", - 'type' => 'string', - 'example' => 'AAC', - ], - 'Profile' => [ - 'title' => '音频编码预置。'."\n" - .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', - 'description' => 'The audio codec profile. If the Codec parameter is set to AAC, the valid values are aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", - 'type' => 'string', - 'example' => 'aac_low', - ], - 'Samplerate' => [ - 'title' => '采样率。'."\n" - .' 默认值：44100'."\n" - .' 支持22050、32000、44100、48000、96000，'."\n" - .' 单位：Hz', - 'description' => 'The sampling rate.'."\n" - ."\n" - .'* Default value: 44100. Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" - .'* Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Bitrate' => [ - 'title' => '输出文件的音频码率。'."\n" - .' 值范围：[8，1000]'."\n" - .' 单位：Kbps'."\n" - .' 默认值：128', - 'description' => 'The audio bitrate of the output file.'."\n" - ."\n" - .'* Valid values: \\[8,1000].'."\n" - .'* Unit: Kbit/s.'."\n" - .'* Default value: 128.'."\n", - 'type' => 'string', - 'example' => '128', - ], - 'Channels' => [ - 'title' => '声道数。'."\n" - .' 默认值：2', - 'description' => 'The number of sound channels. Default value: 2.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Remove' => [ - 'title' => '是否删除音频流。', - 'description' => 'Indicates whether the audio stream is deleted.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Volume' => [ - 'title' => '音量控制', - 'description' => 'The volume configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => '音量调整方式', - 'description' => 'The volume adjustment method. Valid values:'."\n", - 'type' => 'string', - 'example' => 'auto', - ], - 'IntegratedLoudnessTarget' => [ - 'title' => '目标音量', - 'description' => 'The output volume.'."\n", - 'type' => 'string', - 'example' => '-6', - ], - 'TruePeak' => [ - 'title' => '最大峰值', - 'description' => 'The peak volume.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'LoudnessRangeTarget' => [ - 'title' => '音量范围', - 'description' => 'The volume range.'."\n", - 'type' => 'string', - 'example' => '8', - ], - ], - ], - ], - ], - 'Container' => [ - 'title' => '封装格式设置', - 'description' => 'The encapsulation format settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '容器格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mp4', - ], - ], - ], - 'MuxConfig' => [ - 'title' => '封装设置', - 'description' => 'The encapsulation settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Segment' => [ - 'title' => '切片设置', - 'description' => 'The segment settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Duration' => [ - 'title' => '切片时长', - 'description' => 'The segment length.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ForceSegTime' => [ - 'title' => '强制切片时间点', - 'description' => 'The forced segmentation point in time.'."\n", - 'type' => 'string', - 'example' => '2,3', - ], - ], - ], - ], - ], - 'TransConfig' => [ - 'description' => 'The conditional transcoding configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'TransMode' => [ - 'description' => 'The video transcoding mode. Valid values:'."\n" - ."\n" - .'* onepass: You can set this parameter to onepass if the Bitrate parameter is set to ABR. The encoding speed of this mode is faster than that of the twopass mode.'."\n" - .'* twopass: You can set this parameter to twopass if the Bitrate parameter is set to VBR. The encoding speed of this mode is slower than that of the onepass mode.'."\n" - .'* CBR: the constant bitrate mode.'."\n" - ."\n" - .'Default value: onepass.'."\n", - 'type' => 'string', - 'example' => 'onepass', - ], - 'IsCheckReso' => [ - 'description' => 'Indicates whether the video resolution was checked. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the width or height of the input video is less than that of the output video, the resolution of the input video is used for transcoding.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckResoFail' => [ - 'description' => 'Indicates whether the video resolution was checked. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the width or height of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrate' => [ - 'description' => 'Indicates whether the video bitrate was checked. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input video is less than that of the output video, the bitrate of the input video is used for transcoding.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrateFail' => [ - 'description' => 'Indicates whether the video bitrate was checked. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrate' => [ - 'description' => 'Indicates whether the audio bitrate was checked. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input audio is less than that of the output audio, the bitrate of the input audio is used for transcoding.'."\n" - .'* false'."\n" - ."\n" - .'Default value:'."\n" - ."\n" - .'* If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" - .'* If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrateFail' => [ - 'description' => 'Indicates whether the audio bitrate was checked. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input audio is less than that of the output audio, the transcoding job fails.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'AdjDarMethod' => [ - 'description' => 'The method that is used to adjust 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" - ."\n" - .'Default value: none.'."\n" - ."\n" - .'For more information about examples, see How do I set the resolution for an output video?'."\n", - 'type' => 'string', - 'example' => 'none', - ], - ], - ], - 'Tags' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'ImageWatermarks' => [ - 'title' => '图片水印配置', - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Width' => [ - 'title' => '宽', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Dx' => [ - 'title' => '水印位置，x', - 'description' => 'The position of the watermark on the x-axis.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Dy' => [ - 'title' => '水印位置，y', - 'description' => 'The position of the watermark on the y-axis.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ReferPos' => [ - 'title' => '参考位置: TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft', - 'description' => 'The reference position of the watermark. Valid values: TopLeft, TopRight, BottomLeft, and BottomRight. Default value: TopLeft.'."\n", - 'type' => 'string', - 'example' => 'TopLeft', - ], - 'Timeline' => [ - 'title' => '显示时间设置', - 'description' => 'The timeline settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'title' => '开始时间', - 'description' => 'The start time of the stream.'."\n", - 'type' => 'string', - 'example' => '00:00:05', - ], - 'Duration' => [ - 'title' => '显示时长，秒数 或者 "ToEND"', - 'description' => 'The duration of the stream. Valid values: the number of seconds or "ToEND".'."\n", - 'type' => 'string', - 'example' => 'ToEND', - ], - ], - ], - 'File' => [ - 'title' => '水印图片文件', - 'description' => 'The watermark image file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'TextWatermarks' => [ - 'title' => '文字水印配置', - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码', - 'description' => 'The watermark text. Base64 encoding is not required. The string must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'example' => '测试水印', - ], - 'FontName' => [ - 'title' => '字体', - 'description' => 'The font of the text.'."\n", - 'type' => 'string', - 'example' => 'SimSun', - ], - 'FontColor' => [ - 'title' => '颜色', - 'description' => 'The color of the text.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'FontAlpha' => [ - 'title' => '透明度', - 'description' => 'The transparency of the watermark.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'Top' => [ - 'title' => '水印位置，距离上边距离', - 'description' => 'The distance of the watermark from the top edge.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Left' => [ - 'title' => '水印位置，距离左边距离', - 'description' => 'The distance of the watermark from the left edge.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'FontSize' => [ - 'title' => '字体大小', - 'description' => 'The size of the text.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'BorderWidth' => [ - 'title' => '边框宽度', - 'description' => 'The border width.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BorderColor' => [ - 'title' => '边框颜色', - 'description' => 'The border color.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'Adaptive' => [ - 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', - 'description' => 'Indicates whether the text size was adjusted based on the output video dimensions. Valid values: true and false. Default value: false.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - 'Subtitles' => [ - 'title' => '字幕压制配置', - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '字幕文件格式', - 'description' => 'The format of the subtitle file.'."\n", - 'type' => 'string', - 'example' => 'vtt', - ], - 'CharEnc' => [ - 'title' => '文件 encoding 格式', - 'description' => 'The file encoding format.'."\n", - 'type' => 'string', - 'example' => 'UTF-8', - ], - 'File' => [ - 'title' => '字幕文件', - 'description' => 'The subtitle file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'Encryption' => [ - 'title' => '加密配置。', - 'description' => 'The encryption settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'EncryptType' => [ - 'title' => '加密类型。', - 'description' => 'The encryption type.'."\n", - 'type' => 'string', - 'example' => 'PrivateEncryption', - ], - 'CipherText' => [ - 'title' => '标准加密的密钥密文。', - 'description' => 'The ciphertext of HTTP Live Streaming (HLS) encryption.'."\n", - 'type' => 'string', - 'example' => 'MTYi00NDU0LTg5O****', - ], - 'DecryptKeyUri' => [ - 'title' => '标准加密的解密服务地址。', - 'description' => 'The endpoint of the decryption service for HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', - ], - 'KeyServiceType' => [ - 'title' => '密钥服务类型。目前仅支持KMS和Base64', - 'description' => 'The type of the key service. Valid values: KMS and Base64.'."\n", - 'type' => 'string', - 'example' => 'KMS', - ], - ], - ], - 'CombineConfigs' => [ - 'title' => '多输入合流配置', - 'description' => 'The multi-input stream merge configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AudioIndex' => [ - 'title' => '音频流Index', - 'description' => 'The audio stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'VideoIndex' => [ - 'title' => '视频流Index', - 'description' => 'The video stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'Start' => [ - 'title' => '输入流的开始时间。 默认为0', - 'description' => 'The start time of the input stream. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Duration' => [ - 'title' => '输入流的持续时间。 默认为视频时长。', - 'description' => 'The duration of the input stream. The default value is the duration of the video.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '20.0', - ], - ], - 'description' => '', - ], - ], - 'IsInheritTags' => [ - 'description' => 'Indicates whether the tags of the input stream are inherited in the output stream. This parameter does not take effect when the input is not a media asset. Default value: false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Output' => [ - 'title' => '输出媒体配置', - 'description' => 'The output file configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'OutputUrl' => [ - 'description' => 'The path of the transcoded output stream. This parameter is required only when the output is a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4'."\n", - ], - ], - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '任务调度信息', - 'description' => 'The scheduling information about the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the snapshot job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'Status' => [ - 'title' => '转码任务任务状态 - Init: 已提交, Processing: 转码中, Success: 转码成功, Fail: 转码失败, Deleted: 已删除', - 'description' => 'The state of the transcoding job. Valid values: Init (the job is submitted), Success (the job is successful), Fail (the job failed), and Deleted (the job is deleted).'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'OutFileMeta' => [ - 'title' => '任务生成视频 Media 信息', - 'description' => 'The media information about the video generated by the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '基础文件信息', - 'description' => 'The basic file information.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资 ID。', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '486c2890096871edba6f81848c016303', - ], - 'FileName' => [ - 'title' => '文件名。', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'file.m3u8', - ], - 'FileStatus' => [ - 'title' => '文件状态。', - 'description' => 'The state of the file.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型。取值: source_file, transcode_file', - 'description' => 'The file type. Valid values: source_file and transcode_file.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小。单位：Byte。', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '31737', - ], - 'FileUrl' => [ - 'title' => '文件 URL。', - '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 region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '视频格式名称。', - 'description' => 'The name of the video format.'."\n", - 'type' => 'string', - 'example' => 'hls,applehttp', - ], - 'Duration' => [ - 'title' => '视频时长（单位: 秒）。', - 'description' => 'The duration of the video. 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 output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - ], - ], - 'AudioStreamInfoList' => [ - 'title' => '音频流信息', - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CodecName' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'CodecLongName' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'AAC (Advanced Audio Coding)', - ], - 'CodecTimeBase' => [ - 'title' => '编码器时间基。', - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/44100', - ], - 'CodecTagString' => [ - 'title' => '编码器标签名。', - 'description' => 'The name of the encoder tag.'."\n", - 'type' => 'string', - 'example' => '[15][0][0][0]', - ], - 'CodecTag' => [ - 'title' => '编码器标签。', - 'description' => 'The encoder tag.'."\n", - 'type' => 'string', - 'example' => '0x000f', - ], - 'SampleFmt' => [ - 'title' => '采样格式。', - 'description' => 'The sample format.'."\n", - 'type' => 'string', - 'example' => 'fltp', - ], - 'SampleRate' => [ - 'title' => '采样率（单位: Hz）。', - 'description' => 'The sampling rate. Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'title' => '声道数。', - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ChannelLayout' => [ - 'title' => '声道布局。', - 'description' => 'The sound channel layout.'."\n", - 'type' => 'string', - 'example' => 'stereo', - ], - 'Timebase' => [ - 'title' => '时间基。', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/90000', - ], - 'StartTime' => [ - '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', - ], - 'Bitrate' => [ - 'title' => '码率。', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '0.f', - ], - 'Lang' => [ - 'title' => '语言。', - 'description' => 'The language of the stream.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - ], - ], - ], - 'VideoStreamInfoList' => [ - 'title' => '视频流信息', - 'description' => 'The information about the video stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the video stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Codec_name' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'h264', - ], - 'Codec_long_name' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - ], - 'Profile' => [ - 'title' => '编码器预设。', - 'description' => 'The encoder profile.'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'Codec_time_base' => [ - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/50', - ], - 'Codec_tag_string' => [ - 'title' => '编码格式标记文本。', - 'description' => 'The tag string of the encoding format.'."\n", - 'type' => 'string', - 'example' => '[27][0][0][0]', - ], - 'Codec_tag' => [ - 'title' => '编码格式标记。', - 'description' => 'The tag of the encoding format.'."\n", - 'type' => 'string', - 'example' => '0x001b', - ], - 'Width' => [ - 'title' => '宽。', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - 'Has_b_frames' => [ - 'title' => '是否有B帧。'."\n" - .'取值: '."\n" - .'- 0: 没有 B 帧, '."\n" - .'- 1: 有一个 B 帧, '."\n" - .'- 2: 有多个连续 B 帧。', - 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). Valid values:'."\n" - ."\n" - .'* 0: The stream contains no B-frames.'."\n" - .'* 1: The stream contains one B-frame.'."\n" - .'* 2: The stream contains multiple consecutive B-frames.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Sar' => [ - 'title' => '采集点数宽高比。', - 'description' => 'The aspect ratio of the area from which the sampling points are collected.'."\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.'."\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 of the stream.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - 'Rotate' => [ - 'title' => '视频画面旋转角度。'."\n" - .'取值 0, 90, 180, 270。'."\n" - .'默认值 0', - 'description' => 'The rotation angle of the video image. Valid values: 0, 90, 180, and 270. Default value: 0.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - ], - ], - 'SubmitResultJson' => [ - 'title' => '任务提交结果', - 'description' => 'The job submission result.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'SubmitTime' => [ - 'title' => '任务提交时间', - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务结束时间', - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'RequestId' => [ - 'title' => '提交任务时请求 ID', - 'description' => 'The ID of the request that submitted the job.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - ], - ], - ], - 'CreateTime' => [ - 'title' => '任务创建时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'Name' => [ - 'title' => '任务名。', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'transcode-job', - ], - 'RequestId' => [ - 'title' => '提交任务时请求 ID。', - 'description' => 'The ID of the request that submitted the job.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'ParentJobId' => [ - 'title' => '主任务 ID。', - 'description' => 'The main job ID.'."\n", - 'type' => 'string', - 'example' => '8b2198504dd340b7b3c9842a74fc9baa', - ], - 'JobCount' => [ - 'title' => '子任务数量。', - 'description' => 'The number of subjobs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + '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' => [ - 'title' => '任务状态。 Success: 所有子任务完成后，有一个子任务则为成功, Fail: 所有子任务失败', - 'description' => 'The state of the job.'."\n" - ."\n" - .'* Success: At least one of the subjobs is successful.'."\n" - .'* Fail: All subjobs failed.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'TriggerSource' => [ - 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', - 'description' => 'The source of the job. Valid values:'."\n" - ."\n" - .'* API'."\n" - .'* WorkFlow'."\n" - .'* Console'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'Percent' => [ - 'title' => '任务完成百分比。', - 'description' => 'The completion percentage of the job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SubmitTime' => [ - 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", + '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' => '2022-01-12T08:49:41Z', - ], - 'InputGroup' => [ - 'title' => '任务输入组。单输入时为转码任务，多输入时为合流任务。', - 'description' => 'The input group of the job. An input of a single file indicates a transcoding job. An input of multiple files indicates an audio and video stream merge job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the job input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], + 'example' => 'Finished', + 'title' => '', ], - 'OutputGroup' => [ - 'title' => '任务输出组。', - 'description' => 'The output group of the job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出媒体配置', - 'description' => 'The output file configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'OutputUrl' => [ - 'description' => 'The URL of the output stream.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4'."\n", - ], - ], - ], - 'ProcessConfig' => [ - 'title' => '任务处理配置', - 'description' => 'The job processing configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Transcode' => [ - 'title' => '转码配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Video' => [ - 'title' => 'video 设置', - 'description' => 'The video settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '编码格式', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264', - ], - 'Profile' => [ - 'title' => '编码级别。'."\n" - .' 支持baseline、main、high。'."\n" - .' baseline：针对移动设备。'."\n" - .' main：针对标准分辨率设备。'."\n" - .' high：针对高分辨率设备。'."\n" - .' 默认值：high。', - 'description' => 'The encoding profile. Valid values: baseline, main, and high.'."\n" - ."\n" - .'* baseline: applicable to mobile devices.'."\n" - .'* main: applicable to standard-definition devices.'."\n" - .'* high: applicable to high-definition devices.'."\n" - ."\n" - .'Default value: high.'."\n", - 'type' => 'string', - 'example' => 'Main', - ], - 'Bitrate' => [ - 'title' => '视频平均码率。'."\n" - .' 取值范围：[10，50000]。'."\n" - .' 单位：Kbps。', - 'description' => 'The average bitrate of the video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '3000', - ], - 'Crf' => [ - 'title' => '码率-质量控制因子。'."\n" - .' 取值范围：[0，51]。'."\n" - .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" - .' 如果设置了Crf，则Bitrate的设置失效。', - 'description' => 'The constant rate factor.'."\n" - ."\n" - .'* Valid values: \\[0,51].'."\n" - .'* Default value: 23 if the encoding format is H.264, or 26 if the encoding format is H.265.'."\n" - .'* If this parameter is specified, the value of Bitrate becomes invalid.'."\n", - 'type' => 'string', - 'example' => '23', - ], - 'Width' => [ - 'title' => '宽。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始宽度。', - 'description' => 'The width of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the width of the input video.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始高度。', - 'description' => 'The height of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the height of the input video.'."\n", - 'type' => 'string', - 'example' => '1080', - ], - 'Fps' => [ - 'title' => '帧率。'."\n" - .' 取值范围：(0,60]。'."\n" - .' 当输入文件帧率超过60时取60。'."\n" - .' 默认值：取输入文件帧率', - 'description' => 'The frame rate.'."\n" - ."\n" - .'* Valid values: (0,60].'."\n" - .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" - .'* Default value: the frame rate of the input video.'."\n", - 'type' => 'string', - 'example' => '25', - ], - 'Gop' => [ - 'title' => '关键帧间最大帧数。'."\n" - .' 取值范围：[1，1080000]。'."\n" - .' 默认值：250。', - 'description' => 'The maximum number of frames between two keyframes.'."\n" - ."\n" - .'* Valid values: \\[1,1080000].'."\n" - .'* Default value: 250.'."\n", - 'type' => 'string', - 'example' => '250', - ], - 'Preset' => [ - 'title' => '视频算法器预置。只有H264支持该参数。'."\n" - .'支持veryfast、fast、medium、slow、slower。'."\n" - .'默认值：medium。', - 'description' => 'The preset video algorithm. This parameter takes effect only if the encoding format is H.264. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.'."\n", - 'type' => 'string', - 'example' => 'medium', - ], - 'ScanMode' => [ - 'title' => '扫描模式。'."\n" - .'支持interlaced、progressive。', - 'description' => 'The scan mode. Valid values: interlaced and progressive.'."\n", - 'type' => 'string', - 'example' => 'progressive', - ], - 'PixFmt' => [ - 'title' => '视频颜色格式。'."\n" - .' 范围：yuv420p，yuvj420p等标准颜色格式。', - 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", - 'type' => 'string', - 'example' => 'yuv420p', - ], - 'Remove' => [ - 'title' => '是否去掉视频', - 'description' => 'Indicates whether the video was removed.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Crop' => [ - 'title' => '视频画面裁切'."\n" - .' 支持2种方式。'."\n" - .' 自动检测黑边并裁切，设置为“border”'."\n" - .' 自定义裁切，参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The method of video cropping. Valid values: border: automatically detects and removes black bars. A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'Pad' => [ - 'title' => '视频贴黑边'."\n" - .' 参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The black bars added to the video.'."\n" - ."\n" - .'* Format: width:height:left:top.'."\n" - .'* Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'LongShortMode' => [ - 'title' => '是否开启横竖屏自适应（即：长短边模式）', - 'description' => 'Indicates whether the auto-rotate screen feature is enabled.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Bufsize' => [ - 'title' => '缓冲区大小'."\n" - .' 值范围：[1000，128000]'."\n" - .' 默认值：6000'."\n" - .' 单位：Kb', - 'description' => 'The buffer size.'."\n" - ."\n" - .'* Valid values: \\[1000,128000].'."\n" - .'* Default value: 6000.'."\n" - .'* Unit: KB.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - 'Maxrate' => [ - 'title' => '视频码率峰值'."\n" - .' 值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum bitrate of the output video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '9000', - ], - 'AbrMax' => [ - 'title' => 'abr 最大码率(只有窄高1有效)'."\n" - .'值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum ABR. This parameter takes effect only for Narrowband HD 1.0.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - ], - ], - 'Audio' => [ - 'title' => 'audio 设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" - .' 默认值：AAC', - 'description' => 'The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.'."\n", - 'type' => 'string', - 'example' => 'AAC', - ], - 'Profile' => [ - 'title' => '音频编码预置。'."\n" - .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', - 'description' => 'The audio codec profile. If the Codec parameter is set to AAC, the valid values are aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", - 'type' => 'string', - 'example' => 'aac_low', - ], - 'Samplerate' => [ - 'title' => '采样率。'."\n" - .' 默认值：44100'."\n" - .' 支持22050、32000、44100、48000、96000，'."\n" - .' 单位：Hz', - 'description' => 'The sampling rate.'."\n" - ."\n" - .'* Default value: 44100.'."\n" - .'* Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" - .'* Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Bitrate' => [ - 'title' => '输出文件的音频码率。'."\n" - .' 值范围：[8，1000]'."\n" - .' 单位：Kbps'."\n" - .' 默认值：128', - 'description' => 'The audio bitrate of the output file.'."\n" - ."\n" - .'* Valid values: \\[8,1000].'."\n" - .'* Unit: Kbit/s.'."\n" - .'* Default value: 128.'."\n", - 'type' => 'string', - 'example' => '128', - ], - 'Channels' => [ - 'title' => '声道数。'."\n" - .' 默认值：2', - 'description' => 'The number of sound channels. Default value: 2.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Remove' => [ - 'title' => '是否删除音频流。', - 'description' => 'Indicates whether the audio stream is deleted.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Volume' => [ - 'title' => '音量控制', - 'description' => 'The volume configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => '音量调整方式', - 'description' => 'The volume adjustment method. Valid values:'."\n", - 'type' => 'string', - 'example' => 'auto', - ], - 'IntegratedLoudnessTarget' => [ - 'title' => '目标音量', - 'description' => 'The output volume.'."\n", - 'type' => 'string', - 'example' => '-6', - ], - 'TruePeak' => [ - 'title' => '最大峰值', - 'description' => 'The peak volume.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'LoudnessRangeTarget' => [ - 'title' => '音量范围', - 'description' => 'The volume range.'."\n", - 'type' => 'string', - 'example' => '8', - ], - ], - ], - ], - ], - 'Container' => [ - 'title' => '封装格式设置', - 'description' => 'The encapsulation format settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '容器格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mp4', - ], - ], - ], - 'MuxConfig' => [ - 'title' => '封装设置', - 'description' => 'The encapsulation settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Segment' => [ - 'title' => '切片设置', - 'description' => 'The segment settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Duration' => [ - 'title' => '切片时长', - 'description' => 'The segment length.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ForceSegTime' => [ - 'title' => '强制切片时间点', - 'description' => 'The forced segmentation point in time.'."\n", - 'type' => 'string', - 'example' => '2,3', - ], - ], - ], - ], - ], - 'TransConfig' => [ - 'description' => 'The conditional transcoding configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'TransMode' => [ - 'description' => 'The video transcoding mode. Valid values:'."\n" - ."\n" - .'* onepass: You can set this parameter to onepass if the Bitrate parameter is set to ABR. The encoding speed of this mode is faster than that of the twopass mode.'."\n" - .'* twopass: You can set this parameter to twopass if the Bitrate parameter is set to VBR. The encoding speed of this mode is slower than that of the onepass mode.'."\n" - .'* CBR: the constant bitrate mode.'."\n" - ."\n" - .'Default value: onepass.'."\n", - 'type' => 'string', - 'example' => 'onepass', - ], - 'IsCheckReso' => [ - 'description' => 'Indicates whether the video resolution was checked. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the width or height of the input video is less than that of the output video, the resolution of the input video is used for transcoding.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckResoFail' => [ - 'description' => 'Indicates whether the video resolution was checked. You can specify only one of the IsCheckReso and IsCheckResoFail parameters. The priority of the IsCheckResoFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the width or height of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrate' => [ - 'description' => 'Indicates whether the video bitrate was checked. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input video is less than that of the output video, the bitrate of the input video is used for transcoding.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckVideoBitrateFail' => [ - 'description' => 'Indicates whether the video bitrate was checked. You can specify only one of the IsCheckVideoBitrate and IsCheckVideoBitrateFail parameters. The priority of the IsCheckVideoBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input video is less than that of the output video, the transcoding job fails.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrate' => [ - 'description' => 'Indicates whether the audio bitrate was checked. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input audio is less than that of the output audio, the bitrate of the input audio is used for transcoding.'."\n" - .'* false'."\n" - ."\n" - .'Default value:'."\n" - ."\n" - .'* If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false.'."\n" - .'* If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IsCheckAudioBitrateFail' => [ - 'description' => 'Indicates whether the audio bitrate was checked. You can specify only one of the IsCheckAudioBitrate and IsCheckAudioBitrateFail parameters. The priority of the IsCheckAudioBitrateFail parameter is higher. Valid values:'."\n" - ."\n" - .'* true If the bitrate of the input audio is less than that of the output audio, the transcoding job fails.'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'AdjDarMethod' => [ - 'description' => 'The method that is used to adjust 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" - ."\n" - .'Default value: none.'."\n", - 'type' => 'string', - 'example' => 'none', - ], - ], - ], - ], - ], - ], - ], - 'ImageWatermarks' => [ - 'title' => '图片水印配置', - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The watermark configuration of an image.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Width' => [ - 'title' => '宽', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Dx' => [ - 'title' => '水印位置，x', - 'description' => 'The position of the watermark on the x-axis.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Dy' => [ - 'title' => '水印位置，y', - 'description' => 'The position of the watermark on the y-axis.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ReferPos' => [ - 'title' => '参考位置: TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft', - 'description' => 'The reference position of the watermark. Valid values: TopLeft, TopRight, BottomLeft, and BottomRight. Default value: TopLeft.'."\n", - 'type' => 'string', - 'example' => 'TopLeft', - ], - 'Timeline' => [ - 'title' => '显示时间设置', - 'description' => 'The timeline settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'title' => '开始时间', - 'description' => 'The start time of the stream.'."\n", - 'type' => 'string', - 'example' => '00:00:05', - ], - 'Duration' => [ - 'title' => '显示时长，秒数 或者 "ToEND"', - 'description' => 'The duration of the stream. Valid values: the number of seconds or "ToEND".'."\n", - 'type' => 'string', - 'example' => 'ToEND', - ], - ], - ], - 'File' => [ - 'title' => '水印图片文件', - 'description' => 'The watermark image file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'TextWatermarks' => [ - 'title' => '文字水印配置', - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码', - 'description' => 'The watermark text. Base64 encoding is not required. The string must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'example' => '测试水印', - ], - 'FontName' => [ - 'title' => '字体', - 'description' => 'The font of the text.'."\n", - 'type' => 'string', - 'example' => 'SimSun', - ], - 'FontColor' => [ - 'title' => '颜色', - 'description' => 'The color of the text.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'FontAlpha' => [ - 'title' => '透明度', - 'description' => 'The transparency of the watermark.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'Top' => [ - 'title' => '水印位置，距离上边距离', - 'description' => 'The distance of the watermark from the top edge.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Left' => [ - 'title' => '水印位置，距离左边距离', - 'description' => 'The distance of the watermark from the left edge.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'FontSize' => [ - 'title' => '字体大小', - 'description' => 'The size of the text.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'BorderWidth' => [ - 'title' => '边框宽度', - 'description' => 'The border width.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BorderColor' => [ - 'title' => '边框颜色', - 'description' => 'The border color.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'Adaptive' => [ - 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', - 'description' => 'Indicates whether the text size was adjusted based on the output video dimensions. Valid values: true and false. Default value: false.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - 'Subtitles' => [ - 'title' => '字幕压制配置', - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '字幕文件格式', - 'description' => 'The format of the subtitle file.'."\n", - 'type' => 'string', - 'example' => 'vtt', - ], - 'CharEnc' => [ - 'title' => '文件 encoding 格式', - 'description' => 'The file encoding format.'."\n", - 'type' => 'string', - 'example' => 'UTF-8', - ], - 'File' => [ - 'title' => '字幕文件', - 'description' => 'The subtitle file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'Encryption' => [ - 'title' => '加密配置。', - 'description' => 'The encryption settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'EncryptType' => [ - 'title' => '加密类型。', - 'description' => 'The encryption type.'."\n", - 'type' => 'string', - 'example' => 'PrivateEncryption', - ], - 'CipherText' => [ - 'title' => '标准加密的密钥密文。', - 'description' => 'The ciphertext of HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'MTYi00NDU0LTg5O****', - ], - 'DecryptKeyUri' => [ - 'title' => '标准加密的解密服务地址。', - 'description' => 'The endpoint of the decryption service for HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', - ], - 'KeyServiceType' => [ - 'title' => '密钥服务类型。目前仅支持KMS和Base64', - 'description' => 'The type of the key service. Valid values: KMS and Base64.'."\n", - 'type' => 'string', - 'example' => 'KMS', - ], - ], - ], - 'CombineConfigs' => [ - 'title' => '多输入合流配置', - 'description' => 'The multi-input stream merge configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AudioIndex' => [ - 'title' => '音频流Index', - 'description' => 'The audio stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'VideoIndex' => [ - 'title' => '视频流Index', - 'description' => 'The video stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'Start' => [ - 'title' => '输入流的开始时间。 默认为0', - 'description' => 'The start time of the input stream. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Duration' => [ - 'title' => '输入流的持续时间。 默认为视频时长。', - 'description' => 'The duration of the input stream. The default value is the duration of the video.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '20.0', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - ], + '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' => ''], ], - 'UserData' => [ - 'title' => '用户数据。', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', + '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' => ''], ], - 'ScheduleConfig' => [ - 'title' => '任务调度配置。', - 'description' => 'The scheduling configuration of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the snapshot job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], + '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' => '', ], ], ], - '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\\": \\"测试水印\\",\\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 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 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\\": \\"测试水印\\",\\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 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 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 information about a transcoding job.', - ], - 'ListTranscodeJobs' => [ - 'methods' => [ - 'get', - 'post', + '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' => ''], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -26135,1166 +14598,487 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146716', + 'abilityTreeNodes' => ['FEATUREiceM55707'], + ], 'parameters' => [ [ - 'name' => 'StartOfCreateTime', + 'name' => 'StartTs', 'in' => 'query', - 'schema' => [ - 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-01T00:00:00Z', - ], + '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' => 'EndOfCreateTime', + 'name' => 'EndTs', 'in' => 'query', - 'schema' => [ - 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-15T00:00:00Z', - ], + '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' => 'ParentJobId', + 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'title' => '按 jobId 筛选。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7b38a5d86f1e47838927b6e7ccb1****', - ], + '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' => 'Status', + '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' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The state of the job.'."\n" - ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Success', + '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' => [ [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', - '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" - .'* CreateTimeAsc: sorts the query results by creation time in ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTimeDesc', + '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' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146724', + 'abilityTreeNodes' => ['FEATUREiceM55707'], + ], + 'parameters' => [ + [ + 'name' => 'StartTs', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小。范围: 0~100，默认值：20。', - 'description' => 'The number of entries per page. Valid values: 0 to 100. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => 'NextPageToken', + 'name' => 'EndTs', 'in' => 'query', - 'schema' => [ - 'title' => '连续分页查询时下一页的标记 (第一页没有)。', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], + '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' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'Jobs' => [ - 'description' => 'The list of jobs.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C'], + 'Data' => [ + 'description' => 'The usage statistics of IMS.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the job.'."\n", 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'title' => '任务创建时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'Name' => [ - 'title' => '任务名。', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'transcode-job', - ], - 'RequestId' => [ - 'title' => '提交任务时请求 ID。', - 'description' => 'The ID of the request that submitted the job.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'ParentJobId' => [ - 'title' => '主任务 ID。', - 'description' => 'The main job ID.'."\n", - 'type' => 'string', - 'example' => '8b2198504dd340b7b3c9842a74fc9baa', - ], - 'JobCount' => [ - 'title' => '子任务数量。', - 'description' => 'The number of subjobs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'title' => '任务状态。 Success: 所有子任务完成后，有一个子任务则为成功, Fail: 所有子任务失败', - 'description' => 'The state of the job.'."\n" - ."\n" - .'* Success: At least one of the subjobs is successful.'."\n" - .'* Fail: All subjobs failed.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'TriggerSource' => [ - 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', - 'description' => 'The source of the job. Valid values:'."\n" - ."\n" - .'* API'."\n" - .'* WorkFlow'."\n" - .'* Console'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'Percent' => [ - 'title' => '任务完成百分比。', - 'description' => 'The completion percentage of the job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SubmitTime' => [ - 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'InputGroup' => [ - 'title' => '任务输入组。单输入时为转码任务，多输入时为合流任务。', - 'description' => 'The input group of the job. An input of a single file indicates a transcoding job. An input of multiple files indicates an audio and video stream merge job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'InputUrl' => [ - 'description' => 'The URL of the media asset. This parameter is specified only when the media asset is transcoded.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - 'OutputGroup' => [ - 'title' => '任务输出组。', - 'description' => 'The output group of the job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出媒体配置', - 'description' => 'The output file configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - 'OutputUrl' => [ - 'description' => 'The URL of the transcoded output stream. This parameter is required only when the output is a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4', - ], - ], - ], - 'ProcessConfig' => [ - 'title' => '任务处理配置', - 'description' => 'The job processing configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Transcode' => [ - 'title' => '转码配置', - 'description' => 'The transcoding configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Video' => [ - 'title' => 'video 设置', - 'description' => 'The video settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '编码格式', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264', - ], - 'Profile' => [ - 'title' => '编码级别。'."\n" - .' 支持baseline、main、high。'."\n" - .' baseline：针对移动设备。'."\n" - .' main：针对标准分辨率设备。'."\n" - .' high：针对高分辨率设备。'."\n" - .' 默认值：high。', - 'description' => 'The encoding profile. Valid values: baseline, main, and high.'."\n" - ."\n" - .'* baseline: applicable to mobile devices.'."\n" - .'* main: applicable to standard-definition devices.'."\n" - .'* high: applicable to high-definition devices.'."\n" - ."\n" - .'Default value: high.'."\n", - 'type' => 'string', - 'example' => 'Main', - ], - 'Bitrate' => [ - 'title' => '视频平均码率。'."\n" - .' 取值范围：[10，50000]。'."\n" - .' 单位：Kbps。', - 'description' => 'The average bitrate of the video.'."\n" - ."\n" - .'* Valid values: \\[10,50000].'."\n" - .'* Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '3000', - ], - 'Crf' => [ - 'title' => '码率-质量控制因子。'."\n" - .' 取值范围：[0，51]。'."\n" - .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" - .' 如果设置了Crf，则Bitrate的设置失效。', - 'description' => 'The constant rate factor.'."\n" - ."\n" - .'* Valid values: \\[0,51].'."\n" - .'* Default value: 23 if the encoding format is H.264, or 26 if the encoding format is H.265.'."\n" - ."\n" - .'If this parameter is set, the value of Bitrate becomes invalid.'."\n", - 'type' => 'string', - 'example' => '23', - ], - 'Width' => [ - 'title' => '宽。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始宽度。', - 'description' => 'The width of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the width of the input video.'."\n", - 'type' => 'string', - 'example' => '1920', - ], - 'Height' => [ - 'title' => '高。'."\n" - .' 取值范围：[128,4096]。'."\n" - .' 单位：px。'."\n" - .' 默认值：视频原始高度。', - 'description' => 'The height of the output video.'."\n" - ."\n" - .'* Valid values: \\[128,4096].'."\n" - .'* Unit: pixels.'."\n" - .'* Default value: the height of the input video.'."\n", - 'type' => 'string', - 'example' => '1080', - ], - 'Fps' => [ - 'title' => '帧率。'."\n" - .' 取值范围：(0,60]。'."\n" - .' 当输入文件帧率超过60时取60。'."\n" - .' 默认值：取输入文件帧率', - 'description' => 'The frame rate.'."\n" - ."\n" - .'* Valid values: (0,60].'."\n" - .'* The value is 60 if the frame rate of the input video exceeds 60.'."\n" - .'* Default value: the frame rate of the input video.'."\n", - 'type' => 'string', - 'example' => '25', - ], - 'Gop' => [ - 'title' => '关键帧间最大帧数。'."\n" - .' 取值范围：[1，1080000]。'."\n" - .' 默认值：250。', - 'description' => 'The maximum number of frames between two keyframes.'."\n" - ."\n" - .'* Valid values: \\[1,1080000].'."\n" - .'* Default value: 250.'."\n", - 'type' => 'string', - 'example' => '250', - ], - 'Preset' => [ - 'title' => '视频算法器预置。只有H264支持该参数。'."\n" - .'支持veryfast、fast、medium、slow、slower。'."\n" - .'默认值：medium。', - 'description' => 'The preset video algorithm. This parameter takes effect only if the encoding format is H.264. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.'."\n", - 'type' => 'string', - 'example' => 'medium', - ], - 'ScanMode' => [ - 'title' => '扫描模式。'."\n" - .'支持interlaced、progressive。', - 'description' => 'The scan mode. Valid values: interlaced and progressive.'."\n", - 'type' => 'string', - 'example' => 'progressive', - ], - 'PixFmt' => [ - 'title' => '视频颜色格式。'."\n" - .' 范围：yuv420p，yuvj420p等标准颜色格式。', - 'description' => 'The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.'."\n", - 'type' => 'string', - 'example' => 'yuv420p', - ], - 'Remove' => [ - 'title' => '是否去掉视频', - 'description' => 'Indicates whether the video was removed.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Crop' => [ - 'title' => '视频画面裁切'."\n" - .' 支持2种方式。'."\n" - .' 自动检测黑边并裁切，设置为“border”'."\n" - .' 自定义裁切，参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The method of video cropping. Valid values:'."\n" - ."\n" - .'* border: automatically detects and removes black bars.'."\n" - .'* A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'Pad' => [ - 'title' => '视频贴黑边'."\n" - .' 参数格式：width:height:left:top。'."\n" - .' 示例：1280:800:0:140', - 'description' => 'The black bars added to the video.'."\n" - ."\n" - .'* Format: width:height:left:top.'."\n" - .'* Example: 1280:800:0:140.'."\n", - 'type' => 'string', - 'example' => '1280:800:0:140', - ], - 'LongShortMode' => [ - 'title' => '是否开启横竖屏自适应（即：长短边模式）', - 'description' => 'Indicates whether the auto-rotate screen feature is enabled.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Bufsize' => [ - 'title' => '缓冲区大小'."\n" - .' 值范围：[1000，128000]'."\n" - .' 默认值：6000'."\n" - .' 单位：Kb', - 'description' => 'The buffer size.'."\n" - ."\n" - .'* Valid values: \\[1000,128000].'."\n" - .'* Default value: 6000.'."\n" - .'* Unit: KB.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - 'Maxrate' => [ - 'title' => '视频码率峰值'."\n" - .' 值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum bitrate of the output video. Valid values: \\[10,50000]. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '9000', - ], - 'AbrMax' => [ - 'title' => 'abr 最大码率(只有窄高1有效)'."\n" - .'值范围[10，50000]，单位Kbps。', - 'description' => 'The maximum adaptive bitrate (ABR). This parameter takes effect only for Narrowband HD 1.0. Valid values: \\[10,50000]. Unit: Kbit/s.'."\n", - 'type' => 'string', - 'example' => '6000', - ], - ], - ], - 'Audio' => [ - 'title' => 'audio 设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" - .' 默认值：AAC', - 'description' => 'The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.'."\n", - 'type' => 'string', - 'example' => 'AAC', - ], - 'Profile' => [ - 'title' => '音频编码预置。'."\n" - .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', - 'description' => 'The audio codec profile. If the Codec parameter is set to AAC, the valid values are aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.'."\n", - 'type' => 'string', - 'example' => 'aac_low', - ], - 'Samplerate' => [ - 'title' => '采样率。'."\n" - .' 默认值：44100'."\n" - .' 支持22050、32000、44100、48000、96000，'."\n" - .' 单位：Hz', - 'description' => 'The sampling rate.'."\n" - ."\n" - .'* Default value: 44100.'."\n" - .'* Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" - .'* Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Bitrate' => [ - 'title' => '输出文件的音频码率。'."\n" - .' 值范围：[8，1000]'."\n" - .' 单位：Kbps'."\n" - .' 默认值：128', - 'description' => 'The audio bitrate of the output file.'."\n" - ."\n" - .'* Valid values: \\[8,1000].'."\n" - .'* Unit: Kbit/s.'."\n" - .'* Default value: 128.'."\n", - 'type' => 'string', - 'example' => '128', - ], - 'Channels' => [ - 'title' => '声道数。'."\n" - .' 默认值：2', - 'description' => 'The number of sound channels. Default value: 2.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Remove' => [ - 'title' => '是否删除音频流。', - 'description' => 'Indicates whether the audio stream is deleted.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'Volume' => [ - 'title' => '音量控制', - 'description' => 'The volume configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => '音量调整方式', - 'description' => 'The volume adjustment method. Valid values:'."\n", - 'type' => 'string', - 'example' => 'auto', - ], - 'IntegratedLoudnessTarget' => [ - 'title' => '目标音量', - 'description' => 'The output volume.'."\n", - 'type' => 'string', - 'example' => '-6', - ], - 'TruePeak' => [ - 'title' => '最大峰值', - 'description' => 'The peak volume.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'LoudnessRangeTarget' => [ - 'title' => '音量范围', - 'description' => 'The volume range.'."\n", - 'type' => 'string', - 'example' => '8', - ], - ], - ], - ], - ], - 'Container' => [ - 'title' => '封装格式设置', - 'description' => 'The encapsulation format settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '容器格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mp4', - ], - ], - ], - 'MuxConfig' => [ - 'title' => '封装设置', - 'description' => 'The encapsulation settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Segment' => [ - 'title' => '切片设置', - 'description' => 'The segment settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Duration' => [ - 'title' => '切片时长', - 'description' => 'The segment length.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ForceSegTime' => [ - 'title' => '强制切片时间点', - 'description' => 'The forced segmentation point in time.'."\n", - 'type' => 'string', - 'example' => '2,3', - ], - ], - ], - ], - ], - 'Tags' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'ImageWatermarks' => [ - 'title' => '图片水印配置', - 'description' => 'The watermark configuration for an image.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The watermark configuration for an image.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Width' => [ - 'title' => '宽', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '32', - ], - 'Dx' => [ - 'title' => '水印位置，x', - 'description' => 'The position of the watermark on the x-axis.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Dy' => [ - 'title' => '水印位置，y', - 'description' => 'The position of the watermark on the y-axis.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ReferPos' => [ - 'title' => '参考位置: TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft', - 'description' => 'The reference position of the watermark. Valid values: TopLeft, TopRight, BottomLeft, and BottomRight. Default value: TopLeft.'."\n", - 'type' => 'string', - 'example' => 'TopLeft', - ], - 'Timeline' => [ - 'title' => '显示时间设置', - 'description' => 'The timeline settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'title' => '开始时间', - 'description' => 'The beginning of the time range for which data was queried.'."\n", - 'type' => 'string', - 'example' => '00:00:05', - ], - 'Duration' => [ - 'title' => '显示时长，秒数 或者 "ToEND"', - 'description' => 'The duration of the stream. Valid values: the number of seconds or "ToEND".'."\n", - 'type' => 'string', - 'example' => 'ToEND', - ], - ], - ], - 'File' => [ - 'title' => '水印图片文件', - 'description' => 'The watermark image file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'TextWatermarks' => [ - 'title' => '文字水印配置', - 'description' => 'The configurations of the text watermarks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the text watermark.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码', - 'description' => 'The watermark text. Base64 encoding is not required. The string must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'example' => '测试水印', - ], - 'FontName' => [ - 'title' => '字体', - 'description' => 'The font of the text.'."\n", - 'type' => 'string', - 'example' => 'SimSun', - ], - 'FontColor' => [ - 'title' => '颜色', - 'description' => 'The color of the text.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'FontAlpha' => [ - 'title' => '透明度', - 'description' => 'The transparency of the watermark.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'Top' => [ - 'title' => '水印位置，距离上边距离', - 'description' => 'The distance of the watermark from the top edge.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Left' => [ - 'title' => '水印位置，距离左边距离', - 'description' => 'The distance of the watermark from the left edge.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'FontSize' => [ - 'title' => '字体大小', - 'description' => 'The size of the text.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'BorderWidth' => [ - 'title' => '边框宽度', - 'description' => 'The border width.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BorderColor' => [ - 'title' => '边框颜色', - 'description' => 'The border color.'."\n", - 'type' => 'string', - 'example' => '#006400', - ], - 'Adaptive' => [ - 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', - 'description' => 'Indicates whether the text size was adjusted based on the output video dimensions. true / false, default: false'."\n", - 'type' => 'string', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - 'Subtitles' => [ - 'title' => '字幕压制配置', - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The subtitle configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板 ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', - ], - 'OverwriteParams' => [ - 'title' => '覆盖参数, 若填写会覆盖模板对应参数', - 'description' => 'The parameters that are used to overwrite the corresponding parameters of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '字幕文件格式', - 'description' => 'The format of the subtitle file.'."\n", - 'type' => 'string', - 'example' => 'vtt', - ], - 'CharEnc' => [ - 'title' => '文件 encoding 格式', - 'description' => 'The file encoding format.'."\n", - 'type' => 'string', - 'example' => 'UTF-8', - ], - 'File' => [ - 'title' => '字幕文件', - 'description' => 'The subtitle file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - ], - ], - 'Encryption' => [ - 'title' => '加密配置。', - 'description' => 'The encryption settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'EncryptType' => [ - 'title' => '加密类型。', - 'description' => 'The encryption type.'."\n", - 'type' => 'string', - 'example' => 'PrivateEncryption', - ], - 'CipherText' => [ - 'title' => '标准加密的密钥密文。', - 'description' => 'The ciphertext of HTTP Live Streaming (HLS) encryption.'."\n", - 'type' => 'string', - 'example' => 'MTYi00NDU0LTg5O****', - ], - 'DecryptKeyUri' => [ - 'title' => '标准加密的解密服务地址。', - 'description' => 'The endpoint of the decryption service for HLS encryption.'."\n", - 'type' => 'string', - 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', - ], - ], - ], - 'CombineConfigs' => [ - 'title' => '多输入合流配置', - 'description' => 'The multi-input stream merge configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AudioIndex' => [ - 'title' => '音频流Index', - 'description' => 'The audio stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'VideoIndex' => [ - 'title' => '视频流Index', - 'description' => 'The video stream index.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 或 exclude', - ], - 'Start' => [ - 'title' => '输入流的开始时间。 默认为0', - 'description' => 'The start time of the input stream. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.0', - ], - 'Duration' => [ - 'title' => '输入流的持续时间。 默认为视频时长。', - 'description' => 'The duration of the input stream. The default value is the duration of the video.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '20.0', - ], - ], - 'description' => '', - ], - ], - 'IsInheritTags' => [ - 'description' => 'Indicates whether the tags of the input stream are inherited in the output stream. This parameter does not take effect when the input is not a media asset. Default value: false.'."\n", - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - 'UserData' => [ - 'title' => '用户数据。', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '任务调度配置。', - 'description' => 'The scheduling configuration of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], + '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' => '', ], - 'NextPageToken' => [ - 'title' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', - '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.'."\n", + ], + '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' => '019daf5780f74831b0e1a767c9f1c178', + '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'], ], - 'description' => '', + '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\\": \\"测试水印\\",\\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 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ],\\n \\"IsInheritTags\\": true\\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' => 'Queries a list of transcoding jobs.', - ], - 'SubmitPackageJob' => [ - 'summary' => 'Submits a packaging job.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', - 'http', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146436', + 'abilityTreeNodes' => ['FEATUREiceM55707'], + ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'job-name', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Inputs', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Input' => [ - 'title' => '打包播放流文件信息', - 'description' => 'The information about the input stream file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Output', + 'name' => 'TraceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object. If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported. If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The TraceId of the player.', 'type' => 'string', 'required' => false, 'example' => '0bc5e70516766285805381012d271e', 'title' => ''], ], [ - 'name' => 'ScheduleConfig', + 'name' => 'BeginTs', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The scheduling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], + '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' => 'UserData', + 'name' => 'EndTs', 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"param": "value"}', - ], + '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' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'JobId' => [ - 'title' => '打包任务ID', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '2d705f385b704ee5b*******a36d93e0', + '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' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"JobId\\": \\"2d705f385b704ee5b*******a36d93e0\\"\\n}","type":"json"}]', - 'title' => 'SubmitPackageJob', - ], - 'GetPackageJob' => [ - 'summary' => 'Queries the information about a packaging job.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -27302,912 +15086,483 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230670', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '任务 ID', - 'description' => 'The job ID. You can obtain the job ID from the response parameters of the [SubmitPackageJob](~~461964~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => '727dc0e296014bb58670940a3da95592', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'PackageJob' => [ - 'title' => '打包任务信息', - 'description' => 'The information about the packaging job.'."\n", + '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' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], - 'TriggerSource' => [ - 'description' => 'The source of the job. Valid values:'."\n" - ."\n" - .'* API'."\n" - .'* WorkFlow'."\n" - .'* Console'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'job-name', - ], - 'Inputs' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Input' => [ - 'title' => '打包播放流文件信息', - 'description' => 'The information about the input stream file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - 'Output' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.m3u8', - ], - ], - ], - 'OutputUrl' => [ - 'description' => 'The URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/output.m3u8', - ], - 'PipelineId' => [ - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => '36f3fee40aa047c0b067d0fb85edc12b', - ], - 'Priority' => [ - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'Code' => [ - 'description' => 'The error code returned if the job fails.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'Message' => [ - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => 'Resource content bad.', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-09-08T11:34:05Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-09-08T11:44:05Z', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '{"param": "value"}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-09-08T11:34:05Z'."\n", - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-09-08T11:44:05Z'."\n", - ], + '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' => ''], ], - 'description' => '', + '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', - ], - 'ListPackageJobs' => [ - 'summary' => 'Queries packaging jobs.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', - 'http', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'StartOfCreateTime', + 'name' => 'VoiceId', 'in' => 'query', - 'schema' => [ - 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-01T00:00:00Z', - ], + 'schema' => ['description' => 'The voice ID.', 'type' => 'string', 'required' => true, 'example' => 'xiaozhuan', 'title' => ''], ], [ - 'name' => 'EndOfCreateTime', + 'name' => 'RecordUrl', 'in' => 'query', - 'schema' => [ - 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-15T00:00:00Z', - ], + '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' => 'JobId', + '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' => '按 jobId 筛选。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7b38a5d86f1e47838927b6e7ccb11cbe', + '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' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The state of the job.'."\n" - ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Success', + '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' => [ [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', - '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" - .'* CreateTimeAsc: sorts the jobs by creation time in ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTimeDesc', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小。范围: 0~100，默认值：20。', - 'description' => 'The number of entries per page. Valid values: 0 to 100. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => 'NextPageToken', + 'name' => 'IndexType', 'in' => 'query', 'schema' => [ - 'title' => '连续分页查询时下一页的标记 (第一页没有)。', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", + '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' => false, - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + 'required' => true, + 'title' => '', + 'example' => 'mm', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'PackageJobList' => [ - 'title' => '打包任务列表', - 'description' => 'The list of packaging jobs.'."\n", - 'type' => 'object', - 'properties' => [ - 'PackageJobs' => [ - 'description' => 'The list of packaging jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The packaging job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '7b38a5d86f1e47838927b6e7ccb11cbe', - ], - 'TriggerSource' => [ - 'description' => 'The source of the job. Valid values:'."\n" - ."\n" - .'* API'."\n" - .'* WorkFlow'."\n" - .'* Console'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'job-name', - ], - 'Inputs' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Input' => [ - 'title' => '打包播放流文件信息', - 'description' => 'The information about the input stream file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - ], - ], - ], - 'Output' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - 'PipelineId' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.'."\n", - 'type' => 'string', - 'example' => '5b40833e4c3e4d4e95a866abb9a42510', - ], - 'Priority' => [ - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority. Default value: 6.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Code' => [ - 'description' => 'The error code returned if the job fails.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'Message' => [ - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => 'Resource content bad. ', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-07-07T14:00:32Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-07-07T15:00:32Z', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '{"param": "value"}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-07-07T14:00:32Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-07-07T15:00:32Z', - ], - ], - ], - ], - 'NextPageToken' => [ - 'title' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', - '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.'."\n", - 'type' => 'string', - 'example' => '019daf5780f74831b0e1a767c9f1c178', - ], - ], - ], + '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' => ''], ], - 'description' => '', + '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', - ], - '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', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], - 'parameters' => [], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'DataKey' => [ - 'description' => 'The information about the data key.'."\n", - 'type' => 'object', - 'properties' => [ - 'KeyId' => [ - 'description' => 'The ID of the customer master key (CMK). The ID must be globally unique.'."\n", - 'type' => 'string', - 'example' => '7906979c-8e06-46a2-be2d-68e3ccbc****'."\n", - ], - 'Plaintext' => [ - 'description' => 'The Base64-encoded plaintext of the data key.'."\n", - 'type' => 'string', - 'example' => 'QmFzZTY0IGVuY29kZWQgcGxhaW50****'."\n", - ], - 'CiphertextBlob' => [ - 'description' => 'The ciphertext of the encrypted data key. This parameter is used as CipherText when you create a transcoding job.'."\n", - 'type' => 'string', - 'example' => ' '."\n" - .'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', - ], - ], - ], + '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' => '', ], ], ], - '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', - ], - 'DecryptKMSDataKey' => [ - 'summary' => 'Decrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], + ], 'parameters' => [ [ - 'name' => 'CiphertextBlob', + '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 ciphertext that you want to decrypt.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', - ], + 'schema' => ['description' => 'The name of the output.', 'type' => 'string', 'required' => false, 'example' => 'AliTestOutput', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'DataKey' => [ - 'description' => 'The information about the decryption result.'."\n", - 'type' => 'object', - 'properties' => [ - 'KeyId' => [ - 'description' => 'The ID of the customer master key (CMK) that was used to decrypt the ciphertext.'."\n", - 'type' => 'string', - 'example' => '202b9877-5a25-46e3-a763-e20791b5****'."\n", - ], - 'Plaintext' => [ - 'description' => 'The plaintext that is generated after decryption.'."\n", - 'type' => 'string', - 'example' => 'tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****'."\n", - ], - ], - ], + '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' => '', ], ], ], - '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', - ], - 'SubmitSnapshotJob' => [ - 'summary' => 'Submits a snapshot job.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'https', - 'http', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceMX4DML'], + ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SampleJob', - ], - ], - [ - 'name' => 'Input', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The snapshot input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Media', - ], - '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" - .'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.'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the Intelligent Media Services (IMS) console.', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object.mp4', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'Current call instance ID, used only in inbound call transfer scenarios.', 'type' => 'string', 'required' => false, 'example' => 'call_instance_202******', 'title' => ''], ], [ - 'name' => 'Output', + 'name' => 'CalledNumber', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The snapshot output.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - '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" - .'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".'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the IMS console.', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://test-bucket/output-{Count}.jpg', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The target phone number for call transfer.', 'type' => 'string', 'required' => false, 'example' => '13**********', 'title' => ''], ], [ - 'name' => 'TemplateConfig', + 'name' => 'TransferPrompt', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The snapshot template configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****'."\n", - ], - 'OverwriteParams' => [ - 'description' => 'The parameters that are used to overwrite the corresponding parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The snapshot type. Valid values:'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Sprite', - ], - 'FrameType' => [ - 'title' => '截图公共参数', - 'description' => 'The type of the frame.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'intra', - ], - 'Count' => [ - 'description' => 'The number of snapshots.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], - 'Interval' => [ - 'description' => 'The interval at which snapshots are captured.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'Time' => [ - 'description' => 'The point in time at which the system starts to capture snapshots in the input video.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - 'Width' => [ - 'description' => 'The width of a captured snapshot.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '720', - ], - 'Height' => [ - 'description' => 'The height of a captured snapshot.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '480', - ], - 'BlackLevel' => [ - 'description' => 'The threshold that is used to filter out black frames for the first snapshot to be captured. This feature is available if you request the system to capture multiple snapshots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'PixelBlackThreshold' => [ - 'description' => 'The color value threshold that determines whether a pixel is black.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '70', - ], - 'SpriteSnapshotConfig' => [ - 'title' => '雪碧图配置', - 'description' => 'The configuration of the sprite snapshot.'."\n", - 'type' => 'object', - 'properties' => [ - 'CellWidth' => [ - 'description' => 'The width of a single snapshot before tiling. The default value is the width of the output snapshot.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '720', - ], - 'CellHeight' => [ - 'description' => 'The height of a single snapshot before tiling. The default value is the height of the output snapshot.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '480', - ], - 'Padding' => [ - 'description' => 'The spacing between two adjacent snapshots. Default value: 0. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'Margin' => [ - 'description' => 'The width of the frame. Default value: 0. Unit: pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'Columns' => [ - 'description' => 'The number of columns that the image sprite contains.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'Lines' => [ - 'description' => 'The number of rows that the image sprite contains.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'Color' => [ - 'description' => 'The background color.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '#000000', - ], - ], - 'required' => false, - ], - 'IsSptFrag' => [ - 'title' => 'Webvtt截图配置:是否拼合输出', - 'description' => 'The WebVTT snapshot configuration that specifies whether to merge the output snapshots.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], + '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' => 'ScheduleConfig', + 'name' => 'ErrorPrompt', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The scheduling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****'."\n", - ], - ], - 'required' => false, - ], + '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' => 'UserData', + 'name' => 'CallerNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"test parameter": "test value"}', - ], + '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' => 'PlainResponse', - 'description' => 'PlainResponse'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '550e8400********55440000'."\n"], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitSnapshotJob', - ], - 'SubmitDynamicImageJob' => [ - 'summary' => 'Submits an image animation job.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -28215,289 +15570,197 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236524', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'AIAgentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SampleJob', - ], + 'schema' => ['description' => 'The AI agent ID.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ - 'name' => 'Input', + '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' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Media' => '', - 'OSS' => '', - ], - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The input file. If Type is set to OSS, set this parameter to the URL of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. The URL of an OSS object can be in one of the following formats:'."\n" - ."\n" - .'1. oss://bucket/object'."\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.'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the Intelligent Media Services (IMS) console.', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object.mp4', - ], - ], - 'required' => true, - ], + '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' => 'Output', + '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 output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Media' => '', - 'OSS' => '', - ], - 'example' => 'Media', - ], - 'Media' => [ - 'description' => 'The output 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" - .'* oss://bucket/object'."\n" - .'* 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.'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the IMS console.', - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], - ], - 'required' => true, - ], + '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' => 'TemplateConfig', + 'name' => 'ChatSyncConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The snapshot template configuration.'."\n", + 'description' => 'The chat synchronization configuration.', 'type' => 'object', 'properties' => [ - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****'."\n", - ], - 'OverwriteParams' => [ - 'description' => 'The parameters that are used to overwrite the corresponding parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'description' => 'The format of the animated image. Valid values:'."\n" - ."\n" - .'* **gif**'."\n" - .'* **webp**'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'gif' => 'gif', - 'webp' => 'webp', - ], - 'example' => 'gif', - ], - 'Width' => [ - 'description' => 'The width of the animated image. Valid values: \\[128,4096].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - ], - 'Height' => [ - 'description' => 'The height of the animated image. Valid values: \\[128,4096].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '720', - ], - 'Fps' => [ - 'description' => 'The frame rate. Valid values: \\[1,60].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '15', - ], - 'ScanMode' => [ - 'description' => 'The scan mode. Valid values:'."\n" - ."\n" - .'* **interlaced**'."\n" - .'* **progressive** This is the default value.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'progressive' => '', - 'interlaced' => '', - ], - 'example' => 'progressive', - ], - 'LongShortMode' => [ - 'description' => 'Specifies whether to enable the auto-rotate screen feature. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n" - ."\n" - .'Default value: **true**.'."\n" - ."\n" - .'> If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'false', - ], - 'TimeSpan' => [ - 'title' => '时间线参数', - 'description' => 'The timeline parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Seek' => [ - 'description' => 'The start point of the clip.'."\n" - ."\n" - .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" - .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '01:59:59.999 or 32000.23', - ], - 'Duration' => [ - 'description' => 'The length of the clip.'."\n" - ."\n" - .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" - .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '01:59:59.999 or 32000.23', - ], - 'End' => [ - 'description' => 'The length of the ending part of the original clip to be cropped out. If you specify this parameter, the Duration parameter becomes invalid.'."\n" - ."\n" - .'* Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`.'."\n" - .'* Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '01:59:59.999 or 32000.23', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + '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' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ScheduleConfig', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The scheduling settings.'."\n", + 'title' => '', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'PipelineId' => [ - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****'."\n", - ], - 'Priority' => [ - 'description' => 'The priority. Valid values: 1 to 10. Default value: 6. A greater value specifies a higher priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], + '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' => ''], ], - 'required' => false, + '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' => [ [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"SampleKey": "SampleValue"}', + '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' => 'PlainResponse', - 'description' => 'PlainResponse'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', + '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 \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitDynamicImageJob', - ], - 'GetSnapshotUrls' => [ - 'summary' => 'Queries the accessible URLs of the output images of a snapshot job.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -28505,123 +15768,142 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236523', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'AIAgentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'schema' => ['description' => 'The ID of the AI agent.', 'type' => 'string', 'required' => true, 'example' => '19de81b3b3d94abda22******', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'Role', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 30. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => 'OrderBy', + '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' => '排列顺序。取值：Asc，Desc', - 'description' => 'The order that you use to sort the query results. Valid values: Asc and Desc.'."\n" - ."\n" - .'- Asc'."\n" - ."\n" - .'- Desc', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Asc' => '', - 'Desc' => '', + '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' => 'Asc', + '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' => [ [ - 'name' => 'Timeout', - 'in' => 'query', - 'schema' => [ - 'title' => '鉴权超时时间', - 'description' => 'The authentication timeout period. Unit: seconds Default value: 3600. Maximum value: 129600 (36 hours).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', + '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 request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Total' => [ - 'title' => '截图总数量', - 'description' => 'The total number of snapshots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'SnapshotUrls' => [ - 'title' => '截图URL', - 'description' => 'The list of snapshot URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The URL of the snapshot.'."\n", - 'type' => 'string', - 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput-00001.jpg', - ], - ], - 'WebVTTUrl' => [ - 'title' => 'WebVTT文件URL', - 'description' => 'The URL of the WebVTT file.'."\n", - 'type' => 'string', - 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput.vtt', - ], + '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' => '*'], ], - 'description' => '', ], ], ], - '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"}]', - 'title' => 'GetSnapshotUrls', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"ActiveCount\\": 39\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetSnapshotJob' => [ - 'summary' => 'Queries the information about a snapshot job.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetAIWorkflowTask' => [ + 'summary' => 'Retrieves the details of a workflow task.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28629,265 +15911,120 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the snapshot job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****d80e4e4044975745c14b****', - ], + 'schema' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'required' => false, 'example' => '********-266c-4bb8-b20c-6faa********', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'PlainResponse', - 'description' => 'PlainResponse'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'SnapshotJob' => [ - 'title' => '截图任务信息', - 'description' => 'The information about the snapshot job.'."\n", + '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' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'TriggerSource' => [ - 'description' => 'The request trigger source.'."\n" + '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" - .'* Console'."\n" - .'* Workflow'."\n" - .'* API'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Console' => '', - 'Workflow' => '', - 'API' => 'API', - ], - 'example' => 'API', - ], - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => 'Snapshot types'."\n" + .'- running'."\n" ."\n" - .'Valid values:'."\n" + .'- stopped'."\n" ."\n" - .'* WebVtt'."\n" - .'* Sprite'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'WebVtt' => '', - 'Sprite' => '', - 'Normal' => '', - ], - 'example' => 'Sprite', - ], - 'Input' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - '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" - .'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.'."\n", - 'type' => 'string', - 'example' => 'oss://test-bucket/object.mp4', - ], - 'OssFile' => [ - 'title' => '输入类型为媒资ID时的OSS地址', - 'description' => 'The three key elements of OSS.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bucket' => [ - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'test-bucket', - ], - 'Location' => [ - 'description' => 'The OSS location.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Object' => [ - 'description' => 'The OSS object.'."\n", - 'type' => 'string', - 'example' => 'object.mp4', - ], - ], - ], - ], - ], - 'Output' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - '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" - .'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".'."\n", - 'type' => 'string', - 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg', - ], - 'OssFile' => [ - 'title' => '输出类型为媒资ID时的OSS地址', - 'description' => 'The three key elements of OSS.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bucket' => [ - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'test-bucket', - ], - 'Location' => [ - 'description' => 'The OSS location.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Object' => [ - 'description' => 'The OSS object.'."\n", - 'type' => 'string', - 'example' => 'output-{Count}.jpg', - ], - ], - ], - ], - ], - 'Count' => [ - 'description' => 'The number of snapshots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'Async' => [ - 'description' => 'Indicates whether the snapshots were captured in asynchronous mode. Default value: true.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'TemplateConfig' => [ - 'description' => 'The snapshot template configuration.'."\n", - 'type' => 'string', - 'example' => '{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}', - ], - 'PipelineId' => [ - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n" + .'- failed'."\n" ."\n" - .'Valid values:'."\n" + .'- partial-succeeded'."\n" ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Init' => '', - 'Success' => '', - 'Fail' => '', - ], - 'example' => 'Success', - ], - 'Code' => [ - 'description' => 'Error codes'."\n", - 'type' => 'string', - 'example' => 'ResourceNotFound', - ], - 'Message' => [ - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => 'The specified resource for "Pipeline" could not be found.', - ], - 'SubmitTime' => [ - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', - ], - 'UserData' => [ - 'description' => 'The user-defined parameters.'."\n", - 'type' => 'string', - 'example' => '{"test parameter": "test value"}', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", + .'- succeeded', + 'enumValueTitles' => ['running' => '', 'stopped' => '', 'failed' => '', 'partial-succeeded' => '', 'succeeded' => ''], 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', + 'example' => 'succeeded', + 'title' => '', ], - 'ModifiedTime' => [ - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', + '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 \\"SnapshotJob\\": {\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"测试任务\\",\\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"}]', - 'title' => 'GetSnapshotJob', - ], - 'GetDynamicImageJob' => [ - 'summary' => 'Queries the information about an image animation job.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -28895,538 +16032,346 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => ['FEATUREiceN57D5I'], + ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****d80e4e4044975745c14b****', - ], + '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' => 'PlainResponse', - 'description' => 'PlainResponse'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******36-3C1E-4417-BDB2-1E034F******', - ], - 'DynamicImageJob' => [ - 'title' => '截图任务信息', - 'description' => 'The information about the snapshot job.'."\n", + 'Config' => [ + 'description' => 'The ad insertion configuration.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****'."\n", - ], - 'TriggerSource' => [ - 'description' => 'The request trigger source.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Console'."\n" - .'* Workflow'."\n" - .'* API'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Console' => '', - 'Workflow' => '', - 'API' => 'API', - ], - 'example' => 'API', - ], - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'SampleJob', - ], - 'Input' => [ - 'description' => 'The input of the job.'."\n", + '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' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Media' => '', - 'OSS' => '', - ], - 'example' => 'OSS', - ], - '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" - .'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.'."\n", - 'type' => 'string', - 'example' => 'oss://test-bucket/sample-input.mp4', - ], - 'OssFile' => [ - 'title' => '输入类型为媒资ID时的OSS地址', - 'description' => 'The three key elements of OSS.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bucket' => [ - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'test-bucket', - ], - 'Location' => [ - 'description' => 'The OSS location.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Object' => [ - 'description' => 'The OSS object.'."\n", - 'type' => 'string', - 'example' => 'sample-input.mp4', - ], - ], - ], + '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' => '', ], - 'Output' => [ - 'description' => 'The output of the job.'."\n", + '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' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values: OSS: an OSS object. Media: a media asset.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Media' => '', - 'OSS' => '', - ], - 'example' => 'Media', - ], - '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" - .'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.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'OssFile' => [ - 'title' => '输出类型为媒资ID时的OSS地址', - 'description' => 'The three key elements of OSS.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bucket' => [ - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'sample-bucket', - ], - 'Location' => [ - 'description' => 'The OSS location.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai', - ], - 'Object' => [ - 'description' => 'The OSS object.'."\n", - 'type' => 'string', - 'example' => 'path/to/object', - ], - ], - ], - ], - ], - 'OutputUrl' => [ - 'description' => 'The URL of the output animated image.'."\n", - 'type' => 'string', - 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif', - ], - 'TemplateConfig' => [ - 'description' => 'The animation template configuration.'."\n", - 'type' => 'string', - 'example' => '{"Format":"gif","Fps":5,"Height":1080,"Width":1920}', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'PipelineId' => [ - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Init' => '', - 'Success' => '', - 'Fail' => '', + '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' => 'Success', - ], - 'Code' => [ - 'description' => 'Error codes'."\n", - 'type' => 'string', - 'example' => 'ResourceNotFound', - ], - 'Message' => [ - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => 'The specified resource for "CustomTemplate" could not be found.', - ], - 'SubmitTime' => [ - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '{"sampleParam": "sampleValue"}', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], + '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', - ], - 'ListSnapshotJobs' => [ - 'summary' => 'Queries a list of snapshot jobs.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceMX4DML'], + ], 'parameters' => [ [ - 'name' => 'StartOfCreateTime', + 'name' => 'LicenseItemId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range during which the jobs to be queried were created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-12T00:00:00Z', - ], + 'schema' => ['description' => 'The ID of the batch.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '17712***', 'title' => ''], ], [ - 'name' => 'EndOfCreateTime', + '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' => [ - 'description' => 'The end of the time range during which the jobs to be queried were created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-14T00:00:00Z', + '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 state of the job.'."\n" + 'description' => 'The status of the license batch. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- `1`: Normal'."\n" ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', + .'- `2`: Expired', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'enumValueTitles' => [ - 'Init' => '', - 'Success' => '', - 'Fail' => '', - ], - 'example' => 'Success', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'OrderBy', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'title' => '排序顺序：CreateTimeDesc 和 CreateTimeAsc', - 'description' => 'The order that you use to sort the query results.'."\n" - ."\n" - .'1. CreateTimeDesc'."\n" - .'2. CreateTimeAsc'."\n" + 'description' => 'The license type. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- `1`: voice call'."\n" ."\n" - .'* CreateTimeDesc: sorts the jobs by creation time in descending order'."\n" - .'* CreateTimeAsc: sorts the jobs by creation time in ascending order.'."\n", - 'type' => 'string', + .'- `2`: visual understanding', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'enumValueTitles' => [ - 'CreateTimeDesc' => '', - 'CreateTimeAsc' => '', - ], - 'example' => 'CreateTimeDesc', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'JobId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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. Default value: 20. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'NextPageToken', + 'name' => 'NeedTotalCount', 'in' => 'query', - 'schema' => [ - 'title' => '连续分页查询时下一页的标记', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'ApiResponse\\'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Jobs' => [ - 'description' => 'The list of jobs.'."\n", + '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 information about the snapshot job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'TriggerSource' => [ - 'description' => 'The request trigger source.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Console'."\n" - .'* Workflow'."\n" - .'* API'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Console' => '', - 'Workflow' => '', - 'API' => 'API', - ], - 'example' => 'API', - ], - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'SampleJob', - ], - 'Type' => [ - 'description' => 'The type of the job.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* WebVtt'."\n" - .'* Sprite'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'WebVtt' => '', - 'Sprite' => '', - 'Normal' => '', - ], - 'example' => 'Sprite', - ], - 'Input' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object.mp4', - ], - ], - ], - 'Output' => [ - 'description' => 'The output of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - '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" - .'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".'."\n", - 'type' => 'string', - 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg', - ], - ], - ], - 'Count' => [ - 'description' => 'The number of snapshots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Async' => [ - 'description' => 'Indicates whether the snapshots were captured in asynchronous mode.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'PipelineId' => [ - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n" - ."\n" - .'* **Success**: The job is successful.'."\n" - .'* **Fail**: The job failed.'."\n" - .'* **Init**: The job is submitted.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Init' => '', - 'Success' => '', - 'Fail' => '', - ], - 'example' => 'Success', - ], - 'SubmitTime' => [ - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', - ], - ], - ], - ], - 'NextPageToken' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', + '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' => '', ], ], ], - '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"}]', - 'title' => 'ListSnapshotJobs', - ], - 'ListDynamicImageJobs' => [ - 'summary' => 'Queries a list of image animation jobs.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -29434,377 +16379,448 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'StartOfCreateTime', + 'name' => 'AvatarId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range during which the jobs to be queried were created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-12T00:00:00Z', - ], + 'schema' => ['description' => '- The ID of the digital human.', 'type' => 'string', 'required' => true, 'example' => 'Avatar-XXXX', 'title' => ''], ], - [ - 'name' => 'EndOfCreateTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The end of the time range during which the jobs to be queried were created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-14T00:00:00Z', + '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' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the job.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Init' => '', - 'Success' => '', - 'Fail' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetAvatar', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'Success', ], ], + ], + 'translator' => 'manual', + ], + 'GetAvatarTrainingJob' => [ + 'summary' => 'Queries the information about a digital human training job.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序：CreateTimeDesc 和 CreateTimeAsc', - '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" - .'2. CreateTimeDesc: sorts the jobs by creation time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CreateTimeDesc' => '', - 'CreateTimeAsc' => '', - ], - 'example' => 'CreateTimeDesc', - ], + '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' => '任务ID', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****cdb3e74639973036bc84****', + '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' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + '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' => [ [ - 'name' => 'NextPageToken', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207313', + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], + ], + 'parameters' => [ + [ + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '连续分页查询时下一页的标记', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cdb3e74639973036bc84', - ], + 'schema' => ['description' => 'The ID of the quick video production job.', 'type' => 'string', 'required' => false, 'example' => '****b4549d46c88681030f6e****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainResponse>', - 'description' => 'PlainResponse\\'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Jobs' => [ - 'description' => 'The list of jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about an image animation job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], - 'TriggerSource' => [ - 'description' => 'The request trigger source.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Console'."\n" - .'* Workflow'."\n" - .'* API'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Console' => '', - 'Workflow' => '', - 'API' => 'API', - ], - 'example' => 'API', - ], - 'Name' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'SampleJob', - ], - 'Input' => [ - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.'."\n" - ."\n" - .'*'."\n" - .'*'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Media' => '', - 'OSS' => '', - ], - 'example' => 'OSS', - ], - '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" - .'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.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object', - ], - ], - ], - 'Output' => [ - 'description' => 'The output of the job.'."\n", + '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' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n" - ."\n" - .'*'."\n" - .'*'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Media' => '', - 'OSS' => '', - ], - 'example' => 'Media', - ], - '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" - .'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.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], - ], - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], - 'PipelineId' => [ - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n" - ."\n" - .'* **Success**: The job is successful.'."\n" - .'* **Fail**: The job failed.'."\n" - .'* **Init**: The job is submitted.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Init' => '', - 'Success' => '', - 'Fail' => '', + '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' => ''], ], - 'example' => 'Success', - ], - 'SubmitTime' => [ - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:17:54Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-07-12T16:30:54Z', + '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' => ''], ], - ], - 'NextPageToken' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****'."\n", + 'title' => '', + 'example' => '', ], ], + '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', - ], - 'SubmitSyncMediaInfoJob' => [ - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'create', - 'abilityTreeCode' => '139552', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'autoTest' => true, + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'CateId', 'in' => 'query', - 'schema' => [ - 'title' => '任务名字', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'job-name', - ], + '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' => 'Input', + 'name' => 'PageNo', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '任务输入', - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object.'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the Intelligent Media Services (IMS) console.'."\n" - ."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The page number. Default value: 1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user-data', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ScheduleConfig', + 'name' => 'SortBy', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '调度参数', - 'description' => 'The scheduling parameters. This parameter is optional.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], + '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' => [ @@ -29812,1062 +16828,411 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + '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' => '', ], - 'MediaInfoJob' => [ - 'title' => 'MediaInfoJobDTO', - 'description' => 'MediaInfoJobDTO'."\n", + 'SubCategories' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Name' => [ - 'title' => '任务名字。', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'job-name', - ], - 'TriggerSource' => [ - 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', - 'description' => 'The source of the job. Valid values: API, WorkFlow, and Console.'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'JobId' => [ - 'title' => '任务 ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], - 'Input' => [ - 'title' => '任务输入。', - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" + '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" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object. If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported. If Type is set to Media, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - 'Async' => [ - 'title' => '是否异步处理。', - 'description' => 'Indicates whether asynchronous processing was performed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserData' => [ - 'title' => '用户数据。', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '调度信息。', - 'description' => 'The scheduling information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'Status' => [ - 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The state of the job. Valid values: Init (the job is submitted), Success (the job is successful), and Fail (the job failed).'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'SubmitResultJson' => [ - 'title' => '任务提交信息。', - 'description' => 'The job submission information.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'MediaInfoProperty' => [ - 'title' => '媒体信息详情。', - 'description' => 'The details of the media information.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '基础文件信息', - 'description' => 'The basic file information.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资 ID。', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '999e68259c924f52a6be603cbb3f91cc', - ], - 'FileName' => [ - 'title' => '文件名。', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'file.m3u8', - ], - 'FileStatus' => [ - 'title' => '文件状态。', - 'description' => 'The state of the file. Valid values:'."\n" - ."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型。取值: source_file, transcode_file', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小。单位：Byte。', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '31737', - ], - 'FileUrl' => [ - 'title' => '文件 URL。', - '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 region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '视频格式名称。', - 'description' => 'The name of the video format.'."\n", - 'type' => 'string', - 'example' => 'hls,applehttp', - ], - 'Duration' => [ - 'title' => '视频时长（单位: 秒）。', - 'description' => 'The duration of the video. 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 output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - ], - ], - 'AudioStreamInfoList' => [ - 'title' => '音频流信息', - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CodecName' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'CodecLongName' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'AAC (Advanced Audio Coding)', - ], - 'CodecTimeBase' => [ - 'title' => '编码器时间基。', - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/44100', - ], - 'CodecTagString' => [ - 'title' => '编码器标签名。', - 'description' => 'The name of the encoder tag.'."\n", - 'type' => 'string', - 'example' => '[15][0][0][0]', - ], - 'CodecTag' => [ - 'title' => '编码器标签。', - 'description' => 'The encoder tag.'."\n", - 'type' => 'string', - 'example' => '0x000f', - ], - 'SampleFmt' => [ - 'title' => '采样格式。', - 'description' => 'The sample format.'."\n", - 'type' => 'string', - 'example' => 'fltp', - ], - 'SampleRate' => [ - 'title' => '采样率（单位: Hz）。', - 'description' => 'The sampling rate. Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'title' => '声道数。', - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ChannelLayout' => [ - 'title' => '声道布局。', - 'description' => 'The sound channel layout.'."\n", - 'type' => 'string', - 'example' => 'stereo', - ], - 'Timebase' => [ - 'title' => '时间基。', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/90000', - ], - 'StartTime' => [ - 'title' => '开始时间。', - 'description' => 'The start time of the stream.'."\n", - 'type' => 'string', - 'example' => '1.473556', - ], - 'Duration' => [ - 'title' => '时长（单位: 秒）。', - 'description' => 'The duration of the file.'."\n", - 'type' => 'string', - 'example' => '403.039989', - ], - 'Bitrate' => [ - 'title' => '码率。', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '0.f', - ], - 'Lang' => [ - 'title' => '语言。', - 'description' => 'The language of the stream.'."\n", - 'type' => 'string', - 'example' => 'us', - ], - ], - ], - ], - 'VideoStreamInfoList' => [ - 'title' => '视频流信息', - 'description' => 'The information about the video stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the video stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Codec_name' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'h264', - ], - 'Codec_long_name' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - ], - 'Profile' => [ - 'title' => '编码器预设。', - 'description' => 'The encoder profile.'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'Codec_time_base' => [ - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/50', - ], - 'Codec_tag_string' => [ - 'title' => '编码格式标记文本。', - 'description' => 'The tag string of the encoding format.'."\n", - 'type' => 'string', - 'example' => '[27][0][0][0]', - ], - 'Codec_tag' => [ - 'title' => '编码格式标记。', - 'description' => 'The tag of the encoding format.'."\n", - 'type' => 'string', - 'example' => '0x001b', - ], - 'Width' => [ - 'title' => '宽。', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - 'Has_b_frames' => [ - 'title' => '是否有B帧。'."\n" - .'取值: '."\n" - .'- 0: 没有 B 帧, '."\n" - .'- 1: 有一个 B 帧, '."\n" - .'- 2: 有多个连续 B 帧。', - 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). Valid values:'."\n" - ."\n" - .'* 0: The stream contains no B-frames.'."\n" - .'* 1: The stream contains one B-frame.'."\n" - .'* 2: The stream contains multiple consecutive B-frames.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Sar' => [ - 'title' => '采集点数宽高比。', - 'description' => 'The aspect ratio of the area from which the sampling points are collected.'."\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.'."\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 file.'."\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 of the stream.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'Rotate' => [ - 'title' => '视频画面旋转角度。'."\n" - .'取值 0, 90, 180, 270。'."\n" - .'默认值 0', - 'description' => 'The rotation angle of the video image.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], + .'- **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' => '', ], - ], - 'SubmitTime' => [ - 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'RequestId' => [ - 'title' => '请求 ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + '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', + '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'], ], - '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 \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"999e68259c924f52a6be603cbb3f91cc\\",\\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' => 'SubmitSyncMediaInfoJob', - 'summary' => 'Submits a media file in synchronous mode for media information analysis.', - 'description' => 'You can call this operation to analyze an input media file in synchronous mode. This operation is suitable for scenarios that require high real-time performance and low concurrency. If it takes an extended period of time to obtain the media information about the input media file, the request may time out or the obtained information may be inaccurate. We recommend that you call the [SubmitMediaInfoJob](~~441222~~) operation to obtain media information.'."\n", - ], - 'SubmitMediaInfoJob' => [ - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '任务名字', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'job-name', - ], - ], - [ - 'name' => 'Input', - 'in' => 'query', - 'style' => 'json', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '任务输入', - 'description' => 'The input of the job.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。取值： OSS: OSS文件, Media: 媒资 ID', - 'description' => 'The type of the media object. Valid values: OSS and Media. A value of OSS indicates an Object Storage Service (OSS) object. A value of Media indicates a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - 'description' => 'The media object.'."\n" - ."\n" - .'* If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" - ."\n" - .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the Intelligent Media Services (IMS) console.'."\n" - ."\n" - .'* If Type is set to Media, set this parameter to the ID of a media asset.', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/path/to/video.mp4', + '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' => '', ], ], - 'required' => true, + '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' => [ [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user-data', + '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' => [ [ - 'name' => 'ScheduleConfig', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceEO4QPO'], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '调度参数', - 'description' => 'The scheduling parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], + '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' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'MediaInfoJob' => [ - 'title' => 'MediaInfoJobDTO', - 'description' => 'MediaInfoJobDTO'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], + 'CustomTemplate' => [ + 'title' => '', + 'description' => 'The template details.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '任务名字', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'job-name', - ], - 'TriggerSource' => [ - 'title' => '任务来源 - API, WorkFlow, Console', - 'description' => 'The source of the job. Valid values: API, WorkFlow, and Console.'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'JobId' => [ - 'title' => '任务 id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], - 'Input' => [ - 'title' => '任务输入', - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。取值： OSS: OSS文件, Media: 媒资 ID', - 'description' => 'The type of the media object. Valid values: OSS and Media. A value of OSS indicates an OSS object. A value of Media indicates a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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, set this parameter to the ID of a media asset.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - 'Async' => [ - 'title' => '是否异步处理', - 'description' => 'Indicates whether asynchronous processing was performed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '调度信息', - 'description' => 'The scheduling information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'Status' => [ - 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The state of the job. Valid values: Init (the job is submitted), Success (the job is successful), and Fail (the job failed).'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'SubmitResultJson' => [ - 'title' => '任务提交信息', - 'description' => 'The job submission information.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'MediaInfoProperty' => [ - 'title' => '媒体信息详情', - 'description' => 'The details of the media information.'."\n", + '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' => [ - 'FileBasicInfo' => [ - 'title' => '基础文件信息', - 'description' => 'The basic file information.'."\n", + 'TranscodeTemplateHint' => [ 'type' => 'object', 'properties' => [ - 'MediaId' => [ - 'title' => '媒资 ID。', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '2b36bd19c13f4145b094c0cad80dbce5', - ], - 'FileName' => [ - 'title' => '文件名。', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'file.m3u8', - ], - 'FileStatus' => [ - 'title' => '文件状态。', - 'description' => 'The state of the file.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型。取值: source_file, transcode_file', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小。单位：Byte。', - 'description' => 'The file size.'."\n", - 'type' => 'string', - 'example' => '31737', - ], - 'FileUrl' => [ - 'title' => '文件url。', - '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 region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '视频格式名称。', - 'description' => 'The name of the video format.'."\n", - 'type' => 'string', - 'example' => 'hls,applehttp', - ], - 'Duration' => [ - 'title' => '视频时长（单位: 秒）。', - 'description' => 'The duration of the video.'."\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 output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - ], - ], - 'AudioStreamInfoList' => [ - 'title' => '音频流信息', - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CodecName' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'CodecLongName' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'AAC (Advanced Audio Coding)', - ], - 'CodecTimeBase' => [ - 'title' => '编码器时间基。', - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/44100', - ], - 'CodecTagString' => [ - 'title' => '编码器标签名。', - 'description' => 'The name of the encoder tag.'."\n", - 'type' => 'string', - 'example' => '[15][0][0][0]', - ], - 'CodecTag' => [ - 'title' => '编码器标签。', - 'description' => 'The encoder tag.'."\n", - 'type' => 'string', - 'example' => '0x000f', - ], - 'SampleFmt' => [ - 'title' => '采样格式。', - 'description' => 'The sample format.'."\n", - 'type' => 'string', - 'example' => 'fltp', - ], - 'SampleRate' => [ - 'title' => '采样率（单位: Hz）。', - 'description' => 'The sampling rate. Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'title' => '声道数。', - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ChannelLayout' => [ - 'title' => '声道布局。', - 'description' => 'The sound channel layout.'."\n", - 'type' => 'string', - 'example' => 'stereo', - ], - 'Timebase' => [ - 'title' => '时间基。', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/90000', - ], - 'StartTime' => [ - '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', - ], - 'Bitrate' => [ - 'title' => '码率。', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '0.f', - ], - 'Lang' => [ - 'title' => '语言。', - 'description' => 'The language of the stream.'."\n", - 'type' => 'string', - 'example' => 'us', - ], - ], - ], - ], - 'VideoStreamInfoList' => [ - 'title' => '视频流信息', - 'description' => 'The information about the video stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the video stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Codec_name' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'h264', - ], - 'Codec_long_name' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - ], - 'Profile' => [ - 'title' => '编码器预设。', - 'description' => 'The encoder profile.'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'Codec_time_base' => [ - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/50', - ], - 'Codec_tag_string' => [ - 'title' => '编码格式标记文本。', - 'description' => 'The tag string of the encoding format.'."\n", - 'type' => 'string', - 'example' => '[27][0][0][0]', - ], - 'Codec_tag' => [ - 'title' => '编码格式标记。', - 'description' => 'The tag of the encoding format.'."\n", - 'type' => 'string', - 'example' => '0x001b', - ], - 'Width' => [ - 'title' => '宽。', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - '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" - .'* 1: The stream contains one B-frame.'."\n" - .'* 2: The stream contains multiple consecutive B-frames.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Sar' => [ - 'title' => '采集点数宽高比。', - 'description' => 'The aspect ratio of the area from which the sampling points are collected.'."\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' => [ - 'description' => 'The average frame rate.'."\n", - 'type' => 'string', - 'example' => '25.0', - ], - 'Time_base' => [ - 'description' => 'The time base.'."\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 file.'."\n", - 'type' => 'string', - 'example' => '403.039989', - ], - 'Bit_rate' => [ - '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 of the stream.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'Rotate' => [ - 'title' => '视频画面旋转角度。取值 0, 90, 180, 270。默认值 0', - 'description' => 'The rotation angle of the video image.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], + 'BitrateControlType' => ['description' => 'The bitrate control type.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'Hint for transcoding templates.', + 'title' => '', + 'example' => '', ], ], - ], - 'SubmitTime' => [ - 'title' => '任务提交时间', - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务完成时间', - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', + 'description' => 'Reserved for frontend display.', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], - 'description' => '', + '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 \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"2b36bd19c13f4145b094c0cad80dbce5\\",\\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' => 'SubmitMediaInfoJob', - 'summary' => 'Submits a media information analysis job in asynchronous mode.', - 'description' => 'You can call this operation to analyze an input media file by using a callback mechanism or initiating subsequent queries. This operation is suitable for scenarios in which real-time performance is less critical and high concurrency is expected.'."\n", - ], - 'GetMediaInfoJob' => [ - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => [], @@ -30875,507 +17240,208 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'VoiceId', 'in' => 'query', - 'schema' => [ - 'title' => '任务 ID', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], + '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' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'MediaInfoJob' => [ - 'title' => 'MediaInfoJobDTO', - 'description' => 'MediaInfoJobDTO'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], + 'Data' => [ + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '任务名字', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'job-name', - ], - 'TriggerSource' => [ - 'title' => '任务来源 - API, WorkFlow, Console', - 'description' => 'The source of the job. Valid values: API, WorkFlow, and Console.'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'JobId' => [ - 'title' => '任务 id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], - 'Input' => [ - 'title' => '任务输入', - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - 'Async' => [ - 'title' => '是否异步处理', - 'description' => 'Indicates whether asynchronous processing was performed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '调度信息', - 'description' => 'The scheduling information.'."\n", + 'CustomizedVoice' => [ + 'description' => 'The personalized human voice.', 'type' => 'object', 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + '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' => '', ], - 'Status' => [ - 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The state of the job. Valid values: Init (the job is submitted), Success (the job is successful), and Fail (the job failed).'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'SubmitResultJson' => [ - 'title' => '任务提交信息', - 'description' => 'The job submission information.'."\n", - 'type' => 'object', - ], - 'MediaInfoProperty' => [ - 'title' => '媒体信息详情', - 'description' => 'The details of the media information.'."\n", + ], + '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' => [ - 'FileBasicInfo' => [ - 'title' => '基础文件信息', - 'description' => 'The basic file information.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资 ID。', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => 'e520090207114cc7a392d44f0b211574', - ], - 'FileName' => [ - 'title' => '文件名。', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'file.m3u8', - ], - 'FileStatus' => [ - 'title' => '文件状态。', - 'description' => 'The state of the file.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型。取值: source_file, transcode_file', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小。单位：Byte。', - 'description' => 'The file size.'."\n", - 'type' => 'string', - 'example' => '31737', - ], - 'FileUrl' => [ - 'title' => '文件 URL。', - '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 region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '视频格式名称。', - 'description' => 'The name of the video format.'."\n", - 'type' => 'string', - 'example' => 'hls,applehttp', - ], - 'Duration' => [ - 'title' => '视频时长（单位: 秒）。', - 'description' => 'The duration of the video. 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 output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - ], - ], - 'AudioStreamInfoList' => [ - 'title' => '音频流信息', - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CodecName' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'CodecLongName' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'AAC (Advanced Audio Coding)', - ], - 'CodecTimeBase' => [ - 'title' => '编码器时间基。', - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/44100', - ], - 'CodecTagString' => [ - 'title' => '编码器标签名。', - 'description' => 'The name of the encoder tag.'."\n", - 'type' => 'string', - 'example' => '[15][0][0][0]', - ], - 'CodecTag' => [ - 'title' => '编码器标签。', - 'description' => 'The encoder tag.'."\n", - 'type' => 'string', - 'example' => '0x000f', - ], - 'SampleFmt' => [ - 'title' => '采样格式。', - 'description' => 'The sample format.'."\n", - 'type' => 'string', - 'example' => 'fltp', - ], - 'SampleRate' => [ - 'title' => '采样率（单位: Hz）。', - 'description' => 'The sampling rate. Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'title' => '声道数。', - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ChannelLayout' => [ - 'title' => '声道布局。', - 'description' => 'The sound channel layout.'."\n", - 'type' => 'string', - 'example' => 'stereo', - ], - 'Timebase' => [ - 'title' => '时间基。', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/90000', - ], - 'StartTime' => [ - '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', - ], - 'Bitrate' => [ - 'title' => '码率。', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '0.f', - ], - 'Lang' => [ - 'title' => '语言。', - 'description' => 'The language of the stream.'."\n", - 'type' => 'string', - 'example' => 'us', - ], - ], - 'description' => '', - ], - ], - 'VideoStreamInfoList' => [ - 'title' => '视频流信息', - 'description' => 'The information about the video stream.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Codec_name' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'h264', - ], - 'Codec_long_name' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - ], - 'Profile' => [ - 'title' => '编码器预设。', - 'description' => 'The encoder profile.'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'Codec_time_base' => [ - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/50', - ], - 'Codec_tag_string' => [ - 'title' => '编码格式标记文本。', - 'description' => 'The tag string of the encoding format.'."\n", - 'type' => 'string', - 'example' => '[27][0][0][0]', - ], - 'Codec_tag' => [ - 'title' => '编码格式标记。', - 'description' => 'The tag of the encoding format.'."\n", - 'type' => 'string', - 'example' => '0x001b', - ], - 'Width' => [ - 'title' => '宽。', - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '478', - ], - 'Has_b_frames' => [ - 'title' => '是否有B帧。'."\n" - .'取值: '."\n" - .'- 0: 没有 B 帧, '."\n" - .'- 1: 有一个 B 帧, '."\n" - .'- 2: 有多个连续 B 帧。', - 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). Valid values:'."\n" - ."\n" - .'* 0: The stream contains no B-frames.'."\n" - .'* 1: The stream contains one B-frame.'."\n" - .'* 2: The stream contains multiple consecutive B-frames.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Sar' => [ - 'title' => '采集点数宽高比。', - 'description' => 'The aspect ratio of the area from which the sampling points are collected.'."\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.'."\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 file.'."\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 of the stream.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'Rotate' => [ - 'title' => '视频画面旋转角度。'."\n" - .'取值 0, 90, 180, 270。'."\n" - .'默认值 0', - 'description' => 'The rotation angle of the video image.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - 'description' => '', - ], - ], + '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' => ''], ], - ], - 'SubmitTime' => [ - 'title' => '任务提交时间', - 'description' => 'The time when the job was submitted.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务完成时间', - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', + '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' => '*'], ], - 'description' => '', ], ], ], - '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.', + 'translator' => 'manual', ], - 'ListMediaInfoJobs' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetDefaultStorageLocation' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31383,1288 +17449,776 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'StartOfCreateTime', - 'in' => 'query', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-01T00:00:00Z', + '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' => '', ], ], - [ - 'name' => 'EndOfCreateTime', - 'in' => 'query', - 'schema' => [ - 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-15T00:00:00Z', - ], + ], + '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' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'title' => '按 jobId 筛选。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7b38a5d86f1e47838927b6e7ccb11cbe', + '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' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The state of the job. Valid values:'."\n" - ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'OrderBy', + 'name' => 'Scenario', 'in' => 'query', 'schema' => [ - 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', - 'description' => 'The order that you use to sort the query results. Valid values:'."\n" + 'description' => 'The demonstration scenario.'."\n" ."\n" - .'* CreateTimeDesc: sorts the query results by creation time in descending order.'."\n" - .'* CreateTimeAsc: sorts the query results by creation time in ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTimeDesc', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小。范围: 0~100，默认值：20。', - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'title' => '连续分页查询时下一页的标记 (第一页没有)。', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", + .'Valid values:'."\n" + ."\n" + .'- **story**'."\n" + ."\n" + .'- **interaction**'."\n" + ."\n" + .'- **navigation**', 'type' => 'string', - 'required' => false, - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + 'required' => true, + 'enum' => ['story', 'interaction', 'navigation'], + 'example' => 'story', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'Jobs' => [ - 'description' => 'The list of media information analysis jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '任务名字。', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'example' => 'job-name', - ], - 'TriggerSource' => [ - 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', - 'description' => 'The source of the job. Valid values:'."\n" - ."\n" - .'* API'."\n" - .'* WorkFlow'."\n" - .'* Console'."\n", - 'type' => 'string', - 'example' => 'API', - ], - 'JobId' => [ - 'title' => '任务 ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', - ], - 'Input' => [ - 'title' => '任务输入。', - 'description' => 'The input of the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '媒体对象类型。'."\n" - .'取值： '."\n" - .'- OSS: OSS文件。'."\n" - .'- Media: 媒资 ID。'."\n", - 'description' => 'The type of the media object. Valid values:'."\n" - ."\n" - .'* OSS: an Object Storage Service (OSS) object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '媒体值：'."\n" - .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" - .' type 为 Media 时，为媒资 ID。', - '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" - .'* If Type is set to Media, the ID of a media asset is returned.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/path/to/video.mp4', - ], - ], - ], - 'Async' => [ - 'title' => '是否异步处理。', - 'description' => 'Indicates whether asynchronous processing was performed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserData' => [ - 'title' => '用户数据。', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'user-data', - ], - 'ScheduleConfig' => [ - 'title' => '调度信息。', - 'description' => 'The scheduling information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'title' => '管道 ID。', - 'description' => 'The ID of the MPS queue to which the job was submitted.'."\n", - 'type' => 'string', - 'example' => 'e37ebee5d98b4781897f6086e89f9c56', - ], - 'Priority' => [ - 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', - 'description' => 'The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'Status' => [ - 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The state of the job. Valid values:'."\n" - ."\n" - .'* Init: The job is submitted.'."\n" - .'* Success: The job is successful.'."\n" - .'* Fail: The job failed.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'SubmitResultJson' => [ - 'title' => '任务提交信息。', - 'description' => 'The job submission information.'."\n", - 'type' => 'object', - ], - 'MediaInfoProperty' => [ - 'title' => '媒体信息详情。', - 'description' => 'The details of the media information.'."\n", + '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' => [ - 'FileBasicInfo' => [ - 'title' => '基础文件信息', - 'description' => 'The basic file information.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资 ID。', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '4765337007f571edbfdf81848c016303', - ], - 'FileName' => [ - 'title' => '文件名。', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'file.m3u8', - ], - 'FileStatus' => [ - 'title' => '文件状态。', - 'description' => 'The state of the file.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型。取值: source_file, transcode_file', - 'description' => 'The file type. Valid values: source_file and transcode_file.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小。单位：Byte。', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '31737', - ], - 'FileUrl' => [ - 'title' => '文件 URL。', - '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 region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '视频格式名称。', - 'description' => 'The name of the video format.'."\n", - 'type' => 'string', - 'example' => 'hls,applehttp', - ], - 'Duration' => [ - 'title' => '视频时长（单位: 秒）。', - 'description' => 'The duration of the video. 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.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '478', - ], - ], - ], - 'AudioStreamInfoList' => [ - 'title' => '音频流信息', - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the audio stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CodecName' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'CodecLongName' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'AAC (Advanced Audio Coding)', - ], - 'CodecTimeBase' => [ - 'title' => '编码器时间基。', - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/44100', - ], - 'CodecTagString' => [ - 'title' => '编码器标签名。', - 'description' => 'The name of the encoder tag.'."\n", - 'type' => 'string', - 'example' => '[15][0][0][0]', - ], - 'CodecTag' => [ - 'title' => '编码器标签。', - 'description' => 'The encoder tag.'."\n", - 'type' => 'string', - 'example' => '0x000f', - ], - 'SampleFmt' => [ - 'title' => '采样格式。', - 'description' => 'The sampling format.'."\n", - 'type' => 'string', - 'example' => 'fltp', - ], - 'SampleRate' => [ - 'title' => '采样率（单位: Hz）。', - 'description' => 'The sampling rate. Unit: Hz.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'title' => '声道数。', - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ChannelLayout' => [ - 'title' => '声道布局。', - 'description' => 'The sound channel layout.'."\n", - 'type' => 'string', - 'example' => 'stereo', - ], - 'Timebase' => [ - 'title' => '时间基。', - 'description' => 'The time base.'."\n", - 'type' => 'string', - 'example' => '1/90000', - ], - 'StartTime' => [ - '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', - ], - 'Bitrate' => [ - 'title' => '码率。', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '0.f', - ], - 'Lang' => [ - 'title' => '语言。', - 'description' => 'The language of the stream.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - ], - ], - ], - 'VideoStreamInfoList' => [ - 'title' => '视频流信息', - 'description' => 'The information about the video stream.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the video stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '流序号。', - 'description' => 'The sequence number of the stream.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Codec_name' => [ - 'title' => '编码格式。', - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => 'h264', - ], - 'Codec_long_name' => [ - 'title' => '编码格式名。', - 'description' => 'The name of the encoding format.'."\n", - 'type' => 'string', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - ], - 'Profile' => [ - 'title' => '编码器预设。', - 'description' => 'The encoder profile.'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'Codec_time_base' => [ - 'description' => 'The time base of the encoder.'."\n", - 'type' => 'string', - 'example' => '1/50', - ], - 'Codec_tag_string' => [ - 'title' => '编码格式标记文本。', - 'description' => 'The tag string of the encoding format.'."\n", - 'type' => 'string', - 'example' => '[27][0][0][0]', - ], - 'Codec_tag' => [ - 'title' => '编码格式标记。', - 'description' => 'The tag of the encoding format.'."\n", - 'type' => 'string', - 'example' => '0x001b', - ], - 'Width' => [ - 'title' => '宽。', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '848', - ], - 'Height' => [ - 'title' => '高。', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '478', - ], - 'Has_b_frames' => [ - 'title' => '是否有B帧。'."\n" - .'取值: '."\n" - .'- 0: 没有 B 帧, '."\n" - .'- 1: 有一个 B 帧, '."\n" - .'- 2: 有多个连续 B 帧。', - 'description' => 'Indicates whether the video stream contains bidirectional frames (B-frames). Valid values:'."\n" - ."\n" - .'* 0: The stream contains no B-frames.'."\n" - .'* 1: The stream contains one B-frame.'."\n" - .'* 2: The stream contains multiple consecutive B-frames.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Sar' => [ - 'title' => '采集点数宽高比。', - 'description' => 'The aspect ratio of the area from which the sampling points are collected.'."\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.'."\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 of the stream.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - 'Rotate' => [ - 'title' => '视频画面旋转角度。'."\n" - .'取值 0, 90, 180, 270。'."\n" - .'默认值 0', - 'description' => 'The rotation angle of the video image.'."\n" - ."\n" - .'* Valid values: 0, 90, 180, and 270.'."\n" - .'* Default value: 0.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], + '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' => '', ], - 'SubmitTime' => [ - 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'FinishTime' => [ - 'title' => '任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', - '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.'."\n", - 'type' => 'string', - 'example' => '2022-01-12T08:49:41Z', - ], - 'RequestId' => [ - 'title' => '请求 ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', - ], + 'title' => '', + 'example' => '', ], ], - ], - 'NextPageToken' => [ - 'title' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', - '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.'."\n", - 'type' => 'string', - 'example' => '019daf5780f74831b0e1a767c9f1c178', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + '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.', - ], - 'CreateLiveTranscodeTemplate' => [ - 'summary' => 'Creates a live stream transcoding template, which can be referenced when submitting a transcoding job.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The type of the template. Valid values:'."\n" - ."\n" - .'* normal'."\n" - .'* narrow-band'."\n" - .'* audio-only'."\n" - .'* origin'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'normal', - 'enum' => [ - 'normal', - 'narrow-band', - 'audio-only', - 'origin', - ], - ], - ], - [ - 'name' => 'Name', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the template.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my template', - 'maxLength' => 20, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], - [ - 'name' => 'TemplateConfig', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The configuration of the template.'."\n", + 'title' => '', + 'description' => 'PlainResponse', 'type' => 'object', 'properties' => [ - 'VideoParams' => [ - 'description' => 'The video parameters.'."\n", + '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' => [ - 'Codec' => [ - 'description' => 'The encoding type. Valid values:'."\n" + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****'."\n", 'title' => ''], + 'TriggerSource' => [ + 'description' => 'The request trigger source.'."\n" ."\n" - .'* H.264'."\n" - .'* H.265'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'H.264', - 'enum' => [ - 'H.264', - 'H.265', - ], - ], - 'Height' => [ - 'description' => 'The height of the output video. Valid values: Height ≥ 128 max (Height,Width) ≤ 2560 min (Height,Width) ≤ 1440'."\n" + .'Valid values:'."\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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '720', - ], - 'Width' => [ - 'description' => 'The width of the output video. Valid values: Width ≥ 128 max (Height,Width) ≤ 2560 min (Height,Width) ≤ 1440'."\n" + .'- Console'."\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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1280', - ], - 'Fps' => [ - 'description' => 'The frame rate of the output video. Unit: frames per second (FPS). Valid values: 1 to 60.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '25', - ], - 'Bitrate' => [ - 'description' => 'The bitrate of the output video. Unit: Kbit/s. Valid values: 1 to 6000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2500', - ], - 'Gop' => [ - 'description' => 'The group of pictures (GOP) of the output video. Unit: frame. Valid values: 1 to 3000.'."\n", + .'- Workflow'."\n" + ."\n" + .'- API', + 'enumValueTitles' => ['Console' => '', 'Workflow' => '', 'API' => 'API'], 'type' => 'string', - 'required' => false, - 'example' => '1000', + 'example' => 'API', + '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - 'enum' => [ - '1', - '2', - '3', + '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' => '', ], - ], - 'required' => false, - ], - 'AudioParams' => [ - 'description' => 'The audio parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'description' => 'The audio codec. Valid values:'."\n" - ."\n" - .'* AAC'."\n" - .'* MP3'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAC', - 'enum' => [ - 'AAC', - 'MP3', + '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' => '', ], - 'Bitrate' => [ - 'description' => 'The bitrate of the output audio. Unit: Kbit/s. Valid values: 1 to 1000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], - 'Samplerate' => [ - 'description' => 'The audio sampling rate. Valid values: 22050 to 96000.'."\n" + '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" - .'Note: If you set AudioProfile to aac_ld, the audio sampling rate cannot exceed 44,100.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '44100', - ], - 'Channels' => [ - 'description' => 'The number of sound channels. Valid values: 1: mono 2: binaural'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'Profile' => [ - 'description' => 'The audio codec profile. Valid values when the Codec parameter is set to AAC:'."\n" + .'Valid values:'."\n" ."\n" - .'* aac_low'."\n" - .'* aac_he'."\n" - .'* aac_he_v2'."\n" - .'* aac_ld'."\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' => 'aaclow', - 'enum' => [ - 'aac_low', - 'aac_he', - 'aac_he_v2', - 'aac_ld', - ], + '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' => ''], ], - 'required' => false, + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'TemplateId' => [ - 'description' => 'The ID of the template.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], - ], - ], + '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'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParam.Height', - 'errorMessage' => 'Invalid Parameters: Height', - ], - [ - 'errorCode' => 'InvalidParam.Width', - 'errorMessage' => 'Invalid Parameters: Width', - ], - [ - 'errorCode' => 'InvalidParam.Fps', - 'errorMessage' => 'Invalid Parameters: Fps', - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDynamicImageJob'], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetDynamicImageJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'CreateLiveTranscodeTemplate', + 'translator' => 'manual', ], - 'GetLiveTranscodeTemplate' => [ - 'summary' => 'Queries the information a live stream transcoding template.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetEditingProject' => [ + 'summary' => 'Queries the information about an online editing project.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'PrivateKey' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceM55707'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287666****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'TemplateContent' => [ - 'description' => 'The content of the template.'."\n", + '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' => [ - 'Name' => [ - 'description' => 'The name of the template.'."\n", - 'type' => 'string', - 'example' => 'my-template', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => 'bcfa57950bc649b2abfb476ecd36ea4f', - ], - 'Type' => [ - 'description' => 'The type of the template.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Category' => [ - 'description' => 'The category of the template. Valid values:'."\n" - ."\n" - .'* system'."\n" - .'* customized'."\n", - 'type' => 'string', - 'example' => 'customized', - ], - 'CreateTime' => [ - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-25T06:15:14Z', - ], - 'TemplateConfig' => [ - 'description' => 'The configuration of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'VideoParams' => [ - 'description' => 'The video parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'description' => 'The encoding type.'."\n", - 'type' => 'string', - 'example' => 'H.264', - ], - 'Height' => [ - 'description' => 'The height of the output video.'."\n", - 'type' => 'string', - 'example' => '720', - ], - 'Width' => [ - 'description' => 'The width of the output video.'."\n", - 'type' => 'string', - 'example' => '1280', - ], - 'Fps' => [ - 'description' => 'The frame rate of the output video.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'Bitrate' => [ - 'description' => 'The bitrate of the output video.'."\n", - 'type' => 'string', - 'example' => '2500', - ], - 'Gop' => [ - 'description' => 'The group of pictures (GOP) of the output video.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'Profile' => [ - 'description' => 'The encoding profile.'."\n", - 'type' => 'string', - 'example' => '2', - ], - ], - ], - 'AudioParams' => [ - 'description' => 'The audio parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'description' => 'The audio codec.'."\n", - 'type' => 'string', - 'example' => 'AAC', - ], - 'Bitrate' => [ - 'description' => 'The bitrate of the output audio.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'Samplerate' => [ - 'description' => 'The audio sampling rate.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Profile' => [ - 'description' => 'The audio codec profile.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], + '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' => 'InvalidParam', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', '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', - ], - 'UpdateLiveTranscodeTemplate' => [ - 'summary' => 'Updates the information about a live stream transcoding template.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceM55707'], + ], '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://ims.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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], - ], - [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'ID of the online editing project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '*****fb2101cb318*****'], ], - [ - 'name' => 'TemplateConfig', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The configuration of the template.'."\n", + 'title' => '', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'VideoParams' => [ - 'description' => 'The video parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'description' => 'The encoding type. Valid values:'."\n" - ."\n" - .'* H.264'."\n" - .'* H.265'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'H.264' => 'H.264', - 'H.265' => 'H.265', + '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' => '', ], - 'example' => 'H.264', - 'enum' => [], - ], - 'Height' => [ - 'description' => 'The height of the output video. Valid values:'."\n" - ."\n" - .'* Height ≥ 128'."\n" - .'* max (Height,Width) ≤ 2560'."\n" - .'* min（Height,Width）≤ 1440'."\n" - ."\n" - .'> The resolution of a video transcoded by using the H.265 Narrowband HD template cannot exceed 1,280 × 720 pixels.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '720', - ], - 'Width' => [ - 'description' => 'The width of the output video. Valid values:'."\n" - ."\n" - .'* Width ≥ 128'."\n" - .'* max (Height,Width) ≤ 2560'."\n" - .'* min（Height,Width）≤ 1440'."\n" - ."\n" - .'> The resolution of a video transcoded by using the H.265 Narrowband HD template cannot exceed 1,280 × 720 pixels.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1280', - ], - 'Fps' => [ - 'description' => 'The frame rate of the output video. Unit: frames per second (FPS). Valid values: 1 to 60.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Bitrate' => [ - 'description' => 'The bitrate of the output video. Unit: Kbit/s. Valid values: 1 to 6000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2500', - ], - 'Gop' => [ - 'description' => 'The group of pictures (GOP) of the output video. Unit: frame. Valid values: 1 to 3000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], - 'Profile' => [ - 'description' => 'The video 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:'."\n" - ."\n" - .'* 1: baseline. This value is suitable for mobile devices.'."\n" - .'* 2: main. This value is suitable for standard-definition devices.'."\n" - .'* 3: high. This value is suitable for high-definition devices.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 1 => '1', - '2', - '3', + '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' => '', ], - 'example' => '2', ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'example' => '', ], - 'AudioParams' => [ - 'description' => 'The audio parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'description' => 'The audio codec. Valid values: AAC MP3'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MP3' => 'MP3', - 'AAC' => 'AAC', - ], - 'example' => 'AAC', - 'enum' => [], - ], - 'Bitrate' => [ - 'description' => 'The bitrate of the output audio. Unit: Kbit/s. Valid values: 1 to 1000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], - '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 44100.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '44100', - ], - 'Channels' => [ - 'description' => 'The number of sound channels. Valid values: 1: mono 2: binaural'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 1 => '1', - '2', - ], - 'example' => '2', - ], - 'Profile' => [ - 'description' => 'The audio codec profile. Valid values when the Codec parameter is set to AAC:'."\n" - ."\n" - .'* aac_low'."\n" - .'* aac_he'."\n" - .'* aac_he_v2'."\n" - .'* aac_ld'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aac_low', - 'enum' => [], + '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' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', + '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' => 'InvalidParam.TemplateIdInuse', - 'errorMessage' => 'Parameters: templateId is inuse.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + 404 => [ + ['errorCode' => 'ProjectNotFound', 'errorMessage' => 'The specified project not found', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', - 'title' => 'UpdateLiveTranscodeTemplate', - ], - 'DeleteLiveTranscodeTemplate' => [ - 'summary' => 'Deletes a live stream transcoding template.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****d80e4e4044975745c14b****', - 'enum' => [], - ], - ], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", + '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' => '******3B-0E1A-586A-AC29-742247******', + 'example' => 'on', + 'title' => '', ], + 'AuthKey' => ['description' => 'The authentication key. This parameter is returned only for HTTP callbacks.', 'type' => 'string', 'example' => 'TestKey001', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParam', - 'errorMessage' => 'Parameters: templateId is inuse.', + '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\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', - 'title' => 'DeleteLiveTranscodeTemplate', + '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', ], - 'ListLiveTranscodeTemplates' => [ - 'summary' => 'Queries a list of live stream transcoding templates.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotwordLibrary' => [ + 'summary' => 'Queries the information about a specified hotword library based on the ID.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32672,512 +18226,266 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + 'tenantRelevance' => 'tenant', + ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The type of the template. Valid values:'."\n" - ."\n" - .'* normal'."\n" - .'* narrow-band'."\n" - .'* audio-only'."\n" - .'* origin'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - 'enum' => [ - 'normal', - 'narrow-band', - 'audio-only', - 'origin', - ], - ], - ], - [ - 'name' => 'VideoCodec', - 'in' => 'query', - 'schema' => [ - 'description' => 'The video codec. Valid values:'."\n" - ."\n" - .'* H.264'."\n" - .'* H.265'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'H.264', - 'enum' => [ - 'H.264', - 'H.265', - ], - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '0', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '20', - 'default' => '50', - ], - ], - [ - '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" - .'* desc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - 'default' => 'desc', - 'enum' => [ - 'asc', - 'desc', - ], - ], - ], - [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_template', - ], - ], - [ - 'name' => 'Category', + 'name' => 'HotwordLibraryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the template. Valid values:'."\n" - ."\n" - .'* system'."\n" - .'* customized'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'customized', - 'enum' => [ - 'system', - 'customized', - ], - ], + 'schema' => ['description' => 'The ID of the hotword library.', 'type' => 'string', 'required' => true, 'example' => '****96e8864746a0b6f3****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TemplateContentList' => [ - 'description' => 'The list of transcoding templates.'."\n", + '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' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => 'my_template', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '9b1571b513cb44f7a1ba6ae561ff46f7', - ], - 'Type' => [ - 'description' => 'The type of the template.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Category' => [ - 'description' => 'The category of the template. Valid values:'."\n", - 'type' => 'string', - 'example' => 'system', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-20T03:26:36Z', - ], - 'TemplateConfig' => [ - 'description' => 'The configuration of the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'VideoParams' => [ - 'description' => 'The video parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'description' => 'The encoding format.'."\n", - 'type' => 'string', - 'example' => '264', - ], - 'Height' => [ - 'description' => 'The vertical resolution of the video.'."\n", - 'type' => 'string', - 'example' => '1280', - ], - 'Width' => [ - 'description' => 'The horizontal resolution of the video.'."\n", - 'type' => 'string', - 'example' => '720', - ], - 'Fps' => [ - 'description' => 'The video frame rate.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'Bitrate' => [ - 'description' => 'The video bitrate.'."\n", - 'type' => 'string', - 'example' => '2500', - ], - 'Gop' => [ - 'description' => 'The group of pictures (GOP) of the output video. Unit: frame.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'Profile' => [ - 'description' => 'The encoding profile.'."\n", - 'type' => 'string', - 'example' => '3', - ], - ], - ], - 'AudioParams' => [ - 'description' => 'The audio parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Codec' => [ - 'description' => 'The audio codec.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAC', - ], - 'Bitrate' => [ - 'description' => 'The audio bitrate.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'Samplerate' => [ - 'description' => 'The audio sampling rate.'."\n", - 'type' => 'string', - 'example' => '44100', - ], - 'Channels' => [ - 'description' => 'The number of sound channels.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Profile' => [ - 'description' => 'The encoding profile.'."\n", - 'type' => 'string', - 'example' => 'aac_low', - ], - ], - ], - ], - ], - ], - 'description' => '', - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', + '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' => '*'], + ], ], ], ], - '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', + 'translator' => 'manual', ], - 'SubmitLiveTranscodeJob' => [ - 'summary' => 'Submits a live stream transcoding job.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetIpcDeviceInfo' => [ + 'summary' => 'Obtain IPC device information.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the transcoding job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task1', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => false, 'example' => 'd123', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], + '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' => 'StartMode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start mode of the transcoding job.'."\n" - ."\n" - .'* 0: The transcoding job immediately starts.'."\n" - .'* 1: The transcoding job starts at the scheduled time.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], + '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' => 'StreamInput', + 'name' => 'Capability', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the input stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input stream. The value can only be rtmp.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp', - 'enum' => [ - 'rtmp', - ], - ], - 'InputUrl' => [ - 'description' => 'The URL of the input stream.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp://mydomain/app/stream1', - ], - ], - 'required' => true, - ], + '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' => 'TranscodeOutput', + 'name' => 'PageNo', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the transcoding output.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output stream. A value of LiveCenter indicates that the URL of the output stream is generated based on the domain name of ApsaraVideo Live. The value can only be LiveCenter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'LiveCenter', - ], - 'DomainName' => [ - 'description' => 'The streaming domain name of ApsaraVideo Live.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mydomain', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'Page number for paging. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'TimedConfig', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configuration of a timed transcoding job. This parameter is required if you set StartMode to 1.'."\n", - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of the transcoding job. Note: The time span between the start time and the current time cannot exceed seven days.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-21T00:00:00Z', - ], - 'EndTime' => [ - 'description' => 'The stop time of the transcoding job. Note: The time span between the stop time and the current time cannot exceed seven days.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-20T08:20:32Z', - ], - ], - 'required' => false, - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'JobId' => [ - 'description' => 'The ID of the transcoding job.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', + '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' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', + '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\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitLiveTranscodeJob', - 'description' => '* When you submit a transcoding job that immediately takes effect, make sure that the input stream can be streamed.'."\n" - .'* When you submit a timed transcoding job, make sure that the input stream can be streamed before the specified time.'."\n", + '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', ], - 'SendLiveTranscodeJobCommand' => [ - 'summary' => 'Sends a command to process a live stream transcoding job.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice6HV5HL'], + ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The ID of the transcoding job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - 'enum' => [], - ], + 'schema' => ['description' => 'The application name of the live stream.', 'type' => 'string', 'required' => false, 'example' => 'testrecord', 'title' => ''], ], [ - 'name' => 'Command', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The operation command. Only the stop command is supported. This command is used to stop a transcoding job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'stop', - 'enum' => [ - 'stop', - ], - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', - 'title' => 'SendLiveTranscodeJobCommand', - ], - 'GetLiveTranscodeJob' => [ - 'summary' => 'Queries the information about a live stream transcoding job.', - 'methods' => [ - 'get', - 'post', + 'title' => 'GetLiveEditingIndexFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveEditingIndexFile'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -33185,344 +18493,219 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice6HV5HL'], + ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The ID of the transcoding job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - 'enum' => [], - ], + 'schema' => ['description' => 'The ID of the live editing job.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Job' => [ - 'description' => 'The information about the transcoding job.'."\n", + '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' => [ - 'Name' => [ - 'description' => 'The name of the transcoding job.'."\n", - 'type' => 'string', - 'example' => 'task1', - ], - 'JobId' => [ - 'description' => 'The ID of the transcoding job.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'TemplateType' => [ - 'description' => 'The type of the template.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => 'b6491d5b3e514b7d895d14b5453ea119', - ], - 'TemplateName' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => 'basic', - ], - 'StartMode' => [ - 'description' => 'The start mode of the job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n" - ."\n" - .'* 0: The job is not started.'."\n" - .'* 1: The job is in progress.'."\n" - .'* 2: The job is stopped.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'StreamInput' => [ - 'description' => 'The information about the input stream.'."\n", + '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' => [ - 'Type' => [ - 'description' => 'The type of the input stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp', - ], - 'InputUrl' => [ - 'description' => 'The URL of the input stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://mydomain/app/stream1', - ], + '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' => '', ], - 'OutputStream' => [ - 'description' => 'The information about the output stream.'."\n", + 'MediaProduceConfig' => [ + 'title' => '', + 'description' => 'The production configurations.', 'type' => 'object', 'properties' => [ - 'StreamInfos' => [ - 'description' => 'The information about the output stream.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output stream protocol. Only the RTMP protocol is supported.'."\n", - 'type' => 'string', - 'example' => 'rtmp', - ], - 'OutputUrl' => [ - 'description' => 'The URL of the output stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://mydomain/app/mytranscode1', - ], - ], - 'description' => '', - ], - ], + 'Mode' => ['description' => 'The editing mode. Default value: Accurate.', 'type' => 'string', 'example' => 'Accurate', 'title' => ''], ], + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-20T02:48:58Z', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => '%s', + '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\\": \\"******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', + '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', ], - 'UpdateLiveTranscodeJob' => [ - 'summary' => 'Updates the information about a live stream transcoding job.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetLivePackageChannel' => [ + 'summary' => 'Gets details about a live package channel.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239699', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mytest3', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], - [ - 'name' => 'StreamInput', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the input stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input stream. The value can only be rtmp.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp', - 'enum' => [ - 'rtmp', - ], - ], - 'InputUrl' => [ - 'description' => 'The URL of the input stream.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp://mydomain/app/stream1', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'TranscodeOutput', + 'name' => 'GroupName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the transcoding output.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output stream. A value of LiveCenter indicates that the URL of the output stream is generated based on the domain name of ApsaraVideo Live. The value can only be LiveCenter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'LiveCenter', - ], - 'DomainName' => [ - 'description' => 'The streaming domain name of ApsaraVideo Live.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mydomain', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ - 'name' => 'TimedConfig', + 'name' => 'ChannelName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configuration of a timed transcoding job.'."\n", - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of the transcoding job. Note: The time span between the start time and the current time cannot exceed seven days.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-06-19T02:16:41Z'."\n", - ], - 'EndTime' => [ - 'description' => 'The stop time of the transcoding job. Note: The time span between the stop time and the current time cannot exceed seven days.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-05T06:08:31Z', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', - 'title' => 'UpdateLiveTranscodeJob', - 'description' => '* For a non-timed transcoding job, you can modify the Name parameter of the job, regardless of the job state.'."\n" - .'* For a timed job, you can modify the Name, StreamInput, TranscodeOutput, and TimedConfig parameters. However, the StreamInput, TranscodeOutput, and TimedConfig parameters can be modified only when the job is not started.'."\n", - ], - 'DeleteLiveTranscodeJob' => [ - 'summary' => '删除指定转码任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + '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' => [], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The ID of the transcoding job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - 'enum' => [], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetLivePackageChannel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', - 'title' => 'DeleteLiveTranscodeJob', + 'translator' => 'manual', ], - 'ListLiveTranscodeJobs' => [ - 'summary' => 'Queries a list of live stream transcoding jobs.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetLivePackageChannelGroup' => [ + 'summary' => 'Gets details about a live package channel group by name.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33530,407 +18713,298 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238116', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The type of the template used by the transcoding job.'."\n" - ."\n" - .'* normal'."\n" - .'* narrow-band'."\n" - .'* audio-only'."\n" - .'* origin'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - 'enum' => [ - 'normal', - 'narrow-band', - 'audio-only', - 'origin', - ], - ], - ], - [ - 'name' => 'StartMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start mode of the transcoding job.'."\n" - ."\n" - .'* 0: The transcoding job immediately starts.'."\n" - .'* 1: The transcoding job starts at the scheduled time.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '0', - '1', - ], - 'example' => '0', - ], - ], - [ - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '0', - '1', - '2', - ], - 'example' => '1', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '0', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '20', - 'default' => '50', - ], - ], - [ - '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" - .'* desc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - 'default' => 'desc', - 'enum' => [ - 'asc', - 'desc', - ], - ], - ], - [ - 'name' => 'KeyWord', + 'name' => 'GroupName', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '24ecbb5c-4f98-4194-9400-f17102e27fc5', - ], + 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'JobList' => [ - 'description' => 'The list of transcoding jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the transcoding job.'."\n", - 'type' => 'string', - 'example' => 'mytask', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - 'TemplateType' => [ - 'description' => 'The type of the transcoding template used by the transcoding job.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'TemplateId' => [ - 'description' => 'The ID of the transcoding template used by the transcoding job.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287666****', - ], - 'TemplateName' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'StartMode' => [ - 'description' => 'The start mode of the job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Status' => [ - 'description' => 'The state of the job.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'StreamInput' => [ - 'description' => 'The information about the input stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp', - ], - 'InputUrl' => [ - 'description' => 'The URL of the input stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://mydomain/app/stream1', - ], - ], - ], - 'OutputStream' => [ - 'description' => 'The information about the output stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'StreamInfos' => [ - 'description' => 'The list of stream URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output stream protocol. Only the RTMP protocol is supported.'."\n", - 'type' => 'string', - 'example' => 'rtmp', - ], - 'OutputUrl' => [ - 'description' => 'The URL of the output stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://mydomain/app/mytranscode1', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-20T02:48:58Z', - ], - ], - 'description' => '', + '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' => '', ], ], ], - '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\\": \\"模板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', - ], - 'CreateLiveRecordTemplate' => [ - 'summary' => 'Creates a live stream recording template to submit live stream recording jobs.', - 'methods' => [ - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239770', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'RecordFormat', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '录制格式', - 'description' => 'The list of recording formats.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '格式', - 'description' => 'The recording format.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '格式', - 'description' => 'The format.'."\n" - ."\n" - .'> If you set this parameter to m3u8, you must also specify the SliceOssObjectPrefix and SliceDuration parameters.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'm3u8', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'm3u8', - 'mp4', - 'flv', - ], - ], - 'SliceDuration' => [ - 'title' => '切片时长', - 'description' => 'The duration of a single segment. Unit: seconds.'."\n" - ."\n" - .'> This parameter takes effect only if you set Format to m3u8.'."\n" - ."\n" - .'If you do not specify this parameter, the default value 30 seconds is used. Valid values: 5 to 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'required' => false, - 'example' => '30', - 'pattern' => '', - 'default' => '', - ], - 'OssObjectPrefix' => [ - 'title' => 'Oss对象名', - 'description' => 'The name of the recording file that is stored in Object Storage Service (OSS).'."\n" - ."\n" - .'* The name must be less than 256 bytes in length and can contain the {JobId}, {Sequence}, {StartTime}, {EndTime}, {EscapedStartTime}, and {EscapedEndTime} variables.'."\n" - .'* The name must contain the {StartTime} and {EndTime} variables or the {EscapedStartTime} and {EscapedEndTime} variables.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', - 'pattern' => '', - 'default' => '', - ], - 'SliceOssObjectPrefix' => [ - 'title' => '切片Oss对象名', - 'description' => 'The name of the TS segment.'."\n" - ."\n" - .'> This parameter is required only if you set Format to m3u8.'."\n" - ."\n" - .'* By default, the duration of a segment is 30 seconds. The segment name must be less than 256 bytes in length and can contain the {JobId}, {UnixTimestamp}, and {Sequence} variables.'."\n" - .'* The segment name must contain the {UnixTimestamp} and {Sequence} variables.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}', - 'pattern' => '', - 'default' => '', - ], - 'CycleDuration' => [ - 'description' => 'The duration of the recording cycle. Unit: seconds. If you do not specify this parameter, the default value 6 hours is used.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If a live stream is interrupted during a recording cycle but is resumed within 3 minutes, the stream is recorded in the same recording before and after the interruption.'."\n" - ."\n" - .'* If a live stream is interrupted for more than 3 minutes, a new recording is generated. To change the default stream interruption time, submit a ticket.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'required' => false, - 'example' => '3600', + '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' => '', ], - 'deprecated' => false, - 'required' => false, + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', 'title' => ''], ], - 'deprecated' => false, - 'required' => true, + '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' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源名称', - 'description' => 'The name of the template.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'pattern' => '', - 'default' => '', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'TemplateId' => [ - 'title' => '资源一级ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '****96e8864746a0b6f3****', - 'pattern' => '', - 'readOnly' => true, - 'default' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', + '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 \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\"\\n}","type":"json"}]', - 'title' => 'CreateLiveRecordTemplate', - 'description' => 'You must specify a recording template for live stream recording. You can configure information such as the format and duration of a recording in a recording template. The recording format can be M3U8, MP4, or FLV.'."\n", + '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', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -33943,666 +19017,728 @@ [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - ], + '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RecordTemplate' => [ - 'title' => '录制模板', - 'description' => 'The recording template.'."\n", + 'title' => '', + 'description' => 'The recording template.', 'type' => 'object', 'properties' => [ 'RecordFormatList' => [ - 'title' => '录制格式', - 'description' => 'The list of recording formats.'."\n", + 'title' => '', + 'description' => 'The list of recording formats.', 'type' => 'array', 'items' => [ - 'title' => '格式', - 'description' => 'The recording format.'."\n", + 'title' => '', + 'description' => 'The recording format.', 'type' => 'object', 'properties' => [ 'Format' => [ - 'title' => '格式', - 'description' => 'The output file format.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'm3u8', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'm3u8', - 'mp4', - 'flv', - ], - ], - 'OssObjectPrefix' => [ - 'title' => 'Oss对象名', - 'description' => 'The name of the recording file that is stored in Object Storage Service (OSS).'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'record/{JobId}/{Sequence}{EscapedStartTime}{EscapedEndTime}', - 'pattern' => '', - 'default' => '', - ], - 'SliceOssObjectPrefix' => [ - 'title' => '切片Oss对象名', - 'description' => 'The name of the TS segment.'."\n", + 'description' => 'The output file format.', 'type' => 'string', 'deprecated' => false, - 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}', 'pattern' => '', 'default' => '', + 'enum' => ['m3u8', 'mp4', 'flv'], + 'title' => '', + 'example' => 'm3u8', ], - 'CycleDuration' => [ - 'description' => 'The duration of the recording cycle. Unit: seconds. If you do not specify this parameter, the default value 6 hours is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '7200', - ], - 'SliceDuration' => [ - 'description' => 'The duration of a single segment. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + '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' => [ - 'title' => '创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2022-07-20T03:26:36Z', - ], - 'LastModified' => [ - 'title' => '创建时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2022-07-20T03:26:36Z', - ], - 'TemplateId' => [ - 'title' => '资源一级ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '资源名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test template', - 'pattern' => '', - 'default' => '', - ], + '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' => [ - 'title' => '资源名称', 'description' => 'The type of the template.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* system'."\n" - .'* custom'."\n", + .'- system'."\n" + ."\n" + .'- custom', + 'enumValueTitles' => ['system' => 'system', 'custom' => 'custom'], 'type' => 'string', 'deprecated' => false, - 'enumValueTitles' => [ - 'system' => 'system', - 'custom' => 'custom', - ], - 'example' => 'custom', 'pattern' => '', 'default' => '', + 'title' => '', + 'example' => 'custom', ], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C892855F-95DF-50D6-A28C-279ABDB76810', - ], + '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', - ], - 'UpdateLiveRecordTemplate' => [ - 'summary' => 'Updates the information about a live stream recording template.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRecordTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RecordFormat', - 'in' => 'formData', - 'style' => 'json', + '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 list of recording formats.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '格式', - 'description' => 'The recording format.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '格式', - 'description' => 'The format of recording files.'."\n" - ."\n" - .'> If you set this parameter to m3u8, you must also specify the SliceOssObjectPrefix and SliceDuration parameters.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'm3u8', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'm3u8', - 'mp4', - 'flv', + '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', ], ], - 'SliceDuration' => [ - 'title' => '切片时长', - 'description' => 'The duration of a single segment. Unit: seconds'."\n" - ."\n" - .'> This parameter takes effect only if you set Format to m3u8.'."\n" - ."\n" - .'If you do not specify this parameter, the default value 30 seconds is used. Valid values: 5 to 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'required' => false, - 'example' => '30', - 'pattern' => '', - 'default' => '', - ], - 'OssObjectPrefix' => [ - 'title' => 'Oss对象名', - 'description' => 'The name of the recording that is stored in Object Storage Service (OSS).'."\n" - ."\n" - .'* The name must be less than 256 bytes in length and can contain the {JobId}, {Sequence}, {StartTime}, {EndTime}, {EscapedStartTime}, and {EscapedEndTime} variables.'."\n" - .'* The name must contain the {StartTime} and {EndTime} variables or the {EscapedStartTime} and {EscapedEndTime} variables.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', - 'pattern' => '', - 'default' => '', - ], - 'SliceOssObjectPrefix' => [ - 'title' => '切片Oss对象名', - 'description' => 'The name of the TS segment.'."\n" - ."\n" - .'> This parameter is required only if you set Format to m3u8. By default, the duration of a segment is 30 seconds. The segment name must be less than 256 bytes in length and can contain the {JobId}, {UnixTimestamp}, and {Sequence} variables.'."\n" - ."\n" - .'The segment name must contain the {UnixTimestamp} and {Sequence} variables.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}'."\n", - 'pattern' => '', - 'default' => '', - ], - 'CycleDuration' => [ - 'description' => 'The duration of the recording cycle. Unit: seconds If you do not specify this parameter, the default value 6 hours is used.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If a live stream is interrupted during a recording cycle but is resumed within 3 minutes, the stream is recorded in the same recording before and after the interruption.'."\n" - ."\n" - .'* If a live stream is interrupted for more than 3 minutes, a new recording is generated. To change the default stream interruption time, submit a ticket.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'required' => false, - 'example' => '3600', + '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' => '', ], - 'deprecated' => false, - 'required' => false, + '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' => '*'], ], - 'deprecated' => false, - 'required' => true, ], ], + ], + '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' => 'formData', + 'in' => 'query', + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '资源一级ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'default' => '', + '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' => ''], + ], [ - 'name' => 'Name', - 'in' => 'formData', + ['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' => [ - 'title' => '资源名称', - 'description' => 'The template name.'."\n", + 'description' => 'The ID of the transcoding job.', 'type' => 'string', - 'deprecated' => false, 'required' => true, - 'example' => 'test template', - 'pattern' => '', - 'default' => '', + 'enum' => [], + 'title' => '', + 'example' => '****20b48fb04483915d4f2cd8ac****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '资源一级ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3', - 'pattern' => '', - 'readOnly' => true, - 'default' => '', + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3\\"\\n}","type":"json"}]', - 'title' => 'UpdateLiveRecordTemplate', - 'description' => 'Only user-created templates can be updated. The preset template cannot be updated.'."\n", - ], - 'DeleteLiveRecordTemplate' => [ - 'summary' => 'Deletes a live stream recording template without affecting existing jobs.', - 'methods' => [ - 'post', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + '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' => '资源一级ID', - '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.'."\n", - 'type' => 'string', - 'properties' => [], - 'deprecated' => false, - 'required' => true, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'readOnly' => true, - 'default' => '', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3E5330CF-B4C8-5BEF-AA6B-8E70BD20FAEE', + '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' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5330CF-B4C8-5BEF-AA6B-8E70BD20FAEE\\"\\n}","type":"json"}]', - 'title' => 'DeleteLiveRecordTemplate', + 'translator' => 'manual', ], - 'ListLiveRecordTemplates' => [ - 'summary' => 'Queries a list of live stream recording templates.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMediaConnectFlow' => [ + 'summary' => 'Retrieves the details of a MediaConnect Flow instance.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test template', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the template.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* system'."\n" - .'* custom'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'system' => '', - 'custom' => '', - ], - 'example' => 'custom', - ], - ], - [ - 'name' => 'TemplateIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - ], - 'required' => false, - 'maxItems' => 100, - 'description' => '', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Minimum value: 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SortBy', + 'name' => 'FlowId', '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" - .'* desc: sorts the query results in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', - ], - 'example' => 'desc', - ], + 'schema' => ['description' => 'The ID of the MediaConnect Flow instance.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RecordTemplateList' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'The list of recording templates.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'LiveRecordTemplateItemType', - 'description' => 'The recording template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '资源名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test template', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '资源名称', - 'description' => 'The type of the template.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'custom', - 'pattern' => '', - 'default' => '', - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'deprecated' => false, - 'example' => '2022-07-20T03:26:36Z', - 'pattern' => '', - 'default' => '', - ], - 'TemplateId' => [ - 'title' => '资源一级ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'default' => '', - ], - 'RecordFormatList' => [ - 'title' => '录制格式', - 'description' => 'The list of recording formats.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '格式', - 'description' => 'The recording format.'."\n", - 'type' => 'object', - 'properties' => [ - 'Format' => [ - 'title' => '格式', - 'description' => 'The output file format.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'm3u8', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'm3u8', - 'mp4', - 'flv', - ], - ], - 'SliceDuration' => [ - 'title' => '切片时长', - 'description' => 'The duration of a single segment. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '30', - 'pattern' => '', - 'default' => '', - ], - 'OssObjectPrefix' => [ - 'title' => 'Oss对象名', - 'description' => 'The name of the recording file that is stored in Object Storage Service (OSS).'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', - 'pattern' => '', - 'default' => '', - ], - 'SliceOssObjectPrefix' => [ - 'title' => '切片Oss对象名', - 'description' => 'The name of the TS segment.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}', - 'pattern' => '', - 'default' => '', - ], - 'CycleDuration' => [ - 'description' => 'The duration of the recording cycle. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '21600', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2022-07-20T02:48:58Z', - ], - ], - ], - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', - ], - 'TotalCount' => [ - 'title' => '总记录数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'PageNo' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'SortBy' => [ - '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" - .'* desc: sorts the query results in descending order.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', + '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' => ''], ], - 'example' => 'desc', + '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' => '', ], ], ], - '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', - ], - 'SubmitLiveRecordJob' => [ - 'summary' => 'Submits a live stream recording job.', - 'methods' => [ - 'post', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -34610,425 +19746,439 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'NotifyUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => '回调地址', - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'https://example.com/imsnotify', - 'pattern' => '', - 'default' => '', - ], + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => true, 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', 'title' => ''], ], - [ - 'name' => 'StreamInput', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The URL of the live stream.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the live stream URL. The value can only be rtmp.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'rtmp' => 'rtmp', - ], - 'example' => 'rtmp', - ], - 'Url' => [ - 'description' => 'The URL of the live stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp://example.com/live/stream1', + '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' => ''], ], - 'deprecated' => false, - 'required' => true, + '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' => [ [ - 'name' => 'RecordOutput', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The storage address of the recording.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the storage address.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss', - ], - 'Bucket' => [ - 'description' => 'The bucket name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'imsbucket1', - ], - 'Endpoint' => [ - 'description' => 'The endpoint of the storage service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss-cn-hangzhou.aliyuncs.com', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:GetMediaConnectFlowAllOutputName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'deprecated' => false, - 'required' => true, ], ], + ], + 'translator' => 'manual', + ], + 'GetMediaConnectFlowInput' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'title' => '录制模板ID', - 'description' => 'The ID of the recording template.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'default' => '', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源名称', - 'description' => 'The name of the recording job.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'live stream record 1', - 'pattern' => '', - 'default' => '', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Response content.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', - ], - 'JobId' => [ - 'title' => '若创建接口为异步实现，则需返回明确的JobId。', - 'description' => 'The ID of the recording job.'."\n", - 'type' => 'string', - 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\"\\n}","type":"json"}]', - 'title' => 'SubmitLiveRecordJob', - 'description' => 'You can call this operation to record live streams of ApsaraVideo Live or third-party Real-Time Messaging Protocol (RTMP) live streams. We recommend that you ingest a stream before you call this operation to submit a recording job. If no stream is pulled from the streaming URL, the job attempts to pull a stream for 3 minutes. If the attempt times out, the recording service stops.'."\n" - ."\n" - .'Before you submit a recording job, you must prepare an Object Storage Service (OSS) or ApsaraVideo VOD bucket. We recommend that you use a storage address configured in Intelligent Media Services (IMS) to facilitate the management and processing of generated recording files.'."\n" - ."\n" - .'If the preset recording template does not meet your requirements, you can create a custom recording template.'."\n", - ], - 'GetLiveRecordJob' => [ - 'summary' => 'Queries the information about a live stream recording job.', - 'methods' => [ - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The ID of the recording job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RecordJob' => [ - 'title' => '录制任务', - 'description' => 'The details of the recording job.'."\n", + 'Content' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'NotifyUrl' => [ - 'title' => '回调地址', - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'https://example.com/imsnotify', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2022-07-20T02:48:58Z', - ], - 'StreamInput' => [ - 'description' => 'The URL of the live stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the live stream. The value can only be rtmp.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'rtmp' => 'rtmp', - ], - 'example' => 'rtmp', - ], - 'Url' => [ - 'description' => 'The URL of the live stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://example.com/app/stream', - ], - ], - 'deprecated' => false, - ], - 'RecordOutput' => [ - 'description' => 'The storage address of the recording.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the storage address.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* vod'."\n" - .'* oss'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'vod' => 'vod', - 'oss' => 'oss', - ], - 'example' => 'oss', - ], - 'Bucket' => [ - 'description' => 'The bucket name.'."\n", - 'type' => 'string', - 'example' => 'imsbucket1', - ], - 'Endpoint' => [ - 'description' => 'The endpoint of the storage service.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai.aliyuncs.com', - ], - ], - 'deprecated' => false, - ], - 'TemplateId' => [ - 'title' => '录制模板ID', - 'description' => 'The ID of the recording template.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'default' => '', - ], - 'TemplateName' => [ - 'title' => '录制模板ID', - 'description' => 'The name of the recording template.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'test template', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '资源名称', - 'description' => 'The name of the recording job.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '', - 'pattern' => '', - 'default' => '', - ], - 'JobId' => [ - 'title' => '资源名称', - 'description' => 'The ID of the recording job.'."\n", + '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', - 'deprecated' => false, - 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'default' => '', + 'example' => 'SRT-PULL', + 'title' => '', ], - 'Status' => [ - 'title' => '资源名称', - 'description' => 'The state of the recording job.'."\n" + '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" - .'* paused: The job is paused.'."\n" - .'* initial: The job is not started.'."\n" - .'* started: The job is in progress.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [ - 'paused' => 'paused', - 'initial' => 'initial', - 'started' => 'started', - ], - 'example' => 'paused', - 'pattern' => '', - 'default' => '', + .'- 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' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B57A046C-CE33-5FBB-B57A-D2B89ACF6907', - ], + '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' => '', ], ], ], - '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\\": \\"直播活动录制任务1\\",\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\",\\n \\"Status\\": \\"paused\\"\\n },\\n \\"RequestId\\": \\"B57A046C-CE33-5FBB-B57A-D2B89ACF6907\\"\\n}","type":"json"}]', - 'title' => 'GetLiveRecordJob', - ], - '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', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceEO4QPO'], + ], 'parameters' => [ [ - 'name' => 'RecordIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The collection of IDs of recording files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the recording file in the UUID format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '13cbb83e-043c-4728-ac35-****', - ], - 'required' => true, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'RemoveFile', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to delete the original files in OSS.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the media transcoding job.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '13cbb83e-043c-4728-ac35-*****', - ], - 'DeleteFileInfoList' => [ - 'description' => 'The list of files deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The file deleted.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code that identifies the result of the deletion.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => 'The result of deletion.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RecordId' => [ - 'description' => 'The ID of the deleted recording file.'."\n", - 'type' => 'string', - 'example' => '13cbb83e-043c-4728-ac35-*****', + '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' => ''], ], - ], - 'Message' => [ - 'description' => 'The description of the state returned.'."\n", - 'type' => 'string', - 'example' => 'OK', + 'example' => '', ], ], + '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', - ], - 'ListLiveRecordJobs' => [ - 'summary' => 'Queries a list of live stream recording jobs by page.', - 'methods' => [ - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -35036,265 +20186,368 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '6890', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + ], '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', - ], - ], - [ - '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.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2022-07-15T08:00:00Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'MediaId', '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.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2022-07-11T08:00:00Z', - ], + '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' => 'Status', + 'name' => 'InputURL', '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" - .'* initial: The job is not started.'."\n" - .'* started: The job is in progress.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'paused' => 'paused', - 'initial' => 'initial', - 'started' => 'started', - ], - 'example' => 'started', - ], + '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' => 'PageNo', + 'name' => 'OutputType', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'ReturnDetailedInfo', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + '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' => 'SortBy', + 'name' => 'AuthTimeout', '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" - .'* desc: sorts the query results in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', - ], - 'example' => 'desc', - ], + 'schema' => ['description' => 'The validity period of the signed URL, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A27DFFA4-F272-5563-8363-CB0BC42740BA', - ], - 'LiveRecordJobs' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'The list of live stream recording jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'LiveRecordJobItemType', - 'description' => 'LiveRecordJobItemType'."\n", - 'type' => 'object', - 'properties' => [ - 'RecordOutput' => [ - 'description' => 'The storage address of the recording.'."\n", + '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' => [ - 'Type' => [ - 'description' => 'The type of the storage address.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* vod'."\n" - .'* oss'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'vod' => 'vod', - 'oss' => 'oss', + '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' => 'oss', + 'example' => '', ], - 'Bucket' => [ - 'description' => 'The bucket name.'."\n", - 'type' => 'string', - 'example' => 'imsbucket1', + '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' => '', ], - 'Endpoint' => [ - 'description' => 'The endpoint of the storage service.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-hangzhou.aliyuncs.com', + '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' => '', ], ], - 'deprecated' => false, - ], - 'Name' => [ - 'title' => '资源名称', - 'description' => 'The name of the recording job.'."\n", - 'type' => 'string', - 'deprecated' => false, + 'description' => '', + 'title' => '', 'example' => '', - 'pattern' => '', - 'default' => '', - ], - 'NotifyUrl' => [ - 'title' => '回调地址', - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'https://example.com/imsnotify', - 'pattern' => '', - 'default' => '', - ], - 'TemplateId' => [ - 'title' => '录制模板ID', - 'description' => 'The ID of the recording template.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2022-07-20T03:26:36Z', ], - 'StreamInput' => [ - 'description' => 'The URL of the live stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the live stream URL.'."\n", - 'type' => 'string', - 'example' => 'rtmp', - ], - 'Url' => [ - 'description' => 'The URL of the live stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://example-live.com/live/stream1', + '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' => '', ], - 'deprecated' => false, - ], - 'JobId' => [ - 'description' => 'The ID of the recording job.'."\n", - 'type' => 'string', - 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', - ], - 'Status' => [ - 'description' => 'The state of the recording job.'."\n", - 'type' => 'string', - 'example' => 'paused', - ], - 'TemplateName' => [ - 'description' => 'The name of the recording template.'."\n", - 'type' => 'string', - 'example' => 'test template', ], + 'title' => '', + 'example' => '', ], ], - ], - 'TotalCount' => [ - 'title' => '总记录数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '180', - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'SortBy' => [ - 'description' => 'The sorting order. By default, the query results are sorted by creation time in descending order.'."\n", - 'type' => 'string', - 'example' => 'desc', + 'title' => '', + 'example' => '', ], ], + '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\\": \\"直播活动录制任务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', - ], - 'ListLiveRecordFiles' => [ - 'summary' => 'Queries all recording index files in the specified period of time.', - 'methods' => [ - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -35305,1204 +20558,1392 @@ '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-12-22T08:00:00Z', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-12-21T08:00:01Z', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82dfa8e8', 'title' => '', 'required' => false], ], - [ - 'name' => 'JobIds', - 'in' => 'query', - 'style' => 'flat', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The list of job IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the recording job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9E83D5D0-8D72-5E7D-B61A-****', + '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' => '', + ], ], - 'required' => false, - 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + ], + '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' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 5 to 30. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + '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' => [ [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ [ - 'name' => 'RecordFormat', - 'in' => 'query', - 'schema' => [ - 'description' => 'The format of the recording file. Valid values:'."\n" - ."\n" - .'M3U8, FLV, and MP4'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm3u8', - ], + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DE24625C-7C0F-4020-8448-****', - ], - 'PageNo' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SortBy' => [ - 'description' => 'The sorting order of the index files by creation time.'."\n", - 'type' => 'string', - 'example' => 'asc', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of files that meet the specified conditions.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'Files' => [ - 'description' => 'The list of index files.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RecordUrl' => [ - 'description' => 'The URL of the index file.'."\n", - 'type' => 'string', - 'example' => 'http://****/atestObject****.m3u8', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2015-12-01T07:36:00Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2015-12-01T07:36:10Z', - ], - 'Duration' => [ - 'description' => 'The recording length. Unit: seconds.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100.0', - ], - 'Width' => [ - 'description' => 'The width of the video.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '480', - ], - 'Height' => [ - 'description' => 'The height of the video.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '640', - ], - 'CreateTime' => [ - 'description' => 'The time when the file was created in UTC.'."\n", - 'type' => 'string', - 'example' => '2016-05-27T09:40:56Z', - ], - 'RecordOutput' => [ - 'description' => 'The storage information about the recording file.'."\n", - 'type' => 'string', - 'example' => '{ "Type": "oss", "Endpoint":"oss-cn-shanghai.aliyuncs.com", "Bucket": "test-bucket" }', - ], - 'RecordId' => [ - 'description' => 'The ID of the index file.'."\n", - 'type' => 'string', - 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', - ], - 'StreamUrl' => [ - 'description' => 'The name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'LiveStream***', + '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' => '', ], - 'JobName' => [ - 'description' => 'The name of the recording job.'."\n", - 'type' => 'string', - 'example' => 'LiveRecordJob***', + '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' => '', ], - 'Format' => [ - 'description' => 'The format of the recording file.'."\n", - 'type' => 'string', - 'example' => 'm3u8', + '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' => '', ], - 'JobId' => [ - 'description' => 'The ID of the recording job.'."\n", - 'type' => 'string', - 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + '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' => '', ], - 'description' => '', + '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' => '', ], ], ], - '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', - ], - 'CreateLiveSnapshotTemplate' => [ - 'summary' => 'Create a live stream snapshot template to facilitate the creation of snapshot jobs.', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'TemplateName', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板名称。'."\n", - 'description' => 'The name of the template.'."\n" - ."\n" - .'* It cannot exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'OverwriteFormat', - 'in' => 'formData', - 'schema' => [ - 'title' => '覆盖截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" - .'支持占位符：'."\n" - .'{JobId}：截图任务ID'."\n" - .'不允许填写{UnixTimestamp}、{Sequence}、{Date}等占位符'."\n" - .'覆盖截图和序列截图的文件格式至少要设置一个。', - '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" - .'* It cannot exceed 255 characters in length.'."\n" - .'* The {JobId} placeholder is supported. It specifies the ID of the snapshot job.'."\n" - .'* Placeholders such as {UnixTimestamp}, {Sequence}, and {Date} are not allowed.'."\n" - .'* You must specify at least one of the OverwriteFormat and SequenceFormat parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'snapshot/{JobId}.jpg', - ], - ], - [ - 'name' => 'SequenceFormat', - 'in' => 'formData', - 'schema' => [ - 'title' => '序列截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" - .'支持占位符：'."\n" - .'{JobId}：截图任务ID'."\n" - .'{Date}：截图日期'."\n" - .'{UnixTimestamp}：时间戳'."\n" - .'{Sequence}：序列号'."\n" - .'其中{UnixTimestamp}、{Sequence}至少要填写一个。'."\n" - .'覆盖截图和序列截图的文件格式至少要设置一个。', - '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" - .'* It cannot exceed 255 characters in length.'."\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" - .'* You must specify at least one of the OverwriteFormat and SequenceFormat parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', - ], - ], - [ - 'name' => 'TimeInterval', + 'name' => 'InputId', 'in' => 'formData', - 'schema' => [ - 'title' => '截图时间间隔，取值范围是[5, 3600]。', - 'description' => 'The interval between two adjacent snapshots. Unit: seconds.'."\n" - ."\n" - .'* Valid values: \\[5,3600].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '5', - ], + 'schema' => ['description' => 'The ID of the input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'TemplateId' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287782****', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + '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'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetMediaLiveInput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\"\\n}","type":"json"}]', - 'title' => 'CreateLiveSnapshotTemplate', + 'translator' => 'manual', ], - 'GetLiveSnapshotTemplate' => [ - 'summary' => 'Queries the information about a live stream snapshot template.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMediaLiveInputSecurityGroup' => [ + 'summary' => 'Gets details about a security group in MediaLive.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], + 'name' => 'SecurityGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The data returned.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'TemplateId' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - 'TemplateName' => [ - 'title' => '模板名称。', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'title' => '模板类型。'."\n" - .'custom：自定义'."\n" - .'system：系统预置', - 'description' => 'The type of the template.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* system'."\n" - .'* custom'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'system' => '', - 'custom' => '', + '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' => '', + ], ], - 'example' => 'custom', - ], - 'OverwriteFormat' => [ - 'title' => '覆盖截图文件格式。', - 'description' => 'The naming format of the snapshot captured in overwrite mode.'."\n", - 'type' => 'string', - 'example' => 'snapshot/{JobId}.jpg', - ], - 'SequenceFormat' => [ - 'title' => '序列截图文件格式。', - 'description' => 'The naming format of the snapshot captured in time series mode.'."\n", - 'type' => 'string', - 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', - ], - 'TimeInterval' => [ - 'title' => '截图时间间隔。', - 'description' => 'The interval between two adjacent snapshots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'LastModified' => [ - 'title' => '创建时间。', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-02-02T22:22:22Z', - ], - 'CreateTime' => [ - 'title' => '修改时间。', - 'description' => 'The time when the configuration was modified.'."\n", - 'type' => 'string', - 'example' => '2022-02-02T22:22:22Z', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + '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' => [ [ - [ - 'errorCode' => 'TemplateNotFound', - 'errorMessage' => 'No such template.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetMediaLiveInputSecurityGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateName\\": \\"模板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', + 'translator' => 'manual', ], - 'UpdateLiveSnapshotTemplate' => [ - 'summary' => 'Updates the information about a live stream snapshot template.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMediaMarks' => [ + 'summary' => 'Queries the information about marks based on mark IDs.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - ], - [ - 'name' => 'TemplateName', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板名称。', - 'description' => 'The name of the template.'."\n" - ."\n" - .'* It cannot exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'OverwriteFormat', - 'in' => 'formData', - 'schema' => [ - 'title' => '覆盖截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" - .'支持占位符：'."\n" - .'{JobId}：截图任务ID'."\n" - .'不允许填写{UnixTimestamp}、{Sequence}等占位符'."\n" - .'覆盖截图和序列截图的文件格式至少要设置一个。', - '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" - .'* The value cannot exceed 255 characters in length.'."\n" - .'* The {JobId} placeholder is supported. It specifies the ID of the snapshot job.'."\n" - .'* Placeholders such as {UnixTimestamp}, {Sequence}, and {Date} are not allowed.'."\n" - .'* You must specify at least one of the OverwriteFormat and SequenceFormat parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'snapshot/{JobId}.jpg', - ], - ], - [ - 'name' => 'SequenceFormat', - 'in' => 'formData', - 'schema' => [ - 'title' => '序列截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" - .'支持占位符：'."\n" - .'{JobId}：截图任务ID'."\n" - .'{Date}：截图日期'."\n" - .'{UnixTimestamp}：时间戳'."\n" - .'{Sequence}：序列号'."\n" - .'其中{UnixTimestamp}、{Sequence}至少要填写一个。'."\n" - .'覆盖截图和序列截图的文件格式至少要设置一个。', - '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" - .'* The value cannot exceed 255 characters in length.'."\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" - .'* You must specify at least one of the OverwriteFormat and SequenceFormat parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', - ], + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ - 'name' => 'TimeInterval', - 'in' => 'formData', - 'schema' => [ - 'title' => '截图时间间隔，[5, 3600]。', - 'description' => 'The interval between two adjacent snapshots. Unit: seconds.'."\n" - ."\n" - .'* Valid values: \\[5,3600].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '5', - ], + '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.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + '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' => [ [ - [ - 'errorCode' => 'TemplateNotFound', - 'errorMessage' => 'No such template.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetMediaMarks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'UpdateLiveSnapshotTemplate', + 'translator' => 'manual', ], - 'DeleteLiveSnapshotTemplate' => [ - 'summary' => 'Deletes a live stream snapshot template.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceM55707'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], + '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 data returned.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + 404 => [ + ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job not found', 'description' => ''], ], - [ - [ - 'errorCode' => 'TemplateNotFound', - 'errorMessage' => 'No such template.', - ], + ], + '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'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetMediaProducingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'DeleteLiveSnapshotTemplate', + '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', ], - 'ListLiveSnapshotTemplates' => [ - 'summary' => 'Queries a list of live stream snapshot templates by page.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetPackageJob' => [ + 'summary' => 'Queries the information about a packaging job.', + 'methods' => ['get', 'post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SearchKeyWord', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索关键词，模板ID/名称，名称支持模糊搜索。', - '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.'."\n" - ."\n" - .'* It cannot exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - ], - [ - 'name' => 'TemplateIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '指定模板ID查询，如果指定SearchKeyWord，该条件不生效。', - 'description' => 'The template IDs.'."\n" - ."\n" - .'* If you specify the SearchKeyWord parameter, this condition does not take effect.'."\n" - .'* The maximum length of the array is 200.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => '****a046-263c-3560-978a-fb287782****', - 'description' => '', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'title' => '模板类型，默认是查询全部。'."\n" - .'custom：自定义'."\n" - .'system：系统预置', - 'description' => 'The type of the template. By default, all types are queried.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* system'."\n" - .'* custom'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'system' => '', - 'custom' => '', - ], - 'example' => 'custom', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '页码，[1, n)，默认是1。', - 'description' => 'The page number. Valid values: \\[1,n). Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页宽，[1, 100]，默认是10。', - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SortBy', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '排序，默认按CreateTime排序，默认是desc。'."\n" - .'asc：升序'."\n" - .'desc：倒序', - '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 by creation time in ascending order.'."\n" - .'* desc: sorts the query results by creation time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', - ], - 'example' => 'desc', - ], + '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' => [ - 'title' => '响应数据。', - 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'TemplateList' => [ - 'title' => '模板列表。', - 'description' => 'The list of the templates.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - 'TemplateName' => [ - 'title' => '模板名称。', - 'description' => 'The template name.'."\n", - 'type' => 'string', + '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' => '', ], - 'Type' => [ - 'title' => '模板类型。'."\n" - .'custom：自定义'."\n" - .'system：系统预置', - 'description' => 'The type of the template.'."\n" + 'title' => '', + 'example' => '', + ], + 'Output' => [ + 'description' => 'The output of the job.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the media object. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- OSS: an OSS object.'."\n" ."\n" - .'* system'."\n" - .'* custom'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'system' => '', - 'custom' => '', - ], - 'example' => 'custom', - ], - 'TimeInterval' => [ - 'title' => '截图时间间隔。', - 'description' => 'The interval between two adjacent snapshots. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CreateTime' => [ - 'title' => '创建时间。', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-20T02:48:58Z', + .'- 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' => '', ], - 'description' => '', + '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' => ''], ], - ], - 'PageNo' => [ - 'title' => '页码。', - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页宽。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SortBy' => [ - 'title' => '排序。', - 'description' => 'The sorting order of the results by creation time.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'TotalCount' => [ - 'title' => '总数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + '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'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetPackageJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateList\\": [\\n {\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateName\\": \\"模板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', + 'translator' => 'manual', ], - 'SubmitLiveSnapshotJob' => [ - 'summary' => 'Submits a live stream snapshot job. If the job is submitted during stream ingest, it automatically starts in asynchronous mode. Otherwise, it does not start.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetPipeline' => [ + 'summary' => 'Queries the information about an ApsaraVideo Media Processing (MPS) queue.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobName', - 'in' => 'formData', - 'schema' => [ - 'title' => '任务名称。', - 'description' => 'The name of the job.'."\n" - ."\n" - .'* It cannot exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], - [ - 'name' => 'StreamInput', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '流输入信息。', - 'description' => 'The information about the input stream.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'title' => '流输入地址。', - 'description' => 'The URL of the input stream.'."\n" - ."\n" - .'* It cannot exceed 255 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp://www.aliyun.com/stream', - ], - 'Type' => [ - 'title' => '流输入类型。', - 'description' => 'The type of the input stream. The value can only be rtmp.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'rtmp' => 'rtmp', + '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' => 'rtmp', + 'example' => '', ], ], - 'required' => true, + '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' => [ [ - 'name' => 'SnapshotOutput', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '截图输出信息。', - 'description' => 'The information about the output snapshot.'."\n", - 'type' => 'object', - 'properties' => [ - 'StorageType' => [ - 'title' => '截图存储类型。', - 'description' => 'The storage type of the snapshot. The value can only be oss.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'oss' => 'oss', - ], - 'example' => 'oss', - ], - 'Endpoint' => [ - 'title' => '截图输出终端。', - 'description' => 'The output endpoint of the snapshot.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss-cn-shanghai.aliyuncs.com', - ], - 'Bucket' => [ - 'title' => '截图输出终端的Bucket。', - 'description' => 'The bucket of the snapshot output endpoint.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testbucket', - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetPipeline', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => true, ], ], + ], + 'translator' => 'manual', + ], + 'GetPlayInfo' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFUMQ35'], + ], + 'parameters' => [ [ - 'name' => 'CallbackUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => '截图回调地址。', - 'description' => 'The snapshot callback URL.'."\n" - ."\n" - .'* It cannot exceed 255 characters in length.'."\n" - .'* Both HTTP and HTTPS URLs are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com/snapshot/callback', - ], + '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' => [ - 'title' => '响应数据。', - 'description' => 'The data returned.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => '', ], - 'JobId' => [ - 'title' => '任务ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287666****', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable. ', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + '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' => [ [ - [ - 'errorCode' => 'TemplateNotFound', - 'errorMessage' => 'No such template. ', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + '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 \\"JobId\\": \\"****a046-263c-3560-978a-fb287666****\\"\\n}","type":"json"}]', - 'title' => 'SubmitLiveSnapshotJob', + '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', ], - 'SendLiveSnapshotJobCommand' => [ - 'summary' => 'Sends a command to process a live stream snapshot job.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetProgram' => [ + 'summary' => 'Queries a program.', + 'description' => ' ', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36510,827 +21951,788 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'title' => '截图任务ID。', - 'description' => 'The ID of the snapshot job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], + 'name' => 'ProgramName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => true, 'example' => 'program1', 'title' => ''], ], [ - 'name' => 'Command', - 'in' => 'formData', - 'schema' => [ - 'title' => '操作指令：start，stop，restart。', - 'description' => 'The operation command.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* stop'."\n" - .'* restart'."\n" - .'* start'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'stop' => '', - 'restart' => '', - 'start' => '', - ], - 'example' => 'start', - ], + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'JobLimitExceeded', - 'errorMessage' => 'Job limit exceeded.', - ], - [ - 'errorCode' => 'StreamNotFound', - 'errorMessage' => 'No such stream.', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], - ], + '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' => [ [ - [ - 'errorCode' => 'JobNotFound', - 'errorMessage' => 'No such job.', - ], - ], - 409 => [ - [ - 'errorCode' => 'JobAlreadyStarted', - 'errorMessage' => 'Job is already started.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetProgram', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'SendLiveSnapshotJobCommand', + 'translator' => 'manual', ], - 'GetLiveSnapshotJob' => [ - 'summary' => 'Queries the information a live stream snapshot job.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetProjectExportJob' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceM55707'], + ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], + 'schema' => ['description' => 'The ID of the project export task.', 'type' => 'string', 'required' => true, 'example' => '****cdb3e74639973036bc84****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'title' => '任务ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - 'JobName' => [ - 'title' => '任务名称。', - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'TemplateId' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287666****', - ], - 'TemplateName' => [ - 'title' => '模板名称。', - 'description' => 'The name of the template.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Status' => [ - 'title' => '任务状态。'."\n" - .'init：未启动'."\n" - .'started：执行中'."\n" - .'paused：已停止', - 'description' => 'The state of the job.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* init: The job is not started.'."\n" - .'* paused: The job is paused.'."\n" - .'* started: The job is in progress.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'init' => '', - 'paused' => '', - 'started' => '', - ], - 'example' => 'started', - ], - 'StreamInput' => [ - 'title' => '输入信息。', - 'description' => 'The input information.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****'], + 'ProjectExportJob' => [ + 'description' => 'The project export task.', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'title' => '输入地址。', - 'description' => 'The URL of the input stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://www.aliyun.com/stream', - ], - 'Type' => [ - 'title' => '输入类型，rtmp、hls、flv。', - 'description' => 'The type of the input stream. The value can only be rtmp.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'rtmp' => 'rtmp', + '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' => '', + ], ], - 'example' => 'rtmp', + 'title' => '', + 'example' => '', ], + 'UserData' => ['description' => 'The custom settings in JSON format.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'SnapshotOutput' => [ - 'title' => '输出信息。', - 'description' => 'The output information.'."\n", - 'type' => 'object', + ], + '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' => [ - 'StorageType' => [ - 'title' => '存储类型，目前只支持oss。', - 'description' => 'The storage type. The value can only be oss.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'oss' => 'oss', - ], - 'example' => 'oss', - ], - 'Endpoint' => [ - 'title' => '输出终端，type=oss时返回OSS域名。', - 'description' => 'The output endpoint. If the storage type is set to oss, the Object Storage Service (OSS) domain name is returned.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai.aliyuncs.com', + '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' => '', ], - 'Bucket' => [ - 'title' => '输出终端的Bucket，type=oss时返回OSS Bucket。', - 'description' => 'The bucket of the output endpoint. If the storage type is set to oss, the OSS bucket is returned.'."\n", - 'type' => 'string', - 'example' => 'testbucket', + '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' => '', ], - ], - ], - 'OverwriteFormat' => [ - 'title' => '覆盖截图格式。', - 'description' => 'The naming format of the snapshot captured in overwrite mode.'."\n", - 'type' => 'string', - 'example' => 'snapshot/{JobId}.jpg', - ], - 'SequenceFormat' => [ - 'title' => '序列截图格式。', - 'description' => 'The naming format of the snapshot captured in time series mode.'."\n", - 'type' => 'string', - 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', - ], - 'TimeInterval' => [ - 'title' => '截图时间间隔。', - 'description' => 'The interval between two adjacent snapshots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CallbackUrl' => [ - 'title' => '截图回调地址。', - 'description' => 'The snapshot callback URL.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com/snapshot/callback', - ], - 'LastModified' => [ - 'title' => '最后修改时间。', - 'description' => 'The time when the file was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-02-02T22:22:22Z', - ], - 'CreateTime' => [ - 'title' => '创建时间。', - 'description' => 'The time when the file was created.'."\n", - 'type' => 'string', - 'example' => '2022-02-02T22:22:22Z', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], - ], - [ - [ - 'errorCode' => 'JobNotFound', - 'errorMessage' => 'No such job.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"JobName\\": \\"截图任务1\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"模板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', - ], - 'DeleteLiveSnapshotFiles' => [ - 'summary' => 'Deletes live stream snapshot files. You can choose to delete only the snapshot files or delete both the snapshot files and the original Object Storage Service (OSS) files.', - 'methods' => [ - 'post', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceP3TB74', - ], + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '截图任务ID。', - 'description' => 'The ID of the snapshot job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - ], - [ - 'name' => 'CreateTimestampList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '创建时间戳列表。', - 'description' => 'The list of timestamps when the jobs were created. The values are UNIX timestamps representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A maximum of 200 jobs can be deleted at a time.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1660638613798', - 'description' => '', - ], - 'required' => true, - 'maxItems' => 200, - ], - ], - [ - 'name' => 'DeleteOriginalFile', - 'in' => 'query', - 'schema' => [ - 'title' => '是否删除原始文件，默认是false。', - 'description' => 'Specifies whether to delete the original files at the same time. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", + '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' => '****2876-6263-4B75-8F2C-CD0F7FCF****', + 'example' => 'Finished', + 'title' => '', ], - 'DeleteFileResultList' => [ - 'title' => '删除结果列表。', - 'description' => 'The list of deleted files.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'title' => 'OK表示删除成功，其他表示删除失败。', - 'description' => 'The result of deletion. A value of OK indicates that the file is deleted. Other values indicate that the file failed to be deleted.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OK: The file was deleted.'."\n" - .'* NotFound: The file was not found.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'OK' => '', - 'NotFound' => '', - ], - 'example' => 'OK', + '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' => ''], ], - 'CreateTimestamp' => [ - 'title' => '创建时间戳。', - 'description' => 'The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1660638613798', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'OverlayNotSupported', - 'errorMessage' => 'Not Sopport to remove overlay snapshot, please remove overlay snapshot from OSS console.', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'BucketNotAuthorized', - 'errorMessage' => 'Bucket is not authorised.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + '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' => [ [ - [ - 'errorCode' => 'JobNotFound', - 'errorMessage' => 'No such job.', - ], - [ - 'errorCode' => 'NoValidSnapshot', - 'errorMessage' => 'No snapshots found with given parameters.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetSmartHandleJob', + '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"}]', - 'title' => 'DeleteLiveSnapshotFiles', + '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', ], - 'ListLiveSnapshotJobs' => [ - 'summary' => 'Queries a list of live stream snapshot jobs by page.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSnapshotJob' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice5MI8QL'], + ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。默认为7天前，StartTime与EndTime间隔不能超过30天。', - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'* The default value is seven days ago.'."\n" - .'* The time range specified by the StartTime and EndTime parameters cannot exceed 30 days.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-02T00:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。默认为StartTime+7天，StartTime与EndTime间隔不能超过30天。', - '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" - .'* By default, EndTime is seven days later than StartTime.'."\n" - .'* The time range specified by the StartTime and EndTime parameters cannot exceed 30 days.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-02T23:59:59Z', - ], - ], - [ - 'name' => 'SearchKeyWord', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索关键词，任务ID/名称，名称支持模糊搜索。', - '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.'."\n" - ."\n" - .'* It cannot exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '任务状态过滤，默认查询全部。'."\n" - .'init：未启动'."\n" - .'started：执行中'."\n" - .'paused：已停止', - 'description' => 'The job state filter. By default, all jobs are queried.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* init: The job is not started.'."\n" - .'* paused: The job is paused.'."\n" - .'* started: The job is in progress.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'init' => '', - 'paused' => '', - 'started' => '', - ], - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '页码，[1, n)，默认是1。', - 'description' => 'The page number. Valid values: \\[1,n). Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页宽，[1, 100]，默认是10。', - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SortBy', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '排序，默认按CreateTime排序，默认是desc。'."\n" - .'asc：升序'."\n" - .'desc：倒序', - '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 by creation time in ascending order.'."\n" - .'* desc: sorts the query results by creation time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', - ], - 'example' => 'desc', - ], + 'schema' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'required' => true, 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据。', - 'description' => 'The data returned.'."\n", + 'title' => '', + 'description' => 'PlainResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobList' => [ - 'title' => '任务列表。', - 'description' => 'The list of jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'title' => '任务ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - 'JobName' => [ - 'title' => '任务名称。', - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'TemplateId' => [ - 'title' => '模板ID。', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****a046-263c-3560-978a-fb287666****', - ], - 'TemplateName' => [ - 'title' => '模板名称。', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Status' => [ - 'title' => '任务状态。'."\n" - .'init：未启动'."\n" - .'started：执行中'."\n" - .'paused：已停止', - 'description' => 'The state of the job.'."\n" + '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" - .'Valid values:'."\n" + .'1. OSS: an Object Storage Service (OSS) object.'."\n" ."\n" - .'* init: The job is not started.'."\n" - .'* paused: The job is paused.'."\n" - .'* started: The job is in progress.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'init' => '', - 'paused' => '', - 'started' => '', + .'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' => '', ], - 'example' => 'started', ], - 'SnapshotOutput' => [ - 'title' => '输出信息。', - 'description' => 'The output information.'."\n", - 'type' => 'object', - 'properties' => [ - 'StorageType' => [ - 'title' => '存储类型，目前只支持oss。', - 'description' => 'The storage type. The value can only be oss.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Endpoint' => [ - 'title' => '输出终端，type=oss时返回OSS域名。', - 'description' => 'The output endpoint. If the storage type is set to oss, the Object Storage Service (OSS) domain name is returned.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai.aliyuncs.com', - ], - 'Bucket' => [ - 'title' => '输出终端的Bucket，type=oss时返回OSS Bucket。', - 'description' => 'The bucket of the output endpoint. If the storage type is set to oss, the OSS bucket is returned.'."\n", - 'type' => 'string', - 'example' => 'testbucket', + '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' => '', ], ], - 'TimeInterval' => [ - 'title' => '截图时间间隔。', - 'description' => 'The interval between two adjacent snapshots. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CreateTime' => [ - 'title' => '创建时间。', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-20T02:48:58Z', - ], + 'title' => '', + 'example' => '', ], - 'description' => '', + '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' => ''], ], - ], - 'PageNo' => [ - 'title' => '页码。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页宽。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SortBy' => [ - 'title' => '排序。', - 'description' => 'The sorting order of the jobs by creation time.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'TotalCount' => [ - 'title' => '总数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'MalformedStartTime', - 'errorMessage' => 'Specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'MalformedEndTime', - 'errorMessage' => 'Specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'EndTimeMismatch', - 'errorMessage' => 'Specified end time does not math the specified start time.', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + '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'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + '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 \\"JobList\\": [\\n {\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"JobName\\": \\"截图任务1\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"模板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', + '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', ], - 'ListLiveSnapshotFiles' => [ - 'summary' => 'Queries a list of live stream snapshot files by page.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSnapshotUrls' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37338,548 +22740,247 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'title' => '截图任务ID。', - 'description' => 'The ID of the snapshot job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****a046-263c-3560-978a-fb287782****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-02-02T00:00:00Z', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。EndTime和StartTime之间的间隔不能超过1天。', - '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-02-02T23:59:59Z', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Limit', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每次获取数量，[1, 100]，默认为10。', - 'description' => 'The number of results to return each time. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => 'SortBy', + 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'title' => '排序，默认为asc。'."\n" - .'asc：按时间升序'."\n" - .'desc：按时间倒序', - 'description' => 'The sorting order. Default value: asc.'."\n" + 'description' => 'The order that you use to sort the query results. Valid values: Asc and Desc.'."\n" ."\n" - .'Valid values:'."\n" + .'- Asc'."\n" ."\n" - .'* asc: sorts the query results by creation time in ascending order.'."\n" - .'* desc: sorts the query results by creation time in descending order.'."\n", + .'- Desc', + 'enumValueTitles' => ['Asc' => '', 'Desc' => ''], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', - ], - 'example' => 'desc', + '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' => [ - 'title' => '响应数据。', - 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'FileList' => [ - 'title' => '文件列表。', - 'description' => 'The list of files.'."\n", + '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' => [ - 'type' => 'object', - 'properties' => [ - 'OssEndpoint' => [ - 'title' => 'OSS域名。', - 'description' => 'The Object Storage Service (OSS) domain name.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-shanghai.aliyuncs.com', - ], - 'OssBucket' => [ - 'title' => 'OSS bucket。', - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'testbucket', - ], - 'OssObject' => [ - 'title' => 'OSS存储对象位置。', - 'description' => 'The location in which the OSS object is stored.'."\n", - 'type' => 'string', - 'example' => 'snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg', - ], - 'CreateTime' => [ - 'title' => '创建时间。', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-02-02T22:22:22Z', - ], - 'CreateTimestamp' => [ - 'title' => '创建时间戳，用于删除传参。', - 'description' => 'The creation timestamp that is used as an input parameter for a delete API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1619503516000', - ], - 'IsOverlay' => [ - 'title' => '是否覆盖截图。', - 'description' => 'Specifies whether to overlay snapshots.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - 'NextStartTime' => [ - 'title' => '下一页的开始时间，没有返回则表示结束翻页。', - 'description' => 'The start time of the next page. If no value is returned, the pagination ends.'."\n", - 'type' => 'string', - 'example' => '2022-02-02T22:22:22Z', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'MalformedStartTime', - 'errorMessage' => 'Specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'MalformedEndTime', - 'errorMessage' => 'Specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'EndTimeMismatch', - 'errorMessage' => 'Specified end time does not math the specified start time.', - ], - ], - 403 => [ - [ - 'errorCode' => 'UserDisable', - 'errorMessage' => 'User is disable.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'OperationDenied', - 'errorMessage' => 'Your account has not enabled the ICE service.', - ], + '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' => [ [ - [ - 'errorCode' => 'JobNotFound', - 'errorMessage' => 'No such job.', - ], - [ - 'errorCode' => 'NoValidSnapshot', - 'errorMessage' => 'No snapshots found with given parameters.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + '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 \\"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', + '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', ], - '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', - ], + 'GetSource' => [ + 'summary' => 'Queries a source.', + 'description' => ' ', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程标题', - 'description' => 'The title of the online editing project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程描述', - 'description' => 'The description of the online editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '描述', - ], - ], - [ - 'name' => 'Timeline', - 'in' => 'formData', - 'schema' => [ - 'title' => '云剪辑工程时间线，Json格式', - 'description' => 'The timeline of the online editing project, in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', - ], - ], - [ - 'name' => 'CoverURL', - 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程封面', - 'description' => 'The thumbnail URL of the online editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://example.com/example.png', - ], - ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****', - ], + 'schema' => ['description' => 'The source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ - 'name' => 'ClipsParam', + 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'title' => '模板素材参数', - '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', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The source type. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ - 'name' => 'TemplateType', + 'name' => 'SourceName', 'in' => 'query', + 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MyVodSource', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => '模板类型', - '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" - .'* VETemplate: an advanced template.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Timeline' => '', - 'VETemplate' => '', + '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' => 'Timeline', + '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' => [ [ - 'name' => 'MaterialMaps', - 'in' => 'query', - 'schema' => [ - 'title' => '工程关联素材，多个素材以逗号（,）分隔；每种类型最多支持10个素材ID', - 'description' => 'The material associated with the project. Separate multiple material IDs with commas (,). Each type supports up to 10 material IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\\"appName\\":\\"testrecord\\",\\"domainName\\":\\"test.alivecdn.com\\",\\"liveUrl\\":\\"rtmp://test.alivecdn.com/testrecord/teststream\\",\\"streamName\\":\\"teststream\\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"}', + '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' => [ [ - 'name' => 'BusinessConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '工程业务配置。如果是直播剪辑工程必填OutputMediaConfig.StorageLocation, Path 不填默认合成的直播片段存储在根路径下 OutputMediaTarget 不填默认oss-object，可以填vod-media 表示存储到vod OutputMediaTarget 为vod-media 时，Path不生效。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'ProjectType', + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '剪辑工程类型，EditingProject: 普通剪辑工程；LiveEditingProject: 直播剪辑工程', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LiveEditingProject', - ], + 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Project' => [ - 'description' => 'The information about the online editing project.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '****01bf24bf41c78b2754cb3187****', - ], - 'Title' => [ - 'title' => '云剪辑工程标题', - 'description' => 'The title of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'example_title', - ], - 'Description' => [ - 'title' => '云剪辑工程描述', - 'description' => 'The description of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'example_description', - ], - 'Timeline' => [ - 'title' => '云剪辑工程时间线，Json格式', - '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****"}]}]}', - ], - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****', - ], - 'ClipsParam' => [ - 'title' => '模板素材参数', - 'description' => 'The template material parameters.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CoverURL' => [ - 'title' => '云剪辑工程封面。', - 'description' => 'The thumbnail URL of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'Status' => [ - 'title' => '云剪辑工程状态。 所有云剪辑工程状态列表： -1:Draft -2:Editing -3:Producing -4:Produced -5:ProduceFailed -7:Deleted', - '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'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'StatusName' => [ - 'title' => '云剪辑状态名称，对应状态列表中状态名称。', - 'description' => 'The status of the online editing project. For more information, see the status list.'."\n", - 'type' => 'string', - 'example' => 'Editing', - ], - 'CreateTime' => [ - 'title' => '云剪辑工程创建时间', - 'description' => 'The time when the online editing project was created.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:07Z', - ], - 'ModifiedTime' => [ - 'title' => '云剪辑工程编辑时间', - 'description' => 'The time when the online editing project was last edited.'."\n", - 'type' => 'string', - 'example' => '2021-01-08T16:52:07Z', - ], - 'Duration' => [ - 'title' => '云剪辑工程时长', - 'description' => 'The duration of the online editing project.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '3.4200000', - ], - 'CreateSource' => [ - 'title' => '云剪辑工程创建方式 -OpenAPI -AliyunConsole -WebSDK -LiveEditingOpenAPI -LiveEditingConsole', - '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'."\n", - 'type' => 'string', - 'example' => 'WebSDK', - ], - 'ModifiedSource' => [ - 'title' => '云剪辑工程创建方式 -OpenAPI -AliyunConsole -WebSDK -LiveEditingOpenAPI -LiveEditingConsole', - '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'."\n", - 'type' => 'string', - 'example' => 'WebSDK', - ], - 'TemplateType' => [ - 'description' => 'The template type of the online editing project. Valid values:'."\n" - ."\n" - .'\\- Timeline'."\n" - ."\n" - .'\\- VETemplate'."\n", - 'type' => 'string', - 'example' => 'Timeline', - ], - 'BusinessConfig' => [ - 'title' => '工程业务配置', - 'description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.'."\n", - 'type' => 'string', - 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', - ], - 'ProjectType' => [ - 'title' => '剪辑工程类型，EditingProject: 普通剪辑工程；LiveEditingProject: 直播剪辑工程', - '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.'."\n", - 'type' => 'string', - 'example' => 'LiveEditingProject', - ], - 'BusinessStatus' => [ - 'title' => '业务状态，业务状态 /** 预约中 **/ RESERVING(0, "Reserving"), /** 预约取消 **/ RESERVATION_CANCELED(1, "ReservationCanceled"), /** 直播中 **/ BROADCASTING(3, "BroadCasting"), /** 加载失败 **/ LOADING_FAILED(4, "LoadingFailed"), /** 直播结束 **/ LIVE_FINISHED(5, "LiveFinished");', - 'description' => 'The business status of the project. This parameter can be ignored for general editing projects. Valid values:'."\n" - ."\n" - .'* Reserving'."\n" - .'* ReservationCanceled'."\n" - .'* BroadCasting'."\n" - .'* LoadingFailed'."\n" - .'* LiveFinished'."\n", - 'type' => 'string', - 'example' => 'Reserving', - ], - ], - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","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\\": \\"见模板使用文档\\",\\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}","errorExample":""},{"type":"xml","example":"\\n ******3B-0E1A-586A-AC29-742247******\\n \\n ****01bf24bf41c78b2754cb3187****\\n example_title\\n example_description\\n {\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"},{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"}]}]}\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n 2\\n Editing\\n 2021-01-08T16:52:07Z\\n 2021-01-08T16:52:07Z\\n 3.42\\n WebSDK\\n WebSDK\\n Timeline\\n \\n","errorExample":""}]', - 'title' => 'CreateEditingProject', - ], - 'GetEditingProject' => [ - 'summary' => 'Queries the information about an online editing project.', - 'methods' => [ - 'get', - 'post', + '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'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + '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' => [ [ - 'PrivateKey' => [], + 'AK' => [], ], ], 'operationType' => 'read', @@ -37887,1117 +22988,1795 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****fb2101bf24b2754cb318787dc****', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app-****', 'title' => ''], ], [ - 'name' => 'RequestSource', + 'name' => 'StorageType', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'WebSDK', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Project' => [ - 'description' => 'The information about the online editing project.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '****fb2101bf24b2754cb318787dc****', - ], - 'Title' => [ - 'title' => '云剪辑工程标题', - 'description' => 'The title of the online editing project.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Timeline' => [ - 'title' => '云剪辑工程时间线', - 'description' => 'The timeline of the online editing project.'."\n", - 'type' => 'string', - 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]}', - ], - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****', - ], - 'ClipsParam' => [ - 'title' => '模板素材参数', - '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' => '', - ], - 'Description' => [ - 'title' => '云剪辑工程描述', - 'description' => 'The description of the online editing project.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CoverURL' => [ - 'title' => '云剪辑工程封面', - 'description' => 'The thumbnail URL of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'oss://example-bucket/example.jpg', - ], - 'CreateTime' => [ - 'title' => '云剪辑工程创建时间', - 'description' => 'The time when the online editing project was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T12:00:00Z', - ], - 'ModifiedTime' => [ - 'title' => '云剪辑工程最新修改时间', - 'description' => 'The time when the online editing project was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T13:00:00Z', - ], - 'Duration' => [ - 'title' => '云剪辑工程总时长', - 'description' => 'The total duration of the online editing project.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24.120000', - ], - 'Status' => [ - 'title' => '云剪辑工程状态', - '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'."\n", - 'type' => 'string', - 'example' => 'Editing', - ], - 'CreateSource' => [ - 'title' => '云剪辑工程创建来源', - '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'."\n", - 'type' => 'string', - 'example' => 'OpenAPI', - ], - 'TemplateType' => [ - 'title' => '云剪辑工程模板类型', - 'description' => 'The template type of the online editing project. Valid values:'."\n" - ."\n" - .'\\- Timeline'."\n" - ."\n" - .'\\- VETemplate'."\n", - 'type' => 'string', - 'example' => 'Timeline', - ], - 'ModifiedSource' => [ - 'title' => '云剪辑工程修改来源', - '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'."\n", - 'type' => 'string', - '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.'."\n", - 'type' => 'string', - 'example' => 'EditingProject', - ], - 'BusinessConfig' => [ - 'description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.'."\n", - 'type' => 'string', - 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', - ], - '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'."\n", - 'type' => 'string', - 'example' => 'Reserving', - ], - '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'."\n", - 'type' => 'string', - 'example' => 'Converted', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'The StorageLocation must be in the same division(apiRegion) as ICE service access point.', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter \\ is not valid.', + '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' => '*'], + ], ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Project\\": {\\n \\"ProjectId\\": \\"****fb2101bf24b2754cb318787dc****\\",\\n \\"Title\\": \\"样本title\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****9b4d7cf14dc7b83b0e801cbe****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****9b4d7cf14dc7b83b0e801cbe****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****1656bca4474999c961a6d2a2****\\\\\\"}]}]}\\",\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"ClipsParam\\": \\"见模板使用文档\\",\\n \\"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}","errorExample":""},{"type":"xml","example":"\\n ****63E8B7C7-4812-46AD-0FA56029AC86****\\n \\n ****fb2101bf24b2754cb318787dc****\\n 样本title\\n {\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****9b4d7cf14dc7b83b0e801cbe****\\"},{\\"MediaId\\":\\"****9b4d7cf14dc7b83b0e801cbe****\\"},{\\"MediaId\\":\\"****1656bca4474999c961a6d2a2****\\"}]}]}\\n 示例描述\\n oss://example-bucket/example.jpg\\n 2020-12-20T12:00:00Z\\n 2020-12-20T13:00:00Z\\n 2\\n OpenAPI\\n Timeline\\n OpenAPI\\n \\n","errorExample":""}]', - 'title' => 'GetEditingProject', + 'translator' => 'manual', ], - 'UpdateEditingProject' => [ - 'summary' => 'Modifies an online editing project. You can call this operation to modify the configurations such as the title, timeline, and thumbnail of an online editing project.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetStreamTagList' => [ + 'summary' => 'Retrieves tags of a live stream media asset.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'PrivateKey' => [], - ], ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], 'parameters' => [ [ - 'name' => 'Title', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程标题', - 'description' => 'The title of the online editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testtimeline', - ], + 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Stream_xxx'], ], [ - 'name' => 'Description', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程描述', - 'description' => 'The description of the online editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testtimeline001desciption', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ - 'name' => 'Timeline', - 'in' => 'formData', - 'schema' => [ - 'title' => '云剪辑工程时间线，Json格式', - 'description' => 'The timeline of the online editing project, in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****cc3308ac500ca54328bc3443****"},{"MediaId":"****da87a9cff64*d88bc6d8326e4****"}]}]}', - ], + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '******b48fb04483915d4f2cd8******', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The template ID. This parameter is used to quickly build a timeline with ease. Note: Only one of ProjectId, Timeline, and TemplateId can be specified. If TemplateId is specified, ClipsParam must also be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****', - ], + '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' => 'ClipsParam', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '模板对应的素材参数', - 'description' => 'The material parameter corresponding to the template, in the JSON format. If TemplateId is specified, ClipsParam must also be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'CoverURL', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程封面', - 'description' => 'The thumbnail URL of the online editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://****.com/6AB4D0E1E1C7446888****.png', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****4ee4b97e27b525142a6b2****', - ], + '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' => 'BusinessStatus', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The business status of the project. This parameter can be ignored for general editing projects. Valid values:'."\n" - ."\n" - .'* Reserving'."\n" - .'* ReservationCanceled'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Reserving', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****25818875-5F78-4AF6-D7393642CA58****', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter \\ is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'ProjectNotFound', - 'errorMessage' => 'The specified project not found', + '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' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ****25818875-5F78-4AF6-D7393642CA58****\\n","errorExample":""}]', - 'title' => 'UpdateEditingProject', + 'translator' => 'manual', ], - 'DeleteEditingProjects' => [ - 'summary' => 'Deletes one or more online editing project.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSystemTemplate' => [ + 'summary' => 'Queries the information about a system template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProjectIds', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程ID。支持多个云剪辑工程，以逗号分隔。', - 'description' => 'The ID of the online editing project. You can specify multiple IDs separated with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****fb2101bf24bf41cb318787dc****,****87dcfb2101bf24bf41cb3187****', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'S00000001-100060'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****25818875-5F78-4AF6-D7393642CA58****', + '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' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"IgnoredList\\": \\"****fb2101bf24bf41cb318787dc****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ****25818875-5F78-4AF6-D7393642CA58****\\n ****fb2101bf24bf41cb318787dc****\\n","errorExample":""}]', - 'title' => 'DeleteEditingProjects', - ], - 'ListEditingProjects' => [ - 'summary' => 'Queries a list of projects that meet the specified conditions. You can filter projects by project creation time.', - 'methods' => [ - 'get', - 'post', + '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'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSystemTemplate'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + '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' => [ [ - 'PrivateKey' => [], + 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '182100', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProjectType', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the editing project. Valid values:'."\n" - ."\n" - .'* EditingProject: a regular editing project.'."\n" - .'* LiveEditingProject: a live stream editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'EditingProject', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], [ - 'name' => 'TemplateType', + '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' => [ - '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" - .'Valid values:'."\n" - ."\n" - .'* Timeline: a regular template.'."\n" - .'* VETemplate: an advanced template.'."\n" - .'* None: general editing.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Timeline' => '', - 'VETemplate' => '', - 'None' => '', + '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' => 'None', + 'example' => '', ], ], - [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-12-21T08:00:01Z', - ], + ], + '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' => [ [ - '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", - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-02T23:59:59Z', + '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' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword. You can search by job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******6f36bc45d09a9d5cde49******', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the online editing project. By default, online editing projects in all states are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Produced', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ - 'name' => 'CreateSource', + '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' => [ - 'description' => 'The method for creating the online editing project. Valid values:'."\n" - ."\n" - .'\\- OpenAPI'."\n" - ."\n" - .'\\- AliyunConsole'."\n" - ."\n" - .'\\- WebSDK'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI', + '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' => [ [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', + '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' => [ [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceDXIJ4D'], + ], + 'parameters' => [ [ - 'name' => 'SortBy', + 'name' => 'TemplateId', '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" - .'* CreationTime:Asc: sorts the results in chronological order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreationTime:Desc', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'NextToken' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Nzv3rcKla9wHUGua9YXHNA==', - ], - 'MaxResults' => [ - 'title' => 'MaxResults本次请求所返回的最大记录条数', - 'description' => 'The maximum number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ProjectList' => [ - 'description' => 'The queried online editing projects.'."\n", + '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' => [ - 'ProjectId' => [ - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '****fddd7748b58bf1d47e95****', - ], - 'Title' => [ - 'description' => 'The title of the online editing project.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => 'The description of the online editing project.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CoverURL' => [ - 'description' => 'The thumbnail URL of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'https://xxx.com/cover/xxx.jpg', - ], - 'CreateTime' => [ - 'description' => 'The time when the online editing project was created.'."\n", - 'type' => 'string', - 'example' => '2017-01-11T12:00:00Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the online editing project was last modified.'."\n", - 'type' => 'string', - 'example' => '2017-01-11T12:00:00Z', - ], - '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", - 'type' => 'string', - 'example' => 'Produced', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the production of the online editing project failed.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the production of the online editing project failed.'."\n", - 'type' => 'string', - 'example' => 'The specified parameter \\"LiveStreamConfig\\" is not valid. specified parameter example is not valid.', - ], - 'CreateSource' => [ - 'description' => 'The method for editing the online editing project. Valid values:'."\n" - ."\n" - .'\\- OpenAPI'."\n" + 'Key' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'video1', 'title' => ''], + 'Type' => [ + 'description' => 'The material type.'."\n" ."\n" - .'\\- AliyunConsole'."\n" + .'Valid values:'."\n" ."\n" - .'\\- WebSDK'."\n", - 'type' => 'string', - 'example' => 'OpenAPI', - ], - 'ModifiedSource' => [ - 'description' => 'The method for modifying the online editing project last time.'."\n", - 'type' => 'string', - 'example' => 'OpenAPI', - ], - 'TemplateType' => [ - 'description' => 'The template type. Valid values:'."\n" + .'- Video'."\n" ."\n" - .'* Timeline: a regular template.'."\n" - .'* VETemplate: an advanced template.'."\n", - 'type' => 'string', - 'example' => 'Timeline', - ], - 'ProjectType' => [ - 'description' => 'The type of the editing project. Valid values:'."\n" + .'- Text'."\n" ."\n" - .'* EditingProject: a regular editing project.'."\n" - .'* LiveEditingProject: a live stream editing project.'."\n", - 'type' => 'string', - 'example' => 'EditingProject', - ], - 'BusinessConfig' => [ - 'description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.'."\n", + .'- Image', + 'enumValueTitles' => ['Video' => '', 'Text' => '', 'Image' => ''], 'type' => 'string', - 'example' => '{}', - ], - 'BusinessStatus' => [ - 'description' => 'The business status of the project. This parameter can be ignored for general editing projects.'."\n", - 'type' => 'string', - 'example' => '{}', - ], + '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' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain template parameter information', + 'changeSet' => [ + ['createdAt' => '2025-12-04T16:20:10.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"NextToken\\": \\"Nzv3rcKla9wHUGua9YXHNA==\\",\\n \\"MaxResults\\": 10,\\n \\"ProjectList\\": [\\n {\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"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"}]', - 'title' => 'ListEditingProjects', - ], - 'AddEditingProjectMaterials' => [ - 'summary' => 'Adds one or more materials to an online editing project.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplateParams'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], ], - [ - 'PrivateKey' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*****b2101cb318c*****', - ], - ], - [ - 'name' => 'MaterialMaps', + 'name' => 'ParentJobId', 'in' => 'query', - 'schema' => [ - 'title' => '素材ID', - '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" - .'* audio'."\n" - .'* image'."\n" - .'* liveStream'."\n" - .'* editingProject'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\\"appName\\":\\"testrecord\\",\\"domainName\\":\\"test.alivecdn.com\\",\\"liveUrl\\":\\"rtmp://test.alivecdn.com/testrecord/teststream\\",\\"streamName\\":\\"teststream\\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"}', - ], + 'schema' => ['description' => 'Job ID', 'type' => 'string', 'docRequired' => true, 'example' => 'ab4802364a2e49208c99efab82dfa8e8', 'title' => '', 'required' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'ProjectId' => [ - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '*****67ae06542b9b93e0d1c387*****', - ], - 'MediaInfos' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that meet the specified conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '*****5cb2e35433198daae94a72*****', + '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' => '', ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'The basic information of the media assets.'."\n", + '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' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '*****5cb2e35433198daae94a72*****', - ], - 'InputURL' => [ - 'title' => '待注册的媒资在相应系统中的地址', - 'description' => 'The URL of the media asset in another service.'."\n", - 'type' => 'string', - 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Video', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'Source' => [ - 'title' => '来源', - 'description' => 'The source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => 'The title of the media asset.'."\n", - 'type' => 'string', - 'example' => 'default_title_2020-12-23T03:32:59Z', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => 'The description of the media asset.'."\n", - 'type' => 'string', - 'example' => 'sample_description', - ], - 'Category' => [ - 'title' => '分类', - 'description' => 'The category of the media asset.'."\n", - 'type' => 'string', - 'example' => 'audio', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => 'The tags of the media asset.'."\n", - 'type' => 'string', - 'example' => 'sample_tag', - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => 'The thumbnail URL of the media asset.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'userData', - ], - 'Snapshots' => [ - 'title' => '截图', - 'description' => 'The snapshots of the media asset.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Status' => [ - 'title' => '资源状态', - 'description' => 'The status of the media asset. Valid values:'."\n" - ."\n" - .'\\- Init'."\n" - ."\n" - .'\\- Preparing'."\n" - ."\n" - .'\\- PrepareFail'."\n" - ."\n" - .'\\- Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TranscodeStatus' => [ - 'title' => '转码状态', - 'description' => 'The transcoding status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Init', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T03:32:59Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => 'The time when the media asset was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T03:32:59Z', - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => 'The time when the media asset was deleted.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T03:32:59Z', - ], - 'SpriteImages' => [ - 'title' => '雪碧图', - 'description' => 'The sprite of the media asset.'."\n", - 'type' => 'string', - 'example' => 'http://outin-example.oss-cn-shanghai.aliyuncs.com/test.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], + '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' => '', ], - 'FileInfoList' => [ - 'title' => 'FileInfos', - 'description' => 'FileInfos'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '文件基础信息，包含时长，大小等', - 'description' => 'The basic information of the file, including the duration and size.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'example.mp4', - ], - 'FileStatus' => [ - 'title' => '文件状态', - 'description' => 'The file status.'."\n" - ."\n" - .'\\-Uploading'."\n" - ."\n" - .'\\-Normal'."\n" - ."\n" - .'\\-UploadFail'."\n" - ."\n" - .'\\-Disable'."\n" - ."\n" - .'\\-Deleted'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小（字节）', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '30611502', - ], - 'FileUrl' => [ - 'title' => '文件oss地址', - 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'Region' => [ - 'title' => '文件存储区域', - 'description' => 'The region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', + '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' => '', + ], ], - 'FormatName' => [ - 'title' => '封装格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + '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' => '', ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '216.206667', + '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' => '', ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '1132.68', + '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' => '', ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '960', + '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' => ''], ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '540', + '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' => '', ], - 'description' => '', ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'description' => '', - ], - ], - 'LiveMaterials' => [ - 'description' => 'The materials associated with the live stream.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => 'The application name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'testrecord', - ], - 'StreamName' => [ - 'description' => 'The name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'teststream', - ], - 'DomainName' => [ - 'description' => 'The domain name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'test.alivecdn.com', - ], - 'LiveUrl' => [ - 'description' => 'The URL of the live stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://test.alivecdn.com/testrecord/teststream', + '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' => '', ], - 'description' => '', - ], - ], - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the regular editing project associated with the live stream editing project.'."\n", - 'type' => 'string', - 'example' => '*****c38767ae06542b9b93e0d1*****', ], - 'example' => '*****9b145c5cafc2e057304fcd*****', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter \\ is not valid.', - ], + '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'], ], - 404 => [ - [ - 'errorCode' => 'ProjectNotFound', - 'errorMessage' => 'The specified project not found', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n *****ACB-44F2-5F2D-88D7-1283E70*****\\n *****67ae06542b9b93e0d1c387*****\\n \\n *****5cb2e35433198daae94a72*****\\n \\n *****5cb2e35433198daae94a72*****\\n http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4\\n Video\\n general\\n oss\\n default_title_2020-12-23T03:32:59Z\\n sample_description\\n audio\\n sample_tag\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n userData\\n null\\n Normal\\n Init\\n 2020-12-23T03:32:59Z\\n 2020-12-23T03:32:59Z\\n 2020-12-23T03:32:59Z\\n http://outin-example.oss-cn-shanghai.aliyuncs.com/test.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n \\n \\n \\n example.mp4\\n Normal\\n source_file\\n 30611502\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n cn-shanghai\\n mov,mp4,m4a,3gp,3g2,mj2\\n 216.206667\\n 1132.68\\n 960\\n 540\\n \\n \\n \\n \\n testrecord\\n teststream\\n test.alivecdn.com\\n rtmp://test.alivecdn.com/testrecord/teststream\\n \\n *****c38767ae06542b9b93e0d1*****\\n","errorExample":""}]', - 'title' => 'AddEditingProjectMaterials', + 'translator' => 'manual', ], - 'GetEditingProjectMaterials' => [ - 'summary' => 'Queries all materials associated with an online editing project.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetUrlUploadInfos' => [ + 'summary' => 'Queries the information about URL-based upload jobs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'PrivateKey' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, @@ -39005,647 +24784,540 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'JobIds', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*****fb2101cb318*****', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******89-C21D-4B78-AE24-3788B8******', - ], - 'ProjectId' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'string', - 'example' => '*****67ae06542b9b93e0d1c387*****', - ], - 'MediaInfos' => [ - 'title' => '符合要求的媒资集合', - 'description' => 'The media assets that meet the specified conditions.'."\n", + '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' => [ - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '*****64623a94eca8516569c8fe*****', - ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'The basic information of the media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '*****64623a94eca8516569c8f*****', - ], - 'InputURL' => [ - 'title' => '待注册的媒资在相应系统中的地址', - 'description' => 'The URL of the media asset in another service.'."\n", - 'type' => 'string', - 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => 'The type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => 'The business type of the media asset.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'Source' => [ - 'title' => '来源', - 'description' => 'The source of the media asset.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => 'The title of the media asset.'."\n", - 'type' => 'string', - 'example' => 'file.mp4', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => 'The description of the media asset.'."\n", - 'type' => 'string', - 'example' => 'sample_description', - ], - 'Category' => [ - 'title' => '分类', - 'description' => 'The category of the media asset.'."\n", - 'type' => 'string', - 'example' => 'video', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => 'The tags of the media asset.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => 'The thumbnail URL of the media asset.'."\n", - 'type' => 'string', - 'example' => 'http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => 'userData', - ], - 'Snapshots' => [ - 'title' => '截图', - 'description' => 'The snapshots of the media asset.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Status' => [ - 'title' => '资源状态', - 'description' => 'The status of the media asset.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TranscodeStatus' => [ - 'title' => '转码状态', - 'description' => 'The transcoding status of the media asset.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TranscodeSuccess: transcoding completed.'."\n" - .'* TranscodeFailed: transcoding failed.'."\n" - .'* Init: initializing.'."\n" - .'* Transcoding: transcoding in progress.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TranscodeSuccess' => '', - 'TranscodeFailed' => '', - 'Init' => '', - 'Transcoding' => '', - ], - 'example' => 'Init', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => 'The time when the media asset was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:08Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => 'The time when the media asset was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:08Z', - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => 'The time when the media asset was deleted.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:08Z', - ], - 'SpriteImages' => [ - 'title' => '雪碧图', - 'description' => 'The sprite of the media asset'."\n", - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - 'FileInfoList' => [ - 'title' => 'FileInfos', - 'description' => 'The information about the file.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileBasicInfo' => [ - 'title' => '文件基础信息，包含时长，大小等', - 'description' => 'The basic information of the file, such as the duration and size.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'example.mp4', - ], - 'FileStatus' => [ - 'title' => '文件状态', - 'description' => 'The file status.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'FileType' => [ - 'title' => '文件类型', - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'source_file', - ], - 'FileSize' => [ - 'title' => '文件大小（字节）', - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '30611502', - ], - 'FileUrl' => [ - 'title' => '文件oss地址', - 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'Region' => [ - 'title' => '文件存储区域', - 'description' => 'The region in which the file resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'FormatName' => [ - 'title' => '封装格式', - 'description' => 'The container format.'."\n", - 'type' => 'string', - 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', - ], - 'Duration' => [ - 'title' => '时长', - 'description' => 'The duration.'."\n", - 'type' => 'string', - 'example' => '216.206667', - ], - 'Bitrate' => [ - 'title' => '码率', - 'description' => 'The bitrate.'."\n", - 'type' => 'string', - 'example' => '1132.68', - ], - 'Width' => [ - 'title' => '宽', - 'description' => 'The width.'."\n", - 'type' => 'string', - 'example' => '960', - ], - 'Height' => [ - 'title' => '高', - 'description' => 'The height.'."\n", - 'type' => 'string', - 'example' => '540', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], + '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' => '', ], - 'LiveMaterials' => [ - 'description' => 'The materials associated with the live stream.'."\n", + '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' => [ - 'AppName' => [ - 'description' => 'The application name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'testrecord', - ], - 'StreamName' => [ - 'description' => 'The name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'testrecord', - ], - 'DomainName' => [ - 'description' => 'The domain name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'test.alivecdn.com', - ], - 'LiveUrl' => [ - 'description' => 'The URL of the live stream.'."\n", - 'type' => 'string', - 'example' => 'rtmp://test.alivecdn.com/testrecord/teststream', - ], + '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' => ''], ], - 'description' => '', - ], - ], - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the regular editing project associated with the live stream editing project.'."\n", - 'type' => 'string', - 'example' => '*****c38767ae06542b9b93e0d1*****', + 'title' => '', + 'example' => '', ], - 'example' => '*****9b145c5cafc2e057304fcd*****', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter \\ is not valid.', - ], + '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'], ], - 404 => [ - [ - 'errorCode' => 'ProjectNotFound', - 'errorMessage' => 'The specified project not found', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetUrlUploadInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ******89-C21D-4B78-AE24-3788B8******\\n *****67ae06542b9b93e0d1c387*****\\n \\n *****64623a94eca8516569c8fe*****\\n \\n *****64623a94eca8516569c8f*****\\n http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4\\n video\\n general\\n oss\\n file.mp4\\n sample_description\\n video\\n 标签,tag1\\n http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature\\n userData\\n null\\n Normal\\n Init\\n 2020-12-26T04:11:08Z\\n 2020-12-26T04:11:08Z\\n 2020-12-26T04:11:08Z\\n null\\n \\n \\n \\n example.mp4\\n Normal\\n source_file\\n 30611502\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n cn-shanghai\\n mov,mp4,m4a,3gp,3g2,mj2\\n 216.206667\\n 1132.68\\n 960\\n 540\\n \\n \\n \\n \\n testrecord\\n testrecord\\n test.alivecdn.com\\n rtmp://test.alivecdn.com/testrecord/teststream\\n \\n *****c38767ae06542b9b93e0d1*****\\n","errorExample":""}]', - 'title' => 'GetEditingProjectMaterials', + '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', ], - 'DeleteEditingProjectMaterials' => [ - 'summary' => 'Deletes one or more materials from an online editing project.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetVideoList' => [ + 'summary' => 'Gets information about video and audio files.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AK' => [], + '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'], ], [ - 'PrivateKey' => [], + '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'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*****fb2101cb318*****', - ], + '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' => 'MaterialIds', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '素材ID', - 'description' => 'The material ID. Separate multiple material IDs with commas (,). You can specify up to 10 IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*****cbd721b418a89a7dafb1dc*****,*****86f5d534c95997c55c96f*****', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'MaterialType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '素材类型', - 'description' => 'The material type. Valid values:'."\n" - ."\n" - .'\\- video'."\n" - ."\n" - .'\\- image'."\n" - ."\n" - .'\\- audio'."\n" - ."\n" - .'\\- subtitle'."\n" - ."\n" - .'\\- text'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'video', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******36-3C1E-4417-BDB2-1E034F******', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter \\ is not valid.', - ], + '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'], ], - 404 => [ - [ - 'errorCode' => 'ProjectNotFound', - 'errorMessage' => 'The specified project not found', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetVideoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******36-3C1E-4417-BDB2-1E034F******\\n","errorExample":""}]', - 'title' => 'DeleteEditingProjectMaterials', + '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', - ], + 'GetVodPackagingAsset' => [ + 'summary' => 'Queries a VOD packaging asset.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice20UKYV'], + ], 'parameters' => [ [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application name of the live stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testrecord', - ], - ], - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name of the live stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test.alivecdn.com', - ], - ], - [ - 'name' => 'StreamName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the live stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'teststream', - ], - ], - [ - 'name' => 'ProjectId', + 'name' => 'AssetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the live stream editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*****cb6307a4edea614d8b3f3c*****', - ], + 'schema' => ['description' => 'The name of the VOD packaging asset.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '30min_movie'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The result of asset query.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', - ], - 'IndexFile' => [ - 'description' => 'The URL of the index file.'."\n", - 'type' => 'string', + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"IndexFile\\": \\"https://bucket.oss-cn-shanghai.aliyuncs.com/test/live1.m3u8?<鉴权>&x-oss-process=hls/sign\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4E84BE44-58A7-****-****-FBEBEA16EF94\\n https://bucket.oss-cn-shanghai.aliyuncs.com/test/live1.m3u8?<鉴权>&x-oss-process=hls/sign\\n","errorExample":""}]', - 'title' => 'GetLiveEditingIndexFile', - ], - 'SubmitProjectExportJob' => [ - 'summary' => 'Submits a project export task.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'ConfigurationName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the online editing project.'."\n" - .'>Either ProjectId or Timeline must be provided.>', - 'type' => 'string', - 'required' => false, - 'example' => '*****67ae06542b9b93e0d1c387*****', - ], + 'schema' => ['description' => 'The name of the packaging configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'hls_3s'], ], - [ - 'name' => 'Timeline', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The timeline of the online editing job. For data structure, see [Timeline](~~198823~~).'."\n" - .'>Either ProjectId or Timeline must be provided.>', - 'type' => 'string', - 'required' => false, - 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + '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' => [ [ - 'name' => 'ExportType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The export type. Valid values:'."\n" - ."\n" - .'* **BaseTimeline**: exports the timeline.'."\n" - .'* **AdobePremierePro**: exports an Adobe Premiere Pro project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BaseTimeline', + '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' => [ [ - 'name' => 'OutputMediaConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The output path for the exported project and generated intermediate files, in JSON format. The export destination only supports OSS. Path fields:'."\n" - ."\n" - .'* **Bucket**: Required. The OSS bucket name.'."\n" - .'* **Prefix**: Optional. The path prefix. If not specified, it defaults to the root directory.'."\n" - .'* **Width**: Optional. The width of the output. The value must be a positive integer. If not provided, the system automatically calculates the value based on the input project or timeline.'."\n" - .'* **Height**: Optional. The height of the output. The value must be a positive integer. If not provided, the system automatically calculates the value based on the input project or timeline.', - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "Bucket": "example-bucket",'."\n" - .' "Prefix": "example_prefix",'."\n" - .' "Width": 1920,'."\n" - .' "Height": 1080'."\n" - .'}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice20UKYV'], + ], + 'parameters' => [ [ - 'name' => 'UserData', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}'."\n", - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The query result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'title' => '合成作业Id', - 'description' => 'The ID of the project export task.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], + '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\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\"\\n}","type":"json"}]', - 'title' => 'SubmitProjectExportJob', - ], - 'GetProjectExportJob' => [ - 'summary' => 'Queries the information of a project export task.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -39654,428 +25326,695 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the project export task.', - 'type' => 'string', - 'required' => true, - 'example' => '****cdb3e74639973036bc84****', - ], + 'schema' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'required' => false, 'example' => '******4215e042b3966ca5441e******', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', - ], - 'ProjectExportJob' => [ - 'description' => 'The project export task.'."\n", + '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' => [ - 'JobId' => [ - 'description' => 'The ID of the project export task.', - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****'."\n", - ], - 'ProjectId' => [ - 'description' => 'The ID of the online editing project.', - 'type' => 'string', - 'example' => '****fddd7748b58bf1d47e95****'."\n", - ], - 'ExportType' => [ - 'description' => 'The export type. Valid values:'."\n" - ."\n" - .'* **BaseTimeline**: exports the timeline.'."\n" - .'* **AdobePremierePro**: exports an Adobe Premiere Pro project.'."\n", - 'type' => 'string', - 'example' => 'BaseTimeline', - ], + 'TaskId' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'example' => '******4215e042b3966ca5441e******', 'title' => ''], 'Status' => [ - 'description' => 'The status of the project export task. Valid values:'."\n" + 'description' => 'The task state.'."\n" ."\n" - .'- Init: Initializing'."\n" - .'- Processing'."\n" - .'- Success'."\n" - .'- Failed', - 'type' => 'string', - 'example' => 'Success', - ], - 'Code' => [ - 'description' => 'The error code for the failed export task.'."\n" - .'>Use the error code for troubleshooting.>', - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'Message' => [ - 'description' => 'The error message for the failed export task.'."\n" - .'>Use the error message for troubleshooting.>', + .'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' => 'The specified parameter is not valid.', - ], - 'ExportResult' => [ - 'description' => 'The exported data.'."\n", + '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' => [ - 'Timeline' => [ - 'description' => 'The timeline of the online editing job. This field is returned when ExportType is BaseTimeline. For data structure, see [Timeline](~~198823~~).'."\n", + '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' => '{"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}]}]}', + 'example' => 'Active', + 'title' => '', ], - 'ProjectUrl' => [ - 'description' => 'The URL of the exported project, which is typically a signed OSS URL. This field is returned when ExportType is AdobePremierePro.'."\n", + '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' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example_prefix/exported_project_1e8c39a502c3436c84f88290cd713bf3.zip?Expires=1750331685&....', + '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' => '', ], - 'UserData' => [ - 'description' => 'The user-defined data in the JSON format.', - 'type' => 'string', - 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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 },\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\",\\\\\\"Key\\\\\\":\\\\\\"Valuexxx\\\\\\"}\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetProjectExportJob', - ], - 'SubmitMediaProducingJob' => [ - 'summary' => 'Submits a media editing and production job. If you need to perform any form of post-production such as editing and production on video or audio materials, you can call this operation to automate the process.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], + ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the editing project.'."\n" - ."\n" - .'> : You must specify one of ProgectId, Timeline, and TempalteId and leave the other two parameters empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxfb2101cb318xxxxx', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], - [ - 'name' => 'Timeline', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The timeline of the online editing job. For more information about the parameters, see [Timeline configurations](~~198823~~).'."\n" - ."\n" - .'> : You must specify one of ProgectId, Timeline, and TempalteId and leave the other two parameters empty.', - 'type' => 'string', - 'required' => false, - 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + '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' => [ [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The template ID. The template is used to build a timeline with ease.'."\n" - ."\n" - .'> : You must specify one of ProgectId, Timeline, and TempalteId and leave the other two parameters empty. If TemplateId is specified, ClipsParam must also be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****96e8864746a0b6f3****', + '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' => [ [ - 'name' => 'ClipsParam', - 'in' => 'query', - 'schema' => [ - 'description' => 'The material parameters of 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](~~445399~~) and [Create and use advanced templates](~~445389~~).', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '6890', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], + ], + 'parameters' => [ [ - 'name' => 'ProjectMetadata', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata of the editing project, in the JSON format. For more information about the parameters, see [ProjectMetadata](~~357745~~).', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The media asset ID.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], - [ - 'name' => 'OutputMediaTarget', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'* oss-object: OSS object in an OSS bucket.'."\n" - .'* vod-media: media asset in ApsaraVideo VOD.'."\n" - .'* S3: output file based on the Amazon Simple Storage Service (S3) protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss-object', + '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' => [ [ - 'name' => 'OutputMediaConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configurations of the output file, in the JSON format. You can specify an OSS URL or a storage location in a storage bucket of ApsaraVideo VOD.'."\n" - ."\n" - .'To store the output file in OSS, you must specify MediaURL. To store the output file in ApsaraVideo VOD, you must specify StorageLocation and FileName.'."\n" - ."\n" - .'For more information, see [OutputMediaConfig](~~357745~~).', - 'type' => 'string', - 'required' => true, - 'example' => '{"MediaURL":"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4"}', + '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' => [ [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - '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~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"NotifyAddress":"https://xx.com/xx","RegisterMediaNotifyAddress":"https://xxx.com/xx"}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], + ], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'JobId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The storyboard job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****', + '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' => [ [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source of the editing and production request. Valid values:'."\n" - ."\n" - .'* OpenAPI'."\n" - .'* AliyunConsole'."\n" - .'* WebSDK'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OPENAPI', + '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' => [ [ - 'name' => 'EditingProduceConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters for editing and production. For more information, see [EditingProduceConfig](~~357745~~).'."\n" - ."\n" - .'> If no thumbnail is specified in EditingProduceConfig, the first frame of the video is used as the thumbnail.'."\n" - ."\n" - .'* AutoRegisterInputVodMedia: specifies whether to automatically register the ApsaraVideo VOD media assets in your timeline with IMS. Default value: true.'."\n" - .'* OutputWebmTransparentChannel: specifies whether the output video contains alpha channels. Default value: false.'."\n" - .'* CoverConfig: the custom thumbnail parameters.'."\n" - .'*', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "AutoRegisterInputVodMedia": "true",'."\n" - .' "OutputWebmTransparentChannel": "true"'."\n" - .'}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], + ], + 'parameters' => [ [ - 'name' => 'MediaMetadata', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata of the produced video, in the JSON format. For more information about the parameters, see [MediaMetadata](~~357745~~).', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "Title":"test-title",'."\n" - .' "Tags":"test-tags1,tags2"'."\n" - .'}', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'ProjectId' => [ - 'title' => '剪辑工程Id', - 'description' => 'The ID of the editing project.'."\n", - 'type' => 'string', - 'example' => '****b4549d46c88681030f6e****', - ], - 'JobId' => [ - 'title' => '合成作业Id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'MediaId' => [ - 'title' => '合成ICE媒资Id', - 'description' => 'The media asset ID of the output file.'."\n", - 'type' => 'string', - 'example' => '****c469e944b5a856828dc2****', - ], - 'VodMediaId' => [ - 'title' => 'vod媒资id', - 'description' => 'The media asset ID of the output file in ApsaraVideo VOD if the output file is stored in ApsaraVideo VOD.'."\n", - 'type' => 'string', - 'example' => '****d8s4h75ci975745c14b****', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter \\ is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'ProjectNotFound', - 'errorMessage' => 'The specified project not found', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"ProjectId\\": \\"****b4549d46c88681030f6e****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"VodMediaId\\": \\"****d8s4h75ci975745c14b****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ****36-3C1E-4417-BDB2-1E034F****\\n ****b4549d46c88681030f6e****\\n ****d80e4e4044975745c14b****\\n ****c469e944b5a856828dc2****\\n","errorExample":""}]', - 'title' => 'SubmitMediaProducingJob', - 'description' => '* This operation returns only the submission result of a media editing and production job. When the submission result is returned, the job may still be in progress. After a media editing and production job is submitted, the job is queued in the background for asynchronous processing.'."\n" - .'* The materials referenced in the timeline of an online editing project can be media assets in the media asset library or Object Storage Service (OSS) objects. External URLs or Alibaba Cloud Content Delivery Network (CDN) URLs are not supported. To use an OSS object as a material, you must set MediaUrl to an OSS URL, such as https://your-bucket.oss-region-name.aliyuncs.com/your-object.ext.'."\n" - .'* After the production is complete, the output file is automatically registered as a media asset. The media asset first needs to be analyzed. After the media asset is analyzed, you can query the duration and resolution information based on the media asset ID.'."\n" - ."\n" - .'## [](#)Limits'."\n" - ."\n" - .'* The throttling threshold of this operation is 30 queries per second (QPS).'."\n" - ."\n" - .' **'."\n" - ."\n" - .' **Note** If the threshold is exceeded, a "Throttling.User" error is returned when you submit an editing job. For more information about how to resolve this issue, see the [FAQ](~~453484~~).'."\n" - ."\n" - .'* You can create up to 100 video tracks, 100 image tracks, and 100 subtitle tracks in a project.'."\n" - ."\n" - .'* The total size of material files cannot exceed 1 TB.'."\n" - ."\n" - .'* The OSS buckets in which the materials reside and where the output media assets are stored must be in the same region as the region in which Intelligent Media Services (IMS) is activated.'."\n" - ."\n" - .'* An output video must meet the following requirements:'."\n" - ."\n" - .' * Both the width and height must be at least 128 pixels.'."\n" - .' * Both the width and height cannot exceed 4,096 pixels.'."\n" - .' * The shorter side of the video cannot exceed 2,160 pixels.'."\n", - 'requestParamsDescription' => '## **Sample OutputMediaConfig parameter configurations**.'."\n" - ."\n" - .'**Example: Store the output file in OSS**'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "MediaURL":"https://my-test-bucket.oss-cn-shanghai.aliyuncs.com/test/xxxxxtest001xxxxx.mp4",'."\n" - .' "Bitrate": 2000, '."\n" - .' "Width": 800, '."\n" - .' "Height": 680'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'To store the output file in OSS, you must specify MediaURL. The default value of OutputMediaTarget is oss-object, which specifies to store the output file in OSS. Other parameters are optional. Bitrate specifies the bitrate of the output file. Generally, the higher the bitrate, the clearer the video. The maximum value is 5000. Width and Height specify the resolution of the output file.'."\n" - ."\n" - .'Specify the OSS URL in the following format: https://bucketname.oss-region-name.aliyuncs.com/xxx/yyy.ext.'."\n" - ."\n" - .'bucketname: the name of the OSS bucket.'."\n" - ."\n" - .'region-name.aliyuncs.com: the public endpoint of OSS. For example, the endpoints of the China (Shanghai), China (Beijing), and China (Hangzhou) regions are:'."\n" - ."\n" - .'```'."\n" - .'oss-cn-shanghai.aliyuncs.com'."\n" - .'oss-cn-hangzhou.aliyuncs.com '."\n" - .'oss-cn-beijing.aliyuncs.com'."\n" - .'```'."\n" - ."\n" - .'**Example: Store the output file in ApsaraVideo VOD**'."\n" - ."\n" - .'```'."\n" - .'{ '."\n" - .' "StorageLocation": "outin-*xxxxxx7d2a3811eb83da00163exxxxxx.oss-cn-shanghai.aliyuncs.com", '."\n" - .' "FileName": "output.mp4", '."\n" - .' "Bitrate": 2000, '."\n" - .' "Width": 800, '."\n" - .' "Height": 680'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'To store the output file in ApsaraVideo VOD, you must specify StorageLocation and FileName. Set OutputMediaTarget to vod-media, which specifies to store the output file in a storage bucket of ApsaraVideo VOD. The storage locations that can be used in ApsaraVideo VOD can be found in the storage addresses for media assets after media assets are uploaded to ApsaraVideo VOD.'."\n" - ."\n" - .'**Parameters in OutputMediaConfig**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|:---|:---|:---|'."\n" - .'|MediaURL|String|The URL of the output file. If OutputMediaTarget is set to oss-object, specify the HTTP URL of the OSS object, such as http://xxx-bucket-name.oss-cn-shanghai.aliyuncs.com/OSS. The region is the same as the region in which the operation is called.|'."\n" - .'|StorageLocation|String|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.|'."\n" - .'|FileName|String|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.|'."\n" - .'|Width|Integer|The width of the output file. You can leave this parameter empty. The default value is the maximum width of the input materials.|'."\n" - .'|Height|Integer|The height of the output file. You can leave this parameter empty. The default value is the maximum height of the input materials.|'."\n" - .'|Bitrate|Integer|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.|'."\n" - .'|VodTemplateGroupId|String|The ID of the VOD transcoding template group. If VOD transcoding is not required, set the value to VOD\\_NO\\_TRANSCODE.|', + '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', ], - 'GetMediaProducingJob' => [ - 'summary' => 'Queries the information about a media editing and production job. The requested information includes the state, timeline, template, and data of the job. You can call this operation to query only media editing and production jobs created within the past year.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetYikeUserCredit' => [ + 'summary' => 'Retrieves the credit balance for a Yike user.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -40087,1404 +26026,1279 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'YikeUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media editing and production job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****cdb3e74639973036bc84****', - ], + 'schema' => ['description' => 'The user ID of the Yike sub-account.', 'type' => 'string', 'required' => true, 'example' => 'id', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****83B7-7F87-4792-BFE9-63CD2137****', - ], - 'MediaProducingJob' => [ - 'description' => 'The information about the online editing project.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the media editing and production job.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], - 'ProjectId' => [ - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '****fddd7748b58bf1d47e95****', - ], - 'MediaId' => [ - 'description' => 'The media asset ID of the output file.'."\n", - 'type' => 'string', - 'example' => '****0cc6ba49eab379332c5b****', - ], - 'MediaURL' => [ - 'description' => 'The URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4', - ], - 'Timeline' => [ - 'description' => 'The timeline of the media editing and production job.'."\n", - 'type' => 'string', - 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', - ], - 'TemplateId' => [ - 'description' => 'The ID of the template used by the media editing and production job.'."\n", - 'type' => 'string', - 'example' => '****6e76134d739cc3e85d3e****', - ], - 'ClipsParam' => [ - 'description' => 'The template parameters of the media editing and production job.'."\n", - 'type' => 'string', - 'example' => '{"VideoArray":["****05512043f49f697f7425****","****05512043f49f697f7425****","****05512043f49f697f7425****"]}', - ], - 'Duration' => [ - 'description' => 'The duration of the output file.'."\n" - ."\n" - .'Note: This parameter has a value if the job is successful and the output file is an audio or video file.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '30.500000', - ], - 'CreateTime' => [ - 'description' => 'The time when the media editing and production 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.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T13:33:40Z', - ], - 'CompleteTime' => [ - 'description' => 'The time when the media editing and production 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.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T13:33:52Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the media editing and production 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.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T13:33:49Z', - ], - 'Status' => [ - 'description' => 'The state of the media editing and production job. Valid values:'."\n" - ."\n" - .'Init'."\n" - ."\n" - .'Queuing'."\n" - ."\n" - .'Processing'."\n" - ."\n" - .'Success'."\n" - ."\n" - .'Failed'."\n", - 'type' => 'string', - 'example' => 'Failed', - ], - 'Code' => [ - 'description' => 'The response code'."\n" - ."\n" - .'Note: Pay attention to this parameter if the job failed.'."\n", - 'type' => 'string', - 'example' => 'ExceededMaximumValue', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'Note: Pay attention to this parameter if the job failed.'."\n", - 'type' => 'string', - 'example' => 'The specified "Width_Height" has exceeded maximum value.', - ], - 'VodMediaId' => [ - 'description' => 'The media asset ID of the output file in ApsaraVideo VOD if the output file is stored in ApsaraVideo VOD.'."\n", - 'type' => 'string', - 'example' => '****332c5b0cc6ba49eab379****', - ], - 'UserData' => [ - 'description' => 'The user-defined data in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}', - ], - 'SubJobMaterials' => [ - 'description' => 'The materials of the media editing and production job if the job is a subjob of a quick video production job, including the broadcast text and title.'."\n", - 'type' => 'string', - 'example' => '{"Title": "Title", "SpeechText": "Broadcast text of a quick video production job"}'."\n", - ], - 'Progress' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter \\ is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'JobNotFound', - 'errorMessage' => 'The specified job not found', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ****83B7-7F87-4792-BFE9-63CD2137****\\n \\n ****cdb3e74639973036bc84****\\n ****fddd7748b58bf1d47e95****\\n ****0cc6ba49eab379332c5b****\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4\\n {\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"},{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"}]}]}\\n ****6e76134d739cc3e85d3e****\\n {\\"VideoArray\\":[\\"****05512043f49f697f7425****\\",\\"****05512043f49f697f7425****\\",\\"****05512043f49f697f7425****\\"]}\\n 30.5\\n 2020-12-23T13:33:40Z\\n 2020-12-23T13:33:52Z\\n 2020-12-23T13:33:49Z\\n Failed\\n ExceededMaximumValue\\n The specified \\"Width_Height\\" has exceeded maximum value.\\n \\n","errorExample":""}]', - 'title' => 'GetMediaProducingJob', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"CreditUsage\\": \\"100\\",\\n \\"CreditTotal\\": \\"400\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'SubmitLiveEditingJob' => [ - 'summary' => 'Submits a live editing job to merge one or more live stream clips into one video. After a live editing job is submitted, the job is queued in the background for asynchronous processing. You can call the GeLiveEditingJob operation to query the state of the job based on the job ID. You can also call the GetMediaInfo operation to query the information about the generated media asset based on the media asset ID.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InsertMediaToSearchLib' => [ + 'summary' => 'Insert a media asset into the search library.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], 'parameters' => [ [ - 'name' => 'Clips', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'description' => 'The clips in the JSON array format. The output video is created by merging these clips sequentially.'."\n" - ."\n" - .'Each clip has a start time and an end time. If no live stream parameters are specified, the outer live stream configurations apply. The start and end timestamps are in UTC. For more information about the parameters, see the "Clip" section of this topic.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{\\"StartTime\\": \\" 2021-06-21T08:01:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:03:00Z\\" , "AppName": "app", "DomainName": "domain.com", "StreamName": "stream"}, {\\"StartTime\\": \\" 2021-06-21T08:05:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:09:00Z\\" }]', - ], + 'schema' => ['description' => 'The name of the search library. Default value: ims-default-search-lib.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the live editing project. If this parameter is specified, the system reads the storage configurations of the project. If this parameter is not specified, the specified storage configurations take precedence.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****fddd7748b58bf1d47e95****', - ], + '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' => 'LiveStreamConfig', + 'name' => 'MediaType', 'in' => 'query', 'schema' => [ - 'description' => 'The live stream configurations, in the JSON format. The configurations must include the following parameters:'."\n" + 'description' => 'The type of the media asset. Valid values:'."\n" + ."\n" + .'- video (default)'."\n" + ."\n" + .'- image'."\n" ."\n" - .'* AppName: the name of the application to which the live stream belongs.'."\n" - .'* DomainName: the domain name of the application.'."\n" - .'* StreamName: the name of the live stream.'."\n", + .'- audio', + 'enumValueTitles' => ['image' => 'image', 'video' => 'video', 'audio' => 'audio'], 'type' => 'string', 'required' => false, - 'example' => '{ "AppName": "app", "DomainName": "domain.com", "StreamName": "stream" }', + 'example' => 'video', + 'title' => '', ], ], [ - 'name' => 'OutputMediaConfig', + 'name' => 'Input', 'in' => 'query', - 'schema' => [ - 'description' => 'The configurations of the output file, in the JSON format. You can specify an OSS URL or a storage location in a storage bucket of ApsaraVideo VOD.'."\n" - ."\n" - .'* To store the output file in OSS, you must specify MediaURL.'."\n" - .'* To store the output file in ApsaraVideo VOD, you must specify StorageLocation and FileName.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'MediaProduceConfig', + 'name' => 'MsgBody', 'in' => 'query', - 'schema' => [ - 'description' => 'The production configurations, in the JSON format. Mode specifies the editing mode. Valid values:'."\n" - ."\n" - .'* **AccurateFast** (default): fast editing. It is faster than the Accurate mode. The resolution of the output file is the same as that of the source stream. You cannot specify the width and height of the output file.'."\n" - .'* **Accurate**: accurate editing. In this mode, you can specify the width and height of the output file.'."\n" - .'* **Rough**: rough editing. The minimum precision is one TS segment. The output file comprises all segments within the specified time range. You can specify the width and height of the output file.'."\n" - .'* **RoughFast**: fast rough editing. It is faster than the Accurate mode. The minimum precision is one TS segment. The output file comprises all segments within the specified time range. The resolution of the output file is the same as that of the source stream. You cannot specify the width and height of the output file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Mode": "AccurateFast"}', - ], + 'schema' => ['description' => 'The message body.', 'type' => 'string', 'required' => false, 'example' => '{"title":"test","customFields":{"intField1":12,"strField1":"abc"}}', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'ImagesInput', 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data in the JSON format, which can be up to 512 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"key": "value"}', - ], + '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' => 'OutputMediaTarget', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'* oss-object: OSS object in an OSS bucket.'."\n" - .'* vod-media: media asset in Alibaba Cloud VOD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss-object', - ], + 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'ProjectId' => [ - 'description' => 'The ID of the live editing project.'."\n", - 'type' => 'string', - 'example' => '****fddd7748b58bf1d47e95****', - ], - 'JobId' => [ - 'description' => 'The ID of the live editing job.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - 'MediaId' => [ - 'description' => 'The media asset ID of the output file.'."\n", - 'type' => 'string', - 'example' => '****c469e944b5a856828dc2****', - ], - 'MediaURL' => [ - 'description' => 'The URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4', - ], - 'VodMediaId' => [ - 'description' => 'The media asset ID of the output file in ApsaraVideo VOD if the output file is stored in ApsaraVideo VOD.'."\n", - 'type' => 'string', - 'example' => '****d7578s4h75ci945c14b****', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"MediaURL\\": \\"http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4\\",\\n \\"VodMediaId\\": \\"****d7578s4h75ci945c14b****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ****36-3C1E-4417-BDB2-1E034F****\\n ****fddd7748b58bf1d47e95****\\n ****d80e4e4044975745c14b****\\n ****c469e944b5a856828dc2****\\n http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4\\n","errorExample":""}]', - 'title' => 'SubmitLiveEditingJob', - 'description' => 'Live editing is supported for live streams that are recorded and stored in Object Storage Service (OSS) and ApsaraVideo VOD. If multiple live streams are involved in a single job, only those recorded within the same application are supported for mixed editing. The streams must all be recorded either in OSS or ApsaraVideo VOD.'."\n", - 'requestParamsDescription' => '### Clip'."\n" - ."\n" - .'|Parameter|Type|Example|Description|Required|'."\n" - .'|---|---|---|---|---|'."\n" - .'|StartTime|String|2021-06-21T08:01:00Z|The start time of the captured clip. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.|Yes|'."\n" - .'|EndTime|String|2021-06-21T08:05:00Z|The end time of the captured clip. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.|Yes|'."\n" - .'|AppName|String|app|The name of the application to which the live stream belongs. If you do not specify this parameter, the outer live stream configurations apply.|No|'."\n" - .'|DomainName|String|domain.com|The domain name. If you do not specify this parameter, the outer live stream configurations apply.|No|'."\n" - .'|StreamName|String|stream|The name of the live stream. If you do not specify this parameter, the outer live stream configurations apply.|No|'."\n" - .'|CoverTime|String|2021-06-21T08:03:00Z|The timestamp in the clip. The image at this timestamp is used as the thumbnail of the output file. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If you specify CoverTime for multiple clips, only the first one takes effect. CoverTime must be later than or equal to StartTime and earlier than or equal to EndTime.|No|'."\n" - .'|CoverUrl|String|https://test.oss-cn-shanghai.aliyuncs.com|The output URL of the thumbnail. The OSS bucket must be in the same region in which IMS is activated. Only self-managed OSS buckets are supported. Buckets managed by ApsaraVideo VOD are not supported.|No|', - ], - '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. You can call this operation to query only live editing jobs created within the past year.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235498', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'title' => '直播剪辑JobId', - 'description' => 'The ID of the live editing job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****d80e4e4044975745c14b****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'LiveEditingJob' => [ - 'title' => '直播剪辑任务', - 'description' => 'The information about the live editing job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'title' => '直播剪辑任务ID', - 'description' => 'The ID of the live editing job.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', - ], - 'ProjectId' => [ - 'title' => '直播剪辑工程ID', - 'description' => 'The ID of the live editing project.'."\n", - 'type' => 'string', - 'example' => '****fddd7748b58bf1d47e95****', - ], - 'Status' => [ - 'title' => '直播剪辑作业状态，取值可能为如下值： -Init （初始状态） -Queuing（排队中） -Processing（处理中） -Success（成功） -Failed（失败）', - 'description' => 'The state of the live editing job. Valid values: Init, Queuing, Processing, Success, and Failed.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Clips' => [ - 'title' => '剪辑片段列表', - 'description' => 'The clips.'."\n", - 'type' => 'string', - 'example' => '[{\\"StartTime\\": \\" 2021-06-21T08:01:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:03:00Z\\" }]', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '{"key": "value\'}', - ], - 'CreationTime' => [ - 'title' => '直播剪辑作业创建时间，格式为utc时间。 格式为："2021-06-21T08:01:00Z"。', - '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.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T13:33:40Z', - ], - 'ModifiedTime' => [ - 'title' => '直播剪辑作业修改时间，格式为utc时间。 格式为："2021-06-21T08:01:00Z"。', - '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.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T13:33:49Z', - ], - 'CompleteTime' => [ - 'title' => '直播剪辑作业完成时间，格式为utc时间。 格式为："2021-06-21T08:01:00Z"。', - '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.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T13:33:52Z', - ], - 'MediaId' => [ - 'title' => '输出成品的资源Id', - 'description' => 'The media asset ID of the output file.'."\n", - 'type' => 'string', - 'example' => '****0cc6ba49eab379332c5b****', - ], - 'MediaURL' => [ - 'title' => '输出成品的资源文件URL', - 'description' => 'The URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4', - ], - 'Code' => [ - 'title' => '剪辑合成作业错误码 注：作业失败时关注该字段', - 'description' => 'The response code. Note: Pay attention to this parameter if the job failed.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'Message' => [ - 'title' => '剪辑合成作业错误信息 注：作业失败时关注该字段', - 'description' => 'The returned message. Note: Pay attention to this parameter if the job failed.'."\n", - 'type' => 'string', - 'example' => 'The specific parameter LiveStreamConfig is not valid.', - ], - 'LiveStreamConfig' => [ - 'title' => '直播剪辑配置', - 'description' => 'The live editing configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'title' => '播流所属应用名称', - 'description' => 'The name of the application to which the live stream belongs.'."\n", - 'type' => 'string', - 'example' => 'app', - ], - 'DomainName' => [ - 'title' => '播流所属域名', - 'description' => 'The domain name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'domain.com', - ], - 'StreamName' => [ - 'title' => '播流所属流名', - 'description' => 'The name of the live stream.'."\n", - 'type' => 'string', - 'example' => 'streamName', - ], + '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' => '', ], - ], - 'MediaProduceConfig' => [ - 'title' => '直播剪辑合成配置', - 'description' => 'The production configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'title' => '剪辑模式，默认Accurate', - 'description' => 'The editing mode. Default value: Accurate.'."\n", - 'type' => 'string', - 'example' => 'Accurate', + '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' => ''], ], - 'OutputMediaConfig' => [ - 'title' => '输出成片的存储配置', - 'description' => 'The storage configurations of the output file.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaURL' => [ - 'title' => '输出成片的文件地址', - 'description' => 'The URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4', - ], - 'StorageLocation' => [ - 'title' => '当 OutputMediaTarget 的目标为 vod-media 时， 指定 storage location 来存储媒资到 VOD; storage location 是 VOD 中的文件存储位置， 不包含 http:// 的前缀， 如: outin-xxxxxx.oss-cn-shanghai.aliyuncs.com', - '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.'."\n", - 'type' => 'string', - 'example' => 'outin-xxxxxx.oss-cn-shanghai.aliyuncs.com', - ], - 'FileName' => [ - 'title' => '当 OutputMediaTarget 的目标为 vod-media 时，指定 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.'."\n", - 'type' => 'string', - 'example' => 'test.mp4', - ], - 'Width' => [ - 'title' => '输出成品的宽。可以不填，默认值是多个素材的最大宽', - 'description' => 'The width of the output file. You can leave this parameter empty. The default value is the maximum width of the input materials.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '640', - ], - 'Height' => [ - 'title' => '输出成品的高。可以不填，默认值是多个素材的最大高', - 'description' => 'The height of the output file. You can leave this parameter empty. The default value is the maximum height of the input materials.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '480', - ], - 'Bitrate' => [ - 'title' => '输出成品的码率，单位为Kbps。可以不填，默认值是多个素材的最高码率', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'VodTemplateGroupId' => [ - 'title' => '合成成片输出到vod，指定vod转码模板组。如不需要VOD转码，请填写 "VOD_NO_TRANSCODE".', - 'description' => 'The ID of the VOD transcoding template group. If VOD transcoding is not required, set the value to VOD_NO_TRANSCODE.'."\n", - 'type' => 'string', - 'example' => 'VOD_NO_TRANSCODE', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ****36-3C1E-4417-BDB2-1E034F****\\n \\n ****cdb3e74639973036bc84****\\n ****fddd7748b58bf1d47e95****\\n Success\\n [{\\\\\\"StartTime\\\\\\": \\\\\\" 2021-06-21T08:01:00Z\\\\\\", \\\\\\"EndTime\\\\\\": \\\\\\" 2021-06-21T08:03:00Z\\\\\\" }]\\n {\\"key\\": \\"value\'}\\n 2020-12-23T13:33:40Z\\n 2020-12-23T13:33:49Z\\n 2020-12-23T13:33:52Z\\n ****0cc6ba49eab379332c5b****\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4\\n InvalidParameter\\n The specific parameter LiveStreamConfig is not valid.\\n \\n app\\n domain.com\\n streamName\\n \\n \\n Accurate\\n \\n \\n https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4\\n outin-xxxxxx.oss-cn-shanghai.aliyuncs.com\\n test.mp4\\n 640\\n 480\\n 1000\\n VOD_NO_TRANSCODE\\n \\n \\n","errorExample":""}]', - 'title' => 'GetLiveEditingJob', - ], - 'SubmitBatchMediaProducingJob' => [ - 'summary' => 'Submits a quick video production job that intelligently edits multiple video, audio, and image assets to generate multiple videos at a time.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '131231', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '236523', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '调用方保证请求幂等性Client Token', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****'."\n", - ], - ], - [ - 'name' => 'InputConfig', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户合成输出配置', - 'description' => 'The input configurations. For more information, see [InputConfig](~~2692547#2faed1559549n~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'EditingConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The editing configurations. For more information, see [EditingConfig](~~2692547#1be9bba03b7qu~~).'."\n", - '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" - .'}', - ], + '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' => 'OutputConfig', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '任务来源', - 'description' => 'The output configurations. For more information, see [OutputConfig](~~2692547#447b928fcbuoa~~).'."\n", - 'type' => 'string', - '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" - .'}', - ], + 'schema' => ['description' => 'Page number. Default Value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~357745~~).', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Phone number. Specify Number to directly query the corresponding phone number.', 'type' => 'string', 'required' => false, 'example' => '139xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'TemplateConfig', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'JobId' => [ - 'title' => '批量混剪任务jobId', - 'description' => 'The ID of the quick video production job.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', - 'title' => 'SubmitBatchMediaProducingJob', - ], - 'GetBatchMediaProducingJob' => [ - 'summary' => 'Queries the information about a quick video production job, including the input parameters, job state, and the IDs and URLs of the output media assets. You can call this operation to query only quick video production jobs created within the past year.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '207313', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', - ], + 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ - 'name' => 'JobId', + '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 ID of the quick video production job.'."\n", + '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' => '****b4549d46c88681030f6e****', + 'example' => 'Explicit', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'EditingBatchJob' => [ - 'description' => 'The information about the quick video production job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****b6b2750d4308892ac3330238****', - ], - 'InputConfig' => [ - 'description' => 'The input configurations. For more information, see [InputConfig](~~2692547#2faed1559549n~~).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'EditingConfig' => [ - 'description' => 'The editing configurations. For more information, see [EditingConfig](~~2692547#1be9bba03b7qu~~).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "MediaConfig": {'."\n" - .' "Volume": 0'."\n" - .' },'."\n" - .' "SpeechConfig": {'."\n" - .' "Volume": 1'."\n" - .' },'."\n" - .' "BackgroundMusicConfig": {'."\n" - .' "Volume": 0.3'."\n" - .' }'."\n" - .'}', - ], - 'OutputConfig' => [ - 'description' => 'The output configurations. For more information, see [OutputConfig](~~2692547#447b928fcbuoa~~).'."\n", - '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" - .'}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'Finished', - ], - '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"}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "ErrorCode": "InvalidMaterial.NotFound",'."\n" - .' "ErrorMessage": "The specified clips id not found:[\\"****30d0b5e871eebb2ff7f6c75a****\\"]"'."\n" - .'}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:47:07Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:57:07Z'."\n", - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:57:07Z'."\n", - ], - 'JobType' => [ - 'type' => 'string', - ], - 'SubJobList' => [ - 'description' => 'The quick video production subjobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the quick video production subjob.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'description' => 'The ID of the output media asset.'."\n", - 'type' => 'string', - 'example' => '****1470b11171ee9d19e7e6c66a****', - ], - 'JobId' => [ - 'description' => 'The subjob ID.'."\n", - 'type' => 'string', - 'example' => '****8e81933d44e3ae69e2f81485****', - ], - 'MediaURL' => [ - 'description' => 'The URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned if the subjob failed. This parameter is not returned if the subjob is successful.'."\n", - 'type' => 'string', - 'example' => 'InvalidMaterial.NotFound', - ], - 'ErrorMessage' => [ - 'description' => 'The error message that is returned if the subjob failed. This parameter is not returned if the subjob is successful.'."\n", - 'type' => 'string', - 'example' => 'The specified clips id not found:["****30d0b5e871eebb2ff7f6c75a****"]', - ], - 'ProjectId' => [ - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '****7cc47fe04eaa81bd853acb6a****', - ], - 'Duration' => [ - 'type' => 'number', - 'format' => 'float', - ], - ], - ], - ], - 'ExtendInput' => [ - 'type' => 'string', - ], - 'ExtendOutput' => [ - 'type' => 'string', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": \\"****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\\\\t\\\\\\"textMatchMediaOutputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"textMatchMediaSentenceOutputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"duration\\\\\\": 3.366667,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"matchClipList\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"clipId\\\\\\": \\\\\\"null-2\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"endTime\\\\\\": 11.16,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"mediaId\\\\\\": \\\\\\"****a0900f5071efbf1ce7e6c66a****\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"score\\\\\\": -0.253,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"startTime\\\\\\": 8.04\\\\n\\\\t\\\\t\\\\t\\\\t}],\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"text\\\\\\": \\\\\\"附近的商场新开了一家盒马鲜生\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"textId\\\\\\": \\\\\\"0\\\\\\"\\\\n\\\\t\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\t{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"duration\\\\\\": 1.566667,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"matchClipList\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"clipId\\\\\\": \\\\\\"null-1\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"endTime\\\\\\": 1.54,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"mediaId\\\\\\": \\\\\\"****a0900f5071efbf1ce7e6c66a****\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"score\\\\\\": -0.2326,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"startTime\\\\\\": 0\\\\n\\\\t\\\\t\\\\t\\\\t}],\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"text\\\\\\": \\\\\\"今天是第一天开业\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"textId\\\\\\": \\\\\\"0\\\\\\"\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t]\\\\n\\\\t}]\\\\n}\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetBatchMediaProducingJob', - ], - 'SubmitSportsHighlightsJob' => [ - 'summary' => 'Submits a sports highlights job to generate a highlights video of an event based on event materials that contain commentary.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => 'create', - 'abilityTreeCode' => '235590', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238120', + 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'title' => '调用方保证请求幂等性Client Token', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****'."\n", - ], + 'schema' => ['description' => 'The configuration name. Fuzzy match is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ad'], ], [ - 'name' => 'InputConfig', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户合成输出配置', - 'description' => 'The input configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'OutputConfig', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '任务来源', - 'description' => 'The output configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" - .' "Count": 1,'."\n" - .' "Width": 1080,'."\n" - .' "Height": 1920'."\n" - .'}', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'UserData', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'The user-defined data.'."\n", + 'description' => 'The sorting order of the configurations by creation time. asc: ascending. desc: descending.', + 'enumValueTitles' => ['asc' => '', 'desc' => ''], 'type' => 'string', + 'title' => '', 'required' => false, - 'example' => '', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****'."\n", - ], - 'JobId' => [ - 'description' => 'The ID of the sports highlights job.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****'."\n", + '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', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\\\n\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\\\n\\"\\n}","type":"json"}]', - 'title' => 'SubmitSportsHighlightsJob', - ], - 'SubmitScreenMediaHighlightsJob' => [ - 'summary' => 'Submits a task to automatically recognize the highlight segments in the video input and compile them into a dramatic and engaging clip.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAdInsertions'], + ], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InputConfig', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户合成输出配置', - 'description' => 'The input configuration. For detailed parameters, see [InputConfig](~~2863940#dda38bf6ec2pk~~).', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "MediaArray": ['."\n" - .' "****9d46c886b45481030f6e****",'."\n" - .' "****6c886b4549d481030f6e****"'."\n" - .' ]'."\n" - .'}', - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EditingConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The editing configuration. For detailed parameters, see [EditingConfig](~~2863940#9b05519d46e0x~~).', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "MediaConfig": {'."\n" - .' "Volume": 1'."\n" - .' },'."\n" - .' "ProcessConfig": {'."\n" - .' "AllowTransition": true,'."\n" - .' "TransitionList": ["fadecolor"]'."\n" - .' }'."\n" - .'}', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'OutputConfig', + 'name' => 'ResourceArn', 'in' => 'query', - 'schema' => [ - 'title' => '任务来源', - 'description' => 'The output configuration. For detailed parameters, see [OutputConfig](~~2863940#4111a373d0xbz~~).', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" - .' "Count": 1,'."\n" - .' "Width": 1080,'."\n" - .' "Height": 1920'."\n" - .'}', - ], + 'schema' => ['description' => 'The ARN of the source or program.', 'type' => 'string', 'required' => true, 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~357745~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'JobId' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****'."\n", + '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\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\\\n\\"\\n}","type":"json"}]', - 'title' => 'SubmitScreenMediaHighlightsJob', - ], - '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.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '12624', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'BusinessType', 'in' => 'query', - 'schema' => [ - 'title' => '查询以下状态的合成任务，支持多值，以英文逗号分隔', - 'description' => 'The job state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Init: The job is initialized.'."\n" - .'* Failed: The job failed.'."\n" - .'* Success: The job is successful.'."\n" - .'* Processing: The job is in progress.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Init' => '', - 'Failed' => '', - 'Success' => '', - 'Processing' => '', - ], - 'example' => 'Success', - ], + 'schema' => ['description' => 'The business type of the media asset.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '"sticker"'], ], [ - 'name' => 'JobType', + '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' => [ - 'description' => 'The job type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LiveEditingJob: live editing job.'."\n" - .'* EditingJob: regular template-based editing job'."\n" - .'* VETemplateJob: advanced template-based editing job.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LiveEditingJob' => '', - 'EditingJob' => '', - 'VETemplateJob' => '', + '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' => 'EditingJob', + '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' => [ [ - 'name' => 'StartTime', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-01-11T12:00:00Z', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => '- The page number.'."\n" + ."\n" + .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PageSize', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-02T23:59:59Z', - ], + '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' => 'Keyword', + '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' => [ - 'description' => 'The search keyword. For example, you can use a job ID as the keyword to search for jobs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', + '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' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******927cfb53d05b96c1bfe1******', + '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' => [ [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******8750b54e3c976a47da6f******', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => '- The page number.'."\n" + ."\n" + .'- Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return.'."\n" - ."\n" - .'Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + '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' => 'SortBy', + 'name' => 'AvatarType', '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" - .'* CreationTime:Desc: sorted by creation time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CreationTime:Asc' => '', - 'CreationTime:Desc' => '', - ], - 'example' => 'CreationTime:Desc', - ], + 'schema' => ['description' => '- The type of the digital human.'."\n" + ."\n" + .'- 2DAvatar', 'type' => 'string', 'required' => false, 'example' => '2DAvatar', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MediaProducingJobList' => [ - 'description' => 'The queried media editing and production jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried media editing and production job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the online editing job.'."\n", - 'type' => 'string', - 'example' => '******8750b54e3c976a47da6f******', - ], - 'ProjectId' => [ - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '******faa3b542f5a6135217e3******', - ], - 'MediaId' => [ - 'description' => 'The media asset ID of the output file.'."\n", - 'type' => 'string', - 'example' => '0ce4ea70f52471edab61f7e7d6786302', - ], - 'MediaURL' => [ - 'description' => 'The URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'http://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4', - ], - 'TemplateId' => [ - 'description' => 'The ID of the online editing template.'."\n", - 'type' => 'string', - 'example' => 'cb786a39c5d44cecb23d8c864facffc1', - ], - 'ClipsParam' => [ - 'description' => 'The template material parameters.'."\n", - 'type' => 'string', - 'example' => '{"Text1":"text","Text0":"text","Media1":"mediaId","Media0":"mediaId"}', - ], - 'Duration' => [ - 'description' => 'The duration of the output file. Unit: seconds.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '15.5', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-03-21T16:40:00Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2022-03-21T16:40:30Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-03-21T16:41:00Z', - ], - 'Status' => [ - 'description' => 'The job state.'."\n", - 'type' => 'string', - 'example' => 'Sucess', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The returned message. Note: Pay attention to this parameter if the job failed.'."\n", - 'type' => 'string', - 'example' => 'The resource operated InputFile is bad', - ], - 'UserData' => [ - 'description' => 'The user-defined data in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{"key":"value"}', + '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' => '', ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned.'."\n" - ."\n" - .'Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - '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"}]', - 'title' => 'ListMediaProducingJobs', + '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', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -41494,20 +27308,13 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '216608', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', - ], + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the quick video production job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****d80e4e4044975745c14b****', - ], + 'schema' => ['description' => 'The ID of the quick video production job.', 'type' => 'string', 'required' => false, 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], [ 'name' => 'JobType', @@ -41517,15 +27324,14 @@ ."\n" .'Valid values:'."\n" ."\n" - .'* Script: script-based editing job that mixes media assets.'."\n" - .'* Smart_Mix: intelligent editing job that mixes media assets.'."\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, - 'enumValueTitles' => [ - 'Script' => '', - 'Smart_Mix' => '', - ], 'example' => 'Script', + 'title' => '', ], ], [ @@ -41536,40 +27342,29 @@ ."\n" .'Valid values:'."\n" ."\n" - .'* Finished'."\n" - .'* Init'."\n" - .'* Failed'."\n" - .'* Processing'."\n", + .'- Finished'."\n" + ."\n" + .'- Init'."\n" + ."\n" + .'- Failed'."\n" + ."\n" + .'- Processing', + 'enumValueTitles' => ['Finished' => '', 'Init' => '', 'Failed' => '', 'Processing' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Finished' => '', - 'Init' => '', - 'Failed' => '', - 'Processing' => '', - ], '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-02T00:00:00Z', - ], + '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-06-05T15:59:59Z', - ], + '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', @@ -41577,866 +27372,751 @@ 'schema' => [ 'description' => 'The sorting parameter. Valid values:'."\n" ."\n" - .'* desc (default): sorted by creation time in descending order.'."\n" - .'* asc: sorted by creation time in ascending order.'."\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, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', - ], '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mRZkKAovub0xWVfH14he4Q==', - ], + '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The maximum number of entries to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], 'EditingBatchJobList' => [ - 'description' => 'The queried quick video production jobs.'."\n", + 'description' => 'The queried quick video production jobs.', 'type' => 'array', 'items' => [ - 'description' => 'The queried quick video production job.'."\n", + 'description' => 'The queried quick video production job.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the quick video production job.'."\n", - 'type' => 'string', - 'example' => '******7ecbee4c6d9b8474498e******', - ], - 'InputConfig' => [ - 'description' => 'The input configurations.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'EditingConfig' => [ - 'description' => 'The editing configurations. For more information, see [EditingConfig](~~2692547#1be9bba03b7qu~~).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "MediaConfig": {'."\n" - .' "Volume": 0'."\n" - .' },'."\n" - .' "SpeechConfig": {'."\n" - .' "Volume": 1'."\n" - .' },'."\n" - .' "BackgroundMusicConfig": {'."\n" - .' "Volume": 0.3'."\n" - .' }'."\n" - .'}', - ], - 'OutputConfig' => [ - 'description' => 'The output configurations. For more information, see [OutputConfig](~~2692547#447b928fcbuoa~~).'."\n", - '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" - .'}', - ], + '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" - .'* Init'."\n" - .'* Failed'."\n" - .'* Processing'."\n", + .'- Finished'."\n" + ."\n" + .'- Init'."\n" + ."\n" + .'- Failed'."\n" + ."\n" + .'- Processing', + 'enumValueTitles' => ['Finished' => '', 'Init' => '', 'Failed' => '', 'Processing' => ''], 'type' => 'string', - 'enumValueTitles' => [ - 'Finished' => '', - 'Init' => '', - 'Failed' => '', - 'Processing' => '', - ], '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' => '', - ], - 'Extend' => [ - 'description' => 'The extended information of the job.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2023-06-09T06:36:48Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-06-09T06:37:58Z', - ], + '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.'."\n", - 'type' => 'string', + '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" - .'* Smart_Mix: intelligent editing job that mixes media assets.'."\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', - 'enumValueTitles' => [ - 'Script' => '', - 'Smart_Mix' => '', - ], '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.'."\n", - 'type' => 'string', - 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', - ], - 'MaxResults' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + '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 \\\\\\"回龙观盒马鲜生开业啦\\\\\\"],\\\\n \\\\\\"SpeechTextArray\\\\\\": [\\\\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\\\\\\"}或{\\\\\\"NotifyAddress\\\\\\":\\\\\\"https://xx.xx.xxx\\\\\\"}或{\\\\\\"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"}]', + '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', - ], - 'AddTemplate' => [ - 'summary' => 'Creates a template.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'The name of the custom template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '视频添加水印模板', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '模板类型，取值范围：Timeline', - '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" - .'* 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" - .'', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Timeline' => '', - 'VETemplate' => '', - ], - 'example' => 'Timeline', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'title' => '参见Timeline模板Config文档', - '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" - .'* For more information about Config object examples, see [Basic template configurations](~~451634~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '参见Timeline模板Config文档', - ], - ], - [ - 'name' => 'CoverUrl', + 'name' => 'ResourceArn', 'in' => 'query', - 'schema' => [ - 'title' => '模板封面', - 'description' => 'The URL of the template thumbnail.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', - ], + 'schema' => ['description' => 'The ARN of the channel.', 'type' => 'string', 'required' => true, 'example' => 'acs:ims:mediaweaver:::channel/myChannel', 'title' => ''], ], [ - 'name' => 'PreviewMedia', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'title' => '预览视频媒资id', - 'description' => 'The ID of the template preview video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****01bf24bf41c78b2754cb3187****', - ], + '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' => 'Status', + 'name' => 'SortByModifiedTime', 'in' => 'query', - 'schema' => [ - 'title' => '模板状态', - 'description' => 'The template state. Valid values:'."\n" - ."\n" - .'* Available: The template is available.'."\n" - .'* Created: The template is created but not ready for use.'."\n" - .'* Uploading: The video is being uploaded.'."\n" - .'* Processing: The advanced template is being processed.'."\n" - .'* UploadFailed: Failed to upload the video.'."\n" - .'* ProcessFailed: Failed to process the advanced template.'."\n" - ."\n" - .'', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'UploadFailed' => '', - 'ProcessFailed' => '', - 'Available' => '', - 'Uploading' => '', - 'Created' => '', - 'Processing' => '', - ], - 'example' => 'Available', - ], + 'schema' => ['description' => 'The sorting order by modification time. Valid values: asc and desc.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'GmtStart', 'in' => 'query', - 'schema' => [ - 'title' => '模板创建来源，默认OpenAPI', - 'description' => 'The source from which the template is created. Valid values:'."\n" - ."\n" - .'* OpenAPI'."\n" - .'* AliyunConsole'."\n" - .'* WebSDK'."\n" - ."\n" - .'', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', - ], - 'example' => 'OpenAPI', - ], + 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '2024-11-21T16:10:45Z', 'title' => ''], ], [ - 'name' => 'RelatedMediaids', + 'name' => 'GmtEnd', 'in' => 'query', - 'schema' => [ - 'title' => '模板相关素材，模板编辑器使用', - 'description' => 'The IDs of the materials associated with the template for use by the regular template editor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"video":["1805a0c6ca544fb395a06ca683619655"]}', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', - ], - 'Template' => [ - 'title' => '模板信息', - 'description' => 'The template information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****01bf24bf41c78b2754cb3187****', - ], - 'Name' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '视频添加水印模板', - ], - 'Type' => [ - 'title' => '模板类型', - 'description' => 'The template type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Timeline: regular template.'."\n" - .'* VETemplate: advanced template.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Timeline' => '', - 'VETemplate' => '', - ], - 'example' => 'Timeline', - ], - 'Config' => [ - 'title' => '参见Timeline模板Config文档', - 'description' => 'The template configurations.'."\n", - 'type' => 'string', - 'example' => '参见Timeline模板Config文档', - ], - 'CoverUrl' => [ - 'title' => '模板封面', - 'description' => 'The URL of the template thumbnail.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', - ], - 'PreviewMedia' => [ - 'title' => '预览视频媒资id', - 'description' => 'The ID of the preview video.'."\n", - 'type' => 'string', - 'example' => '****01bf24bf41c78b2754cb3187****', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* UploadFailed: Failed to upload the video.'."\n" - .'* ProcessFailed: Failed to process the advanced template.'."\n" - .'* Available: The template is available.'."\n" - .'* Uploading: The video is being uploaded.'."\n" - .'* Created: The template is created but not ready for use.'."\n" - .'* Processing: The advanced template is being processed.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'UploadFailed' => '', - 'ProcessFailed' => '', - 'Available' => '', - 'Uploading' => '', - 'Created' => '', - 'Processing' => '', - ], - 'example' => 'Available', - ], - 'CreateSource' => [ - 'title' => '模板创建来源', - 'description' => 'The source from which the template was created.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* WebSDK'."\n" - .'* OpenAPI'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', - ], - 'example' => 'OpenAPI', - ], - 'ModifiedSource' => [ - 'title' => '模板修改来源', - 'description' => 'The source from which the template was modified.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* WebSDK'."\n" - .'* OpenAPI'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', - ], - 'example' => 'OpenAPI', + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"Template\\": {\\n \\"TemplateId\\": \\"****01bf24bf41c78b2754cb3187****\\",\\n \\"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}","errorExample":""},{"type":"xml","example":"\\n ****2876-6263-4B75-8F2C-CD0F7FCF****\\n \\n","errorExample":""}]', - 'title' => 'AddTemplate', - 'description' => '* For more information about how to use a regular template, see [Create and use a regular template](~~445399~~).'."\n" - .'* For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).'."\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.', - ], - 'GetTemplate' => [ - 'summary' => 'Queries the information about a template based on the template ID. You can call this operation to query the information about an advanced template if the template is in the Available state.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => false, 'example' => 'MyChannel', 'title' => ''], ], [ - 'name' => 'RelatedMediaidFlag', + 'name' => 'ChannelTier', 'in' => 'query', - 'schema' => [ - 'title' => '是否返回模板关联素材，1返回，默认0，不返回', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The tier of the channel. Valid values: basic and standard.', 'type' => 'string', 'required' => false, 'example' => 'basic', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Template' => [ - 'description' => 'The template information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Name' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '视频添加水印模板', - ], - 'Type' => [ - 'title' => '模板类型', - 'description' => 'The template type. Valid values:'."\n" - ."\n" - .'* Timeline'."\n" - .'* VETemplate'."\n", - 'type' => 'string', - 'example' => 'Timeline', - ], - 'Config' => [ - 'title' => '模板配置', - '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" - .'* For more information about the configurations of an advanced template, see [Create and use advanced templates](~~445389~~).', - 'type' => 'string', - 'example' => '参考Timeline模板配置详解', - ], - 'PreviewMedia' => [ - 'title' => '预览素材', - 'description' => 'The preview media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state. Valid values:'."\n" - ."\n" - .'* Available'."\n" - .'* Created'."\n" - .'* Uploading'."\n" - .'* Processing'."\n" - .'* UploadFailed'."\n" - .'* ProcessFailed'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'CreateSource' => [ - 'title' => '创建来源', - 'description' => 'The source from which the template was created. Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* OpenAPI'."\n" - .'* WebSDK'."\n", - 'type' => 'string', - 'example' => 'OpenAPI', - ], - 'ModifiedSource' => [ - 'title' => '修改来源', - 'description' => 'The source from which the template was modified. Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* OpenAPI'."\n" - .'* WebSDK'."\n", - 'type' => 'string', - 'example' => 'OpenAPI', - ], - 'PreviewMediaStatus' => [ - 'title' => '预览素材状态', - '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" - .'* Preparing: The source file is being prepared. For example, the file is being uploaded or edited.'."\n" - .'* PrepareFail: The source file failed to be prepared. For example, the information about the source file failed to be obtained.'."\n" - .'* Normal: The source file is ready.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'CreationTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'ModifiedTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'CoverURL' => [ - 'title' => '封面URL', - 'description' => 'The thumbnail URL.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', - ], - 'ClipsParam' => [ - '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" - .'* [Create and use advanced templates](~~445389~~)', - 'type' => 'string', - 'example' => '{"Media1":"mediaId","Text1":"text"}', - ], - 'RelatedMediaids' => [ - 'title' => '模板关联素材', - 'description' => 'The IDs of the materials associated with the template for use by the regular template editor.'."\n", - 'type' => 'string', - 'example' => '{"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}', - ], - ], + [ + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Template\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"视频添加水印模板\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"参考Timeline模板配置详解\\",\\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}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n \\n","errorExample":""}]', - '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" - .'* For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).', - ], - 'UpdateTemplate' => [ - 'summary' => 'Modifies an online editing template. You can modify the template title and template configurations.', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceEO4QPO'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The ID of the online editing template. You can obtain the template ID in the [Intelligent Media Services (IMS) console](https://ice.console.aliyun.com/production/template/list/common) or the response parameters of the [AddTemplate](~~441161~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'Name', + 'name' => 'Subtype', 'in' => 'query', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'The name of the online editing template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '视频添加水印模板', - ], - ], - [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'title' => '参见模板Config文档', - 'description' => 'The template configurations. For more information, see [Config object of a regular template](~~456193~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "VideoTracks": ['."\n" - .' {'."\n" - .' "VideoTrackClips": ['."\n" - .' {'."\n" - .' "Sys_Type" : "ArrayItems",'."\n" - .' "Sys_ArrayObject" : "$VideoArray",'."\n" - .' "Sys_Template" : {'."\n" - .' "MediaId" : "$MediaId"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], + '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' => 'CoverUrl', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '模板封面', - 'description' => 'The URL of the template thumbnail.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', - ], + 'schema' => ['description' => 'The name of the template.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-template'], ], [ - 'name' => 'PreviewMedia', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '预览视频媒资id', - 'description' => 'The ID of the preview video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****96e8864746a0b6f3****'], ], [ - 'name' => 'Status', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '模板状态', - 'description' => 'The template state. Valid values:'."\n" - ."\n" - .'* Available: The template is available.'."\n" - .'* Created: The template is created but not ready for use.'."\n" - .'* Uploading: The video is being uploaded.'."\n" - .'* Processing: The advanced template is being processed.'."\n" - .'* UploadFailed: Failed to upload the video.'."\n" - .'* ProcessFailed: Failed to process the advanced template.'."\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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Available', - ], + 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], [ - 'name' => 'Source', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '修改来源，默认OpenAPI', - 'description' => 'The source from which the template is modified. Default value: OpenAPI. Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* OpenAPI'."\n" - .'* WebSDK'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], [ - 'name' => 'RelatedMediaids', + 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'title' => '模板相关素材，模板编辑器使用', - 'description' => 'The IDs of the materials associated with the template for use by the regular template editor.'."\n", + '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' => '{"video":["******c04f1d4a06996144cc1a******","******cb7db64841b159b4f2ea******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}', + 'example' => 'CreateTimeDesc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The root object of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8D475A5-F2EC-5755-ABD8-22D5561C****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n","errorExample":""}]', - 'title' => 'UpdateTemplate', - 'description' => '* For more information about how to use a regular template, see [Create and use a regular template](~~445399~~).'."\n" - .'* For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).', - ], - 'DeleteTemplate' => [ - 'summary' => 'Deletes templates.', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TemplateIds', + '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' => [ - 'title' => '模板id，多个id用英文逗号隔开', - 'description' => 'The IDs of the templates that you want to delete. Separate multiple IDs with commas (,).'."\n", + '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' => '****20b48fb04483915d4f2cd8ac****,****20b48fb04483915d4f2cd8ac****', + 'example' => 'Standard', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n","errorExample":""}]', - '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" - .'* For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).', - ], - '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', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -42444,391 +28124,312 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '当前页码。默认值为1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，每页显示条数。默认值为10，最大值为100。', - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '模板类型', - 'description' => 'The template type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Timeline'."\n" - .'* VETemplate'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Timeline' => 'Timeline', - 'VETemplate' => 'VETemplate', - ], - 'example' => 'Timeline', - ], + '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' => 'Status', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* UploadFailed: Failed to upload the video.'."\n" - .'* ProcessFailed: Failed to process the advanced template.'."\n" - .'* Available: The template is available.'."\n" - .'* Uploading: The video is being uploaded.'."\n" - .'* Created: The template is created but not ready for use.'."\n" - .'* Processing: The advanced template is being processed.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'UploadFailed' => '', - 'ProcessFailed' => '', - 'Available' => '', - 'Uploading' => '', - 'Created' => '', - 'Processing' => '', + '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' => 'Available', + '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' => [ [ - 'name' => 'CreateSource', - 'in' => 'query', - 'schema' => [ - 'title' => '创建来源', - 'description' => 'The source from which the template was created.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* WebSDK'."\n" - .'* OpenAPI'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListCustomizedVoices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'OpenAPI', ], ], + ], + 'translator' => 'manual', + ], + 'ListDNADB' => [ + 'summary' => 'Queries a list of media fingerprint libraries.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'title' => '搜索关键词，可以根据模板id和title搜索', - 'description' => 'The search keyword. You can use the template ID or title as the keyword to search for templates.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146937', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], + 'parameters' => [ [ - 'name' => 'SortType', + 'name' => 'DBIds', 'in' => 'query', - 'schema' => [ - 'title' => '排序参数，默认根据创建时间倒序', - '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" - .'* CreationTime:Desc: sorted by creation time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CreationTime:ASC' => '', - 'CreationTime:Desc' => '', - ], - 'example' => 'CreationTime:Desc', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'TotalCount' => [ - 'title' => '本次请求条件下的数据总量。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Templates' => [ - 'description' => 'The queried templates.'."\n", + 'DBList' => [ + 'description' => 'The queried media fingerprint libraries.', 'type' => 'array', 'items' => [ - 'description' => 'The template information.'."\n", + 'description' => 'The queried media fingerprint library.', 'type' => 'object', 'properties' => [ - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Name' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '视频添加水印模板', - ], - 'Type' => [ - 'title' => '模板类型', - 'description' => 'The template type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Timeline: regular template.'."\n" - .'* VETemplate: advanced template.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Timeline' => '', - 'VETemplate' => '', - ], - 'example' => 'Timeline', - ], - 'Config' => [ - 'title' => '模板配置', - 'description' => 'The template configurations.'."\n", - 'type' => 'string', - 'example' => '参考Timeline模板配置详解', - ], - 'PreviewMedia' => [ - 'title' => '预览素材', - 'description' => 'The preview media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Status' => [ - 'title' => '模板状态', - 'description' => 'The template state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* UploadFailed: Failed to upload the video.'."\n" - .'* ProcessFailed: Failed to process the advanced template.'."\n" - .'* Available: The template is available.'."\n" - .'* Uploading: The video is being uploaded.'."\n" - .'* Created: The template is created but not ready for use.'."\n" - .'* Processing: The advanced template is being processed.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'UploadFailed' => '', - 'ProcessFailed' => '', - 'Available' => '', - 'Uploading' => '', - 'Created' => '', - 'Processing' => '', - ], - 'example' => 'Available', - ], - 'CreateSource' => [ - 'title' => '创建来源', - 'description' => 'The source from which the template was created.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* WebSDK'."\n" - .'* OpenAPI'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', - ], - 'example' => 'OpenAPI', - ], - 'ModifiedSource' => [ - 'title' => '修改来源', - 'description' => 'The source from which the template was modified.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AliyunConsole'."\n" - .'* WebSDK'."\n" - .'* OpenAPI'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', - ], - 'example' => 'OpenAPI', - ], - 'PreviewMediaStatus' => [ - 'title' => '预览素材状态', - 'description' => 'The state of the preview media asset.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PrepareFail'."\n" - .'* Init'."\n" - .'* Normal'."\n" - .'* Preparing'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PrepareFail' => '', - 'Init' => '', - 'Normal' => '', - 'Preparing' => '', - ], - 'example' => 'Normal', - ], - 'CreationTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'ModifiedTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the template was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'CoverURL' => [ - 'title' => '封面URL', - 'description' => 'The thumbnail URL.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', - ], - 'ClipsParam' => [ - 'title' => 'ClipsParam', - 'description' => 'The clip parameters.'."\n", - 'type' => 'string', - 'example' => '{"Media1":"mediaId","Text1":"text"}', - ], + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TotalCount\\": 100,\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"云剪辑模板\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"参考Timeline模板配置详解\\",\\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}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n 100\\n \\n ****20b48fb04483915d4f2cd8ac****\\n 视频添加水印模板\\n Timeline\\n 参考Timeline模板配置详解\\n ****20b48fb04483915d4f2cd8ac****\\n Available\\n OpenAPI\\n OpenAPI\\n Normal\\n 2020-12-26T04:11:10Z\\n 2020-12-26T04:11:10Z\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg\\n \\n","errorExample":""}]', - '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" - .'* For more information about how to use an advanced template, see [Create and use advanced templates](~~445389~~).', - ], - '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', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'title' => '模板Id', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'FileList', + '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' => [ - 'title' => '所需文件列表', - 'description' => 'The materials that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["music.mp3","config.json","assets/1.jpg"]', + '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' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'MaterialUrls' => [ - 'title' => '关联素材地址', - 'description' => 'The URLs of the associated materials.'."\n", - '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"}', - ], + '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' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n {\\"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","errorExample":""}]', - 'title' => 'GetTemplateMaterials', + 'translator' => 'manual', ], - 'GetTemplateParams' => [ - 'summary' => 'Queries the parameters for replaceable materials in a template, including the parameter names, default values, and material thumbnails. Only advanced templates are supported.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDynamicImageJobs' => [ + 'summary' => 'Queries a list of image animation jobs.', + 'methods' => ['get', 'post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], @@ -42836,210 +28437,417 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceDXIJ4D', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateId', + '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' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", + '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' => '****20b48fb04483915d4f2cd8ac****', + '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 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'PlainResponse\\', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '******419c8741c1b4325f035b******', - ], - 'ParamList' => [ - 'description' => 'The queried parameters.'."\n", + '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 template parameters.'."\n", + 'description' => 'The information about an image animation job.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '模板ID', - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'video1', - ], - 'Type' => [ - 'description' => 'The material type.'."\n" + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], + 'TriggerSource' => [ + 'description' => 'The request trigger source.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Video'."\n" - .'* Text'."\n" - .'* Image'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Video' => '', - 'Text' => '', - 'Image' => '', - ], - 'example' => 'Image', - ], - 'CoverUrl' => [ - 'description' => 'The thumbnail URL of the original material.'."\n", - 'type' => 'string', - 'example' => 'https://ice-materials-***.alicdn.com/***/********20221****.jpg', - ], - 'MediaUrl' => [ - 'description' => 'The URL of the original material.'."\n", + .'- Console'."\n" + ."\n" + .'- Workflow'."\n" + ."\n" + .'- API', + 'enumValueTitles' => ['Console' => '', 'Workflow' => '', 'API' => 'API'], 'type' => 'string', - 'example' => 'https://ice-materials-***.alicdn.com/***/********2022111618012453120c2a81*******.mp4', + 'example' => 'API', + 'title' => '', ], - 'Content' => [ - 'description' => 'The original subtitle content.'."\n", - 'type' => 'string', + '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' => '', ], - 'X' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Y' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Width' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Height' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'TimelineIn' => [ - 'type' => 'number', - 'format' => 'float', + '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' => '', ], - 'TimelineOut' => [ - 'type' => 'number', - 'format' => 'float', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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\\": \\"字幕测试\\",\\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"}]', - 'title' => 'GetTemplateParams', - ], - 'DeleteHotwordLibrary' => [ - 'summary' => 'Deletes a specified hotword library based on the ID.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDynamicImageJobs'], + ], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '182100', + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ - 'name' => 'HotwordLibraryId', + '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' => [ - 'title' => '删除热词库Id', - 'description' => 'The ID of the hotword library that you want to delete.'."\n", + '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' => '****cdb3e74639973036bc84****', + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****83B7-7F87-4792-BFE9-63CD2137****', - ], - 'Success' => [ - 'title' => '删除是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'default' => 'true', + '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', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteHotwordLibrary', - 'description' => '## [](#)'."\n" - ."\n" - .'* You can call this operation to delete a specified hotword library.'."\n" - .'* The delete operation is irreversible.'."\n" - .'* You can create up to 100 hotword libraries in an account.'."\n", - ], - 'GetHotwordLibrary' => [ - 'summary' => 'Queries the information about a specified hotword library based on the ID.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -43048,101 +28856,145 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'HotwordLibraryId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'title' => '热词库Id', - 'description' => 'The ID of the hotword library.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****96e8864746a0b6f3****', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****12e8864746a0a398****', - ], - 'HotwordLibraryId' => [ - 'title' => '热词库Id', - 'description' => 'The ID of the hotword library.'."\n", - 'type' => 'string', - 'example' => '****05512043f49f697f7425****', - ], - 'Name' => [ - 'title' => '热词库名称', - 'description' => 'The name of the hotword library.'."\n", - 'type' => 'string', - 'example' => '热词库名称', - ], - 'Description' => [ - 'title' => '热词库描述', - 'description' => 'The description of the hotword library.'."\n", - 'type' => 'string', - 'example' => '热词库描述', - ], - 'Hotwords' => [ - 'title' => '热词列表', - 'description' => 'The hotword list.'."\n", + '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' => [ - 'description' => 'The hotword data.'."\n", - '$ref' => '#/components/schemas/Hotword', + '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' => '', ], - ], - 'UsageScenario' => [ - 'title' => '热词库使用场景', - 'description' => 'The usage scenario of the hotword library.'."\n", - 'type' => 'string', - 'example' => 'ASR', - ], - 'CreationTime' => [ - 'title' => '热词库创建时间', - 'description' => 'The time when the hotword library was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-23T13:33:49Z', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****12e8864746a0a398****\\",\\n \\"HotwordLibraryId\\": \\"****05512043f49f697f7425****\\",\\n \\"Name\\": \\"热词库名称\\",\\n \\"Description\\": \\"热词库描述\\",\\n \\"Hotwords\\": [\\n {\\n \\"TranspositionResultList\\": [\\n {\\n \\"TranslatedText\\": \\"你好\\",\\n \\"TargetLanguage\\": \\"zh\\"\\n }\\n ],\\n \\"Language\\": \\"en\\",\\n \\"Text\\": \\"hello\\",\\n \\"Weight\\": 0\\n }\\n ],\\n \\"UsageScenario\\": \\"ASR\\",\\n \\"CreationTime\\": \\"2020-12-23T13:33:49Z\\"\\n}","type":"json"}]', - 'title' => 'GetHotwordLibrary', + '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" - .'You can call this operation to 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.'."\n", - ], - 'ListHotwordLibraries' => [ - 'summary' => 'Queries hotword libraries that meet specific search conditions.', - 'methods' => [ - 'get', - 'post', + .'- 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' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -43154,1061 +29006,1293 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '238120', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'title' => '当前开始读取的位置', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****73f33c91-d59383e8280b****', - ], + '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' => [ - 'title' => '当前页码。默认值为1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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' => [ - 'title' => '分页大小，每页显示条数。默认值为10，最大值为100。', - 'description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => 'The sorting order. By default, the query results are sorted by creation time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreationTime:Desc', + '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' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the hotword library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '热词库使用名称', + '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' => [ [ - 'name' => 'UsageScenario', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239703', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '词库的使用场景'."\n" - .'● ASR智能文本识别：ASR'."\n" - .'● 结构化媒资：StructuredMediaAssets'."\n" - .'● 视频翻译：VideoTranslation', - 'description' => 'The usage scenario of the hotword library. Valid values:'."\n" - ."\n" - .'* ASR: Automatic Speech Recognition'."\n" - .'* StructuredMediaAssets: structured media analysis'."\n" - .'* VideoTranslation: Video translation. This field cannot be modified after the hotword library is created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASR', - ], + 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'example' => 'channel-group-1', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'title' => '筛选开始时间', - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-12-26T04:11:10Z', - ], + 'schema' => ['description' => 'The channel name or description. Fuzzy match is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'group-1'], ], [ - 'name' => 'EndTime', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '筛选结束时间', - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-12-26T04:11:10Z', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MaxResults', + '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' => [ - 'title' => '本次请求所返回的最大记录条数。'."\n" + 'description' => 'The sort order by creation time. Default value: desc.'."\n" ."\n" - .'最大值：100，默认值：10', - 'description' => 'The maximum number of entries to return.'."\n" + .'Valid values:'."\n" ."\n" - .'Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'- asc'."\n" + ."\n" + .'- desc', + 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], + 'type' => 'string', 'required' => false, - 'example' => '10', + 'example' => 'desc', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', - ], - 'NextToken' => [ - 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', - '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.'."\n", - 'type' => 'string', - 'example' => 'CBB6BC61D08', - ], - 'MaxResults' => [ - 'description' => 'The maximum number of hotword libraries that can be returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of hotword libraries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'HotwordLibraryList' => [ - 'description' => 'The hotword libraries.'."\n", + 'LivePackageChannels' => [ + 'title' => '', + 'description' => 'The live package channels.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'LivePackageChannelItemType', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The description of the hotword library. It can be up to 200 characters in length.'."\n", - 'type' => 'string', + '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' => '', ], - 'UsageScenario' => [ - 'description' => 'The usage scenario of the hotword library. Valid values:'."\n" - ."\n" - .'* ASR: Automatic Speech Recognition'."\n" - .'* StructuredMediaAssets: structured media analysis'."\n" - .'* VideoTranslation: Video translation This field cannot be modified after the hotword library is created.'."\n", - 'type' => 'string', - 'example' => 'ASR', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the hotword library was last modified.'."\n", - 'type' => 'string', - 'example' => '2017-01-11T12:00:00Z'."\n", - ], - 'CreationTime' => [ - 'description' => 'The time when the hotword library was created.'."\n", - 'type' => 'string', - 'example' => '2017-01-11T12:00:00Z', - ], - 'HotwordLibraryId' => [ - 'description' => 'The ID of the hotword library.'."\n", - 'type' => 'string', - 'example' => 'a93b91141c0f422fa114af203f8b****', - ], - 'Name' => [ - 'description' => 'The name of the hotword library.'."\n", - 'type' => 'string', - 'example' => 'my_hotwords', - ], + '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'], ], - 'description' => '', + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"NextToken\\": \\"CBB6BC61D08\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 20,\\n \\"HotwordLibraryList\\": [\\n {\\n \\"Description\\": \\"存放名人的词库\\",\\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" + '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" - .'* You can call this operation to get information about all hotword libraries that you created.'."\n" - .'* The API supports fuzzy search by `Name`, filtering by creation time range, and pagination.'."\n" - .'* By default, the results are sorted by creation time in descending order. You can set `SortBy` to change the sorting order.'."\n" - .'* The maximum number of entries returned for each request is 100. Default value: 10.'."\n" - .'* Use `NextToken` for pagination.'."\n", - ], - 'UpdateHotwordLibrary' => [ - 'summary' => 'Modifies a specified hotword library, including its name, description, and hotword list.', - 'methods' => [ - 'get', - 'post', + .'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' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '239774', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '词库名称，长度上限100', - 'description' => 'The name of the hotword library. It can be up to 100 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_hotwords', - ], + 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-group-1'], ], [ - 'name' => 'Description', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'title' => '描述，长度上限200', - 'description' => 'The description of the hotword library. It can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '存放名人的词库', - ], + 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ - 'name' => 'Hotwords', + 'name' => 'Keyword', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '热词列表，长度上限300', - 'description' => 'The hotword list. You can add up to 300 hotword entries to a single library.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '热词信息', - 'description' => 'The hotword information.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Hotword', - ], - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The endpoint name or description. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'endpoint-', 'title' => ''], ], [ - 'name' => 'HotwordLibraryId', + '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 ID of the hotword library.'."\n", + 'description' => 'The sort order by creation time. Valid values: asc and desc (default).', + 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], 'type' => 'string', - 'required' => true, - 'example' => '*a0052ff71efbfd4e7e6c66*', + 'required' => false, + 'example' => 'desc', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '*3B-0E1A-586A-AC29-742247*', - ], - 'Success' => [ - 'title' => '热词库Id', - 'description' => 'The ID of the hotword library.'."\n", - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****', + '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 \\"RequestId\\": \\"*3B-0E1A-586A-AC29-742247*\\",\\n \\"Success\\": \\"****96e8864746a0b6f3****\\"\\n}","type":"json"}]', - 'title' => 'UpdateHotwordLibrary', - 'description' => '## [](#)'."\n" + '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" - .'* You can call this operation to modify a specified hotword library.'."\n" - .'* The hotword library ID (`HotwordLibraryId`) is required to identify the library that requires modification.'."\n" - .'* You can modify its name (`Name` ), description (`Description` ), and hotword list (`HotWords`).'."\n" - .'* Each hotword in the list can also be modified, including its content (`Text`), weight (`Weight`), language (`Language`), and translation results (`TranspositionResultList`).'."\n" - .'* A single account supports up to 100 hotword libraries, each containing a maximum of 300 hotword entries. In a library, the combination of `language` and `text` of an entry must be unique. The combination of `TranslatedText` and `TargetLanguage` in `TranspositionResultList` must also be unique.'."\n", - ], - 'CreateHotwordLibrary' => [ - 'summary' => 'Creates a hotword library.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + .'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' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '词库名称，长度上限100', - 'description' => 'The name of the hotword library. It can be up to 100 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_hotwords', - ], + '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' => 'Description', + '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' => [ - 'title' => '描述，长度上限200', - 'description' => 'The description of the hotword library. It can be up to 200 characters in length.'."\n", - 'type' => 'string', + '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, - 'example' => '存放名人的词库', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UsageScenario', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '词库的使用场景'."\n" - .'● ASR智能文本识别：ASR'."\n" - .'● 结构化媒资：StructuredMediaAssets'."\n" - .'● 视频翻译：VideoTranslation'."\n" - .'词库一旦新增后，该字段不可修改', - '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ASR', - ], + 'schema' => ['description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Hotwords', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '热词列表，长度上限300', - 'description' => 'The hotword list. You can add up to 300 hotword entries to a single library.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '热词信息', - 'description' => 'The hotword information.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Hotword', - ], - 'required' => true, - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '13cbb83e-043c-4728-ac35-*****', - ], - 'HotwordLibraryId' => [ - 'title' => '热词库Id', - 'description' => 'The ID of the hotword library.'."\n", - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\",\\n \\"HotwordLibraryId\\": \\"****96e8864746a0b6f3****\\"\\n}","type":"json"}]', - 'title' => 'CreateHotwordLibrary', - ], - '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', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AvatarName', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '* The name of the digital human.'."\n" - .'* The name can be up to seven characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - 'maxLength' => 7, - ], + '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' => 'AvatarDescription', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '* The description of the digital human.'."\n" - .'* The description can be up to 1,000 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 1027, - ], + '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' => 'AvatarType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the digital human.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2DAvatar', - ], + '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' => 'Thumbnail', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => '* The thumbnail URL.'."\n" - .'* After the digital human is trained, the thumbnail is uploaded to this URL.'."\n" - .'* The URL must be a valid public Object Storage Service (OSS) URL.'."\n" - .'* The URL can be up to 512 characters in length.'."\n", + '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' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', - 'maxLength' => 512, + 'example' => 'started', + 'title' => '', ], ], [ - 'name' => 'Portrait', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '* The media asset ID of the portrait image.'."\n" - .'* The value must be 32 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****571c704445f9a0ee011406c2****', - 'maxLength' => 32, - 'minLength' => 32, - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Video', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '* The ID of the video used for training.'."\n" - .'* The value must be 32 characters in length.'."\n" - .'* Supported formats: MP4, MOV, and WebM.'."\n" - .'* The duration of the video must be 5 to 15 minutes.'."\n" - .'* The resolution of the video must be 1920×1080 or 1080×1920.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****571c704445f9a0ee011406c2****', - 'maxLength' => 32, - 'minLength' => 32, - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Transparent', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => '* Specifies whether the training video supports alpha channels.'."\n" + 'description' => 'The sorting order. By default, the query results are sorted by creation time in descending order.'."\n" ."\n" - .' **'."\n" + .'Valid values:'."\n" ."\n" - .' **Note**: Make sure that the current settings are consistent with those of the submitted training video. Otherwise, the digital human may malfunction.'."\n", - 'type' => 'boolean', + .'- 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' => 'True', + 'example' => 'desc', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the digital human training job.'."\n", - 'type' => 'string', - 'example' => '****d718e2ff4f018ccf419a7b71****', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateAvatarTrainingJob', - ], - 'UpdateAvatarTrainingJob' => [ - 'summary' => 'Modifies a digital human training job. You can modify the basic information or update parameters such as Video and Transparent for retraining if the training failed.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordJobs'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the digital human training job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****cdb3e74639973036bc84****', - ], + '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' => 'AvatarName', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => '* The name of the digital human.'."\n" - .'* The name can be up to seven characters in length.'."\n", + 'description' => 'The template type.', + 'enumValueTitles' => ['system' => 'System-defined', 'custom' => 'Custom'], 'type' => 'string', 'required' => false, - 'example' => '', - 'maxLength' => 7, + 'example' => 'custom', + 'title' => '', ], ], [ - 'name' => 'AvatarDescription', + 'name' => 'TemplateIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '* The description of the digital human.'."\n" - .'* The description can be up to 1,000 characters in length.'."\n", - 'type' => 'string', + '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' => '', - 'maxLength' => 1024, ], ], [ - 'name' => 'Thumbnail', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '* The thumbnail URL.'."\n" - .'* After the digital human is trained, the thumbnail is uploaded to this URL.'."\n" - .'* The URL must be a valid public Object Storage Service (OSS) URL.'."\n" - .'* The URL can be up to 512 characters in length.'."\n" - .'* The URL cannot be updated after the digital human is trained.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', - 'maxLength' => 512, - ], + 'schema' => ['description' => 'The page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Portrait', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '* The media asset ID of the portrait image.'."\n" - .'* The value must be 32 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****571c704445f9a0ee011406c2****', - 'maxLength' => 32, - 'minLength' => 32, - ], + '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' => 'Video', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => '* The ID of the video used for training.'."\n" - .'* The value must be 32 characters in length.'."\n" - .'* Supported formats: MP4, MOV, and WebM.'."\n" - .'* The duration of the video must be 5 to 15 minutes.'."\n" - .'* The resolution of the video must be 1920×1080 or 1080×1920.'."\n", + 'description' => 'The sort order. The default sort is descending by creation time.', + 'enumValueTitles' => ['asc' => 'Ascending', 'desc' => 'Descending (default)'], 'type' => 'string', 'required' => false, - 'example' => '****571c704445f9a0ee011406c2****', - 'maxLength' => 32, - 'minLength' => 32, - ], - ], - [ - 'name' => 'Transparent', - 'in' => 'query', - 'schema' => [ - 'description' => '* Indicates whether the input video supports alpha channels.'."\n" - ."\n" - .'* You can modify this parameter only if the job is in the Init or Fail state.'."\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.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', + 'example' => 'desc', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the digital human training job.'."\n", - 'type' => 'string', - 'example' => '****d718e2ff4f018ccf419a7b71****', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpdateAvatarTrainingJob', - ], - 'SubmitAvatarTrainingJob' => [ - 'summary' => 'Submits a digital human training job. You can call this operation to submit a job the first time or submit a job again with updated parameters if the training failed.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordTemplates'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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 ID of the digital human training job.'."\n", + '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', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', + 'title' => '', + 'required' => false, + 'example' => 'desc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the digital human training job.'."\n", - 'type' => 'string', - 'example' => '****29faef8144638ba42eb8e037****', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****29faef8144638ba42eb8e037****\\"\\n }\\n}","type":"json"}]', - 'title' => 'SubmitAvatarTrainingJob', - ], - 'GetAvatarTrainingJob' => [ - 'summary' => 'Queries the information about a digital human training job.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobId', + '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 ID of the digital human training job.'."\n", + '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', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned by the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Data' => [ - 'description' => 'The data returned if the request was successful.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvatarTrainingJob' => [ - 'description' => 'The information about the digital human training job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the digital human training job.'."\n", - 'type' => 'string', - 'example' => '****55d86f7f4587943ce7734d6b****', - ], - 'AvatarId' => [ - 'description' => 'The ID of the digital human.'."\n", - 'type' => 'string', - 'example' => 'Avatar-XXXX', - ], - 'AvatarName' => [ - 'description' => 'The name of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarDescription' => [ - 'description' => 'The description of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarType' => [ - 'description' => 'The type of the digital human.'."\n", - 'type' => 'string', - 'example' => '2DAvatar', - ], - 'Status' => [ - 'description' => '* The state of the digital human training job.'."\n" - .'* Valid values: Init, Queuing, Training, Success, and Fail.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The status description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Thumbnail' => [ - 'description' => 'The thumbnail URL.'."\n", - 'type' => 'string', - 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', - ], - 'Portrait' => [ - 'description' => 'The media asset ID of the portrait image.'."\n", - 'type' => 'string', - 'example' => '****571c704445f9a0ee011406c2****', - ], - 'Video' => [ - 'description' => 'The ID of the video used for training.'."\n", - 'type' => 'string', - 'example' => '****571c704445f9a0ee011406c2****', - ], - 'Transparent' => [ - 'description' => 'Indicates whether the input video supports alpha channels.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FirstTrainingTime' => [ - 'description' => '* The time when the first training was initiated.'."\n" - .'* 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' => '2020-12-23T13:33:40Z', - ], - 'LastTrainingTime' => [ - 'description' => '* The time when the last training was initiated.'."\n" - .'* 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' => '2020-12-23T13:33:40Z', + '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' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"Data\\": {\\n \\"AvatarTrainingJob\\": {\\n \\"JobId\\": \\"****55d86f7f4587943ce7734d6b****\\",\\n \\"AvatarId\\": \\"Avatar-XXXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Status\\": \\"Success\\\\n\\",\\n \\"Message\\": \\"训练成功\\",\\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', - ], - 'DeleteAvatarTrainingJob' => [ - 'summary' => 'Deletes a digital human training job that is in the Init or Fail state.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobId', + '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 ID of the digital human training job.'."\n", + 'description' => 'The type of the template. By default, templates of all types are queried.', + 'enumValueTitles' => ['system' => 'System template', 'custom' => 'Custom template'], 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the digital human training job.'."\n", - 'type' => 'string', - 'example' => '****d718e2ff4f018ccf419a7b71****', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', - 'title' => 'DeleteAvatarTrainingJob', - ], - 'ListAvatarTrainingJobs' => [ - 'summary' => 'Queries a list of digital human training jobs.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -44216,174 +30300,192 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PageNo', + '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', - 'allowEmptyValue' => false, 'schema' => [ - 'description' => '* The page number.'."\n" - .'* Default value: 1.'."\n", + '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' => '1', - 'default' => '1', + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => '* The number of entries per page.'."\n" - .'* Default value: 10.'."\n" - .'* Valid values: 1 to 100.'."\n", + '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, - 'maximum' => '100', - 'example' => '10', - 'default' => '10', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'Status', + '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 job state.'."\n" - .'* Valid values: Init, Queuing, Training, Success, and Fail.'."\n", + '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' => 'Success', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvatarTrainingJobList' => [ - 'description' => 'The list of digital human training jobs.'."\n", - 'type' => 'array', - 'items' => [ + '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' => [ - 'JobId' => [ - 'description' => 'The ID of the digital human training job.'."\n", - 'type' => 'string', - 'example' => '*****aded114489ea02e0addf93*****', - ], - 'AvatarId' => [ - 'description' => 'The ID of the digital human.'."\n", - 'type' => 'string', - 'example' => 'Avatar-XXX', - ], - 'AvatarName' => [ - 'description' => 'The name of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarDescription' => [ - 'description' => 'The description of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarType' => [ - 'description' => 'The type of the digital human.'."\n", - 'type' => 'string', - 'example' => '2DAvatar', - ], - 'Status' => [ - 'description' => 'The state of the digital human training job.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Message' => [ - 'description' => 'The status description.'."\n", - 'type' => 'string', + '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' => '', ], - 'Portrait' => [ - 'description' => 'The media asset ID of the portrait image.'."\n", - 'type' => 'string', - 'example' => '*****aded114489ea02e0addf93*****', - ], - 'FirstTrainingTime' => [ - 'description' => '* The time when the first training was initiated.'."\n" - .'* 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' => '2020-12-23T13:33:40Z', - ], - 'LastTrainingTime' => [ - 'description' => '* The time when the last training was initiated.'."\n" - .'* 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' => '2020-12-23T13:33:40Z', - ], - 'CreateTime' => [ - 'description' => '* The time when the job was created.'."\n" - .'* 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' => '2020-12-23T13:33:40Z', - ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'CreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2022-07-20T02:48:58Z', 'title' => ''], ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"AvatarTrainingJobList\\": [\\n {\\n \\"JobId\\": \\"*****aded114489ea02e0addf93*****\\",\\n \\"AvatarId\\": \\"Avatar-XXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"训练成功\\",\\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', - ], - 'GetAvatar' => [ - 'summary' => 'Queries the information about a trained digital human.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveTranscodeJobs'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -44391,123 +30493,196 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AvatarId', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => '* The ID of the digital human.'."\n", + '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, - 'example' => 'Avatar-XXXX', + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Avatar' => [ - 'description' => 'The information about the digital human.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvatarId' => [ - 'description' => 'The ID of the digital human.'."\n", - 'type' => 'string', - 'example' => 'Avatar-XXXX', - ], - 'AvatarName' => [ - 'description' => 'The name of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarDescription' => [ - 'description' => 'The description of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarType' => [ - 'description' => 'The type of the digital human.'."\n", - 'type' => 'string', - 'example' => '2DAvatar', - ], - 'Thumbnail' => [ - 'description' => 'The thumbnail URL.'."\n", - 'type' => 'string', - 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', - ], - 'Portrait' => [ - 'description' => 'The media asset ID of the portrait image.'."\n", - 'type' => 'string', - 'example' => '****571c704445f9a0ee011406c2****', - ], - 'Transparent' => [ - 'description' => 'Indicates whether the digital human supports alpha channels.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Width' => [ - 'description' => 'The width of the digital human image in pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1080', - ], - 'Height' => [ - 'description' => 'The height of the digital human image in pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1920', + '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' => '', ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"Avatar\\": {\\n \\"AvatarId\\": \\"Avatar-XXXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\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', - ], - 'ListAvatars' => [ - 'summary' => 'Queries a list of trained digital humans.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveTranscodeTemplates'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -44516,297 +30691,367 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'StartTime', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '* The page number.'."\n" - .'* Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + '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' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '* The number of entries per page.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'example' => '10', - 'default' => '10', - ], + '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' => 'AvatarType', + 'name' => 'MediaType', 'in' => 'query', - 'schema' => [ - 'description' => '* The type of the digital human.'."\n" - .'* 2DAvatar'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2DAvatar', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvatarList' => [ - 'description' => 'The queried digital humans.'."\n", - 'type' => 'array', - 'items' => [ + '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' => [ - 'AvatarId' => [ - 'description' => 'The ID of the digital human.'."\n", - 'type' => 'string', - 'example' => 'Avatar-XXX', - ], - 'AvatarName' => [ - 'description' => 'The name of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarDescription' => [ - 'description' => 'The description of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarType' => [ - 'description' => 'The type of the digital human.'."\n", - 'type' => 'string', - 'example' => '2DAvatar', - ], - 'Thumbnail' => [ - 'description' => 'The thumbnail URL.'."\n", - 'type' => 'string', - 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', - ], - 'Portrait' => [ - 'description' => 'The media asset ID of the portrait image.'."\n", - 'type' => 'string', - 'example' => '****571c704445f9a0ee011406c2****', - ], - 'Transparent' => [ - 'description' => 'Indicates whether the digital human image supports the alpha channels.'."\n", - 'type' => 'boolean', - 'example' => 'true', + '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' => '', ], - 'description' => '', + 'example' => '', ], ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'description' => 'The information about the media asset.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"AvatarList\\": [\\n {\\n \\"AvatarId\\": \\"Avatar-XXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\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', - ], - 'CreateCustomizedVoiceJob' => [ - 'summary' => 'Creates a human voice cloning job. You can configure the basic information of the human voice cloning job.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaBasicInfos'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceHPAMBQ', 'FEATUREice5MI8QL', 'FEATUREiceCJ90B2', 'FEATUREice6MQPM7'], ], 'parameters' => [ [ - 'name' => 'VoiceId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The voice ID. It can be the English name or Chinese Pinyin of the voice.'."\n" - ."\n" - .'* The value must be a unique ID that is not used by other custom voices.'."\n" - .'* The ID can be up to 32 characters in length.'."\n" - .'* Only letters and digits are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xiaozhuan', - 'maxLength' => 32, - 'minLength' => 0, - ], + 'schema' => ['description' => 'Filters the results by job ID.', 'type' => 'string', 'required' => false, 'example' => '88c6ca184c0e47098a5b665e2****', 'title' => ''], ], [ - 'name' => 'VoiceName', + 'name' => 'StartOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The voice name.'."\n" - ."\n" - .'* The name can be up to 32 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 32, - 'minLength' => 0, - ], + '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' => 'VoiceDesc', + 'name' => 'EndOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The voice description.'."\n" - ."\n" - .'* The description can be up to 256 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 256, - 'minLength' => 0, - ], + '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' => 'Gender', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The gender. Valid values:'."\n" - ."\n" - .'* female'."\n" - .'* male'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'female', - 'enum' => [ - 'female', - 'male', - ], - ], + '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' => 'Scenario', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The scenario. Valid values:'."\n" - ."\n" - .'* story'."\n" - .'* interaction'."\n" - .'* navigation'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'story', - 'enum' => [ - 'story', - 'interaction', - 'navigation', - ], - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'VoiceId' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'example' => 'xiaozhuan', - ], - 'JobId' => [ - 'description' => 'The ID of the human voice cloning job.'."\n", - 'type' => 'string', - 'example' => '****29faef8144638ba42eb8e037****', - ], - ], + '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 \\"Success\\": true,\\n \\"Data\\": {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"JobId\\": \\"****29faef8144638ba42eb8e037****\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateCustomizedVoiceJob', - ], - 'GetDemonstrationForCustomizedVoiceJob' => [ - 'summary' => 'Queries the text to be read and sample audio for training a personalized human voice.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -44814,461 +31059,736 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Scenario', + 'name' => 'StartOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The demonstration scenario.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **story**'."\n" - .'* **interaction**'."\n" - .'* **navigation**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'story', - 'enum' => [ - 'story', - 'interaction', - 'navigation', - ], - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'DemonstrationList' => [ - 'description' => 'A list of 20 text entries to be read and the corresponding sample audio.'."\n", - 'type' => 'array', - 'items' => [ + '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' => [ - '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.'."\n", - 'type' => 'string', - 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/1.wav', + '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' => '', ], - 'Text' => [ - 'description' => 'The text content to be read.'."\n", - 'type' => 'string', + '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' => '', ], - 'AudioId' => [ - 'description' => 'The sequence number of the text, which corresponds to the AduioRecordId parameter to be passed during audio check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + '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' => '', ], ], - 'description' => '', + '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' => '', ], ], - [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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\\": \\"不行，他想了一下，我不能这样对国王说，这是在撒谎。\\",\\n \\"AudioId\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDemonstrationForCustomizedVoiceJob', - ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaInfoJobs'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'VoiceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xiaozhuan', - ], + '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' => '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/record1.wav', - ], + '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' => 'AudioRecordId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sequence number of the recording file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Pass' => [ - 'description' => 'Indicates whether the audio file passes the check. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Reason' => [ - 'description' => 'The reason returned if the audio file failed to pass the check.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - ], + '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' => ''], ], - ], - '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', - ], - 'SubmitCustomizedVoiceJob' => [ - 'summary' => 'Submits a basic voice cloning job.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + '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' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'VoiceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xiaozhuan', - 'maxLength' => 32, - 'minLength' => 0, - ], + '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' => 'DemoAudioMediaURL', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the sample audio file.'."\n" - ."\n" - .'* If this parameter is specified, a sample audio file is generated at the specified Object Storage Service (OSS) URL after the training is complete.'."\n" - ."\n" - .'* If this parameter is not specified, no sample audio file is generated.'."\n" - ."\n" - .' **'."\n" - ."\n" - .' **Note**: The URL must be a valid public OSS URL within your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://your-bucket.oss-cn-shanghai.aliyuncs.com/demo.MP3', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the human voice cloning job.'."\n", - 'type' => 'string', - 'example' => '****d718e2ff4f018ccf419a7b71****', - ], - 'VoiceId' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'example' => 'xiaozhuan', + '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', + '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'], ], - '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', - ], - 'SubmitStandardCustomizedVoiceJob' => [ - 'summary' => 'Submits a standard human voice cloning job. After you call this operation, the JobId is returned. The training process is asynchronous. During training, you can call the GetCustomizedVoiceJob operation to query information such as the job state.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaLiveChannels'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'VoiceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The voice name.'."\n" - ."\n" - .'* The name can be up to 32 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'Gender', - 'in' => 'query', - 'schema' => [ - 'description' => 'The gender. Valid values:'."\n" - ."\n" - .'* female'."\n" - .'* male'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'female', - ], + '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' => 'Authentication', - 'in' => 'query', - 'schema' => [ - 'description' => '* The media asset ID of the authentication audio.'."\n" - ."\n" - .'* Upload an audio file for identity authentication. If the voiceprint extracted from the uploaded file differs from that of the training file, the job fails.'."\n" - ."\n" - .' **'."\n" - ."\n" - .' **Note**: Clearly read and record the following text: I confirm to customize human voice cloning and provide audio files that contain my voice for training. I promise that I am responsible for the customized content and that the content complies with laws and regulations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****571c704445f9a0ee011406c2****', - ], + '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' => 'Audios', - 'in' => 'query', - 'schema' => [ - 'description' => '* The material assets IDs of the materials for training.'."\n" - .'* Separate multiple media IDs with commas (,).'."\n" - ."\n" - .'> : The total duration of all materials must be within 15 to 30 minutes. The duration of each material must be greater than 1 minute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****571c704445f9a0ee011406c2****,****571c704445f9a0ee011406c2****,****571c704445f9a0ee011406c2****', - ], + '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' => 'DemoAudioMediaURL', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the sample audio file.'."\n" - ."\n" - .'* If this parameter is specified, a sample audio file is generated at the specified Object Storage Service (OSS) URL after the training is complete.'."\n" - ."\n" - .'* If this parameter is not specified, no sample audio file is generated.'."\n" - ."\n" - .' **'."\n" - ."\n" - .' **Note**: The URL must be a valid public OSS URL within your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://your-bucket.oss-cn-shanghai.aliyuncs.com/demo.mp3', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the human voice cloning job.'."\n", - 'type' => 'string', - 'example' => '****d718e2ff4f018ccf419a7b71****', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ****63E8B7C7-4812-46AD-0FA56029AC86****\\n true\\n \\n ****d718e2ff4f018ccf419a7b71****\\n \\n","errorExample":""}]', - 'title' => 'SubmitStandardCustomizedVoiceJob', - ], - 'GetCustomizedVoiceJob' => [ - 'summary' => 'Queries the information about a human voice cloning job.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -45277,207 +31797,241 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the human voice cloning job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Data' => [ - 'description' => 'The data returned if the request was successful.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomizedVoiceJob' => [ - 'description' => 'The information about the human voice cloning job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the human voice cloning job.'."\n", - 'type' => 'string', - 'example' => '****571c704445f9a0ee011406c2****', - ], - 'VoiceId' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'example' => 'xiaozhuan', - ], - 'Status' => [ - 'description' => 'The job state. Valid values:'."\n" - ."\n" - .'* Initialization'."\n" - .'* AudioDetecting'."\n" - .'* PreTraining'."\n" - .'* Training'."\n" - .'* Success'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'example' => 'Fail', - ], - 'Message' => [ - 'description' => 'The status description.'."\n", - 'type' => 'string', + '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' => '', ], - 'Type' => [ - 'description' => 'The type of the human voice cloning job. Valid values:'."\n" - ."\n" - .'* Basic'."\n" - .'* Standard'."\n", - 'type' => 'string', - 'example' => 'Standard', - ], - 'VoiceName' => [ - 'description' => 'The voice name.'."\n", - 'type' => 'string', - 'example' => 'Xiaozhuan'."\n", - ], - 'VoiceDesc' => [ - 'description' => 'The voice description.'."\n", - 'type' => 'string', - 'example' => 'This is an exclusive voice'."\n", - ], - 'Scenario' => [ - 'description' => 'The scenario. Valid values:'."\n" - ."\n" - .'* story'."\n" - .'* interaction'."\n" - .'* navigation'."\n", - 'type' => 'string', - 'example' => 'story', - ], - 'Gender' => [ - 'description' => 'The gender. Valid values:'."\n" - ."\n" - .'* female'."\n" - .'* male'."\n", - 'type' => 'string', - 'example' => 'female', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2023-06-07T02:27:08Z', - ], + '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' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"CustomizedVoiceJob\\": {\\n \\"JobId\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"Status\\": \\"Fail\\",\\n \\"Message\\": \\"训练失败\\",\\n \\"Type\\": \\"Standard\\",\\n \\"VoiceName\\": \\"小专\\",\\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', - ], - 'DeleteCustomizedVoiceJob' => [ - 'summary' => 'Deletes a human voice cloning job that is not in the Training or Success state.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaLiveInputs'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the human voice cloning job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteCustomizedVoiceJob', - ], - 'ListCustomizedVoiceJobs' => [ - 'summary' => 'Queries a list of human voice cloning jobs.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaMarks'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -45489,379 +32043,183 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '12624', + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + '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' => '10', + 'example' => 'Success', ], ], [ - 'name' => 'Type', + 'name' => 'JobType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the human voice cloning job. Valid values:'."\n" + 'description' => 'The job type.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'* Basic'."\n" - .'* Standard'."\n" + .'- LiveEditingJob: live editing job.'."\n" ."\n" - .'> : If you do not specify this parameter, the default value Basic is used.'."\n", + .'- EditingJob: regular template-based editing job'."\n" + ."\n" + .'- VETemplateJob: advanced template-based editing job.', + 'enumValueTitles' => ['LiveEditingJob' => '', 'EditingJob' => '', 'VETemplateJob' => ''], 'type' => 'string', 'required' => false, - 'example' => 'Standard', - 'enum' => [ - 'Basic', - 'Standard', - 'Premium', - ], + 'example' => 'EditingJob', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomizedVoiceJobList' => [ - 'description' => 'The queried human voice cloning jobs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried human voice cloning job.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the human voice cloning job.'."\n", - 'type' => 'string', - 'example' => '2245ab99a7fd4116a4fd3f499b7a56c5', - ], - 'VoiceId' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'example' => 'xiaozhuan', - ], - 'Status' => [ - 'description' => 'The job state. Valid values:'."\n" - ."\n" - .'* Initialization'."\n" - .'* AudioDetecting'."\n" - .'* PreTraining'."\n" - .'* Training'."\n" - .'* Success'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'VoiceName' => [ - 'description' => 'The voice name.'."\n" - ."\n" - .'* The name can be up to 32 characters in length.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'VoiceDesc' => [ - 'description' => 'The voice description.'."\n" - ."\n" - .'* The description can be up to 256 characters in length.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => '* The voice type. Valid values:'."\n" - ."\n" - .' * Basic'."\n" - .' * Standard'."\n", - 'type' => 'string', - 'example' => 'Standard', - ], - 'Gender' => [ - 'description' => 'The gender. Valid values:'."\n" - ."\n" - .'* female'."\n" - .'* male'."\n", - 'type' => 'string', - 'example' => 'female', - ], - 'Scenario' => [ - 'description' => 'The scenario. Valid values:'."\n" - ."\n" - .'* story'."\n" - .'* interaction'."\n" - .'* navigation'."\n", - 'type' => 'string', - 'example' => 'story', - ], - 'CreateTime' => [ - 'description' => '* The time when the job was created.'."\n" - .'* 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' => '2023-04-01T06:23:59Z', - ], - 'GmtCreate' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-06-27T02:42:28Z', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '271', - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + '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' => ''], ], - ], - '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\\": \\"训练成功\\",\\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', - ], - 'GetCustomizedVoice' => [ - 'summary' => 'Queries the information about a personalized human voice.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + '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' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'VoiceId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xiaozhuan', - ], + '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' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomizedVoice' => [ - 'description' => 'The personalized human voice.'."\n", - 'type' => 'object', - 'properties' => [ - 'VoiceId' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'example' => 'xiaozhuan', - ], - 'VoiceName' => [ - 'description' => 'The voice name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'VoiceDesc' => [ - 'description' => 'The voice description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Gender' => [ - 'description' => 'The gender. Valid values:'."\n" - ."\n" - .'* female'."\n" - .'* male'."\n", - 'type' => 'string', - 'example' => 'female', - ], - 'Scenario' => [ - 'description' => 'The demonstration scenario.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **story**'."\n" - .'* **interaction**'."\n" - .'* **navigation**'."\n", - 'type' => 'string', - 'example' => 'interaction', - ], - 'DemoAudioMediaId' => [ - 'description' => 'The media asset ID of the sample audio file.'."\n", - 'type' => 'string', - 'example' => '****42d3c312402982be65975f5b****', - ], - ], - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the online editing project.', 'type' => 'string', 'required' => false, 'example' => '******927cfb53d05b96c1bfe1******', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"CustomizedVoice\\": {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"VoiceName\\": \\"小专\\",\\n \\"VoiceDesc\\": \\"这是一个个性化人声\\",\\n \\"Gender\\": \\"female\\",\\n \\"Scenario\\": \\"interaction\\",\\n \\"DemoAudioMediaId\\": \\"****42d3c312402982be65975f5b****\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetCustomizedVoice', - ], - 'UpdateCustomizedVoice' => [ - 'summary' => 'Updates a personalized human voice. Only the media asset ID of the sample audio file can be modified.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + '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' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'VoiceId', + '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 voice ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xiaozhuan', - ], + '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' => 'DemoAudioMediaId', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => 'The media asset ID of the sample audio file.'."\n", + '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' => '****4d5e829d498aaf966b119348****', + 'example' => 'CreationTime:Desc', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateCustomizedVoice', - ], - 'ListCustomizedVoices' => [ - 'summary' => 'Queries a list of personalized human voices.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaProducingJobs'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -45869,320 +32227,296 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Type', + 'name' => 'StartOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => '* The voice type. Valid values:'."\n" - ."\n" - .' * Basic'."\n" - .' * Standard'."\n" - ."\n" - .'* If you do not specify this parameter, the default value Basic is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Standard', - ], + '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' => 'PageNo', + 'name' => 'EndOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + '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. Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", + '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' => [ - 'CustomizedVoiceList' => [ - 'description' => 'The queried personalized human voices.'."\n", + 'PackageJobs' => [ + 'description' => 'The list of packaging jobs.', 'type' => 'array', 'items' => [ - 'description' => 'The personalized human voice.'."\n", + 'description' => 'The packaging job.', 'type' => 'object', 'properties' => [ - 'VoiceId' => [ - 'description' => 'The voice ID.'."\n", - 'type' => 'string', - 'example' => 'xiaozhuan', - ], - 'VoiceName' => [ - 'description' => 'The voice name.'."\n", - 'type' => 'string', + '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' => '', ], - 'VoiceDesc' => [ - 'description' => 'The voice description.'."\n", - 'type' => 'string', + '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' => '', ], - 'Gender' => [ - 'description' => 'The gender. Valid values:'."\n" - ."\n" - .'* female'."\n" - .'* male'."\n", - 'type' => 'string', - 'example' => 'male', - ], - 'Scenario' => [ - 'description' => 'The scenario. Valid values:'."\n" - ."\n" - .'* story'."\n" - .'* interaction'."\n" - .'* navigation'."\n", - 'type' => 'string', - 'example' => 'story', - ], - 'DemoAudioMediaId' => [ - 'description' => 'The media asset ID of the sample audio file.'."\n", - 'type' => 'string', - 'example' => '****4d5e829d498aaf966b119348****', - ], - 'Type' => [ - 'description' => '* The voice type. Valid values:'."\n" - ."\n" - .' * Basic'."\n" - .' * Standard'."\n", - 'type' => 'string', - 'example' => 'Standard', - ], - ], + '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' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '41', - ], + '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' => ''], ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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', - ], - 'SubmitASRJob' => [ - 'summary' => 'Submits an automatic speech recognition (ASR) job to extract the start and end time and the corresponding text information of a speech in a video.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPackageJobs'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InputFile', - 'in' => 'query', - 'schema' => [ - 'title' => '输入配置，支持OSS地址和内容库素材ID', - 'description' => 'The input file. You can specify an Object Storage Service (OSS) URL or the ID of a media asset in the media asset library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ****20b48fb04483915d4f2cd8ac****', - ], - ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义设置，为JSON字符串', - 'description' => 'The user-defined data in the JSON format. You can specify your business information, such as the business environment and job information.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "user": "data",'."\n" - .' "env": "prod"'."\n" - .'}', - ], - ], - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'title' => '任务标题', - 'description' => 'The job title, which can be up to 128 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '测试标题', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '任务描述', - 'description' => 'The job description, which can up to 128 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '测试描述', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => 'The start time of the speech to recognize.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00', - ], - ], - [ - 'name' => 'Duration', + 'name' => 'Speed', 'in' => 'query', 'schema' => [ - 'title' => '持续时间', - 'description' => 'The speech duration.'."\n", + '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' => '00:00:10', - ], - ], - [ - 'name' => 'EditingConfig', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'example' => 'Standard', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'title' => '智能任务Id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'State' => [ - 'title' => '任务状态', - 'description' => 'The job state. Valid values:'."\n" - ."\n" - .'* Created'."\n" - .'* Executing'."\n" - .'* Finished'."\n" - .'* Failed'."\n", - 'type' => 'string', - 'example' => 'Finished', + '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"State\\": \\"Finished\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n ****20b48fb04483915d4f2cd8ac****\\n Finished\\n","errorExample":""}]', - 'title' => 'SubmitASRJob', - 'responseParamsDescription' => 'You can call the [GetSmartHandleJob](~~441172~~) operation to query the execution details of an ASR job. The following example shows the result returned by the [GetSmartHandleJob](~~441172~~) operation for a successful job.'."\n" - ."\n" - .' {'."\n" - .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" - .' "JobResult": {'."\n" - .' "AiResult": "[{\\"content\\":\\"Talking about\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"he is now incredibly popular\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"Although ticket prices are high\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"his shows often sell out instantly\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"In addition, he frequently appears on various comedy programs, where he judges performances by new comedians\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" - .' },'."\n" - .' "State": "Finished",'."\n" - .' "Output": "[{\\"content\\":\\"Talking about\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"he is now incredibly popular\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"Although ticket prices are high\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"his shows often sell out instantly\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"In addition, he frequently appears on various comedy programs, where he judges performances by new comedians\\",\\"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" - .' }', - ], - 'SubmitAvatarVideoJob' => [ - 'summary' => 'Submits a task to render a video of an avatar speaking the content of the specified text or a human voice audio file.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -46191,1045 +32525,756 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InputConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The input configurations of the video rendering task for an avatar. You can specify text, the Object Storage Service (OSS) URL of an audio file, or the ID of a media asset. The audio file must be in the MP3 or WAV format.'."\n" - ."\n" - .'>The text must be at least five characters in length.>', - 'type' => 'string', - 'required' => false, - 'example' => '{"Text": "To be, or not to be, that is the question."}', - ], - ], - [ - 'name' => 'EditingConfig', + 'name' => 'ProgramName', 'in' => 'query', - 'schema' => [ - 'description' => 'The avatar configurations, including the avatar ID, voice, and speech rate.', - 'type' => 'string', - 'required' => false, - 'example' => '{"AvatarId":"yunqiao"}', - ], + 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => false, 'example' => 'program1', 'title' => ''], ], [ - 'name' => 'OutputConfig', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'description' => 'The output configurations, including the destination URL for the rendered video.', - 'type' => 'string', - 'required' => false, - 'example' => '{"MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4"}', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ - 'name' => 'Title', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '任务标题', - 'description' => 'The task name. Max length: 128 bytes.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '任务描述', - 'description' => 'The task description. Max length: 128 bytes.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'title' => '自定义设置，为JSON字符串', - 'description' => 'A user-defined JSON string for passing custom business information, such as environment details or task metadata.', - 'type' => 'string', - 'required' => false, - 'example' => '{"user":"data","env":"prod"}', - ], + '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' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******'."\n", - ], - 'JobId' => [ - 'description' => 'The task ID.', - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****'."\n", - ], - 'MediaId' => [ - 'description' => 'The media asset ID of the output file.'."\n", - 'type' => 'string', - 'example' => '******70dcc471edaf00e6f6f4******', + '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', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\\\n\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\\\n\\",\\n \\"MediaId\\": \\"******70dcc471edaf00e6f6f4******\\"\\n}","type":"json"}]', - 'title' => 'SubmitAvatarVideoJob', - 'description' => '- The input supports only text or a human voice audio file in MP3 or WAV format.'."\n" - .'- The output supports MP4 and WebM formats. For the MP4 format, the task produces two videos: one with the avatar on a green screen background and a separate alpha mask video. This is ideal for post-production. For the WebM format, the task produces a single video with a transparent alpha channel, suitable for direct web front-end display. Rendering WebM is slower due to encoding complexity.'."\n" - .'- The final output includes sentence-level timestamps, which are useful for subsequent video editing.', - 'requestParamsDescription' => '### [](#inputconfig-)Examples of InputConfig'."\n" - ."\n" - .'Set InputConfig to the OSS URL of an audio file:'."\n" - ."\n" - .' {'."\n" - .' "InputFile": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp3"'."\n" - .' }'."\n" - ."\n" - .'Set InputConfig to text:'."\n" - ."\n" - .' {'."\n" - .' "Text": "To be, or not to be, that is the question."}'."\n" - ."\n" - .'Set InputConfig to the ID of a media asset:'."\n" - ."\n" - .' {'."\n" - .' "MediaId": "4aef0c80cc0071edbf92f6e7c44b6302"'."\n" - .' }'."\n" - ."\n" - .'### [](#editingconfig-)Example of EditingConfig'."\n" - ."\n" - .'AvatarId: required. The ID of the avatar. For valid values, see [Official avatar examples](https://www.alibabacloud.com/help/en/ims/developer-reference/examples-of-official-images-of-digital-people).\\'."\n" - .'Voice: optional. The voice of the avatar. This parameter takes effect only when InputConfig is set to text. For valid values, see [Intelligent voice samples](https://www.alibabacloud.com/help/en/ims/developer-reference/smart-voice-effect-example).\\'."\n" - .'CustomizedVoice: the custom voice. Specify this parameter if you want to set the avatar voice to a cloned human voice.\\'."\n" - .'LoopMotion: specifies whether the first and last frames of the video are the same. When set to true, it ensures smooth transitions in movements and expressions during loop playback, preventing frame jumps. Valid values: true and false. Default value: false.\\'."\n" - .'SpeechRate: the speech rate. This parameter takes effect only when InputConfig is set to text. Valid values: -500 to 500. Default value: 0.\\'."\n" - .'PitchRate: the pitch. This parameter takes effect only when InputConfig is set to text. Valid values: -500 to 500. Default value: 0.\\'."\n" - .'Volume: the volume. This parameter takes effect only when InputConfig is set to text. Valid values: 0 to 100. Default value: 50.\\'."\n" - .'BackgroundUrl: optional. The background image. If not provided, a black background is used by default. Only JPG and PNG formats are supported. The resolution must be 1080P, matching the orientation (portrait or landscape) of the avatar image.'."\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" - .'### [](#outputconfig-)Example of OutputConfig'."\n" - ."\n" - .' {'."\n" - .' "MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4'."\n" - .' }', - 'responseParamsDescription' => 'You can call the [GetSmartHandleJob](https://help.aliyun.com/document_detail/203429.html) operation to query the state and results of the task. Sample success response:'."\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\\\\\\":4.692,\\\\\\"content\\\\\\":\\\\\\"Do you not see the Yellow River flowing down from the sky and rushing into the sea, never to return? \\\\\\"},{\\\\\\"from\\\\\\":4.692,\\\\\\"to\\\\\\":9.061,\\\\\\"content\\\\\\":\\\\\\"Do you not see, before the mirror\'s gleaming light, one\'s black hair turns to snow white from morning to night? \\\\\\"}]\\"}"'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'Parameters of AiResult:\\'."\n" - .'outputVideoUrl: the URL of the output video. In this example, the output video is in the MP4 format.\\'."\n" - .'subtitleClips: the timestamps of the subtitles.'."\n" - ."\n" - .' {'."\n" - .' "outputVideoUrl": "https://oushu-test-shanghai.oss-cn-shanghai.aliyuncs.com/avatar/222.mp4",'."\n" - .' "subtitleClips": "[{\\"from\\":0.0,\\"to\\":4.692,\\"content\\":\\"Do you not see the Yellow River flowing down from the sky and rushing into the sea, never to return? \\"},{\\"from\\":4.692,\\"to\\":9.061,\\"content\\":\\"Do you not see, before the mirror\'s gleaming light, one\'s black hair turns to snow white from morning to night? \\"}]"'."\n" - .' }', - ], - 'SubmitAudioProduceJob' => [ - 'summary' => 'Converts the provided text content into a high-quality audio file.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'EditingConfig', + 'name' => 'MediaTagId', 'in' => 'query', - 'schema' => [ - 'title' => '音频生产配置', - 'description' => 'The audio editing configurations.'."\n" - ."\n" - .'* voice: the [voice type](~~449563~~).'."\n" - .'* customizedVoice: the ID of the personalized human voice.'."\n" - .'* format: the format of the output file. Valid values: PCM, WAV, and MP3.'."\n" - .'* volume: the volume. Default value: 50. Valid values: 0 to 100.'."\n" - .'* speech_rate: the speech tempo. Default value: 0. Value range: -500 to 500.'."\n" - .'* pitch_rate: the intonation. Default value: 0. Value range: -500 to 500.'."\n" - ."\n" - .'> If you specify both voice and customizedVoice, customizedVoice takes precedence over voice.', - 'type' => 'string', - 'required' => true, - 'example' => '{"voice":"Siqi","format":"MP3","volume":50}', - ], + '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' => 'OutputConfig', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'title' => '音频输出配置', - 'description' => 'The output audio configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"bucket":"bucket","object":"objeck"}', - ], + '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' => 'InputConfig', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'title' => '文本内容。 最大支持300个汉字', - 'description' => 'The text content. A maximum of 2,000 characters are supported. The [Speech Synthesis Markup Language (SSML)](~~2672807~~) is supported.', - 'type' => 'string', - 'required' => true, - 'example' => '测试文本', - ], + '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' => 'Title', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '任务标题', - 'description' => 'The job title. If you do not specify this parameter, the system generates a title based on the current date.'."\n" - ."\n" - .'* The job title can be up to 128 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '任务标题。若不提供，根据日期自动生成默认title 长度不超过128字节 UTF8编码', - ], + 'schema' => ['description' => 'The page number. Default value: 1', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '任务描述', - 'description' => 'The job description.'."\n" - ."\n" - .'* The job description can be up to 1,024 bytes in length.'."\n" - .'* The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '任务描述 长度不超过1024字节 UTF8编码', - ], + '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' => 'UserData', + 'name' => 'IncludeFileBasicInfo', 'in' => 'query', - 'schema' => [ - 'title' => '自定义数据', - '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', - 'required' => false, - 'example' => '{"user":"data"}', - ], + 'schema' => ['description' => 'Specifies whether to return the basic information of the media asset.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'Overwrite', + 'name' => 'BusinessType', 'in' => 'query', - 'schema' => [ - 'title' => '是否覆盖现有OSS文件', - 'description' => 'Specifies whether to overwrite the existing Object Storage Service (OSS) object.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'title' => '任务ID', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'State' => [ - 'title' => '任务状态', - 'description' => 'The job state. Valid values:'."\n" - ."\n" - .'* Created'."\n" - .'* Executing'."\n" - .'* Finished'."\n" - .'* Failed'."\n", - 'type' => 'string', - 'example' => 'Created', - ], - 'MediaId' => [ - 'title' => '媒资Id', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****2bcbfcfa30fccb36f72dca22****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"State\\": \\"Created\\",\\n \\"MediaId\\": \\"****2bcbfcfa30fccb36f72dca22****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n ****20b48fb04483915d4f2cd8ac****\\n Created\\n","errorExample":""}]', - 'title' => 'SubmitAudioProduceJob', - 'responseParamsDescription' => 'You can call the [GetSmartHandleJob](~~441172~~) operation to query the execution details of an intelligent audio production job. The following example shows the result returned by the [GetSmartHandleJob](~~441172~~) operation for a successful job.'."\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": "Talking about Guo Degang, he is now incredibly popular. Although ticket prices are high, his shows often sell out instantly. In addition, he frequently appears on various comedy programs, where he judges performances by new comedians."'."\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\\":\\"Talking about\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"he is now incredibly popular\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"Although ticket prices are high\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"his shows often sell out instantly\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"In addition, he frequently appears on various comedy programs, where he judges performances by new comedians\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" - .' }'."\n" - .' }', - ], - 'SubmitTextGenerateJob' => [ - 'summary' => 'Submits a text generation job to generate marketing copies based on keywords and the requirements for the word count and number of output copies. The word count of the output copies may differ from the specified word count. After the job is submitted, you can call the GetSmartHandleJob operation to obtain the job state and result based on the job ID.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '209430', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], - ], - 'parameters' => [ - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job title.'."\n" - ."\n" - .'The job title can be up to 128 bytes in length.'."\n" - ."\n" - .'The value must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job description, which can be up to 1,024 bytes in length and must be encoded in UTF-8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* MarketingCopy: the marketing copy.'."\n" - .'* Title: the short video title.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MarketingCopy' => '', - 'Title' => '', + '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' => 'MarketingCopy', - ], - ], - [ - 'name' => 'GenerateConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The text generation configurations, including keywords and the requirements for the word count and number of output copies.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - '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', - 'required' => false, 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', - ], - ], - ], - ], + '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'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', - 'title' => 'SubmitTextGenerateJob', + 'ramActions' => [], + 'translator' => 'manual', ], - 'SubmitVideoTranslationJob' => [ - 'summary' => 'Submits a video translation job. You can call this operation to translate video subtitles and speech to a specific language, and synchronize the speakers\' lip movements with the translated audio.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListRecognitionEntities' => [ + 'summary' => 'Lists entities in a specified recognition library. Pagination is supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '222559', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'InputConfig', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'description' => '* The input parameters of the video translation job.'."\n" - .'* A video translation job takes a video or subtitle file as the input.'."\n" - .'* The value must be in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type":"Video","Media":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4"}', - ], + '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' => 'EditingConfig', + 'name' => 'LibId', 'in' => 'query', - 'schema' => [ - 'description' => '* The configuration parameters of the video translation job.'."\n" - .'* The value must be in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"SourceLanguage":"zh","TargetLanguage":"en","DetextArea":"Auto"}', - ], + 'schema' => ['description' => 'The ID of the recognition library.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1965304870001', 'title' => ''], ], [ - 'name' => 'OutputConfig', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '* The output parameters of the video translation job.'."\n" - .'* A video translation job can generate a video or subtitle file as the output.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.mp4"}', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => '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' => [ - 'description' => '* The job title.'."\n", - 'type' => 'string', - 'required' => false, + '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' => [ [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '* The job description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + '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' => 'UserData', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'description' => '* The user-defined data.'."\n" - .'* The data must be in the JSON format, and can be up to 512 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', - ], + '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' => 'ClientToken', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '* The client token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SignatureMehtod', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'SignatureType', + 'name' => 'LibId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", + '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' => [ - 'JobId' => [ - 'description' => 'The ID of the video translation job.'."\n", - 'type' => 'string', - 'example' => '****d718e2ff4f018ccf419a7b71****', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', - 'title' => 'SubmitVideoTranslationJob', - 'description' => 'After you call this operation to submit a video translation job, the system returns a job ID. You can call the GetSmartHandleJob operation based on the job ID to obtain the status and result information of the job.'."\n", - 'requestParamsDescription' => '### [](#inputconfig)InputConfig'."\n" - ."\n" - .'#### [](#)Parameter description'."\n" - ."\n" - .'1. Type: the type of the input file. Valid values:'."\n" - ."\n" - .' * Video: The input is a video.'."\n" - .' * Subtitle: The input is a subtitle file.'."\n" - ."\n" - .'2. Media: the video material. This parameter is required if Type is set to Video. Valid values:'."\n" - ."\n" - .' * Media asset ID in IMS'."\n" - .' * OSS URL'."\n" - ."\n" - .'3. Subtitle: the SRT subtitle file. This parameter is required if Type is set to Subtitle. Valid value:'."\n" - ."\n" - .' * OSS URL'."\n" - ."\n" - .'#### [](#)Examples'."\n" - ."\n" - .'The input is a video, with the media asset ID specified.'."\n" - ."\n" - .' {'."\n" - .' "Type": "Video",'."\n" - .' "Media": "*****c80cc0071edbf92f6e7c44*****"'."\n" - .' }'."\n" - ."\n" - .'The input is a video, with the OSS URL specified.'."\n" + '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" - .' {'."\n" - .' "Type": "Video",'."\n" - .' "Media": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/video.mp4"'."\n" - .' }'."\n" - ."\n" - .'The input is a subtitle file, with the OSS URL specified.'."\n" - ."\n" - .' {'."\n" - .' "Type": "Subtitle",'."\n" - .' "Subtitle": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/subtitle.srt"'."\n" - .' }'."\n" - ."\n" - .'### [](#editingconfig)EditingConfig'."\n" - ."\n" - .'#### [](#-1)Parameter description'."\n" - ."\n" - .'* SourceLanguage: the source language. Valid value:'."\n" - ."\n" - .' * zh: Chinese.'."\n" - ."\n" - .'* TargetLanguage: the target language. Valid values:'."\n" - ."\n" - .' * en: English.'."\n" - .' * Other language codes. For more information, see [Machine Translation language code list](https://www.alibabacloud.com/help/zh/machine-translation/developer-reference/machine-translation-language-code-list?spm=a2c63.p38356.0.0.2bd56b9bPRoCRQ).'."\n" - ."\n" - .'* DetextArea: the area where the subtitle is erased. If this parameter is not specified, the subtitle is not erased. Valid values:'."\n" - ."\n" - .' * Auto: intelligently identifies the subtitle area.'."\n" - ."\n" - .' * \\[\\[x, y, width, height]]: the area where the subtitle is erased. The value is a two-layer array. You can specify multiple areas. The value contains the following options:'."\n" - ."\n" - .' * x: the ratio of the horizontal distance from the upper-left corner of the subtitle frame to the upper-left corner of the video. Valid values: \\[0,1].'."\n" - .' * y: the ratio of the vertical distance from the upper-left corner of the subtitle frame to the upper-left corner of the video. Valid values: \\[0,1].'."\n" - .' * width: the ratio of the width of the subtitle frame to the width of the video. Valid values: \\[0,1].'."\n" - .' * height: the ratio of the height of the subtitle frame to the height of the video. Valid values: \\[0,1].'."\n" - ."\n" - .'* SupportEditing: specifies whether to support custom editing. Valid values:'."\n" - ."\n" - .' * true: supports custom editing. In this case, all intermediate files generated during processing are retained and an editing project is generated for custom production.'."\n" - .' * false: does not support custom editing. This is the default value. In this case, intermediate files are not retained and no editing project is generated.'."\n" - ."\n" - .'* SubtitleTranslate: the subtitle translation configurations.'."\n" - ."\n" - .' * TextSource: the subtitle source. Valid values:'."\n" - ."\n" - .' * OCR: The subtitle is obtained from the video by using optical character recognition (OCR). This is the default value.'."\n" - .' * SubtitleFile: The subtitle is obtained from the input subtitle file.'."\n" - ."\n" - .' * OcrArea: the OCR area. If you do not specify this parameter, the default value Auto is used.'."\n" - ."\n" - .' * Auto: intelligently identifies the subtitle area.'."\n" - ."\n" - .' * SubtitleConfig: the subtitle effect configurations. The parameters are the same as the subtitle parameters in the timeline settings for video editing. For more information, see [SubtitleTrackClip](https://help.aliyun.com/zh/ims/developer-reference/timeline-configuration-description?spm=a2c4g.11186623.0.i2#section-orj-0mj-8j2).'."\n" - ."\n" - .'#### [](#-1)Examples'."\n" - ."\n" - .'Translate the subtitle from Chinese into English, with intelligent subtitle erasure enabled.'."\n" - ."\n" - .' {'."\n" - .' "SourceLanguage": "zh",'."\n" - .' "TargetLanguage": "en",'."\n" - .' "DetextArea": "Auto"'."\n" - .' }'."\n" - ."\n" - .'Translate the subtitle from Chinese into English, and specify the area where the subtitle is erased.'."\n" - ."\n" - .' {'."\n" - .' "SourceLanguage": "zh",'."\n" - .' "TargetLanguage": "en",'."\n" - .' "DetextArea": "[[0.1,0.85,0.8,0.15]]"'."\n" - .' }'."\n" - ."\n" - .'Translate the subtitle from Chinese into English without erasing the subtitle, and specify the area where the translated subtitle is displayed.'."\n" - ."\n" - .' {'."\n" - .' "SourceLanguage": "zh",'."\n" - .' "TargetLanguage": "en",'."\n" - .' "SubtitleTranslate": {'."\n" - .' "TextSource": "OCR",'."\n" - .' "OcrArea": "Auto",'."\n" - .' "SubtitleConfig": {'."\n" - .' "Alignment" : "Center"'."\n" - .' "Y": 0.8'."\n" - .' }'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'### [](#outputconfig)OutputConfig'."\n" - ."\n" - .'#### [](#-2)Parameter description'."\n" - ."\n" - .'* MediaURL: the URL of the output file, which can be a video file or a subtitle file.'."\n" - ."\n" - .'#### [](#-2)Examples'."\n" - ."\n" - .'The output is a video file.'."\n" - ."\n" - .' {'."\n" - .' "MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/video.mp4"'."\n" - .' }'."\n" - ."\n" - .'The output is a subtitle file.'."\n" - ."\n" - .' {'."\n" - .' "MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/subtitle.srt"'."\n" - .' }', - ], - 'SubmitHighlightExtractionJob' => [ - 'summary' => 'Submits a highlight extraction task.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + .'- 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'], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'Algorithm', 'in' => 'query', - 'schema' => [ - 'title' => '调用方保证请求幂等性Client Token', - 'description' => 'The client token used to ensure the idempotency of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****'."\n", - ], + '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' => 'InputConfig', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户合成输出配置', - 'description' => 'The input configuration.'."\n", - 'type' => 'string', - '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' => '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' => 'OutputConfig', + 'name' => 'EntityId', 'in' => 'query', - 'schema' => [ - 'title' => '任务来源', - 'description' => 'The output configuration.'."\n", - 'type' => 'string', - '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" - .'}', - ], + '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' => 'UserData', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~357745#section-urj-v3f-0s1~~).', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'JobId' => [ - 'title' => '批量混剪任务jobId', - 'description' => 'The ID of the highlight extraction task.'."\n", - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'errorMsg:%s', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\"\\n}","type":"json"}]', - 'title' => 'SubmitHighlightExtractionJob', - ], - 'SubmitSegmentationJob' => [ - 'summary' => 'Splits a long video into multiple video clips and outputs as video files or media assets.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + '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'], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'title' => '调用方保证请求幂等性Client Token', - 'description' => 'The client token that is used to ensure the idempotence of the request.', - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****', - ], - ], - [ - 'name' => 'InputConfig', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户合成输出配置', - 'description' => 'The input configuration. For detailed parameters, see [InputConfig](~~2874121#cc59ad3082jbx~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "OSS",'."\n" - .' "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" - .'}'."\n" - .'or {'."\n" - .' "Type": "Media",'."\n" - .' "Media": "ce49a020e****1ef81c1e6f6d5686302"'."\n" - .'}', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ - 'name' => 'OutputConfig', + 'name' => 'WindowDurationSeconds', 'in' => 'query', - 'schema' => [ - 'title' => '任务来源', - 'description' => 'The output configuration. For detailed parameters, see [OutputConfig](~~2874121#cef23186a8d6w~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\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" - .'}', - ], + 'schema' => ['description' => 'The time window of the program schedule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14400', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'The user-defined data in the JSON format, which can be up to 512 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"test": "22"}', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'JobParams', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The task parameters. For details, see [JobParams](~~2874121#a60357f2d5iix~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "Mode": "UserDefined",'."\n" - .' "Ranges": [{'."\n" - .' "In": 10,'."\n" - .' "Out": 20'."\n" - .' }, {'."\n" - .' "In": 35,'."\n" - .' "Out": 50'."\n" - .' }]'."\n" - .'}', - ], + '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' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******'."\n", - ], - 'JobId' => [ - 'title' => '批量混剪任务jobId', - 'description' => 'The task ID.', - 'type' => 'string', - 'example' => '****cdb3e74639973036bc84****'."\n", + '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', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\\\n\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\\\n\\"\\n}","type":"json"}]', - 'title' => 'SubmitSegmentationJob', - ], - 'GetSmartHandleJob' => [ - 'summary' => 'Queries the information about an intelligent job and the execution results of the job based the job ID. You can call this operation to query only intelligent jobs created within the past year.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -47238,762 +33283,450 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeCode' => '237778', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '任务Id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'title' => '任务Id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Output' => [ - 'title' => '任务结果', - 'description' => 'The job results.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'JobResult' => [ - 'description' => 'The job results.'."\n", - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资Id', - 'description' => 'The ID of the media asset.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'AiResult' => [ - 'title' => '智能分析结果', - 'description' => 'The AI analysis result.'."\n", - 'type' => 'string', - 'example' => 'Intelligent segmentation or tagging information'."\n", - ], - 'Usage' => [ - 'description' => 'The token usage. This parameter is returned only for keyword-based text generation jobs.'."\n", - 'type' => 'string', - 'example' => '{"total_tokens":100}', - ], - 'MediaUrl' => [ - 'type' => 'string', - ], - ], - ], - 'State' => [ - 'title' => '任务状态', - 'description' => 'The job state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Finished'."\n" - .'* Failed'."\n" - .'* Executing'."\n" - .'* Created'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Finished' => '', - 'Failed' => '', - 'Executing' => '', - 'Created' => '', - ], - 'example' => 'Finished', - ], - 'UserData' => [ - 'title' => '用户自定义信息', - 'description' => 'The user-defined data in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{"user":"data"}', - ], - 'SmartJobInfo' => [ - 'title' => '智能任务信息', - 'description' => 'The information about the intelligent job.'."\n", - 'type' => 'object', - 'properties' => [ - 'Title' => [ - 'title' => '任务标题', - 'description' => 'The job title.'."\n", - 'type' => 'string', - 'example' => '测试标题', - ], - 'Description' => [ - 'title' => '任务描述', - 'description' => 'The job description.'."\n", - 'type' => 'string', - 'example' => '测试描述', - ], - 'UserId' => [ - 'title' => 'userid', - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '1974526429******', - ], - 'InputConfig' => [ - 'title' => '输入参数', - 'description' => 'The input configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'InputFile' => [ - 'title' => 'OSS地址 或 内容库素材ID', - 'description' => 'The OSS URL or the ID of the material in the media asset library.'."\n", - 'type' => 'string', - 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ******11-DB8D-4A9A-875B-275798******', - ], + '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' => '', ], - ], - 'OutputConfig' => [ - 'title' => '输出配置', - 'description' => 'The output configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bucket' => [ - 'title' => 'OSS Bucket', - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'test-bucket', - ], - 'Object' => [ - 'title' => 'OSS Object', - 'description' => 'The OSS object.'."\n", - 'type' => 'string', - 'example' => 'test-object', + '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"}'], ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'ModifiedTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'JobType' => [ - 'title' => '任务类型', - 'description' => 'The job type.'."\n", - 'type' => 'string', - 'example' => 'ASR', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'ErrorCode' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","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\\": \\"\\"\\n },\\n \\"State\\": \\"Finished\\",\\n \\"UserData\\": \\"{\\\\\\"user\\\\\\":\\\\\\"data\\\\\\"}\\",\\n \\"SmartJobInfo\\": {\\n \\"Title\\": \\"测试标题\\",\\n \\"Description\\": \\"测试描述\\",\\n \\"UserId\\": \\"1974526429******\\",\\n \\"InputConfig\\": {\\n \\"InputFile\\": \\"oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ******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\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n ****20b48fb04483915d4f2cd8ac****\\n {}\\n Finished\\n {\\"user\\":\\"data\\"}\\n \\n 测试标题\\n 测试描述\\n 1974526429******\\n \\n oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ******11-DB8D-4A9A-875B-275798******\\n \\n \\n test-bucket\\n test-object\\n \\n 2020-12-26T04:11:10Z\\n 2020-12-26T04:11:10Z\\n ASR\\n \\n","errorExample":""}]', - 'title' => 'GetSmartHandleJob', - 'responseParamsDescription' => 'Each type of intelligent job returns results in different formats. The following examples are execution results for various intelligent jobs.'."\n" - ."\n" - .'## [](#asr-)ASR-based intelligent subtitle job'."\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\\":\\"Talking about\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"he is now incredibly popular\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"Although ticket prices are high\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"his shows often sell out instantly\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"In addition, he frequently appears on various comedy programs, where he judges performances by new comedians\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'## [](#)Intelligent audio production job'."\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": "Talking about Guo Degang, he is now incredibly popular. Although ticket prices are high, his shows often sell out instantly. In addition, he frequently appears on various comedy programs, where he judges performances by new comedians."'."\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\\":\\"Talking about\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"he is now incredibly popular\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"Although ticket prices are high\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"his shows often sell out instantly\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"In addition, he frequently appears on various comedy programs, where he judges performances by new comedians\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'## [](#)Keyword-based text generation job'."\n" - ."\n" - .' {'."\n" - .' "RequestId":"******AC-5A01-1116-87A4-BF86F2******",'."\n" - .' "UserData":"{\\"NotifyAddress\\":\\"https://****\\"}",'."\n" - .' "JobResult":{'."\n" - .' "AiResult":"[\\"Our new cake shop uses pure dairy cream, offering a mellow and silky smooth taste. Every bite is a sweet surprise, making your taste buds dance with freshness and purity. \\",\\"Explore a new world of desserts at our new cake shop. Our cakes are made with high-quality dairy cream. The flavor is subtly sweet but not overwhelming, with layers of richness. Each cake tells a sweet story of craftsmanship, waiting for you to savor. \\",\\"For those who appreciate the fine things in life, our new cake shop uses premium dairy cream, free from artificial additives. The pure and fragrant milk flavor is light and airy, with each bite offering a unique celebration of pleasures in 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, dairy cream\\\\\\",\\\\\\"textLength\\\\\\":100,\\\\\\"targetCount\\\\\\":3}\\"}"'."\n" - .' }'."\n" - .' }'."\n", - ], - 'DeleteSmartJob' => [ - 'summary' => 'Deletes intelligent jobs based on job IDs.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchLib'], ], ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务id，多个任务id用英文逗号分割', - 'description' => 'The IDs of the jobs to delete. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******b48fb04483915d4f2cd8******,******042d5e4db6866f6289d1******', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n","errorExample":""}]', - 'title' => 'DeleteSmartJob', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'translator' => 'manual', ], 'ListSmartJobs' => [ 'summary' => 'Queries a list of intelligent jobs based on specified parameters.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'title' => '当前开始读取的位置', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****73f33c91-d59383e8280b****', - ], + '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' => [ - 'title' => '分页大小。最大不超过100。 默认值：10', - 'description' => 'The maximum number of entries to return.'."\n" - ."\n" - .'Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => [ - 'title' => '当前页码。默认值为1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，每页显示条数。默认值为10，最大值为100。', - 'description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => [ - 'title' => '任务类型', 'description' => 'The job type.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* ASR: automatic speech recognition(job) job.'."\n" - .'* DynamicChart: dynamic chart job.'."\n" - .'* VideoTranslation: video translation job.'."\n" - .'* TextToSpeech: intelligent audio production job.'."\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', - 'required' => false, - 'enumValueTitles' => [ - 'ASR' => '', - 'DynamicChart' => '', - 'VideoTranslation' => '', - 'TextToSpeech' => '', - ], 'example' => 'ASR', + 'title' => '', + 'required' => false, ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'title' => '排序参数，默认根据创建时间倒序', '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" - .'* CreationTime:Desc: sorted by creation time in descending order.'."\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, - 'enumValueTitles' => [ - 'CreationTime:Asc' => '', - 'CreationTime:Desc' => '', - ], 'example' => 'CreationTime:Desc', + 'title' => '', + 'required' => false, ], ], [ 'name' => 'JobState', 'in' => 'query', 'schema' => [ - 'title' => '任务状态', 'description' => 'The job state.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Finished: The job is complete.'."\n" - .'* Failed: The job failed.'."\n" - .'* Executing: The job is in progress.'."\n" - .'* Created: The job is created.'."\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', - 'required' => false, - 'enumValueTitles' => [ - 'Finished' => '', - 'Failed' => '', - 'Executing' => '', - 'Created' => '', - ], 'example' => 'Finished', + 'title' => '', + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', 'title' => ''], 'SmartJobList' => [ - 'description' => 'The queried intelligent jobs.'."\n", + 'description' => 'The queried intelligent jobs.', 'type' => 'array', 'items' => [ - 'description' => 'The queried intelligent job.'."\n", + 'description' => 'The queried intelligent job.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'title' => '任务Id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Title' => [ - 'title' => '任务标题', - 'description' => 'The job title.'."\n", - 'type' => 'string', - 'example' => '测试标题', - ], - 'Description' => [ - 'title' => '任务描述', - 'description' => 'The job description.'."\n", - 'type' => 'string', - 'example' => '测试描述', - ], - 'UserId' => [ - 'title' => '用户Id', - 'description' => 'The user ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1084506228******', - ], + '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' => [ - 'title' => '任务类型', 'description' => 'The job type.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* ASR: ASR job.'."\n" - .'* DynamicChart: dynamic chart job.'."\n" - .'* TextToSpeech: intelligent audio production job.'."\n", + .'- ASR: ASR job.'."\n" + ."\n" + .'- DynamicChart: dynamic chart job.'."\n" + ."\n" + .'- TextToSpeech: intelligent audio production job.', + 'enumValueTitles' => ['ASR' => '', 'DynamicChart' => '', 'TextToSpeech' => ''], 'type' => 'string', - 'enumValueTitles' => [ - 'ASR' => '', - 'DynamicChart' => '', - 'TextToSpeech' => '', - ], 'example' => 'ASR', + 'title' => '', ], - 'EditingConfig' => [ - 'title' => '输入配置', - 'description' => 'The editing configurations.'."\n", - 'type' => 'string', - 'example' => '{"AudioConfig":{},"InputConfig":""}', - ], - 'UserData' => [ - 'title' => '用户自定义字段', - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '{"user":"data"}', - ], + 'EditingConfig' => ['description' => 'The editing configurations.', 'type' => 'string', 'example' => '{"AudioConfig":{},"InputConfig":""}', 'title' => ''], + 'UserData' => ['description' => 'The user-defined data.', 'type' => 'string', 'example' => '{"user":"data"}', 'title' => ''], 'JobState' => [ - 'title' => '任务状态', 'description' => 'The job state.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Finished: The job is complete.'."\n" - .'* Failed: The job failed.'."\n" - .'* Executing: The job is in progress.'."\n" - .'* Created: The job is created.'."\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', - 'enumValueTitles' => [ - 'Finished' => '', - 'Failed' => '', - 'Executing' => '', - 'Created' => '', - ], 'example' => 'Finished', + 'title' => '', ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], - 'ModifiedTime' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the job was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-12-26T04:11:10Z', - ], + '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.'."\n", + 'title' => '', + 'description' => 'The input configurations.', 'type' => 'object', 'properties' => [ - 'InputFile' => [ - 'title' => '文件信息', - 'description' => 'The information about the input file.'."\n", - 'type' => 'string', - 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', - ], - 'Keyword' => [ - 'title' => '关键词信息', - 'description' => 'The keyword information.'."\n", - 'type' => 'string', - 'example' => '测试关键词', - ], + '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.'."\n", + 'title' => '', + 'description' => 'The output configurations.', 'type' => 'object', 'properties' => [ - 'Bucket' => [ - 'title' => 'OSS Bucket', - 'description' => 'The Object Storage Service (OSS) bucket.'."\n", - 'type' => 'string', - 'example' => 'test-bucket', - ], - 'Object' => [ - 'title' => 'OSS Object', - 'description' => 'The OSS object.'."\n", - 'type' => 'string', - 'example' => 'test-object', - ], + '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' => [ - 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', - '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.'."\n", - 'type' => 'string', - 'example' => 'CBB6BC61D08', - ], - 'MaxResults' => [ - 'title' => '本次请求所返回的最大记录条数，最后一页前每页记录条数为MaxResults取值。 例如： 正例：10,10,5，反例：10,5,10', - '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.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回。', - 'description' => 'Optional. The total number of entries returned. By default, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => '110', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"SmartJobList\\": [\\n {\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Title\\": \\"测试标题\\",\\n \\"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\\": \\"测试关键词\\"\\n },\\n \\"OutputConfig\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Object\\": \\"test-object\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"CBB6BC61D08\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"110\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ****9262E3DA-07FA-4862-FCBB6BC61D08*****\\n \\n ****20b48fb04483915d4f2cd8ac****\\n 测试标题\\n 测试描述\\n ASR\\n {\\"AudioConfig\\":{},\\"InputConfig\\":\\"\\"}\\n {\\"user\\":\\"data\\"}\\n Finished\\n 2020-12-26T04:11:10Z\\n 2020-12-26T04:11:10Z\\n \\n oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\n 测试关键词\\n \\n \\n test-bucket\\n test-object\\n \\n \\n CBB6BC61D08\\n 10\\n 110\\n","errorExample":""}]', 'title' => 'ListSmartJobs', - ], - 'ListSmartSysAvatarModels' => [ - 'summary' => 'Queries a list of system digital humans. This operation supports paged queries.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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', - ], + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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 entries per page. Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The SDK version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], 'SmartSysAvatarModelList' => [ - 'description' => 'The queried digital humans.'."\n", + 'description' => 'A list of system digital avatars.', 'type' => 'array', 'items' => [ - 'description' => 'The queried digital human.'."\n", + 'description' => 'A system digital avatar.', 'type' => 'object', 'properties' => [ - 'AvatarName' => [ - 'description' => 'The name of the digital human.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AvatarId' => [ - 'description' => 'The ID of the digital human. The ID is required to submit a separate digital human rendering job or use the digital human image in an intelligent timeline.'."\n", - 'type' => 'string', - 'example' => 'yunqiao', - ], - 'CoverUrl' => [ - 'description' => 'The sample thumbnail URL of the digital human.'."\n", - 'type' => 'string', - 'example' => 'http://ice-pub-media.myalicdn.com/smart/avatarModel/coverDemo/yunqiao.mp4', - ], - 'VideoUrl' => [ - 'description' => 'The sample video URL of the digital human.'."\n", - 'type' => 'string', - 'example' => 'http://ice-pub-media.myalicdn.com/smart/avatarModel/videoDemo/yunqiao.mp4', - ], - 'Width' => [ - 'description' => 'The video width.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1080', - ], - 'Height' => [ - 'description' => 'The video height.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1920', - ], - 'Bitrate' => [ - 'description' => 'The video bitrate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4000', - ], - 'OutputMask' => [ - 'description' => 'Indicates whether portrait mask rendering is supported.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + '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' => [ - 'title' => '虚拟人总数', - 'description' => 'The total number of system digital human images returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'TotalCount' => ['description' => 'The total number of system digital avatars.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"SmartSysAvatarModelList\\": [\\n {\\n \\"AvatarName\\": \\"云乔\\",\\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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListSmartSysAvatarModels', - ], - 'ListSmartVoiceGroups' => [ - 'summary' => 'Queries a list of speaker groups, including the name, gender, and sample audio of each speaker. The list is grouped by scenario.', - 'methods' => [ - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -48006,420 +33739,960 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '147883', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ 'name' => 'VoiceType', 'in' => 'query', - 'schema' => [ - 'title' => '音色类型，默认不填：返回小模型语种音色。支持传入：'."\n" - .'Cosyvoice，返回Cosyvoice大模型音色示例。', - 'type' => 'string', - 'required' => false, - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '627B30EB-1D0A-5C6D-8467-431626E0FA10', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '627B30EB-1D0A-5C6D-8467-431626E0FA10'], 'VoiceGroups' => [ - 'description' => 'The queried speaker groups.'."\n", + 'description' => 'An array of voice groups.', 'type' => 'array', 'items' => [ - 'description' => 'The queried speaker groups.'."\n", + 'description' => 'A voice group.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The name of the speaker group.'."\n", - 'type' => 'string', - 'example' => '', - ], + 'Type' => ['description' => 'The name of the voice group.', 'type' => 'string', 'example' => 'Ultra HD', 'title' => ''], 'VoiceList' => [ - 'description' => 'The speakers.'."\n", + 'description' => 'The voice list.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the speaker.'."\n", + 'description' => 'A voice.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The speaker name.'."\n", - 'type' => 'string', - 'example' => '', - ], + 'Name' => ['description' => 'The name of the voice.', 'type' => 'string', 'example' => 'Zhi Tian', 'title' => ''], 'VoiceType' => [ - 'description' => 'The speaker type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Male'."\n" - .'* Female'."\n" - .'* Boy'."\n" - .'* Girl'."\n", + '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', - 'enumValueTitles' => [ - 'Male' => 'Male', - 'Female' => 'Female', - 'Boy' => 'Boy', - 'Girl' => 'Girl', - ], 'example' => 'Female', + 'title' => '', ], - 'Voice' => [ - 'description' => 'The speaker ID.'."\n", - 'type' => 'string', - 'example' => 'zhitian', - ], - 'Desc' => [ - 'description' => 'The speaker description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Tag' => [ - 'description' => 'The tag of the speaker type.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Remark' => [ - 'description' => 'The remarks of the speaker.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'VoiceUrl' => [ - 'description' => 'The URL of the sample audio file.'."\n", - 'type' => 'string', - 'example' => 'https://***.com/zhiqing.mp3', - ], - 'SupportSampleRate' => [ - 'type' => 'string', - ], - 'VoiceSource' => [ - 'type' => 'string', - ], - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"627B30EB-1D0A-5C6D-8467-431626E0FA10\\",\\n \\"VoiceGroups\\": [\\n {\\n \\"Type\\": \\"超高清\\",\\n \\"VoiceList\\": [\\n {\\n \\"Name\\": \\"知甜\\",\\n \\"VoiceType\\": \\"Female\\",\\n \\"Voice\\": \\"zhitian\\",\\n \\"Desc\\": \\"甜美女声\\",\\n \\"Tag\\": \\"通用场景\\",\\n \\"Remark\\": \\"中文及中英文混合场景\\",\\n \\"VoiceUrl\\": \\"https://***.com/zhitian.mp3\\",\\n \\"SupportSampleRate\\": \\"48000\\",\\n \\"VoiceSource\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListSmartVoiceGroups', - ], - 'StartAIAgentInstance' => [ - 'summary' => 'Starts an AI agent that is configured in the Intelligent Media Services (IMS) console.', - 'methods' => [ - 'post', + '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'], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236525', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREice7O9OLB'], ], 'parameters' => [ [ - 'name' => 'AIAgentId', + 'name' => 'StartOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent created in the [IMS](https://ims.console.aliyun.com/ai/robot/list) console.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', - ], + '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' => 'RuntimeConfig', + 'name' => 'EndOfCreateTime', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'required' => true, - '$ref' => '#/components/schemas/AIAgentRuntimeConfig', - ], + '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' => 'AgentConfig', + 'name' => 'Status', 'in' => 'query', - 'style' => 'json', 'schema' => [ - '$ref' => '#/components/schemas/AIAgentConfig', + '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' => 'UserData', + 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'description' => '', + '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' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}', + 'example' => 'CreateTimeDesc', ], ], [ - 'name' => 'SessionId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f213fbc005e4f309379701645f4****'."\n", - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ - 'name' => 'ChatSyncConfig', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', + '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' => [ - 'description' => '同步聊天记录配置。', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'IMAIAgentId' => [ - 'description' => 'IM的智能体Id。', - 'type' => 'string', - 'required' => false, - 'example' => '******005e4f309379701645f4****'."\n", - ], - 'ReceiverId' => [ - 'description' => '接收用户Id。', - 'type' => 'string', - 'required' => false, - 'example' => '4167626d312034b2b1c3b7f2f3e41884', + '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' => '*'], ], - 'required' => false, ], ], + ], + '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' => [ [ - 'name' => 'TemplateConfig', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', 'in' => 'query', - 'style' => 'json', + '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' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/AIAgentTemplateConfig', - 'deprecated' => true, + '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' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '39f8e0bc005e4f309379701645f4****', + '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' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"InstanceId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","type":"json"}]', - 'title' => 'StartAIAgentInstance', - 'description' => 'You can call this operation to start an AI agent instance for a conversation. ````````When the AI agent is started, the system returns a unique `InstanceId` for subsequent tracking and operations.'."\n", + 'translator' => 'manual', ], - 'StopAIAgentInstance' => [ - 'summary' => 'Stops an AI agent instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListSystemTemplates' => [ + 'summary' => 'Queries a list of system templates.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236519', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREiceHPAMBQ'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', - ], + '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' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', - 'title' => 'StopAIAgentInstance', - 'description' => '* When you no longer need an AI agent to participate in a conversation or task, you can call this operation to stop the running agent and release relevant resources.****'."\n" - .'* You must specify the unique ID of the AI agent that you want to stop by using InstanceId.****'."\n" - .'* ****'."\n", - ], - 'UpdateAIAgentInstance' => [ - 'summary' => 'Updates the configurations of an AI agent.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSystemTemplates'], + ], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236521', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the AI agent that you want to update.'."\n", + 'description' => 'The template type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Timeline'."\n" + ."\n" + .'- VETemplate', + 'enumValueTitles' => ['Timeline' => 'Timeline', 'VETemplate' => 'VETemplate'], 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', + 'example' => 'Timeline', + 'title' => '', + 'required' => false, ], ], [ - 'name' => 'AgentConfig', + 'name' => 'Status', 'in' => 'query', - 'style' => 'json', 'schema' => [ - '$ref' => '#/components/schemas/AIAgentConfig', + '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' => 'UserData', + 'name' => 'CreateSource', 'in' => 'query', 'schema' => [ - 'description' => '', + '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, - 'example' => '{"VoiceId":"xiaoxia"}', ], ], [ - 'name' => 'TemplateConfig', + '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', - 'style' => 'json', 'schema' => [ - 'description' => 'The template configurations of the AI agent. The configurations are merged with the template configurations that are used to start the AI agent. For more information, see the definition of TemplateConfig.'."\n", + '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, - '$ref' => '#/components/schemas/AIAgentTemplateConfig', - 'deprecated' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', - 'title' => 'UpdateAIAgentInstance', - 'description' => '## [](#)Request description'."\n" + '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" - .'You can call this operation to update the configurations of an AI agent, such as the tone, by specifying the agent ID and configurations.'."\n", - ], - 'DescribeAIAgentInstance' => [ - 'summary' => 'Queries the information about an AI agent.', - 'methods' => [ - 'post', + .'- 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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -48427,110 +34700,553 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236522', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'StartOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Instance' => [ - 'description' => 'The information about the AI agent.'."\n", - 'type' => 'object', - 'properties' => [ - 'CallLogUrl' => [ - 'description' => 'The URL of the call log file.'."\n", - 'type' => 'string', - 'example' => 'https://example.com/call_logs/12345', - ], - 'RuntimeConfig' => [ - 'description' => 'The runtime configurations of the AI agent.'."\n", - 'example' => '{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}', - '$ref' => '#/components/schemas/AIAgentRuntimeConfig', - ], - 'Status' => [ - 'description' => 'The state of the AI agent. Valid values: Finished and Executing.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Finished' => 'Finished', - 'Executing' => 'Executing', + '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' => '', ], - 'example' => 'Finished', - ], - 'TemplateConfig' => [ - 'description' => 'The template configurations of the AI agent.'."\n", - 'example' => '{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}', - '$ref' => '#/components/schemas/AIAgentTemplateConfig', - 'deprecated' => true, - ], - 'UserData' => [ - 'description' => 'The custom information.'."\n", - 'type' => 'string', - 'example' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}', - ], - 'SessionId' => [ - 'type' => 'string', - ], - 'AgentConfig' => [ - '$ref' => '#/components/schemas/AIAgentConfig', - ], - 'GmtCreate' => [ - 'type' => 'string', - ], - 'GmtModified' => [ - 'type' => 'string', ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instance\\": {\\n \\"CallLogUrl\\": \\"https://example.com/call_logs/12345\\",\\n \\"RuntimeConfig\\": {\\n \\"VoiceChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"VisionChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"ChannelId\\": \\"\\",\\n \\"AvatarChat3D\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n }\\n },\\n \\"Status\\": \\"Finished\\",\\n \\"TemplateConfig\\": {\\n \\"VoiceChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AvatarUrlType\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"MessageChat\\": {\\n \\"AppId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ]\\n },\\n \\"VisionChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"AvatarChat3D\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"AvatarId\\": \\"\\",\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n }\\n },\\n \\"UserData\\": \\"{\\\\\\"Email\\\\\\":\\\\\\"johndoe@example.com\\\\\\",\\\\\\"Preferences\\\\\\":{\\\\\\"Language\\\\\\":\\\\\\"en\\\\\\"}}\\",\\n \\"SessionId\\": \\"955535**************\\",\\n \\"AgentConfig\\": {\\n \\"AppId\\": \\"\\",\\n \\"Greeting\\": \\"\\",\\n \\"WakeUpQuery\\": \\"\\",\\n \\"MaxIdleTime\\": 0,\\n \\"UserOnlineTimeout\\": 0,\\n \\"UserOfflineTimeout\\": 0,\\n \\"EnablePushToTalk\\": true,\\n \\"GracefulShutdown\\": true,\\n \\"Volume\\": 0,\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"AvatarUrlType\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AsrConfig\\": {\\n \\"AsrLanguageId\\": \\"\\",\\n \\"AsrMaxSilence\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CustomParams\\": \\"\\",\\n \\"VadDuration\\": 0\\n },\\n \\"TtsConfig\\": {\\n \\"VoiceId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"PronunciationRules\\": [\\n {\\n \\"Word\\": \\"\\",\\n \\"Pronunciation\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"ModelId\\": \\"\\",\\n \\"LanguageId\\": \\"\\",\\n \\"Emotion\\": \\"\\",\\n \\"SpeechRate\\": 0\\n },\\n \\"LlmConfig\\": {\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"OpenAIExtraQuery\\": \\"\\",\\n \\"LlmCompleteReply\\": true,\\n \\"FunctionMap\\": [\\n {\\n \\"Function\\": \\"\\",\\n \\"MatchFunction\\": \\"\\"\\n }\\n ],\\n \\"OutputMinLength\\": 0,\\n \\"OutputMaxDelay\\": 0,\\n \\"HistorySyncWithTTS\\": true\\n },\\n \\"AvatarConfig\\": {\\n \\"AvatarId\\": \\"\\"\\n },\\n \\"InterruptConfig\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"NoInterruptMode\\": \\"\\"\\n },\\n \\"VoiceprintConfig\\": {\\n \\"UseVoiceprint\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"RegistrationMode\\": \\"\\"\\n },\\n \\"TurnDetectionConfig\\": {\\n \\"TurnEndWords\\": [\\n \\"\\"\\n ],\\n \\"Mode\\": \\"\\",\\n \\"SemanticWaitDuration\\": 0,\\n \\"Eagerness\\": \\"\\"\\n },\\n \\"ExperimentalConfig\\": \\"\\",\\n \\"VcrConfig\\": {\\n \\"StillFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"InvalidFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"PeopleCount\\": {\\n \\"Enabled\\": true\\n },\\n \\"Equipment\\": {\\n \\"Enabled\\": true\\n },\\n \\"HeadMotion\\": {\\n \\"Enabled\\": true\\n },\\n \\"LookAway\\": {\\n \\"Enabled\\": true\\n }\\n },\\n \\"OutboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"SipDomain\\": \\"\\"\\n },\\n \\"InboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"AuthUrl\\": \\"\\",\\n \\"AuthToken\\": \\"\\"\\n },\\n \\"AmbientSoundConfig\\": {\\n \\"ResourceId\\": \\"\\",\\n \\"Volume\\": 0\\n },\\n \\"AutoSpeechConfig\\": {\\n \\"UserIdle\\": {\\n \\"WaitTime\\": 0,\\n \\"MaxRepeats\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n },\\n \\"LlmPending\\": {\\n \\"WaitTime\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n },\\n \\"BackChannelingConfigs\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n ],\\n \\"BackChannelingConfig\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\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 },\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', - 'title' => 'DescribeAIAgentInstance', - 'description' => '## [](#)Request description'."\n" - ."\n" - .'* **Feature**: You can call this operation to query the information about an AI agent.'."\n" - .'* **Scenario**: If you need to monitor or analyze the performance of an AI agent in a call or debug the agent configurations, you can call this operation to obtain required data.'."\n", - ], - 'ListAIAgentInstance' => [ - 'summary' => 'Queries a list of AI agents.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTranscodeJobs'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -48542,474 +35258,216 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236523', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ - 'name' => 'AIAgentId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4***', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'StartTime', + 'name' => 'PageSize', '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. This parameter does not have a default value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-01-01T00:00:00Z', - ], + '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' => 'EndTime', + 'name' => 'SortBy', '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. This parameter does not have a default value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-01-02T00:00:00Z', - ], + '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' => 'PageSize', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Valid values: 0 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The search keyword. The names of the returned assets are prefixed with this keyword.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'movie'], ], [ - 'name' => 'PageNumber', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Instances' => [ - 'description' => 'The list of the AI agents.'."\n", + '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' => [ - 'CallLogUrl' => [ - 'description' => 'The URL of the call log file for the AI agent. The structure of the file is CallLog in the JSON format.'."\n", - 'type' => 'string', - 'example' => 'https://example.com/call_logs/12345.json', - ], - 'RuntimeConfig' => [ - 'description' => 'The runtime configurations of the AI agent.'."\n", - 'example' => '{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}', - '$ref' => '#/components/schemas/AIAgentRuntimeConfig', - ], - 'Status' => [ - 'description' => 'The state of the instance. Valid values:'."\n" - ."\n" - .'* Executing'."\n" - .'* Finished'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Finished' => 'Finished', - 'Executing' => 'Executing', + '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' => ''], ], - 'example' => 'Finished', - ], - 'TemplateConfig' => [ - 'description' => 'The template configurations of the AI agent.'."\n", - 'example' => '{"VoiceChat": {"VoiceId": "zhixiaoxia"}}', - '$ref' => '#/components/schemas/AIAgentTemplateConfig', - 'deprecated' => true, - ], - 'UserData' => [ - 'description' => 'The custom information.'."\n", - 'type' => 'string', - 'example' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}', - ], - 'AgentConfig' => [ - '$ref' => '#/components/schemas/AIAgentConfig', + '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' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', - ], + '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 \\"Instances\\": [\\n {\\n \\"CallLogUrl\\": \\"https://example.com/call_logs/12345.json\\",\\n \\"RuntimeConfig\\": {\\n \\"VoiceChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"VisionChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"ChannelId\\": \\"\\",\\n \\"AvatarChat3D\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n }\\n },\\n \\"Status\\": \\"Finished\\",\\n \\"TemplateConfig\\": {\\n \\"VoiceChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AvatarUrlType\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"MessageChat\\": {\\n \\"AppId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ]\\n },\\n \\"VisionChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"AvatarChat3D\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"AvatarId\\": \\"\\",\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n }\\n },\\n \\"UserData\\": \\"{\\\\\\"Email\\\\\\":\\\\\\"johndoe@example.com\\\\\\",\\\\\\"Preferences\\\\\\":{\\\\\\"Language\\\\\\":\\\\\\"en\\\\\\"}}\\",\\n \\"AgentConfig\\": {\\n \\"AppId\\": \\"\\",\\n \\"Greeting\\": \\"\\",\\n \\"WakeUpQuery\\": \\"\\",\\n \\"MaxIdleTime\\": 0,\\n \\"UserOnlineTimeout\\": 0,\\n \\"UserOfflineTimeout\\": 0,\\n \\"EnablePushToTalk\\": true,\\n \\"GracefulShutdown\\": true,\\n \\"Volume\\": 0,\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"AvatarUrlType\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AsrConfig\\": {\\n \\"AsrLanguageId\\": \\"\\",\\n \\"AsrMaxSilence\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CustomParams\\": \\"\\",\\n \\"VadDuration\\": 0\\n },\\n \\"TtsConfig\\": {\\n \\"VoiceId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"PronunciationRules\\": [\\n {\\n \\"Word\\": \\"\\",\\n \\"Pronunciation\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"ModelId\\": \\"\\",\\n \\"LanguageId\\": \\"\\",\\n \\"Emotion\\": \\"\\",\\n \\"SpeechRate\\": 0\\n },\\n \\"LlmConfig\\": {\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"OpenAIExtraQuery\\": \\"\\",\\n \\"LlmCompleteReply\\": true,\\n \\"FunctionMap\\": [\\n {\\n \\"Function\\": \\"\\",\\n \\"MatchFunction\\": \\"\\"\\n }\\n ],\\n \\"OutputMinLength\\": 0,\\n \\"OutputMaxDelay\\": 0,\\n \\"HistorySyncWithTTS\\": true\\n },\\n \\"AvatarConfig\\": {\\n \\"AvatarId\\": \\"\\"\\n },\\n \\"InterruptConfig\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"NoInterruptMode\\": \\"\\"\\n },\\n \\"VoiceprintConfig\\": {\\n \\"UseVoiceprint\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"RegistrationMode\\": \\"\\"\\n },\\n \\"TurnDetectionConfig\\": {\\n \\"TurnEndWords\\": [\\n \\"\\"\\n ],\\n \\"Mode\\": \\"\\",\\n \\"SemanticWaitDuration\\": 0,\\n \\"Eagerness\\": \\"\\"\\n },\\n \\"ExperimentalConfig\\": \\"\\",\\n \\"VcrConfig\\": {\\n \\"StillFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"InvalidFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"PeopleCount\\": {\\n \\"Enabled\\": true\\n },\\n \\"Equipment\\": {\\n \\"Enabled\\": true\\n },\\n \\"HeadMotion\\": {\\n \\"Enabled\\": true\\n },\\n \\"LookAway\\": {\\n \\"Enabled\\": true\\n }\\n },\\n \\"OutboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"SipDomain\\": \\"\\"\\n },\\n \\"InboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"AuthUrl\\": \\"\\",\\n \\"AuthToken\\": \\"\\"\\n },\\n \\"AmbientSoundConfig\\": {\\n \\"ResourceId\\": \\"\\",\\n \\"Volume\\": 0\\n },\\n \\"AutoSpeechConfig\\": {\\n \\"UserIdle\\": {\\n \\"WaitTime\\": 0,\\n \\"MaxRepeats\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n },\\n \\"LlmPending\\": {\\n \\"WaitTime\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n },\\n \\"BackChannelingConfigs\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n ],\\n \\"BackChannelingConfig\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', - 'title' => 'ListAIAgentInstance', - 'description' => '## [](#)Request description'."\n" - ."\n" - .'You can call this operation to query a list of AI agents based on the `AIAgentId`. The optional parameters include `StartTime`, `EndTime`, `PageSize`, and `PageNumber`. The returned result includes the status, runtime configurations, template configurations, custom information, and the URL of call log file for each AI agent.'."\n" - ."\n" - .'**Note**:'."\n" - ."\n" - .'* The default value of `PageSize` is 10, and the default value of `PageNumber` is 1.'."\n", - ], - 'SendAIAgentSpeech' => [ - 'summary' => 'Instructs an AI agent to immediately broadcast a text message and supports interruption settings.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '237311', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + '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' => [], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', - ], - ], - [ - 'name' => 'Text', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'EnableInterrupt', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the broadcast can interrupt the ongoing speech. Default value: true'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], + 'ramActions' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListVodPackagingAssets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', - 'title' => 'SendAIAgentSpeech', - 'description' => 'You can call this operation to instruct an AI agent to broadcast the content that you specify. You can determine whether this broadcast can immediately interrupt the ongoing speech. The interruption is allowed by default.'."\n" - ."\n" - .'**Note**'."\n" - ."\n" - .'* Make sure that the `InstanceId` is valid and corresponds to an existing AI agent.'."\n" - .'* The content of `Text` must comply with the specifications and does not contain sensitive or inappropriate information.'."\n" - .'* If you do not want the new broadcast to interrupt the ongoing speech, you must set `EnableInterrupt` to `false`.'."\n", + 'translator' => 'manual', ], - 'TakeoverAIAgentCall' => [ - 'summary' => 'Hands off a conversation to a human agent.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListVodPackagingConfigurations' => [ + 'summary' => 'Lists VOD packaging configurations.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceMX4DML', - ], + 'abilityTreeNodes' => ['FEATUREice20UKYV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent that will be taken over.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '39f8e0bc005e4f309379701645f4****', - ], + 'schema' => ['description' => 'The name of the packaging group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vod_hls'], ], [ - 'name' => 'HumanAgentUserId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the human agent that will take over the AI agent (UserId in ARTC). If you do not specify this parameter, it is automatically generated and returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'uid2', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'RequireToken', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the ARTC token. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'ChannelId' => [ - 'description' => 'The ID of the ARTC channel.'."\n", - 'type' => 'string', - 'example' => '70f22d5784194938a7e387052f2b3208', - ], - 'HumanAgentUserId' => [ - 'description' => 'The ID of the human agent.'."\n", - 'type' => 'string', - 'example' => 'uid2', - ], - 'Token' => [ - 'description' => 'The ARTC token.'."\n", - 'type' => 'string', - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\",\\n \\"HumanAgentUserId\\": \\"uid2\\",\\n \\"Token\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\"\\n}","type":"json"}]', - 'title' => 'TakeoverAIAgentCall', - ], - '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', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent in the conversation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****'."\n", - ], + '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' => 'Message', + 'name' => 'Keyword', '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"key":"value"}', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'."\n", + '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\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\\\n\\"\\n}","type":"json"}]', - 'title' => 'SendAIAgentDataChannelMessage', - ], - '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', - ], + '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' => [], ], - '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****', - ], - ], + 'ramActions' => [ [ - 'name' => 'Text', - 'in' => 'query', - 'schema' => [ - 'description' => 'The input to the LLM.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hello', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DB488837-3****', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListVodPackagingConfigurations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB488837-3****\\"\\n}","type":"json"}]', - 'title' => 'SendAIAgentText', + 'translator' => 'manual', ], - 'GenerateMessageChatToken' => [ - 'summary' => 'Generates the token required for interactive messaging.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListVodPackagingGroups' => [ + 'summary' => 'Lists VOD packaging groups.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49021,294 +35479,90 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236523', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREice20UKYV'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'AIAgentId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '19de81b3b3d94abda22******', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'UserId', + 'name' => 'PageSize', '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 (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'YOURUSERID', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Role', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The role. A value of admin indicates that the user can perform management operations. This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], + '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' => 'Expire', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The validity period. Unit: seconds. Default value: 3600.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3600', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The query results.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'req_1234567890abcdef', - ], - 'Token' => [ - 'description' => 'The generated token.'."\n", - 'type' => 'string', - 'example' => 'acet**********', - ], - 'AppId' => [ - 'description' => 'The AppID of the user.'."\n", - 'type' => 'string', - 'example' => '***********', - ], - 'UserId' => [ - 'description' => 'The ID of the user for joining the channel.'."\n", - 'type' => 'string', - 'example' => 'YOURUSERID', - ], - 'Nonce' => [ - 'description' => 'The nonce used to generate the token.'."\n", - 'type' => 'string', - 'example' => 'AK-***********', - ], - 'Role' => [ - 'description' => 'The role used to generate the token.'."\n", - 'type' => 'string', - 'example' => 'admin', - ], - 'AppSign' => [ - 'description' => 'The application signature.'."\n", - 'type' => 'string', - 'example' => 'H4sIAAAAAAAE******************', - ], - 'TimeStamp' => [ - 'description' => 'The expiration time. Unit: seconds. Expiration time = Current time + Validity period.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700000000', + '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\\": \\"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', - ], - 'GenerateAIAgentCall' => [ - 'summary' => 'Creates an AI agent. This operation returns the channel in which the AI agent resides, the username of the AI agent in the channel, and the token that you can use 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', - ], + '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' => [], ], - 'parameters' => [ - [ - 'name' => 'AIAgentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', - ], - ], - [ - 'name' => 'Expire', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the token expires. Unit: seconds. Default value: 3600. Valid values: 0 to 604800.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The username of the AI agent in the channel. If you do not specify this parameter, the system automatically generates a username. The value can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '877ae632caae49b1afc81c2e8194ffb4', - ], - ], - [ - 'name' => 'TemplateConfig', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The template configurations of the AI agent. The specified configurations are merged with the template configurations that are specified in the console. If you do not specify this parameter, the system uses the default configurations for an AI agent created in the console.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/AIAgentTemplateConfig', - 'deprecated' => true, - ], - ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}'."\n", - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fw1gr0bc005e4f309379701645f4****', - ], - ], + 'ramActions' => [ [ - 'name' => 'AgentConfig', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - '$ref' => '#/components/schemas/AIAgentConfig', - ], - ], - [ - 'name' => 'ChatSyncConfig', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'IMAIAgentId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '******005e4f309379701645f4****'."\n", - ], - 'ReceiverId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4167626d312034b2b1c3b7f2f3e41884', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'AIAgentUserId' => [ - 'description' => 'The username of the AI agent in the Alibaba Real-Time Communication (ARTC) channel.'."\n", - 'type' => 'string', - 'example' => '877ae632caae49b1afc81c2e8194ffb4', - ], - 'ChannelId' => [ - 'description' => 'The ARTC channel ID.'."\n", - 'type' => 'string', - 'example' => '70f22d5784194938a7e387052f2b3208', - ], - 'InstanceId' => [ - 'description' => 'The ID of the AI agent.'."\n", - 'type' => 'string', - 'example' => '39f8e0bc005e4f309379701645f4****', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', - ], - 'Token' => [ - 'description' => 'The ARTC token of the client.'."\n", - 'type' => 'string', - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', - ], - 'UserId' => [ - 'description' => 'The username in the ARTC channel.'."\n", - 'type' => 'string', - 'example' => 'user123', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListVodPackagingGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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}","type":"json"}]', - 'title' => 'GenerateAIAgentCall', - 'description' => '## [](#)Request description'."\n" - ."\n" - .'You can call this operation to create an AI agent based on the provided ID. You can join the channel based on the returned information and talk to the agent.'."\n" - ."\n" - .'**Note:** Make sure that the provided AI agent ID is valid and configure optional parameters based on your business requirements.'."\n", + 'translator' => 'manual', ], - 'ListAIAgentDialogues' => [ - 'summary' => 'Lists the dialog records of an AI agent.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkflowTasks' => [ + 'summary' => 'Retrieves workflow tasks.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49317,226 +35571,147 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235498', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'SessionId', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'f27f9b9be28642a88e18****', - ], + 'schema' => ['description' => 'The ID of the workflow template.[](https://ims.console.aliyun.com/settings/workflow/list)', 'type' => 'string', 'required' => false, 'example' => '******b4fb044839815d4f2cd8******', 'title' => ''], ], - [ - 'name' => 'RoundLimit', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + [ + 'name' => 'WorkflowName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the workflow template.', 'type' => 'string', 'required' => false, 'example' => 'example-workflow-****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'KeyText', 'in' => 'query', - 'schema' => [ - 'description' => 'Specify the start of the time range to query using a UNIX timestamp accurate to milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], + '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' => 'EndTime', + 'name' => 'StartOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specify the end of the time range to query using a UNIX timestamp accurate to milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '17358082464030', - ], + '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' => 'PageNumber', + 'name' => 'EndOfCreateTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'MaxResults', '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' => '20', - ], + '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' => 'Order', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order. Valid values: '."\n" - ."\n" - .'- DESC: descending order (default)'."\n" - .'- ASC: ascending order', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-***************', - ], - 'Dialogues' => [ - 'description' => 'The dialog records.'."\n", + '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' => [ - 'DialogueId' => [ - 'description' => 'The unique ID of the dialog.', - 'type' => 'string', - 'example' => '19de81b3b3d94abda22****', - ], - 'RoundId' => [ - 'description' => 'The ID of the conversational turn.', - 'type' => 'string', - 'example' => 'f27f9b9be28642a88e18****', - ], - 'Producer' => [ - 'description' => 'The speaker. Valid values: '."\n" - ."\n" - .'- user'."\n" - .'- agent', - 'type' => 'string', - 'enumValueTitles' => [ - 'agent' => 'agent', - 'user' => 'user', - ], - 'example' => 'user', - ], - 'Text' => [ - 'description' => 'The specific content.', - 'type' => 'string', - 'example' => 'Hello', - ], - 'ReasoningText' => [ - 'description' => 'The reasoning trace.'."\n", - 'type' => 'string', - 'example' => 'I\'m thinking'."\n", - ], - 'AttachedFileList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - 'Format' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Name' => [ - 'type' => 'string', - ], - ], + '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' => '', ], - 'Time' => [ - 'description' => 'The UNIX timestamp, measured in milliseconds, which indicates the time when the message was generated.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1734511087000', - ], - 'Type' => [ - 'description' => 'The message type. Valid values:'."\n" - ."\n" - .'Voice calls:'."\n" - ."\n" - .'1. greeting: the welcome message.'."\n" - .'2. normal: the voice response.'."\n" - .'3. speech: the proactive message.'."\n" - ."\n" - .'Messaging conversations:'."\n" - ."\n" - .'1. normal: the text reply.'."\n" - .'2. announcement: the proactive text message.'."\n" - .'3. custom: the custom message.'."\n", - 'type' => 'string', - 'example' => 'announcement', - ], - 'Source' => [ - 'description' => 'The source of the message. Valid values:'."\n" - ."\n" - .'chat: messaging conversations.'."\n" - ."\n" - .'call: voice calls.'."\n", - 'type' => 'string', - 'example' => 'chat', - ], - 'NodeId' => [ - 'type' => 'string', - ], - 'Extend' => [ - 'type' => 'string', - ], + 'UserData' => ['description' => 'The custom data that was passed when the task was submitted.', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', 'title' => ''], ], - 'description' => '', + '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 \\"RequestId\\": \\"7B117AF5-***************\\",\\n \\"Dialogues\\": [\\n {\\n \\"DialogueId\\": \\"19de81b3b3d94abda22****\\",\\n \\"RoundId\\": \\"f27f9b9be28642a88e18****\\",\\n \\"Producer\\": \\"user\\",\\n \\"Text\\": \\"你好\\",\\n \\"ReasoningText\\": \\"我在思考\\",\\n \\"AttachedFileList\\": [\\n {\\n \\"Url\\": \\"\\",\\n \\"Id\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"Type\\": 0,\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Time\\": 1734511087000,\\n \\"Type\\": \\"announcement\\",\\n \\"Source\\": \\"chat\\",\\n \\"NodeId\\": \\"\\",\\n \\"Extend\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListAIAgentDialogues', - ], - 'DeleteAIAgentDialogue' => [ - 'summary' => 'Deletes dialog records of an AI agent.', - 'methods' => [ - 'post', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -49545,322 +35720,422 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235498', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ - 'name' => 'SessionId', + 'name' => 'ProductionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.', - 'type' => 'string', - 'required' => true, - 'example' => '6d594e7f55624c47a48789******', - ], + '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' => 'DialogueId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dialog that you want to delete.', - 'type' => 'string', - 'required' => true, - 'example' => 'f27f9b9be28642a88e18*******', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NodeId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A1******', + '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', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A1******\\"\\n}","type":"json"}]', - 'title' => 'DeleteAIAgentDialogue', - ], - 'SendMessageChatText' => [ - 'summary' => 'Sends a message to the client.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve Folder List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '237311', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the session.', - 'type' => 'string', - 'required' => true, - 'example' => 'f27f9b9be28642a88e18****', - ], - ], - [ - 'name' => 'AIAgentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent.', - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', - ], - ], - [ - 'name' => 'ReceiverId', + 'name' => 'MaxResults', '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', - ], + 'schema' => ['description' => 'The maximum number of results to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the message. Valid values:'."\n" - ."\n" - .'- announcement: notification.'."\n" - .'- custom: custom message.', - 'type' => 'string', - 'required' => true, - 'example' => 'announcement', - ], + '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' => 'Text', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the message.', - 'type' => 'string', - 'required' => true, - 'example' => 'Hello', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Mode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The mode of message sending. Valid values:'."\n" - .'- online'."\n" - .'- offline'."\n" - ."\n" - .'Default value: offline.', - 'type' => 'string', - 'required' => false, - 'example' => 'online', - ], + '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' => 'NeedArchiving', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to archive chat records. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-zna577pdximvztk5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the project list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', - 'title' => 'SendMessageChatText', - ], - 'StartAIAgentOutboundCall' => [ - 'summary' => 'Initiates an outbound phone call for an AI agent.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236524', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], ], 'parameters' => [ [ - 'name' => 'AIAgentId', + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***********e4f309379701645f4****', + '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' => [ [ - 'name' => 'CallerNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '183*****333', + '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' => [ [ - 'name' => 'CalledNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '173*****533', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], + ], + 'parameters' => [ [ - 'name' => 'Config', + 'name' => 'AppId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/AIAgentOutboundCallConfig', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app-1000000', 'title' => ''], ], [ - 'name' => 'UserData', + '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' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'PrecheckYikeAIAppJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f213fbc005e4f309379701645f4****'."\n", + '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' => 'ImsAIAgentFreeObCall', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*********296014bb58670940*********', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '***********-4417-BDB2************', + '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', + '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'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"*********296014bb58670940*********\\",\\n \\"RequestId\\": \\"***********-4417-BDB2************\\"\\n}","type":"json"}]', - 'title' => 'StartAIAgentOutboundCall', - ], - 'ListAIAgentPhoneNumber' => [ - 'summary' => 'Lists available phone numbers.', - 'methods' => [ - 'post', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:QueryCopyrightExtractJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'manual', + ], + 'QueryCopyrightJobList' => [ + 'summary' => 'Queries copyright watermarking jobs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49872,333 +36147,624 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236523', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', - ], + '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' => 'PageNumber', + 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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' => 'Number', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '****cdb3e74639973036bc84****', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + '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' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ - 'description' => '', + 'description' => 'The data returned.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'PhoneNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => '132*****683', + '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' => '', ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + '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' => '', ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '************16-412C-B127-******', - ], - 'TotalNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '186', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + '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 \\"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' => 'ListAIAgentPhoneNumber', - ], - 'ForwardAIAgentCall' => [ - 'summary' => '转呼通话到目标电话', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'call_instance_202******', - ], - ], - [ - 'name' => 'CalledNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13**********', - ], - ], - [ - 'name' => 'TransferPrompt', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => [ [ - 'name' => 'ErrorPrompt', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + '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' => [ [ - 'name' => 'CallerNumber', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobIds', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '550e8400********55440000'."\n", + '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' => '', ], ], ], - '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.', - ], + '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'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:QueryDNAJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"550e8400********55440000\\\\n\\"\\n}","type":"json"}]', - 'title' => 'ForwardAIAgentCall', + 'translator' => 'manual', ], - 'SetAIAgentVoiceprint' => [ - 'summary' => 'Registers a voiceprint.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QueryIProductionJob' => [ + 'summary' => 'Call `QueryIProductionJob` to get the status and result of an intelligent production job.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceMX4DML', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'VoiceprintId', + 'name' => 'ClientToken', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vp_1699123456_8527', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'A token that ensures request idempotence.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], ], [ - 'name' => 'Input', + 'name' => 'JobId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The input file.'."\n", - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'url', - ], - 'Data' => [ - 'description' => 'The media access link.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://my-bucket.oss-cn-hangzhou.aliyuncs.com/audio/sample.wav', - ], - 'Format' => [ - 'description' => 'The audio file format. Only WAV is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'wav', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The intelligent job ID.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '550e8400********55440000', + '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' => '', ], - 'VoiceprintId' => [ - 'description' => 'The ID of the registered voiceprint.'."\n", - 'type' => 'string', - 'example' => 'vp_1699123456_8527', + '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.', - ], + ['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'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QueryIProductionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"550e8400********55440000\\",\\n \\"VoiceprintId\\": \\"vp_1699123456_8527\\"\\n}","type":"json"}]', - 'title' => 'SetAIAgentVoiceprint', + 'translator' => 'machine', ], - 'ClearAIAgentVoiceprint' => [ - 'summary' => 'Deletes a voiceprint based on its ID.', + 'QueryIpcQuota' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50207,1378 +36773,1852 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceMX4DML', - ], + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'VoiceprintId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier for the voiceprint.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vp_1699123456_8527', - ], + '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' => 'RegistrationMode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'ClearAIAgentVoiceprint', - 'description' => '## [](#)'."\n" - ."\n" - .'``````````'."\n", - ], - 'ListAIAgentVoiceprints' => [ - 'summary' => 'Lists the registered voiceprints.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query IPC usage', + 'summary' => 'Query IPC usage.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceMX4DML', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'VoiceprintId', - 'in' => 'query', - 'schema' => [ - 'description' => 'A unique identifier for the voiceprint. This parameter is optional. If provided, only the information for that ID is returned. If not specified, all voiceprints under the account are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vp_1699123456_8527'."\n", - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Value values: \\[1,100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + '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' => 'RegistrationMode', + 'name' => 'MaximumPageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Voiceprints' => [ - 'description' => 'The voiceprints.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The voiceprint information.'."\n", - 'type' => 'object', - 'properties' => [ - 'VoiceprintId' => [ - 'description' => 'The unique identifier for the voiceprint.'."\n", - 'type' => 'string', - 'example' => 'vp_1699123456_8527', + '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' => '', + ], ], - 'GmtCreate' => [ - 'description' => 'The creation time of the voiceprint.'."\n", - 'type' => 'string', - 'example' => '2025-07-28T10:03:58.000+00:00', + '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' => ''], ], - 'GmtModified' => [ - 'description' => 'The last modification time of the voiceprint.'."\n", - 'type' => 'string', - 'example' => '2025-07-28T10:03:58.000+00:00', + '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' => ''], ], - ], - 'TotalCount' => [ - 'description' => 'The total number of voiceprints that match the query criteria.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + 'title' => '', + 'example' => '', ], ], + '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.', - ], - ], - ], - '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', - ], - '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' => [], - ], + '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'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236524', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobDetail'], ], ], - 'parameters' => [ - [ - 'name' => 'AIAgentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*******3b3d94abda22******', - ], - ], - [ - 'name' => 'Input', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The details of the input file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The OSS URL of the input file. Format:'."\n" - ."\n" - .'http(s)://{BucketName}.{Endpoint}/{ObjectName}'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://my-bucket.cn-shanghai.aliyuncs.com/object-id.mp4', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'CallbackConfig', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Callback configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => 'The URL for receiving callback notifications.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://yourcallback', - ], - 'Token' => [ - 'description' => 'The authentication token for callback.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Bearer Token', - ], - ], - 'required' => false, - 'example' => '{"Url":"https://yourcallback","Token":"yourtoken"}', - ], - ], - [ - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3000', - ], - ], + 'ramActions' => [ [ - '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.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'FrameCount' => [ - 'description' => 'The number of frames to capture.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'StartTime' => [ - 'description' => 'The timestamp in the video at which to start capturing frames. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Duration' => [ - 'description' => 'The duration over which to capture the specified number of frames. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Prompt' => [ - 'description' => 'The text prompt to send to the MLLM along with the captured frames.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '**********fb04483915d4f2**********', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '**********-586A-AC29-742247******', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QueryMediaCensorJobDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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.'."\n", + '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', ], - 'GetAiRtcLicenseInfoList' => [ - 'summary' => 'Retrieves a list of license batches for Real-time Conversational AI based on specified filter criteria.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryMediaCensorJobList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceMX4DML', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'LicenseItemId', + 'name' => 'JobIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the batch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '17712***', - ], + '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' => 'Status', + 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the batch. Valid values:'."\n" - ."\n" - .'* `1`: Active'."\n" - .'* `2`: Expired'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '1', - ], + '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' => 'Type', + 'name' => 'MaximumPageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of license. Valid values:'."\n" - ."\n" - .'* `1`: Audio call'."\n" - .'* `2`: Vision call'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '1', - ], + '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' => 'PageNo', + 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + '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' => 'PageSize', + 'name' => 'StartOfJobCreatedTimeRange', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => 'NeedTotalCount', + 'name' => 'EndOfJobCreatedTimeRange', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include the total count of records in the response. Defaults to `true`.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + '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' => [ - 'title' => '', - 'description' => 'ApiResponse\\'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1***', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'httpStatusCode', - ], - 'LicenseInfoList' => [ - 'description' => 'An array of AiRtcLicenseInfoDTO objects, each representing a license batch.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A license batch.'."\n", - '$ref' => '#/components/schemas/AiRtcLicenseInfoDTO', + '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' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + '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' => '', ], ], ], - '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\\": \\"\\",\\n \\"ModificationTime\\": \\"\\",\\n \\"Type\\": 0,\\n \\"LicenseItemId\\": \\"\\",\\n \\"Status\\": 0,\\n \\"ValidDays\\": 0,\\n \\"ExpiredOn\\": \\"\\",\\n \\"BeginOn\\": \\"\\",\\n \\"LicenseCount\\": 0,\\n \\"AvailableCapacity\\": 0,\\n \\"InstanceId\\": \\"\\",\\n \\"ContractNo\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', - 'title' => 'GetAiRtcLicenseInfoList', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'* This API allows you to retrieve a list of license batches for Real-time Conversational AI using filters such as Batch ID, status, and type.'."\n" - .'* By default, the `NeedTotalCount` parameter is set to `true`, indicating that the response includes the total count of matching records. Set it to `false` if you do not need this total.'."\n" - .'* If no filter criteria are provided, the API returns information for all license batches.'."\n", - ], - 'GetAiRtcAuthCodeList' => [ - 'summary' => 'Retrieves a list of Real-time Conversational AI authentication codes and their status for a specified batch.', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceMX4DML', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'LicenseItemId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the batch.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '17712***', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the authorization code. Valid values:'."\n" - ."\n" - .'* `1`: Activated'."\n" - .'* `2`: Inactive'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of license. Valid values:'."\n" - ."\n" - .'* `1`: Audio call'."\n" - .'* `2`: Vision call'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the search library. Default value: ims-default-search-lib.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test1'], ], [ - 'name' => 'NeedTotalCount', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include the total count of records in the response. Defaults to `true`.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c2e77390f75271ec802f0674a2ce6***'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', - 'description' => 'ApiResponse\\'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1***', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'AuthCodeList' => [ - 'description' => 'An array of AiRtcAuthCodeDTO objects, each representing an authorization code.'."\n", + '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' => 'An authorization code.'."\n", - '$ref' => '#/components/schemas/AiRtcAuthCodeDTO', + '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' => '', ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'title' => '', + 'example' => '', ], ], + '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\\": 0,\\n \\"Type\\": 0,\\n \\"AuthCode\\": \\"\\",\\n \\"ActivatedTime\\": \\"\\",\\n \\"DeviceId\\": \\"\\",\\n \\"CreationTime\\": \\"\\",\\n \\"License\\": \\"\\",\\n \\"ModificationTime\\": \\"\\",\\n \\"LicenseItemId\\": \\"\\"\\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" - .'* Pagination is supported via the `PageNo` and `PageSize` parameters.'."\n" - .'* By default, the `NeedTotalCount` parameter is set to `true`, indicating that the response includes the total count of matching records.'."\n" - .'* `LicenseItemId` is a required parameter that specifies the batch to query.'."\n", - ], - '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', + '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'], ], ], - 'parameters' => [ - [ - 'name' => 'LicenseItemId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The batch ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '17712***', - ], - ], - [ - 'name' => 'AuthCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The authorization code.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'iU1IeJech7***', - ], - ], + 'ramActions' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The device ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'device-***', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '', - 'description' => 'ApiResponse\\'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4F9C14FE-1147-15AC-8EDF-A590FF12***', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'License' => [ - 'description' => 'The license information.'."\n", - 'type' => 'string', - 'example' => 'a659a06659a***', - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:QueryMediaIndexJob', + '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"}]', - 'title' => 'ActiveAiRtcLicense', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'This API is used to 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.'."\n", + 'translator' => 'manual', ], - 'SubmitVideoCognitionJob' => [ - 'summary' => 'Submits a video for AI analysis and processing.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QuerySearchIndex' => [ + 'summary' => 'Gets details about a search index.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'description' => 'The video title. It supports letters, digits, and hyphens (-), and cannot start with a special character. Max length: 256 bytes.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'example-title-**** ', - ], - ], - [ - 'name' => 'Params', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'description' => 'Additional request parameters, provided as a JSON string. This is used to pass specific settings for various AI analysis modules, such as Natural Language Processing (NLP), shot segmentation, tagging, and action recognition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "nlpParams": {'."\n" - .' "sourceLanguage": "cn",'."\n" - .' "diarizationEnabled": true,'."\n" - .' "speakerCount": 2,'."\n" - .' "summarizationEnabled": true,'."\n" - .' "summarizationTypes": "Paragraph,Conversational,QuestionsAnswering,MindMap",'."\n" - .' "translationEnabled": true,'."\n" - .' "targetLanguages": "en",'."\n" - .' "autoChaptersEnabled": true,'."\n" - .' "meetingAssistanceEnabled": true'."\n" - .' }'."\n" - .'}', - ], + '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' => 'UserData', + 'name' => 'IndexType', 'in' => 'query', 'schema' => [ - 'description' => 'The user-defined data that is passed through and returned as-is in the response. Max length: 1,024 bytes.'."\n", + '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' => false, - 'example' => '{"test":1}', + 'required' => true, + 'title' => '', + 'example' => 'mm', ], ], - [ - 'name' => 'Input', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'input', - 'description' => 'The media input object.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of media input. Valid values:'."\n" + '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" - .'* OSS'."\n" - .'* Media'."\n" - .'* URL'."\n", + .'- face: face recognition.'."\n" + ."\n" + .'- aiLabel: smart tagging.', + 'enumValueTitles' => ['mm' => 'mm', 'face' => 'face', 'aiLabel' => 'aiLabel'], 'type' => 'string', - 'required' => false, - 'example' => 'Media', + 'title' => '', + 'example' => 'mm', ], - 'Media' => [ - 'description' => 'If Type is set to OSS, specify an OSS path. Example: OSS://test-bucket/video/202208/test.mp4.'."\n" + 'IndexStatus' => [ + 'description' => 'The state of the index. Valid values:'."\n" ."\n" - .'If Type is set to Media, specify a media asset ID. Example: c5c62d8f0361337cab312dce8e77dc6d.'."\n" + .'- active: the index is enabled.'."\n" ."\n" - .'If Type is set to URL, specify an HTTP URL. Example: https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4.'."\n", + .'- Deactive: the index is not enabled.', + 'enumValueTitles' => ['Active' => 'Active', 'Deactive' => 'Deactive'], 'type' => 'string', - 'required' => false, - 'example' => 'c5c62d8f03613************c6d', + 'example' => 'Active', + 'title' => '', ], + 'MediaTotal' => ['description' => 'The total number of media assets.', 'type' => 'string', 'example' => '12', 'title' => ''], ], - 'required' => false, - 'docRequired' => true, - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the template that specifies the analysis algorithms to be used. For details, see [CreateCustomTemplate](https://help.aliyun.com/zh/ims/developer-reference/api-ice-2020-11-09-createcustomtemplate?spm=a2c4g.11186623.help-menu-193643.d\\_5\\_0\\_3\\_3\\_0\\_0.17b66afamjKySv) and [smart tagging template](https://help.aliyun.com/zh/ims/user-guide/smart-tagging-template?spm=a2c4g.11186623.0.i15).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '39f8e0bc00***************', + 'example' => '', ], ], - [ - 'name' => 'TemplateConfig', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + ], + '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'], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:QuerySearchIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitVideoCognitionJob', - 'requestParamsDescription' => '### nlpParams'."\n" - ."\n" - .'|Feature|Parameter|Type|Required|Description|Example|'."\n" - .'|---|---|---|---|---|---|'."\n" - .'||nlpParams|object|Yes|An object containing all NLP-related parameters. This field is required if the analysis template includes the NLP type.|{"sourceLanguage":"cn"}|'."\n" - .'|Transcription|sourceLanguage|string|Yes|The source language for transcription. Valid values: cn (Mandarin), en (English), yue (Cantonese), fspk (Chinese and English).|"cn"|'."\n" - .'||diarizationEnabled|boolean|No|Specifies whether to enable speaker diarization. Default value: false.|true|'."\n" - .'||speakerCount|integer|No|Specifies the number of speakers for diarization. If this parameter is not specified, the speakers are not recognized. Valid values: 0: an arbitrary number of speakers. 2: two speakers.|2|'."\n" - .'|Summarization|summarizationEnabled|boolean|No|Specifies whether to enable summarization, which can generate full-text summaries, speaker summaries, and more.|true|'."\n" - .'||summarizationTypes|string|No|Specify the desired summary types. Valid values: Paragraph (full-text summary), Conversational (speaker summary), QuestionsAnswering (Q&A), and MindMap.|"Paragraph,Conversational,QuestionsAnswering,MindMap"|'."\n" - .'|Translation|translationEnabled|boolean|No|Specifies whether to enable translation.|true|'."\n" - .'||targetLanguages|string|No|The target languages for translation. Valid values: cn (Mandarin), en (English), yue (Cantonese), fspk (Chinese and English).|"en,cn"|'."\n" - .'|Chapter generation|autoChaptersEnabled|boolean|No|Specifies whether to enable chapter generation. The output includes chapter titles and summaries.|true|'."\n" - .'|AI minutes|meetingAssistanceEnabled|boolean|No|Specifies whether to enable AI minutes. The output includes topic classification, keywords, key sentences, and to-do list.|true|', + 'translator' => 'manual', ], - 'QueryVideoCognitionJob' => [ - 'summary' => 'Retrieves the results of an AI analysis and processing task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QuerySearchLib' => [ + 'summary' => 'Gets information about a search library.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the task to query. It is returned when you call the [SubmitSmarttagJob](~~478786~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], - [ - 'name' => 'Params', - 'in' => 'query', - 'schema' => [ - 'description' => 'Additional request parameters, provided as a JSON string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'IncludeResults', + 'name' => 'SearchLibName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Specifies whether to include the full algorithm results in the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'NeedAsr' => [ - 'description' => 'Specifies whether to include Automatic Speech Recognition (ASR) results.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'NeedOcr' => [ - 'description' => 'Specifies whether to include Optical Character Recognition (OCR) results.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'NeedProcess' => [ - 'description' => 'Specifies whether to include the URL to the raw output of the algorithm.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], + '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' => [ - 'JobStatus' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* **Success**'."\n" - .'* **Fail**'."\n" - .'* **Processing**'."\n" - .'* **Submitted**'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******'."\n", - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", + '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' => '{"userId":"123432412831"}'."\n", + 'example' => 'normal', + 'title' => '', ], - 'Results' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'result' => [ - 'description' => 'An array of analysis result objects.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of analysis result. Valid values:'."\n" - ."\n" - .'1. TextLabel: Tags from text content.'."\n" - .'2. VideoLabel: Tags from video content.'."\n" - .'3. ASR: Raw speech recognition results. Not returned by default.'."\n" - .'4. OCR: Raw text recognition results. Not returned by default.'."\n" - .'5. NLP: Natural Language Processing results. Not returned by default.'."\n" - .'6. Process: URL to the raw algorithm output. Not returned by default.'."\n", - 'type' => 'string', - 'example' => 'ASR', - ], - 'Data' => [ - 'description' => 'A JSON string containing the detailed analysis data. The structure of this data depends on the Type field. For details, see the Result parameters section below.'."\n", - 'type' => 'string', - 'example' => '{"title":"example-title-****"} '."\n", - ], - ], - 'description' => '', - ], + '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"}'], ], - 'description' => '', + 'example' => '', ], ], ], - '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}","type":"json"}]', - 'title' => 'QueryVideoCognitionJob', - 'responseParamsDescription' => '**Result parameters**'."\n" - ."\n" - .'**VideoLabel** data structure'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|persons|JSONArray|An array of detected person results.|'."\n" - .'|persons.name|String|The name of the recognized person.|'."\n" - .'|persons.category|String|The category of the person. Valid values: `celebrity`, `politician`, `sensitive`, `unknown`, and the ID of a custom figure library.|'."\n" - .'|persons.ratio|double|The appearance rate of the person. Valid values: 0 to 1.|'."\n" - .'|persons.occurrences|JSONArray|An array of detailed appearance information for the person.|'."\n" - .'|persons.occurrences.score|double|Confidence score of the recognition.|'."\n" - .'|persons.occurrences.from|double|Start time of the appearance, in seconds.|'."\n" - .'|persons.occurrences.to|double|End time of the appearance, in seconds.|'."\n" - .'|persons.occurrences.position|JSONObject|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 this specific coordinate capture, in seconds.|'."\n" - .'|persons.occurrences.scene|String|The shot type. Valid values: `closeUp`, `medium-closeUp`, `medium`, and `medium-long` (full shot).|'."\n" - .'|tags|JSONArray|An array of detected objects, scenes, and other tags. See examples below.|'."\n" - .'|tags.mainTagName|String|The main tag.|'."\n" - .'|tags.subTagName|String|The subtag.|'."\n" - .'|tags.ratio|double|The appearance rate of the tag. Valid values: 0 to 1.|'."\n" - .'|tags.occurrences|JSONArray|An array of detailed appearance information for the tag.|'."\n" - .'|tags.occurrences.score|double|The confidence score.|'."\n" - .'|tags.occurrences.from|double|Start time, in seconds.|'."\n" - .'|tags.occurrences.to|double|End time, in seconds.|'."\n" - .'|classifications|JSONArray|An array of video classification information.|'."\n" - .'|classifications.score|double|The confidence score of the classification.|'."\n" - .'|classifications.category1|String|The level-1 category, such as Lifestyle, Anime, or Automotive.|'."\n" - .'|classifications.category2|String|The level-2 category, such as health or home under the level-1 category Lifestyle.|'."\n" - ."\n" - .'Tags examples'."\n" - ."\n" - .'|mainTagName|subTagName|'."\n" - .'|---|---|'."\n" - .'|Program|Dad, Where Are We Going?, Top Funny Comedian|'."\n" - .'|Role|Doctor, Nurse, Teacher|'."\n" - .'|Object|Piano, Cup, Table, Scrambled eggs with tomato, car, cosmetics|'."\n" - .'|Logo|CCTV-1, CCTV-2, CNN, BBC|'."\n" - .'|Action|Dancing, Kissing, Hugging, Meeting, Singing, Calling, Horseback riding, Fighting|'."\n" - .'|Location|Tiananmen Square, Statue of Liberty, Leshan Giant Buddha, China, America|'."\n" - .'|Scene|Bedroom, Subway Station, Terraced Field, Beach, Desert|'."\n" - ."\n" - .'**ImageLabel** data structure'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|persons|JSONArray|The information about the recognized people.|'."\n" - .'|persons.name|String|The name of the recognized person.|'."\n" - .'|persons.category|String|The type of the recognized person. Valid values: celebrity, politician, and sensitive.|'."\n" - .'|persons.score|double|Confidence score of the recognition.|'."\n" - .'|persons.position|JSONObject|Face coordinates.|'."\n" - .'|persons.position.leftTop|int\\[\\]|The x and y coordinates of the top-left corner.|'."\n" - .'|persons.position.rightBottom|int\\[\\]|The x and y coordinates of the bottom-right corner.|'."\n" - .'|persons.scene|String|The shot type. Valid values: closeUp, medium-closeUp, medium, medium-long.|'."\n" - .'|tags|JSONArray|An array of detected objects, scenes, and other tags. See examples below.|'."\n" - .'|tags.mainTagName|String|The main tag.|'."\n" - .'|tags.subTagName|String|The subtag.|'."\n" - .'|tags.score|double|The confidence score.|'."\n" - ."\n" - .'Tags examples'."\n" - ."\n" - .'|mainTagName|subTagName|'."\n" - .'|---|---|'."\n" - .'|Role|Doctor, Nurse, Teacher|'."\n" - .'|Location|Tiananmen Square, Statue of Liberty, Leshan Giant Buddha, China, America|'."\n" - .'|Action|Talking|'."\n" - .'|Logo|CCTV-1, CCTV-2, CNN, BBC|'."\n" - .'|Action|Dancing, Kissing, Hugging, Meeting, Singing, Calling, Horseback riding, Fighting|'."\n" - .'|Object|Piano, Cup, Table, Scrambled eggs with tomato, car, cosmetics|'."\n" - .'|Scene|Bedroom, Subway Station, Terraced Field, Beach, Desert|'."\n" - ."\n" - .'TextLabel data structure from ASR & OCR'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|tags|JSONArray|The text tags. For more information, see the following table.|'."\n" - .'|tags.name|String|The category of the tag.|'."\n" - .'|tags.value|String|The detected values. May contain multiple values separated by a comma.|'."\n" - ."\n" - .'Tags examples'."\n" - ."\n" - .'|name|value|'."\n" - .'|---|---|'."\n" - .'|Location|Tiananmen Square, Statue of Liberty, Leshan Giant Buddha, China, America|'."\n" - .'|Organization|World Wildlife Fund, China Media Group|'."\n" - .'|Logo|Nike, Li-Ning|'."\n" - .'|Keyword|Backbone force|'."\n" - ."\n" - .'**CPVLabel** data structure'."\n" - ."\n" - .'* cates: An array of hierarchical category results.'."\n" - .'* entities: An array of entity results, with knowledge graph data.'."\n" - .'* hotwords: An array of detected hotwords from a watchlist.'."\n" - .'* freeTags: free tags (keywords).'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|type|String|hmi|The type of the result. Valid values: hmi (human-in-the-loop), autp (automated tagging).|'."\n" - .'|cates|JSONArray|\\-|An array of hierarchical category results.|'."\n" - .'|cates.labelLevel1|String|Travel|The level-1 tag.|'."\n" - .'|cates.labelLevel2|String|Scenery|The level-2 tag.|'."\n" - .'|cates.label|String|""|The name of the tag. An empty value may be returned by the algorithm.|'."\n" - .'|cates.appearanceProbability|double|0.96|The appearance rate.|'."\n" - .'|cates.detailInfo|JSONArray|\\-|\\-|'."\n" - .'|cates.detailInfo.score|double|0.9|The confidence score.|'."\n" - .'|cates.detailInfo.startTime|double|0.021|Start time, in seconds.|'."\n" - .'|cates.detailInfo.endTime|double|29.021|End time, in seconds.|'."\n" - .'|entities|JSONArray|\\-|\\-|'."\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 name of the tag.|'."\n" - .'|entities.appearanceProbability|double|0.067|The appearance rate.|'."\n" - .'|entities.knowledgeInfo|String|{"name": "Huangguoshu Waterfall", "nameEn": "Huangguoshu Waterfall", "description": "One of the four largest waterfalls in Asia"}|The knowledge graph information. The fields are provided in the Appendix.|'."\n" - .'|entities.detailInfo|JSONArray|\\-|\\-|'."\n" - .'|entities.detailInfo.score|double|0.33292606472969055|The confidence score.|'."\n" - .'|entities.detailInfo.startTime|double|6.021|Start time, in seconds.|'."\n" - .'|entities.detailInfo.endTime|double|8.021|End time, in seconds.|'."\n" - .'|entities.detailInfo.trackData|JSONArray|\\-|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|\\-|\\-|'."\n" - .'|hotwords.labelLevel1|String|The information about the hotword.|The level-1 tag.|'."\n" - .'|hotwords.labelLevel1|String|Hotword|The level-2 tag.|'."\n" - .'|hotwords.labelLevel2|String|""|The level-2 tag.|'."\n" - .'|hotwords.label|String|China Meteorological Administration|The content of the hotword.|'."\n" - .'|hotwords.appearanceProbability|double|0.96|The appearance rate.|'."\n" - .'|hotwords.detailInfo|JSONArray|||'."\n" - .'|hotwords.detailInfo.score|double|1.0|The confidence score.|'."\n" - .'|hotwords.detailInfo.startTime|double|0.021|Start time, in seconds.|'."\n" - .'|hotwords.detailInfo.endTime|double|29.021|End time, in seconds.|'."\n" - .'|freeTags|JSONArray|||'."\n" - .'|freeTags.labelLevel1|String|Hotword|The level-1 tag.|'."\n" - .'|freeTags.labelLevel2|String|""|The level-2 tag.|'."\n" - .'|freeTags.label|String|Central Meteorological Observatory|The content of the keyword.|'."\n" - .'|freeTags.appearanceProbability|double|0.96|The appearance rate.|'."\n" - .'|freeTags.detailInfo|JSONArray|||'."\n" - .'|freeTags.detailInfo.score|double|0.9|The confidence score.|'."\n" - .'|freeTags.detailInfo.startTime|double|0.021|Start time, in seconds.|'."\n" - .'|freeTags.detailInfo.endTime|double|29.021|End time, in seconds.|'."\n" - ."\n" - .'**ASR result**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|details|JSONArray|The details of the result.|'."\n" - .'|details.from|double|The start timestamp. Unit: seconds.|'."\n" - .'|details.to|double|The end timestamp. Unit: seconds.|'."\n" - .'|details.content|String|The recognized text.|'."\n" - ."\n" - .'**OCR result**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|details|JSONArray|The details of the result.|'."\n" - .'|details.timestamp|double|The timestamp. Unit: seconds.|'."\n" - .'|details.info|JSONArray|The details of the recognized text at the specified timestamp.|'."\n" - .'|details.info.score|double|The confidence score.|'."\n" - .'|details.info.position|JSONObject|The coordinates of the 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**'."\n" - ."\n" - .'**Note** If you do not use the human-in-the-loop mode and you specify the needMetaData parameter when you call the [SubmitSmarttagJob](~~478786~~) operation, the original title of the video is returned in the result.'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|title|String|The title of the video.|'."\n" - ."\n" - .'**Subtitle extraction result**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|details|JSONArray|The details of the result.|'."\n" - .'|details.allResultUrl|String|The URL of the file that contains all subtitles. The URL is valid for half a year after the task is complete.|'."\n" - .'|details.chResultUrl|String|The URL of the file that contains only Chinese subtitles. The URL is valid for half a year after the task is complete.|'."\n" - .'|details.engResultUrl|String|The URL of the file that contains only English subtitles. The URL is valid for half a year after the task is complete.|'."\n" - ."\n" - .'**Note** The content of the file is in the following format: `Serial number + Time range + Subtitle content`. Each line in the file contains a sentence.'."\n" - ."\n" - .'**NLP-based result**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|transcription|object|The transcription results.|'."\n" - .'|autoChapters|object|A list of automatically generated chapters.|'."\n" - .'|summarization|object|The AI-generated summaries.|'."\n" - .'|meetingAssistance|object|The AI-generated minutes.|'."\n" - .'|translation|object|The text translation result.|'."\n" - ."\n" - .'**Parameters of transcription**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|transcription|object|The transcription results.|'."\n" - .'|transcription.paragraphs|list\\[\\]|The results are organized by paragraph.|'."\n" - .'|transcription.paragraphs\\[i\\].paragraphId|string|The paragraph ID.|'."\n" - .'|transcription.paragraphs\\[i\\].speakerId|string|The speaker ID.|'."\n" - .'|transcription.paragraphs\\[i\\].words|list\\[\\]|The words contained in the paragraph.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].id|int|The word ID. You do not need to pay attention to it.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].sentenceId|int|The sentence ID. The words that have the same sentence ID can be assembled into a sentence.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].start|long|The start time of the word. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].end|long|The end time of the word. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].text|string|The word content.|'."\n" - ."\n" - .'**Parameters of summarization**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|summarization|object|The summary results. The results may be empty or of different summary types.|'."\n" - .'|summarization.paragraphSummary|string|The summary of the full text.|'."\n" - .'|summarization.conversationalSummary|list\\[\\]|A list of speaker 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 corresponding to the speaker.|'."\n" - .'|summarization.questionsAnsweringSummary|list\\[\\]|A list of Q&A.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].question|string|The question.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].sentenceIdsOfQuestion|list\\[\\]|The IDs of transcribed sentences corresponding to this question.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].answer|string|The answer to the question.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].sentenceIdsOfAnswer|list\\[\\]|The IDs of transcribed sentences corresponding to this answer.|'."\n" - .'|summarization.mindMapSummary|list\\[object\\]|The mind map. It may contain the summary of each topic and the relationship between topics.|'."\n" - .'|summarization.mindMapSummary\\[i\\].title|string|The title of the topic.|'."\n" - .'|summarization.mindMapSummary\\[i\\].topic|list\\[object\\]|An array that contains each topic and its 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 that contains the subtopics of the topic. The array can be empty.|'."\n" - ."\n" - .'**Parameters of translation**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|translation|object|The translation result.|'."\n" - .'|translation.paragraphs|list\\[\\]|The translation of the transcribed text, organized by paragraph.|'."\n" - .'|translation.paragraphs.paragraphId|string|The paragraph ID, which corresponds to the paragraph ID in the ASR result.|'."\n" - .'|translation.paragraphs.sentences|list\\[\\]|A list of translated sentences.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].sentenctId|long|The sentence ID.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].start|long|The start time of the sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].end|long|The end time of the sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].text|string|The translated text, which corresponds to the ASR result.|'."\n" - ."\n" - .'**Parameters of autoChapters**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|autoChapters|list\\[\\]|A list of automatically generated chapters.|'."\n" - .'|autoChapters\\[i\\].id|int|The serial number of the chapter.|'."\n" - .'|autoChapters\\[i\\].start|long|The start time of the chapter. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|autoChapters\\[i\\].end|long|The end time of the chapter. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|autoChapters\\[i\\].headline|string|The headline of the chapter.|'."\n" - .'|autoChapters\\[i\\].summary|string|The chapter overview.|'."\n" - ."\n" - .'**Parameters of meetingAssistance**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|meetingAssistance|object|The result of the AI minutes, which may be empty or of different types.|'."\n" - .'|meetingAssistance.keywords|list\\[\\]|A list of extracted keywords.|'."\n" - .'|meetingAssistance.keySentences|list\\[\\]|A list of key sentences.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].id|long|The serial number of the key sentence.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].sentenceId|long|The ID of the key sentence, which corresponds to the sentence ID in the original ASR result.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].start|long|The start time of the key sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].end|long|The end time of the key sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].text|string|The key sentence information.|'."\n" - .'|meetingAssistance.actions|list\\[\\]|A list of to-do items.|'."\n" - .'|meetingAssistance.actions\\[i\\].id|long|The serial number of the to-do item.|'."\n" - .'|meetingAssistance.actions\\[i\\].sentenceId|long|The ID of the key sentence, which corresponds to the sentence ID in the original ASR result.|'."\n" - .'|meetingAssistance.actions\\[i\\].start|long|The start time. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.actions\\[i\\].end|long|The end time. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.actions\\[i\\].text|string|The content of the to-do item.|'."\n" - .'|meetingAssistance.classifications|object|The scene type. Only three types of scenes 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.|', - ], - 'QuerySmarttagJob' => [ - 'summary' => 'Queries the information about a smart tagging job.', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -51590,34 +38630,22 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the smart tagging job that you want to query. You can obtain the job ID from the response parameters of the SubmitSmarttagJob operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '88c6ca184c0e47098a5b665e2****', - ], + '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' => 'The extra parameters that you want to query in the request. The value is a JSON string. Example: {"labelResultType":"auto"}. The value of labelResultType is of the STRING type. Valid values:'."\n" - ."\n" - .'* auto: machine tagging'."\n" - .'* hmi: tagging by human and machine'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"labelResultType":"auto"} '."\n", - ], + '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' => [ @@ -51625,69 +38653,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'JobStatus' => [ - 'description' => 'The status of the job. Valid values:'."\n" - ."\n" - .'* **Success**: The job was successful.'."\n" - .'* **Fail**: The job failed.'."\n" - .'* **Processing**: The job is in progress.'."\n" - .'* **Submitted**: The job is submitted and waiting to be processed.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'UserData' => [ - 'description' => 'The content of callback messages that are sent to Simple Message Queue (SMQ) when the information of the smart tagging job changes. For more information about the parameters contained in the callback message, see the "Callback parameters" section of this topic.'."\n", - 'type' => 'string', - 'example' => '{"userId":"123432412831"}', - ], + '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' => 'The analysis results of the smart tagging job. The value is an array.'."\n", + 'description' => 'An array of analysis result objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the analysis result.'."\n" - ."\n" - .'* The type of the analysis result based on Smart tagging V1.0. Valid values:'."\n" - ."\n" - .'1. TextLabel: the text tag.'."\n" - .'2. VideoLabel: the video tag.'."\n" - .'3. ASR: the original result of automatic speech recognition (ASR). By default, this type of result is not returned.'."\n" - .'4. OCR: the original result of optical character recognition (OCR). By default, this type of result is not returned.'."\n" - .'5. NLP: the natural language processing (NLP)-based result. By default, this type of result is not returned.'."\n" - ."\n" - .'* The type of the analysis result based on Smart tagging V2.0. Valid values:'."\n" - ."\n" - .'1. CPVLabel'."\n" - .'2. Meta: the information about the video file, such as the title of the video. By default, this type of information is not returned.'."\n" - ."\n" - .'* The type of the analysis result based on Smart tagging V2.0-custom. Valid values:'."\n" - ."\n" - .'1. CPVLabel'."\n" - .'2. Meta: the information about the video file, such as the title of the video. By default, this type of information is not returned.'."\n", - 'type' => 'string', - 'example' => 'Meta', - ], - 'Data' => [ - 'description' => 'The details of the analysis result. The value is a JSON string. For more information about the parameters of different result types, see the "Parameters of different result types" section of this topic.'."\n", - 'type' => 'string', - 'example' => '{"title":"example-title-****"} '."\n", - ], + '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', @@ -51698,655 +38722,695 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'type' => 'string', - ], - 'Quota' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Quota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + '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"}]', - 'title' => 'QuerySmarttagJob', - 'responseParamsDescription' => '**Callback parameters** When the status of the smart tagging job changes, ApsaraVideo Media Processing (MPS) sends a message to the specified SMQ queue. For more information about how to specify an SMQ queue for receiving callbacks, see the UpdatePipeline topic. The callback message is a JSON string that contains the parameters described in the following table.'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|Type|String|The type of the job. The fixed value is smarttag, which indicates a smart tagging job.|'."\n" - .'|JobId|String|The unique ID of the job.|'."\n" - .'|State|String|The current status of the job. The value is the same as that of the JobStatus response parameter of the QuerySmarttagJob operation.|'."\n" - .'|State|String|The current status of the job. The value is the same as that of the JobStatus response parameter of the QuerySmarttagJob operation.|'."\n" - .'|UserData|String|The UserData information passed for the SubmitSmarttagJob operation.|'."\n" - .'|UserData|String|The UserData information passed for the SubmitSmarttagJob operation.|'."\n" - ."\n" - .'**Parameters of different result types**'."\n" - ."\n" - .'Parameters of **VideoLabel**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|persons|JSONArray|The information of figures identified by the smart tagging job.|'."\n" - .'|persons.name|String|The name of the identified figure.|'."\n" - .'|persons.category|String|The type of the identified figure. Valid values: `celebrity`, `politician`, `sensitive`, and `unknown`. A figure is identified as unknown based on the custom figure library. In this case, the ID of the custom figure is returned.|'."\n" - .'|persons.ratio|double|The appearance rate of the figure. Valid values: 0 to 1.|'."\n" - .'|persons.occurrences|JSONArray|The details of the appearances of the figure.|'."\n" - .'|persons.occurrences.score|double|The score for the confidence level.|'."\n" - .'|persons.occurrences.from|double|The point in time when the figure appears. Unit: seconds.|'."\n" - .'|persons.occurrences.to|double|The point in time when the figure disappears. Unit: seconds.|'."\n" - .'|persons.occurrences.position|JSONObject|The face coordinates of the figure.|'."\n" - .'|persons.occurrences.position.leftTop|int\\[\\]|The x and y coordinates of the upper-left corner.|'."\n" - .'|persons.occurrences.position.rightBottom|int\\[\\]|The x and y coordinates of the lower-right corner.|'."\n" - .'|persons.occurrences.timestamp|double|The timestamp of the face coordinates. Unit: seconds.|'."\n" - .'|persons.occurrences.scene|String|The camera shot of the figure. Valid values: `closeUp`, `medium-closeUp`, `medium`, and `medium-long`.|'."\n" - .'|tags|JSONArray|The tags of the detected objects. For more information, see the following table.|'."\n" - .'|tags.mainTagName|String|The main tag.|'."\n" - .'|tags.subTagName|String|The subtag.|'."\n" - .'|tags.ratio|double|The appearance rate of the tag. Valid values: 0 to 1.|'."\n" - .'|tags.occurrences|JSONArray|The details of the appearances of the tag.|'."\n" - .'|tags.occurrences.score|double|The score for the confidence level.|'."\n" - .'|tags.occurrences.from|double|The point in time when the tag appears. Unit: seconds.|'."\n" - .'|tags.occurrences.to|double|The point in time when the tag disappears. Unit: seconds.|'."\n" - .'|classifications|JSONArray|The category of the video.|'."\n" - .'|classifications.score|double|The score for the confidence level.|'."\n" - .'|classifications.category1|String|The level-1 category, such as daily life activity, animation, and automobile.|'."\n" - .'|classifications.category2|String|The level-2 category, such as health and home under the level-1 category daily life activity.|'."\n" - ."\n" - .'Examples of video tags'."\n" - ."\n" - .'|mainTagName|subTagName|'."\n" - .'|---|---|'."\n" - .'|Program|Examples: Dad Where Are We Going and Top Funny Comedian.|'."\n" - .'|Figure role|Examples: doctor, nurse, and teacher.|'."\n" - .'|Object|Examples: piano, cup, table, scrambled eggs with tomatoes, car, and cosmetics.|'."\n" - .'|TV channel logo|Examples: CCTV-1, CCTV-2, YOUKU, and Dragon TV.|'."\n" - .'|Action|Examples: dancing, kissing, hugging, meeting, singing, telephoning, horseback riding, and fighting.|'."\n" - .'|Location|Examples: Tian\'anmen Square, the Statue of Liberty, Leshan Giant Buddha, China, and America.|'."\n" - .'|Scene|Examples: bedroom, subway station, terraced field, beach, and desert.|'."\n" - ."\n" - .'Parameters of **ImageLabel**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|persons|JSONArray|The information of figures identified by the smart tagging job.|'."\n" - .'|persons.name|String|The name of the identified figure.|'."\n" - .'|persons.category|String|The type of the identified figure. Valid values: celebrity, politician, and sensitive.|'."\n" - .'|persons.score|double|The score for the confidence level of the identified figure.|'."\n" - .'|persons.position|JSONObject|The face coordinates of the figure.|'."\n" - .'|persons.position.leftTop|int\\[\\]|The x and y coordinates of the upper-left corner.|'."\n" - .'|persons.position.rightBottom|int\\[\\]|The x and y coordinates of the lower-right corner.|'."\n" - .'|persons.scene|String|The camera shot of the figure. Valid values: closeUp, medium-closeUp, medium, and medium-long.|'."\n" - .'|tags|JSONArray|The tags of the detected objects. For more information, see the following table.|'."\n" - .'|tags.mainTagName|String|The main tag.|'."\n" - .'|tags.subTagName|String|The subtag.|'."\n" - .'|tags.score|double|The score for the confidence level.|'."\n" - ."\n" - .'Examples of image tags'."\n" - ."\n" - .'|mainTagName|subTagName|'."\n" - .'|---|---|'."\n" - .'|Figure role|Examples: doctor, nurse, and teacher.|'."\n" - .'|Location|Examples: Tian\'anmen Square, the Statue of Liberty, Leshan Giant Buddha, China, and America.|'."\n" - .'|Action|Example: talking.|'."\n" - .'|TV channel logo|Examples: CCTV-1, CCTV-2, YOUKU, and Dragon TV.|'."\n" - .'|Action|Examples: dancing, kissing, hugging, meeting, singing, telephoning, horseback riding, and fighting.|'."\n" - .'|Object|Examples: piano, cup, table, scrambled eggs with tomatoes, car, and cosmetics.|'."\n" - .'|Scene|Examples: bedroom, subway station, terraced field, beach, and desert.|'."\n" - ."\n" - .'Parameters of TextLabel (from ASR and OCR)'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|tags|JSONArray|The text tags. For more information, see the following table.|'."\n" - .'|tags.name|String|The type of the tag.|'."\n" - .'|tags.value|String|The values of the tag. Multiple tag values are separated by commas (,).|'."\n" - ."\n" - .'Examples of text tags'."\n" - ."\n" - .'|name|value|'."\n" - .'|---|---|'."\n" - .'|Location|Examples: Tian\'anmen Square, the Statue of Liberty, Leshan Giant Buddha, China, and America.|'."\n" - .'|Organization|Examples: China Wildlife Conservation Association and China Media Group (CMG).|'."\n" - .'|Brand name|Examples: Nike and Li-Ning.|'."\n" - .'|Keyword|Example: backbone force.|'."\n" - ."\n" - .'Parameters of **CPVLabel**'."\n" - ."\n" - .'* cates: the tagging category, including level-1 category, level-2 category, and level-3 category.'."\n" - .'* entities: the properties of the tagging category, including the knowledge graph information.'."\n" - .'* hotwords: the hotwords to which you pay attention.'."\n" - .'* freeTags: keywords.'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|type|String|hmi|The type of the result. Valid values: hmi and autp. A value of hmi indicates the results of tagging by human and machine. A value of autp indicates the results of machine tagging.|'."\n" - .'|cates|JSONArray|\\-|The information about the category of the tagging result.|'."\n" - .'|cates.labelLevel1|String|Tourism|The level-1 tag.|'."\n" - .'|cates.labelLevel2|String|Tourist landscape|The level-2 tag.|'."\n" - .'|cates.label|String|""|The name of the tag. An empty value may be returned by the algorithm.|'."\n" - .'|cates.appearanceProbability|double|0.96|The appearance rate of the tag.|'."\n" - .'|cates.detailInfo|JSONArray|\\-|\\-|'."\n" - .'|cates.detailInfo.score|double|0.9|The score for the confidence level.|'."\n" - .'|cates.detailInfo.startTime|double|0.021|The point in time when the object appears in the video.|'."\n" - .'|cates.detailInfo.endTime|double|29.021|The point in time when the object disappears in the video.|'."\n" - .'|entities|JSONArray|\\-|\\-|'."\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 name of the tag.|'."\n" - .'|entities.appearanceProbability|double|0.067|The appearance rate of the tag.|'."\n" - .'|entities.knowledgeInfo|String|{"name": "Huangguoshu Waterfall", "nameEn": "Huangguoshu Waterfall", "description": "One of the four largest waterfalls in Asia"}|The knowledge graph information. The fields contained in the knowledge graph information are provided in Appendix, such as fields related to the intellectual property (IP) that is featured in films and television shows, music, figures, landmarks, and objects.|'."\n" - .'|entities.detailInfo|JSONArray|\\-|\\-|'."\n" - .'|entities.detailInfo.score|double|0.33292606472969055|The score for the confidence level.|'."\n" - .'|entities.detailInfo.startTime|double|6.021|The point in time when the object appears in the video.|'."\n" - .'|entities.detailInfo.endTime|double|8.021|The point in time when the object disappears in the video.|'."\n" - .'|entities.detailInfo.trackData|JSONArray|\\-|The structured information about the tag of the object.|'."\n" - .'|entities.detailInfo.trackData.score|double|0.32|The score for the confidence level.|'."\n" - .'|entities.detailInfo.trackData.bbox|integer\\[\\]|23, 43, 45, 67|The coordinates of the object.|'."\n" - .'|entities.detailInfo.trackData.timestamp|double|7.9|The timestamp of the coordinates. Unit: seconds.|'."\n" - .'|hotwords|JSONArray|\\-|\\-|'."\n" - .'|hotwords.labelLevel1|String|The information about the hotword.|The level-1 tag.|'."\n" - .'|hotwords.labelLevel1|String|Hotword|The level-2 tag.|'."\n" - .'|hotwords.labelLevel2|String|""|The level-2 tag.|'."\n" - .'|hotwords.label|String|China Meteorological Administration|The content of the hotword.|'."\n" - .'|hotwords.appearanceProbability|double|0.96|The appearance rate of the hotword.|'."\n" - .'|hotwords.detailInfo|JSONArray|||'."\n" - .'|hotwords.detailInfo.score|double|1.0|The score for the confidence level.|'."\n" - .'|hotwords.detailInfo.startTime|double|0.021|The point in time when the hotword appears in the video.|'."\n" - .'|hotwords.detailInfo.endTime|double|29.021|The point in time when the hotword disappears in the video.|'."\n" - .'|freeTags|JSONArray|||'."\n" - .'|freeTags.labelLevel1|String|Keyword|The level-1 tag.|'."\n" - .'|freeTags.labelLevel2|String|""|The level-2 tag.|'."\n" - .'|freeTags.label|String|Central Meteorological Observatory|The content of the keyword.|'."\n" - .'|freeTags.appearanceProbability|double|0.96|The appearance rate of the keyword.|'."\n" - .'|freeTags.detailInfo|JSONArray|||'."\n" - .'|freeTags.detailInfo.score|double|0.9|The score for the confidence level.|'."\n" - .'|freeTags.detailInfo.startTime|double|0.021|The point in time when the keyword appears in the video.|'."\n" - .'|freeTags.detailInfo.endTime|double|29.021|The point in time when the keyword disappears in the video.|'."\n" - ."\n" - .'**Parameters of the ASR result**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|details|JSONArray|The details of the result.|'."\n" - .'|details.from|double|The start timestamp of the recognition. Unit: seconds.|'."\n" - .'|details.to|double|The end timestamp of the recognition. Unit: seconds.|'."\n" - .'|details.content|String|The recognized text.|'."\n" - ."\n" - .'**Parameters of the OCR result**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|details|JSONArray|The details of the result.|'."\n" - .'|details.timestamp|double|The timestamp information. Unit: seconds.|'."\n" - .'|details.info|JSONArray|The details of the recognized text at the specified timestamp.|'."\n" - .'|details.info.score|double|The score for the confidence level.|'."\n" - .'|details.info.position|JSONObject|The coordinates of the text.|'."\n" - .'|details.info.position.leftTop|int\\[\\]|The x and y coordinates of the upper-left corner.|'."\n" - .'|details.info.position.rightBottom|int\\[\\]|The x and y coordinates of the lower-right corner.|'."\n" - .'|details.info.content|String|The recognized text.|'."\n" - ."\n" - .'**Parameter of returned metadata**'."\n" - ."\n" - .'**Note** If you do not use tagging by human and machine and you specify the needMetaData parameter when you call the [SubmitSmarttagJob](~~478786~~) operation, the original title of the video is returned in the result.'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|title|String|The title of the video.|'."\n" - ."\n" - .'**Parameters of the extracted caption**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|details|JSONArray|The details of the result.|'."\n" - .'|details.allResultUrl|String|The URL of the file that contains all captions. The URL is valid for half a year after the job is complete.|'."\n" - .'|details.chResultUrl|String|The URL of the file that contains only Chinese captions. The URL is valid for half a year after the job is complete.|'."\n" - .'|details.engResultUrl|String|The URL of the file that contains only English captions. The URL is valid for half a year after the job is complete.|'."\n" - ."\n" - .'**Note** The content of the caption file is in the `Serial number + Time range + Caption content` format. Each line in the file contains a sentence.'."\n" - ."\n" - .'**Parameters of the NLP-based result**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|transcription|object|The speech-to-text result.|'."\n" - .'|autoChapters|object|The chapter overview.|'."\n" - .'|summarization|object|The large model summary.|'."\n" - .'|meetingAssistance|object|The intelligent minutes.|'."\n" - .'|translation|object|The text translation result.|'."\n" - ."\n" - .'**Parameters of transcription**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|transcription|object|The speech-to-text result.|'."\n" - .'|transcription.paragraphs|list\\[\\]|A list of paragraphs that contain the speech-to-text result.|'."\n" - .'|transcription.paragraphs\\[i\\].paragraphId|string|The paragraph ID.|'."\n" - .'|transcription.paragraphs\\[i\\].speakerId|string|The speaker ID.|'."\n" - .'|transcription.paragraphs\\[i\\].words|list\\[\\]|The words contained in the paragraph.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].id|int|The word ID. You do not need to pay attention to it.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].sentenceId|int|The sentence ID. The words that have the same sentence ID can be assembled into a sentence.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].start|long|The start time of the word. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].end|long|The end time of the word. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|transcription.paragraphs\\[i\\].words\\[i\\].text|string|The word.|'."\n" - ."\n" - .'**Parameters of summarization**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|summarization|object|The summary results. The results may be empty or of different summary types.|'."\n" - .'|summarization.paragraphSummary|string|The summary of the full text.|'."\n" - .'|summarization.conversationalSummary|list\\[\\]|A list of summary results for a conversation.|'."\n" - .'|summarization.conversationalSummary\\[i\\].speakerId|string|The speaker ID.|'."\n" - .'|summarization.conversationalSummary\\[i\\].speakerName|string|The name of the speaker.|'."\n" - .'|summarization.conversationalSummary\\[i\\].summary|string|The summary corresponding to the speaker.|'."\n" - .'|summarization.questionsAnsweringSummary|list\\[\\]|A list of summary results for an Q&A.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].question|string|The question.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].sentenceIdsOfQuestion|list\\[\\]|A list of IDs of the sentences that are generated based on the original speech corresponding to the question.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].answer|string|The answer to the question.|'."\n" - .'|summarization.questionsAnsweringSummary\\[i\\].sentenceIdsOfAnswer|list\\[\\]|A list of IDs of the sentences that are generated based on the original speech corresponding to the answer.|'."\n" - .'|summarization.mindMapSummary|list\\[object\\]|The mind map of the summary results. The mind map may contain the summary of each topic and the relationship between topics.|'."\n" - .'|summarization.mindMapSummary\\[i\\].title|string|The title of the topic.|'."\n" - .'|summarization.mindMapSummary\\[i\\].topic|list\\[object\\]|An array that contains each topic and its 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 that contains the subtopics of the topic. The array can be empty.|'."\n" - ."\n" - .'**Parameters of translation**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|translation|object|The translation result.|'."\n" - .'|translation.paragraphs|list\\[\\]|A list of paragraphs that contain the translation result, which corresponds to the ASR result.|'."\n" - .'|translation.paragraphs.paragraphId|string|The paragraph ID, which corresponds to the paragraph ID in the ASR result.|'."\n" - .'|translation.paragraphs.sentences|list\\[\\]|A list of translated text sentences.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].sentenctId|long|The sentence ID.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].start|long|The start time of the sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].end|long|The end time of the sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|translation.paragraphs.sentences\\[i\\].text|string|The translated text, which corresponds to the ASR result.|'."\n" - ."\n" - .'**Parameters of autoChapters**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|autoChapters|list\\[\\]|The chapter overview result that may contain the overview of zero, one, or multiple chapters.|'."\n" - .'|autoChapters\\[i\\].id|int|The serial number of the chapter.|'."\n" - .'|autoChapters\\[i\\].start|long|The start time of the chapter. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|autoChapters\\[i\\].end|long|The end time of the chapter. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|autoChapters\\[i\\].headline|string|The headline of the chapter.|'."\n" - .'|autoChapters\\[i\\].summary|string|The chapter overview.|'."\n" - ."\n" - .'**Parameters of meetingAssistance**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|meetingAssistance|object|The result of the intelligent minutes, which may be empty or of different types.|'."\n" - .'|meetingAssistance.keywords|list\\[\\]|A list of extracted keywords.|'."\n" - .'|meetingAssistance.keySentences|list\\[\\]|A list of extracted key sentences.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].id|long|The serial number of the key sentence.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].sentenceId|long|The ID of the key sentence, which corresponds to the sentence ID in the original ASR result.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].start|long|The start time of the key sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].end|long|The end time of the key sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.keySentences\\[i\\].text|string|The key sentence information.|'."\n" - .'|meetingAssistance.actions|list\\[\\]|A list of to-do items.|'."\n" - .'|meetingAssistance.actions\\[i\\].id|long|The serial number of the to-do item.|'."\n" - .'|meetingAssistance.actions\\[i\\].sentenceId|long|The ID of the key sentence, which corresponds to the sentence ID in the original ASR result.|'."\n" - .'|meetingAssistance.actions\\[i\\].start|long|The start time of the key sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.actions\\[i\\].end|long|The end time of the key sentence. The value is a timestamp representing the number of milliseconds that have elapsed since the audio starts.|'."\n" - .'|meetingAssistance.actions\\[i\\].text|string|The content of the to-do item.|'."\n" - .'|meetingAssistance.classifications|object|The scenario type. Only three types of scenarios are supported.|'."\n" - .'|meetingAssistance.classifications.interview|float|The score for the confidence level of the interview scenario.|'."\n" - .'|meetingAssistance.classifications.lecture|float|The score for the confidence level of the presentation scenario.|'."\n" - .'|meetingAssistance.classifications.meeting|float|The score for the confidence level of the meeting scenario.|', + 'translator' => 'manual', ], - 'SubmitSmarttagJob' => [ - 'summary' => 'Submits a smart tagging job.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryTraceAbJobList' => [ + 'summary' => 'Queries A/B watermarking jobs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'description' => 'The video title. The title can contain letters, digits, and hyphens (-) and cannot start with a special character. The title can be up to 256 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'example-title-**** '."\n", - ], - ], - [ - 'name' => 'Content', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The video description. The description can contain letters, digits, and hyphens (-) and cannot start with a special character. The description can be up to 1 KB in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'example content **** '."\n", - ], + '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' => 'ContentType', + 'name' => 'TraceMediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is discontinued.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'application/zip '."\n", - ], + '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' => 'ContentAddr', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is discontinued.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'http://123.com/testVideo.mp4', - ], + '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' => 'Params', + 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The additional request parameters. The value is a JSON string. Example: {"needAsrData":true, "needOcrData":false}. The following parameters are supported:'."\n" - ."\n" - .'* needAsrData: specifies whether to query the automatic speech recognition (ASR) data. The value is of the BOOLEAN type. Default value: false. Valid values: true and false.'."\n" - .'* needOcrData: specifies whether to query the optical character recognition (OCR) data. The value is of the BOOLEAN type. Default value: false. Valid values: true and false.'."\n" - .'* needMetaData: specifies whether to query the metadata. The value is of the BOOLEAN type. Default value: false. Valid values: true and false.'."\n" - .'* nlpParams: the input parameters of the natural language processing (NLP) operator. The value is a JSON object. This parameter is empty by default, which indicates that the NLP operator is not used. For more information, see the "nlpParams" section of this topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"needAsrData":true, "needOcrData":false}', - ], + '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' => 'NotifyUrl', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL for receiving callbacks. Set the value to an HTTP URL or an HTTPS URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://example.com/endpoint/aliyun/ai?id=76401125000***', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The data to be passed through Simple Message Queue (SMQ, formerly MNS) during callbacks. The data can be up to 1 KB in length. For more information about how to specify an SMQ queue for receiving callbacks, see UpdatePipeline.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{“a”:"test"}', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], - [ - 'name' => 'Input', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'input', - 'description' => 'The job input.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The media type. Valid values:'."\n" - ."\n" - .'* OSS'."\n" - .'* Media'."\n" - .'* URL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Media', - ], - 'Media' => [ - 'description' => 'If Type is set to OSS, specify an OSS path. Example: OSS://test-bucket/video/202208/test.mp4.'."\n" - ."\n" - .'If Type is set to Media, specify a media asset ID. Example: c5c62d8f0361337cab312dce8e77dc6d.'."\n" - ."\n" - .'If Type is set to URL, specify an HTTP URL. Example: https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c5c62d8f0361337cab312dce8e77dc6d', + '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' => ''], ], - 'required' => false, - 'docRequired' => true, + 'example' => '', ], ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the template that specifies the analysis algorithms. For more information about template operations, see [Configure templates](~~445702~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '39f8e0bc005e4f309379701645f4'."\n", - ], + ], + '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' => [ [ - 'name' => 'ScheduleConfig', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'scheduleConfig', - 'description' => 'The scheduling configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which you want to submit the smart tagging job. The MPS queue is bound to an SMQ queue. This parameter specifies the default MPS queue. By default, an MPS queue can process a maximum of two concurrent smart tagging jobs. To increase the limit, submit a ticket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acdbfe4323bcfdae', - ], - 'Priority' => [ - 'description' => 'The job priority. This parameter is not implemented. You can leave this parameter empty or enter a random value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:QueryTraceAbJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'translator' => 'manual', + ], + 'QueryTraceExtractJob' => [ + 'summary' => 'Queries a job for extracting a trace watermark.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TemplateConfig', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], + 'parameters' => [ + [ + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'description' => 'The ID of the smart tagging job. We recommend that you save this ID for subsequent calls of other operations.'."\n", - 'type' => 'string', - 'example' => '****d80e4e4044975745c14b****', + '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' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', - 'title' => 'SubmitSmarttagJob', - 'description' => 'Before you call this operation to submit a smart tagging job, you must add a smart tagging template and specify the analysis types that you want to use in the template. For more information, see CreateCustomTemplate. You can use the smart tagging feature only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions. By default, an ApsaraVideo Media Processing (MPS) queue can process a maximum of two concurrent smart tagging jobs. If you need to process more concurrent smart tagging jobs, submit a ticket to contact Alibaba Cloud Technical Support for evaluation and configuration.'."\n", - 'requestParamsDescription' => '### nlpParams'."\n" - ."\n" - .'|Feature|Parameter|Type|Required|Description|Example|'."\n" - .'|---|---|---|---|---|---|'."\n" - .'||nlpParams|object|Yes|The parameters related to NLP. This parameter is required if NLP is specified in the template. Otherwise, the job fails.|{"sourceLanguage":"cn"}|'."\n" - .'|Transcription|sourceLanguage|string|Yes|The source language used for transcription. Valid values: cn (Chinese), en (English), yue (Cantonese), and fspk (Chinese and English).|"cn"|'."\n" - .'||diarizationEnabled|boolean|No|Specifies whether to enable the speaker diarization feature. Default value: false.|true|'."\n" - .'||speakerCount|integer|No|The speaker diarization parameter. If this parameter is not specified, the speakers are not recognized. 0: The number of speakers to be recognized is not limited. 2: The number of speakers to be recognized is limited to 2.|2|'."\n" - .'|Summarization|summarizationEnabled|boolean|No|Specifies whether to enable the summarization feature. After this feature is enabled, results such as the full-text summary and speaker summary can be generated.|true|'."\n" - .'||summarizationTypes|string|No|The expected summary type. Valid values: Paragraph (full-text summary), Conversational (speaker summary), QuestionsAnswering (Q&A summary), and MindMap (mind map).|"Paragraph,Conversational,QuestionsAnswering,MindMap"|'."\n" - .'|Translation|translationEnabled|boolean|No|Specifies whether to enable the translation feature.|true|'."\n" - .'||targetLanguages|string|No|The target language of translation. Valid values: cn (Chinese), en (English), yue (Cantonese), and fspk (Chinese and English).|"en,cn"|'."\n" - .'|Chapter identification|autoChaptersEnabled|boolean|No|Specifies whether to enable the chapter identification feature. The result includes the chapter title and chapter summary.|true|'."\n" - .'|AI minutes|meetingAssistanceEnabled|boolean|No|Specifies whether to enable the AI minutes feature. The results include categories, keywords, key sentences, and to-do items.|true|', - ], - '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', + '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' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'manual', + ], + 'QueryTraceM3u8JobList' => [ + 'summary' => 'Queries jobs for generating M3U8 files containing specific trace watermark information.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'Algorithm', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition algorithm. Valid values:'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], + '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' => 'LibId', + 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*************24b47865c6**************', - ], + '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' => 'EntityName', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom entity. Max length: 64 bytes.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + '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' => 'EntityInfo', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The extra information about the custom entity, provided as a JSON string. Max length: 256 bytes.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + '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' => [ - 'EntityId' => [ - 'description' => 'The ID of the created entity.'."\n", - 'type' => 'string', - 'example' => '**************544cb84754************', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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******'], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'errorMsg:%s', - ], + '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'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:QueryTraceM3u8JobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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" - .'* 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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", - ], - 'CreateRecognitionLib' => [ - 'summary' => 'Creates a custom library to store the entity information for recognition.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'manual', + ], + 'QueryVideoCognitionJob' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -52355,50 +39419,36 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'Algorithm', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition algorithm. Valid values:'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], + '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' => 'LibName', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the recognition library. Max length: 64 bytes.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'Additional request parameters, specified as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'LibDescription', + 'name' => 'IncludeResults', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The description of the recognition library. Max length: 128 bytes.'."\n", - 'type' => 'string', + '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, - 'docRequired' => false, + 'title' => '', 'example' => '', ], ], @@ -52408,49 +39458,449 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'LibId' => [ - 'description' => 'The ID of the recognition library created.'."\n", - 'type' => 'string', - 'example' => '*************24b47865c6**************', + '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' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'errorMsg:%s', - ], + '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' => [], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + ], + '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' => '', ], ], ], - '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" - .'* 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" - .'* 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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", - ], - 'CreateRecognitionSample' => [ - 'summary' => 'Adds a sample image or a text label to a specific entity within a recognition library.', - 'methods' => [ - 'post', + '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'], ], - 'schemes' => [ - 'https', + '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' => [], @@ -52460,285 +39910,306 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeCode' => '6889', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'Algorithm', + 'name' => 'InputURL', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition this sample is for.'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], + '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' => 'LibId', + 'name' => 'MediaType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*************24b47865c6**************', - ], + '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' => 'EntityId', + 'name' => 'BusinessType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the specific entity within the library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '**************544cb84754************', - ], + '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' => 'ImageUrl', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the sample image.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'https://example.com/sample.png', - ], + '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' => 'LabelPrompt', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom text label.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => [ - 'SampleId' => [ - 'description' => 'The ID of the sample.'."\n", - 'type' => 'string', - 'example' => '**************4d2ba728e2f**************', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + '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******'], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'errorMsg:%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', - ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', '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" - .'* 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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", - ], - 'ListRecognitionSamples' => [ - 'summary' => 'Retrieves all samples of a custom entity. Pagination is supported.', - 'methods' => [ - 'post', + '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'], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'Algorithm', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition algorithm. Valid values:'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], - ], - [ - 'name' => 'LibId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxxxxxxxxxx', - ], - ], - [ - 'name' => 'EntityId', + 'name' => 'InputURL', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the entity.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'e6b985c05174412dbc77c92496b7373b', - ], + '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' => 'PageNumber', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '5e778ec0027b71ed80a8909598506***', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The user data.', 'type' => 'string', 'required' => false, 'example' => '{"MessageCallback":{"CallbackURL":"http://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}', 'title' => ''], ], [ - 'name' => 'EntityName', + 'name' => 'StreamTags', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + '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 ID of the request.'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of samples.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Samples' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Sample' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SampleId' => [ - 'type' => 'string', - ], - 'ImageUrl' => [ - 'type' => 'string', - ], - 'EntityId' => [ - 'type' => 'string', - ], - 'LibId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + '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' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + '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 \\"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' => 'ListRecognitionSamples', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"5e778ec0027b71ed80a8909598506302\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'DeleteRecognitionSample' => [ - 'summary' => 'Deletes a sample for a custom entity.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RegisterYikeAssetMediaInfo' => [ + 'summary' => 'Registers a media asset in the asset library.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -52747,174 +40218,164 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeCode' => '6889', + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ - 'name' => 'Algorithm', + 'name' => 'InputURL', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition algorithm. Valid values:'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], + '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' => 'LibId', + 'name' => 'MediaType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*************24b47865c6**************', - ], + 'schema' => ['title' => '', 'description' => 'The type of the media asset.', 'type' => 'string', 'required' => true, 'example' => 'video'], ], [ - 'name' => 'EntityId', + 'name' => 'ProductionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the entity.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '**************544cb84754************', - ], + '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' => 'SampleId', + 'name' => 'FolderId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the sample that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '**************4d2ba728e2f**************', - ], + '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' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + '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"], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'errorMsg:%s', - ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + ], + '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\\": \\"******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" - .'* 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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\\\n\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ListRecognitionEntities' => [ - 'summary' => 'Retrieves all entities in a specified recognition library. Pagination is supported.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceFFXT3K'], ], 'parameters' => [ [ - 'name' => 'Algorithm', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition algorithm associated with the entity. Valid values:'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], + 'schema' => ['description' => 'The ID of the MediaConnect flow.', 'type' => 'string', 'required' => false, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ - 'name' => 'LibId', + 'name' => 'OutputName', 'in' => 'query', + 'schema' => ['description' => 'The name of the output.', 'type' => 'string', 'required' => false, 'example' => 'AliTestOutput', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1965304870001', + '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' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + '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' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], + ], + 'parameters' => [ + [ + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the storyboard job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -52922,86 +40383,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Entities' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Entity' => [ - 'description' => 'The entities.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The entity.'."\n", - 'type' => 'object', - 'properties' => [ - 'EntityId' => [ - 'description' => 'The ID of the entity.'."\n", - 'type' => 'string', - 'example' => '**************544cb84754************', - ], - 'EntityName' => [ - 'description' => 'The name of the entity.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'EntityInfo' => [ - 'description' => 'The additional information of the entity, in JSON format.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - ], - ], - ], - ], - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + '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\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Entities\\": {\\n \\"Entity\\": [\\n {\\n \\"EntityId\\": \\"**************544cb84754************\\",\\n \\"EntityName\\": \\"巴黎铁塔\\",\\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" - .'* 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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ListRecognitionLibs' => [ - 'summary' => 'Retrieves all custom recognition libraries. Pagination is supported.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SearchEditingProject' => [ + 'summary' => 'Queries online editing projects by creation time and status.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -53009,149 +40425,290 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Algorithm', + '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 type of recognition algorithm. Valid values:'."\n" + '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" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", + .'-ProduceFailed', + 'enumValueTitles' => ['Draft' => '', 'Produced' => '', 'Producing' => '', 'ProduceFailed' => ''], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', + 'title' => '', + 'required' => false, + 'example' => 'Producing', ], ], [ - 'name' => 'PageNumber', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + '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 number of entries per page. Valid values: 1 to 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', + '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' => 'LibId', + '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' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '180', - ], - 'Libs' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Lib' => [ - 'description' => 'The recognition libraries.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LibId' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'example' => '*************24b47865c6**************', - ], - 'LibName' => [ - 'description' => 'The name of the recognition library.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'LibDescription' => [ - 'description' => 'The description of the recognition library.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - 'description' => '', + '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' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + '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' => '*'], + ], ], ], ], - '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\\": \\"大模型acp\\",\\n \\"LibDescription\\": \\"用于商品识别的库\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListRecognitionLibs', - 'description' => '* This operation is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.'."\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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", + 'translator' => 'manual', ], - 'DeleteRecognitionLib' => [ - 'summary' => 'Deletes a custom recognition library, including all entities and samples within it.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => [], @@ -53160,1584 +40717,1607 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeCode' => '236859', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'Algorithm', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition algorithm. Valid values:'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], + 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-1'], ], [ - 'name' => 'LibId', + 'name' => 'MediaIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*************24b47865c6**************', - ], + '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' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'errorMsg:%s', - ], + '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'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:SearchIndexJobRerun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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" - .'* 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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", + 'translator' => 'manual', ], - 'DeleteRecognitionEntity' => [ - 'summary' => 'Deletes an entity from the specified custom recognition library.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SearchMedia' => [ + 'summary' => 'Returns media assets that match the specified conditions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeCode' => '140243', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'Algorithm', + 'name' => 'Match', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of recognition algorithm associated with the entity. Valid values:'."\n" - ."\n" - .'* landmark'."\n" - .'* object'."\n" - .'* logo'."\n" - .'* face'."\n" - .'* label'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'landmark', - ], + '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' => 'LibId', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the recognition library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*************24b47865c6**************', - ], + '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 ID of the entity to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '**************544cb84754************', - ], + '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.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'errorMsg:%s', - ], + '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'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'errorMsg:%s', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMedia', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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" - .'* 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. For more information, see [QPS limits](https://help.aliyun.com/zh/mps/developer-reference/qps-limits?spm=a2c4g.11186623.0.0.647e1081YGcerb).'."\n", + 'translator' => 'manual', ], - 'SubmitIProductionJob' => [ - 'summary' => 'Submits an intelligent production job.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SearchMediaByAILabel' => [ + 'summary' => 'You can perform multimodal search based on person names, captions, and AI categorization.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '195892', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the intelligent production job. The name can be up to 100 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-1'], ], [ - 'name' => 'FunctionName', + 'name' => 'MediaType', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the algorithm that you want to use for the job. Valid values:'."\n" + 'description' => 'The type of the media assets. Valid values:'."\n" ."\n" - .'* **Cover**: This algorithm intelligently generates a thumbnail image for a video.'."\n" - .'* **VideoClip**: This algorithm intelligently generates a summary for a video.'."\n" - .'* **VideoDelogo**: This algorithm removes logos from a video.'."\n" - .'* **VideoDetext**: This algorithm removes captions from a video.'."\n" - .'* **CaptionExtraction**: This algorithm extracts captions from a video and generates the caption file.'."\n" - .'* **VideoGreenScreenMatting**: This algorithm performs green-screen image matting on a video and generates a new video.'."\n" - .'* **FaceBeauty**: This algorithm performs video retouching.'."\n" - .'* **VideoH2V**: This algorithm transforms a video from the landscape mode to the portrait mode.'."\n" - .'* **MusicSegmentDetect**: This algorithm detects the chorus of a song.'."\n" - .'* **AudioBeatDetection**: This algorithm detects rhythms.'."\n" - .'* **AudioQualityAssessment**: This algorithm assesses the audio quality.'."\n" - .'* **SpeechDenoise**: This algorithm performs noise reduction.'."\n" - .'* **AudioMixing**: This algorithm mixes audio streams.'."\n", + .'- image'."\n" + ."\n" + .'- video'."\n" + ."\n" + .'- audio', + 'enumValueTitles' => ['image' => 'image', 'video' => 'video', 'audio' => 'audio'], 'type' => 'string', - 'required' => true, - 'example' => 'Cover', + 'title' => '', + 'required' => false, + 'example' => 'video', ], ], [ - 'name' => 'Input', + 'name' => 'SortBy', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The input file. The file can be an Object Storage Service (OSS) object or a media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The media type. Valid values:'."\n" - ."\n" - .'* OSS: OSS object'."\n" - .'* Media: media asset'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The input file. The file can be an OSS object or a media asset. You can specify the path of an OSS object in one of the following formats:'."\n" - ."\n" - .'1. oss://bucket/object'."\n" - .'2. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object', - ], - ], - 'required' => true, - ], + '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' => 'Output', + 'name' => 'PageNo', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The output file. The file can be an OSS object or a media asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The media type. Valid values:'."\n" - ."\n" - .'* OSS: OSS object'."\n" - .'* Media: media asset'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Biz' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'IMS', - 'VOD', - ], - ], - 'Media' => [ - 'description' => 'The output file. If Type is set to OSS, set this parameter to the path of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. You can specify the path of an OSS object in one of the following formats:'."\n" - ."\n" - .'1. oss://bucket/object'."\n" - .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object', - ], - 'OutputUrl' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'TemplateId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], [ - 'name' => 'JobParams', + '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 algorithm-specific parameters. The parameters are specified as JSON objects and vary based on the algorithm. For more information, see the "Parameters of JobParams" section of this topic.'."\n", + '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' => '{"Model":"gif"}', + 'example' => 'Ocr', + 'title' => '', ], ], [ - 'name' => 'ScheduleConfig', + 'name' => 'SpecificSearch', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The scheduling configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5246b8d12a62433ab77845074039c3dc', - ], - 'Priority' => [ - 'description' => 'The priority of the job. Valid values: 1 to 10. A smaller value indicates a higher priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], - ], - 'required' => false, - ], + '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' => 'UserData', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data that is returned in the response. The value can be up to 1,024 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"test":1}', - ], + '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' => 'ModelId', + 'name' => 'MatchingMode', 'in' => 'query', 'schema' => [ - 'description' => '', + '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' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C1849434-FC47-5DC1-92B6-F7EAAFE3851E', - ], - 'JobId' => [ - 'description' => 'The ID of the intelligent production job.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1849434-FC47-5DC1-92B6-F7EAAFE3851E\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitIProductionJob', - 'requestParamsDescription' => '### [](#jobparams--json-)Parameters of JobParams'."\n" - ."\n" - .'#### [](#cover)Cover'."\n" - ."\n" - .'* Model: specifies the intelligent thumbnail model. The value is of the STRING type. If you leave this parameter empty, a still thumbnail is generated. If you set this parameter to gif, an animated thumbnail is generated.'."\n" - ."\n" - .'#### [](#videodelogo)VideoDelogo'."\n" - ."\n" - .'* LogoModel: specifies the type of a logo that you want to remove. The value is of the STRING type. Valid values: tv and internet. You can select multiple logo types and separate them with commas (,).'."\n" - .'* Boxes: specifies the position of a logo that you want to remove. The value is of the STRING type and is the normalized coordinate of the upper-left corner. You can set the value in the format of \\[xmin, ymin, width, height]. You can remove up to two logos at a time. Example: \\[\\[0, 0, 0.3, 0.3], \\[0.7, 0, 0.3, 0.3]].'."\n" - ."\n" - .'#### [](#videodetext)VideoDetext'."\n" - ."\n" - .'* LimitRegion: specifies the area within which you want to detect captions. The value is of the LIST type and is the normalized coordinate of the upper-left corner. You can set the value in the format of \\[xmin, ymin, width, height]. You can specify multiple coordinates at a time. Example: \\[\\[0, 0, 0.3, 0.3], \\[0.7, 0, 0.3, 0.3]]. **Note: If you do not specify this parameter, the system detects the captions within the bottom 30% of the video image by default.**'."\n" - .'* Time: specifies the time range within which captions are removed. The value is of the LIST type. You can set the value in the format of \\[start_time, end_time]. For example, a value of \\[5, 20] indicates that only the captions between the 5th and 20th seconds of the video are removed.'."\n" - ."\n" - .'#### [](#captionextraction)CaptionExtraction'."\n" - ."\n" - .'* fps: specifies the sampling frame rate. This parameter is optional. The value is an integer. Valid values: \\[2,10]. Default value: 5.'."\n" - .'* roi: specifies the area of interest. If you specify this parameter, only the captions within the specified area are extracted. You can set the normalized value in the following format: \\[\\[top, bottom], \\[left, right]]. Example: \\[\\[0.5, 1], \\[0, 1]]. By default, if you do not specify this parameter, the captions within the bottom quarter of the video image are extracted.'."\n" - .'* lang: specifies the language to be detected. Valid values: ch, en, and ch_ml. Default value: ch.'."\n" - .'* track: specifies the captions that you want to extract. If you set this parameter to main, only the captions of the main track are extracted. If you do not specify this parameter, all captions in the specified area are extracted by default.'."\n" - ."\n" - .'#### [](#videogreenscreenmatting)VideoGreenScreenMatting'."\n" - ."\n" - .'* bgimage: specifies the background image for replacement. Example: http://example-image-\\*\\*\\*\\*.example-location.aliyuncs.com/example/example.jpg. If you do not specify this parameter, a WebM video with alpha channels is returned.'."\n" - ."\n" - .'#### [](#facebeauty)FaceBeauty'."\n" - ."\n" - .'* beauty_params: the parameters of the FaceBeauty operation. Example: "whiten=20,smooth=50,face_thin=50". For more information, see the "FaceBeauty" section of the [Parameters for intelligent production API operations](~~352026~~) topic.'."\n" - ."\n" - .'#### [](#videoh2v)VideoH2V'."\n" - ."\n" - .'None'."\n" - ."\n" - .'#### [](#musicsegmentdetect)MusicSegmentDetect'."\n" - ."\n" - .'None'."\n" - ."\n" - .'#### [](#audiobeatdetection)AudioBeatDetection'."\n" - ."\n" - .'None'."\n" - ."\n" - .'#### [](#audioqualityassessment)AudioQualityAssessment'."\n" - ."\n" - .'None'."\n" - ."\n" - .'#### [](#speechdenoise)SpeechDenoise'."\n" - ."\n" - .'The input audio file must be in the WAV format with a sampling rate of 16,000 Hz or 48,000 Hz.'."\n" - ."\n" - .'#### [](#audiomixing)AudioMixing'."\n" - ."\n" - .'* inputs: specifies the list of URLs of the audio track files to be mixed. You can specify only one URL. Example: {"file":"http://example-bucket-\\*\\*\\*\\*.oss-cn-shanghai.aliyuncs.com/2.mp4"}.', - ], - 'QueryIProductionJob' => [ - 'summary' => 'Queries 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', + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'CustomFilters', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - ], + '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' => 'JobId', + 'name' => 'UtcCreate', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the intelligent production job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - ], - 'JobId' => [ - 'description' => 'The ID of the intelligent production job.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - 'Name' => [ - 'description' => 'The name of the intelligent production job.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'FunctionName' => [ - 'description' => 'The name of the algorithm that you want to use for the job. Valid values:'."\n" - ."\n" - .'* **Cover**: This algorithm intelligently generates a thumbnail image for a video.'."\n" - .'* **VideoClip**: This algorithm intelligently generates a summary for a video.'."\n" - .'* **VideoDelogo**: This algorithm removes logos from a video.'."\n" - .'* **VideoDetext**: This algorithm removes captions from a video.'."\n", - 'type' => 'string', - 'example' => 'Cover', - ], - 'Input' => [ - 'description' => 'The input file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The media type. Valid values:'."\n" - ."\n" - .'1. OSS: Object Storage Service (OSS) object'."\n" - .'2. Media: media asset'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The input file. If Type is set to OSS, set this parameter to the path of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. You can specify the path of an OSS object in one of the following formats:'."\n" - ."\n" - .'1. oss://bucket/object'."\n" - .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object', - ], - ], - ], - 'Output' => [ - 'description' => 'The output file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The media type. Valid values:'."\n" - ."\n" - .'* OSS: OSS object'."\n" - .'* Media: media asset'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Biz' => [ - 'type' => 'string', - ], - 'Media' => [ - 'description' => 'The output file. If Type is set to OSS, set this parameter to the path of an OSS object. If Type is set to Media, set this parameter to the ID of a media asset. You can specify the path of an OSS object in one of the following formats:'."\n" - ."\n" - .'1. oss://bucket/object'."\n" - .'2. http(s)://bucket.oss-\\[RegionId].aliyuncs.com/object bucket in the path specifies an OSS bucket that resides in the same region as the intelligent production job. object in the path specifies the object path in OSS.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object', - ], - 'OutputUrl' => [ - 'type' => 'string', - ], - ], - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => '****96e8864746a0b6f3****', - ], - 'JobParams' => [ - 'description' => 'The algorithm-specific parameters. The parameters are specified as JSON objects and vary based on the algorithm.'."\n", - 'type' => 'string', - 'example' => '{"Model":"gif"}', - ], - 'ScheduleConfig' => [ - 'description' => 'The scheduling configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'PipelineId' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue.'."\n", - 'type' => 'string', - 'example' => 'a54fdc9c9aab413caef0d1150f565e86', - ], - 'Priority' => [ - 'description' => 'The priority of the job in the MPS queue to which the job is added.'."\n" - ."\n" - .'* A value of 10 indicates the highest priority.'."\n" - .'* Default value: **6**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - ], - ], - 'UserData' => [ - 'description' => 'The user-defined data that is returned in the response.'."\n", - 'type' => 'string', - 'example' => '{"test":1}', - ], - 'Result' => [ - 'description' => 'The output of the algorithm. The output is in JSON format and varies based on the algorithm. For more information, see the "Parameters of Result" section of this topic.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'CreateTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-07-07T07:16:11Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2021-11-26T14:50:25Z', - ], - 'Status' => [ - 'description' => 'The status of the job. Valid values:'."\n" - ."\n" - .'* Queuing: The job is waiting in the queue.'."\n" - .'* Analysing: The job is in progress.'."\n" - .'* Fail: The job failed.'."\n" - .'* Success: The job was successful.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'OutputFiles' => [ - 'description' => 'The output files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The path and name of the output file.'."\n", - 'type' => 'string', - 'example' => 'output/xxx.mp4', - ], - ], - 'OutputMediaIds' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'OutputUrls' => [ - 'description' => 'The URLs of the output files.'."\n", + '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 URL of the output file.'."\n", - 'type' => 'string', - 'example' => 'http://xxx', + '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' => '', ], ], ], - '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.', + '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' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"测试任务\\",\\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' => 'QueryIProductionJob', - 'responseParamsDescription' => '### [](#result-)Parameters of Result'."\n" - ."\n" - .'#### [](#cover)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" - .'The Score parameter indicates the confidence score of the thumbnail image. The Time parameter indicates the timestamp of the thumbnail frame. The Url parameter indicates the path of the thumbnail image.'."\n" - ."\n" - .'#### [](#videoclip)VideoClip'."\n" - ."\n" - .'Example: {"VideoSummaryList":\\[{"EndTime":"5.28","StartTime":"0.28"}]}'."\n" - ."\n" - .'The VideoSummaryList parameter indicates a list of the time ranges that are captured from the original video. Unit: seconds.'."\n" - ."\n" - .'#### [](#videodelogo)VideoDelogo'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#videodetext)VideoDetext'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#captionextraction)CaptionExtraction'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#videogreenscreenmatting)VideoGreenScreenMatting'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#facebeauty)FaceBeauty'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#videoh2v)VideoH2V'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#musicsegmentdetect)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)AudioBeatDetection'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#audioqualityassessment)AudioQualityAssessment'."\n" - ."\n" - .'Example: \\[{ "Discontinuity":"Good", "Loudness":"Excellent", "Worst MOS(0-5)":"0.38", "Discontinuity(0-5)":"3.52", "Speech Ratio":"48.55", "Loudness(0-5)":"4.91", "Worst Discontinuity(0-5)":"0.88", "Worst Coloration(0-5)":"0.42", "Channel":"1", "Coloration(0-5)":"0.99", "Bad Mute Ratio(%)":"0.0", "Time":"2022-12-02 16:14:06", "Noisiness(0-5)":"3.28", "MOS":"Poor", "Worst Noisiness(0-5)":"0.91", "Double Talk Ratio(%)":"19.23", "Input":"/home/admin/algo/quality\\*\\*\\*\\*/example.wav", "Total Duration":"42.78", "Noisiness":"Good", "Tag":"Valid", "MOS(0-5)":"1.01", "Loudness(-90dB-0dB)":"-0.59", "Coloration":"Bad", "Saturated Ratio(%)":"37.55" }, { "Discontinuity":"Fair", "Loudness":"Excellent", "Worst MOS(0-5)":"0.65", "Discontinuity(0-5)":"2.45", "Speech Ratio":"41.68", "Loudness(0-5)":"4.52", "Worst Discontinuity(0-5)":"0.66", "Worst Coloration(0-5)":"0.72", "Channel":"2", "Coloration(0-5)":"2.34", "Bad Mute Ratio(%)":"0.0", "Time":"2022-12-02 16:14:06", "Noisiness(0-5)":"2.53", "MOS":"Poor", "Worst Noisiness(0-5)":"0.67", "Double Talk Ratio(%)":"25.93", "Input":"/home/admin/algo/quality\\*\\*\\*\\*/example.wav", "Total Duration":"42.78", "Noisiness":"Fair", "Tag":"Valid", "MOS(0-5)":"1.69", "Loudness(-90dB-0dB)":"-4.82", "Coloration":"Fair", "Saturated Ratio(%)":"0.0" }]'."\n" - ."\n" - .'For more information, see the "AudioQualityAssessment" section of the [Parameters for intelligent production API operations](~~352026~~) topic.'."\n" - ."\n" - .'#### [](#speechdenoise)SpeechDenoise'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.'."\n" - ."\n" - .'#### [](#audiomixing)AudioMixing'."\n" - ."\n" - .'Example: {}'."\n" - ."\n" - .'This algorithm does not return additional information.', + 'translator' => 'manual', ], - 'CreateDNADB' => [ - 'summary' => 'Creates media fingerprint libraries.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the media fingerprint library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'example name', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Model', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The model of the media fingerprint library. Valid values:'."\n" - ."\n" - .'* **Video**'."\n" - .'* **Audio**'."\n" - .'* **Image**'."\n" - .'* **Text** (supported only in the China (Shanghai) region)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Video', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Description', + 'name' => 'EntityId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the media fingerprint library.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], - 'DBInfo' => [ - 'description' => 'The details of the media fingerprint library.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the media fingerprint library.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Name' => [ - 'description' => 'The name of the media fingerprint library.'."\n", - 'type' => 'string', - 'example' => 'example name', - ], - 'Status' => [ - 'description' => 'The state of the media fingerprint library. After a media fingerprint library is created, it enters the offline state. After the media fingerprint library is processed at the backend, it enters the active state.'."\n", - 'type' => 'string', - 'example' => 'offline', - ], - 'DBId' => [ - 'description' => 'The ID of the media fingerprint library. We recommend that you save this ID for subsequent calls of other operations.'."\n", - 'type' => 'string', - 'example' => '88c6ca184c0e47098a5b665e2a12****', - ], - 'Model' => [ - 'description' => 'The model of the media fingerprint library.'."\n", - 'type' => 'string', - 'example' => 'Video', + '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' => '', ], ], ], - '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' => '* You can create up to five media fingerprint libraries within an account. To increase the quota, submit a ticket. You can call the DeleteDNADB operation to delete the fingerprint libraries that you no longer need.'."\n", - ], - 'DeleteDNADB' => [ - 'summary' => 'Deletes a media fingerprint library.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByFace'], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'DBId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media fingerprint library that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'fb712a6890464059b1b2ea7c8647****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMediaByFace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\"\\n}","type":"json"}]', - 'title' => 'DeleteDNADB', + 'translator' => 'manual', ], - 'ListDNADB' => [ - 'summary' => 'Queries a list of media fingerprint libraries.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '146937', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '224461', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'DBIds', + '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 IDs of the media fingerprint libraries. We recommend that you query at most 10 libraries at a time. Separate multiple library IDs with commas (,).'."\n", + 'description' => 'The type of media assets. Valid values:'."\n" + ."\n" + .'- image'."\n" + ."\n" + .'- video', + 'enumValueTitles' => ['image' => 'image', 'video' => 'video'], 'type' => 'string', 'required' => false, - 'example' => '2288c6ca184c0e47098a5b665e2a12****,78dc866518b843259669df58ed30****', + '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' => [ - 'DBList' => [ - 'description' => 'The queried media fingerprint libraries.'."\n", + '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 queried media fingerprint library.'."\n", + 'description' => 'The media asset that matches the search query.', '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" - .'* **active**: The media fingerprint library is online.'."\n" - .'* **deleted**: The media fingerprint library is deleted.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'Description' => [ - 'description' => 'The description of the media fingerprint library.'."\n", - 'type' => 'string', + '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' => '', ], - 'Name' => [ - 'description' => 'The name of the media fingerprint library.'."\n", - 'type' => 'string', - 'example' => 'example-name', - ], - 'Model' => [ - 'description' => 'The model of the media fingerprint library. Valid values:'."\n" - ."\n" - .'* **Video**'."\n" - .'* **Audio**'."\n" - .'* **Image**'."\n" - .'* **Text** (supported only in the China (Shanghai) region)'."\n", - 'type' => 'string', - 'example' => 'Video', - ], - 'DBId' => [ - 'description' => 'The ID of the media fingerprint library.'."\n", - 'type' => 'string', - 'example' => '88c6ca184c0e47098a5b665e2a12****', - ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], + 'Total' => ['description' => 'The total number of media assets that match the search criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBList\\": [\\n {\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"这是一个视频DNA库。\\",\\n \\"Name\\": \\"example-name\\",\\n \\"Model\\": \\"Video\\",\\n \\"DBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\"\\n }\\n ],\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\"\\n}","type":"json"}]', - 'title' => 'ListDNADB', - ], - 'SubmitDNAJob' => [ - 'summary' => 'Submits a media fingerprint analysis job.', - 'methods' => [ - 'post', - 'get', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], 'parameters' => [ [ - 'name' => 'Input', + 'name' => 'SearchLibName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The input file for media fingerprint analysis.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: Object Storage Service (OSS) object.'."\n" - .'2. Media: media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Media', - ], - 'Media' => [ - 'description' => 'The input file. The file can be an OSS object or a media asset. You can specify the path of an OSS object 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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1b1b9cd148034739af413150fded****', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The search library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-1'], ], [ - 'name' => 'PipelineId', + 'name' => 'MediaType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue to which the media fingerprint analysis job is submitted.'."\n", + '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, - 'example' => '5246b8d12a62433ab77845074039****', + 'title' => '', + 'example' => 'video', ], ], [ - 'name' => 'Config', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => 'The configurations of the media fingerprint analysis job. The value is a JSON object. If you specify this parameter, the template parameters are overwritten.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"SaveType": "save","MediaType"":"video"}', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'TemplateId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S00000101-100060', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'UserData', + 'name' => 'Text', 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined data. The data can be up to 128 bytes in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'userData', - ], + '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' => 'PrimaryKey', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The primary key of the video. You must make sure that each primary key is unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3ca84a39a9024f19853b21be9cf9****', - ], + 'schema' => ['description' => 'Namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], [ - 'name' => 'DBId', + 'name' => 'CustomFilters', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media fingerprint library. If you do not specify this parameter, the default media fingerprint library is used. For more information about how to create a media fingerprint library, see [CreateDNADB](~~479275~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2288c6ca184c0e47098a5b665e2a12****', - ], + '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 request ID.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], - 'JobId' => [ - 'description' => 'The ID of the media fingerprint analysis job. We recommend that you save this ID for subsequent calls of other operations.'."\n", - 'type' => 'string', - 'example' => '88c6ca184c0e47098a5b665e2****', + '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' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","type":"json"}]', - 'title' => 'SubmitDNAJob', - 'description' => '* SubmitDNAJob is an asynchronous operation. After a request is sent, the system returns a request ID and a job ID and runs the task in the background.'."\n" - .'* You can call this operation only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.'."\n" - .'* You can submit a text fingerprint analysis job only in the China (Shanghai) region.'."\n", - 'requestParamsDescription' => 'The Config parameter of the media fingerprint analysis job contains the SaveType and MediaType fields.'."\n" - ."\n" - .'SaveType specifies the storage type. Valid values:'."\n" - ."\n" - .'* **nosave**: The fingerprints of the job input are searched but not saved to the media fingerprint library.'."\n" - .'* **save**: The fingerprints of the job input are saved to the media fingerprint library only if the fingerprints are not duplicated with content in the media fingerprint library.'."\n" - .'* **forcesave**: The fingerprints of the job input are forcibly saved to the media fingerprint library.'."\n" - .'* **onlysave**: The fingerprints of the job input are saved to the media fingerprint library but not searched.'."\n" - ."\n" - .'MediaType specifies the media type of the input file. Valid values:'."\n" - ."\n" - .'* **video**'."\n" - .'* **audio**'."\n" - .'* **image**'."\n" - .'* **text**'."\n" - .'* **asr**'."\n", - ], - 'CancelDNAJob' => [ - 'summary' => 'Cancels a media fingerprint analysis job.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByMultimodal'], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media fingerprint analysis job that you want to cancel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2288c6ca184c0e47098a5b665e2a12****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '2288c6ca184c0e47098a5b665e2a12****', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMediaByMultimodal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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" - .'* We recommend that you call the **UpdatePipeline** operation to set the status of the ApsaraVideo Media Processing (MPS) queue to Paused before you cancel a job. This suspends job scheduling in the MPS queue. After the job is canceled, you must set the status of the MPS queue back to Active so that the other jobs in the MPS queue can be scheduled.'."\n", + 'translator' => 'manual', ], - 'DeleteDNAFiles' => [ - 'summary' => 'Deletes files from a media fingerprint library.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], + ], 'parameters' => [ [ - 'name' => 'DBId', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media fingerprint library from which you want to delete files.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'fb712a6890464059b1b2ea7c8647****', - ], + 'schema' => ['description' => 'The name of the search library.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ - 'name' => 'PrimaryKeys', + 'name' => 'PageNo', '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.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '41e6536e4f2250e2e9bf26cdea19****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - ], - 'description' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\"\\n}","type":"json"}]', - 'title' => 'DeleteDNAFiles', - ], - 'ListDNAFiles' => [ - 'summary' => 'Queries a list of files in a media fingerprint library.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + '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'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'NextPageToken', + 'name' => 'EntityId', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ae0fd49c0840e14daf0d66a75b83****', - ], + 'schema' => ['description' => 'The ID of the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2d3bf1e35a1e42b5ab338d701efa****'], ], [ - 'name' => 'PageSize', + 'name' => 'FaceSearchToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '20', - ], + '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' => 'DBId', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the media fingerprint library.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2288c6ca184c0e47098a5b665e2a12****', - ], + '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 request ID.'."\n", - 'type' => 'string', - 'example' => '2AE89FA5-E620-56C7-9B80-75D09757385A', - ], - 'NextPageToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'ae0fd49c0840e14daf0d66a75b83****', - ], - 'FileList' => [ - 'description' => 'The queried files.'."\n", + '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' => [ - 'description' => 'The queried file.'."\n", 'type' => 'object', 'properties' => [ - 'PrimaryKey' => [ - 'description' => 'The primary key of the file.'."\n", - 'type' => 'string', - 'example' => 'ae0fd49c0840e14daf0d66a75b83****', - ], - 'InputFile' => [ - 'description' => 'The Object Storage Service (OSS) information about the input file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Object' => [ - 'description' => 'The name of the OSS object that is used as the input file.'."\n", - 'type' => 'string', - 'example' => 'example-****.mp4', - ], - 'Location' => [ - 'description' => 'The OSS region in which the input file resides.'."\n", - 'type' => 'string', - 'example' => 'oss-cn-beijing', - ], - 'Bucket' => [ - 'description' => 'The name of the OSS bucket in which the input file is stored.'."\n", - 'type' => 'string', - 'example' => 'example-bucket', + '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' => ''], ], - 'description' => '', + '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' => 'You can call this operation to query files in a media fingerprint library based on the library ID. The queried results can be paginated.'."\n", - ], - 'QueryDNAJobList' => [ - 'summary' => 'Queries a list of media fingerprint analysis jobs.', - 'methods' => [ - 'post', - 'get', + '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'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobIds', + 'name' => 'MediaIds', '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 (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '88c6ca184c0e47098a5b665e2a12****', - ], + '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' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], - 'JobList' => [ - 'description' => 'The queried media fingerprint analysis jobs.'."\n", + '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' => [ - 'description' => 'The queried media fingerprint analysis job.'."\n", 'type' => 'object', 'properties' => [ - 'DNAResult' => [ - 'description' => 'The URL of the media fingerprint analysis result.'."\n", - 'type' => 'string', - 'example' => 'http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt', - ], - 'PrimaryKey' => [ - 'description' => 'The primary key of the video. You must make sure that each primary key is unique.'."\n", - 'type' => 'string', - 'example' => '3ca84a39a9024f19853b21be9cf9****', - ], - 'DBId' => [ - 'description' => 'The ID of the media fingerprint library.'."\n", - 'type' => 'string', - 'example' => '2288c6ca184c0e47098a5b665e2a12****', - ], - 'CreationTime' => [ - 'description' => 'The time when the job was created.'."\n", - 'type' => 'string', - 'example' => '2022-12-28T03:21:37Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the job was complete.'."\n", - 'type' => 'string', - 'example' => '2022-12-28T03:21:44Z', - ], - 'Status' => [ - 'description' => 'The job state. Valid values:'."\n" - ."\n" - .'* **Queuing**: The job is waiting in the queue.'."\n" - .'* **Analysing**: The job is in progress.'."\n" - .'* **Success**: The job is successful.'."\n" - .'* **Fail**: The job failed.'."\n", - 'type' => 'string', - 'example' => 'Queuing', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '"The resource operated \\"a887d0b***d805ef6f7f6786302\\" cannot be found"', - ], - 'Config' => [ - 'description' => 'The configurations of the media fingerprint analysis job.'."\n", - 'type' => 'string', - 'example' => '{"SaveType": "save","MediaType"":"video"}', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => 'testdna', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '"InvalidParameter.ResourceNotFound"', - ], - 'Input' => [ - 'description' => 'The details of the input file.'."\n", + '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' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: Object Storage Service (OSS) object.'."\n" - .'2. Media: media asset.'."\n", - 'type' => 'string', - 'example' => 'Media', + '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' => '', ], - '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.'."\n", - 'type' => 'string', - 'example' => '1b1b9cd148034739af413150fded****', + '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' => '', ], ], - ], - 'Id' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '88c6ca184c0e47098a5b665e2a12****', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + '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.|', - ], - 'SubmitCopyrightJob' => [ - 'summary' => 'Submits a job for adding a copyright watermark to a video.', - 'path' => '', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -54748,1111 +42328,684 @@ 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ - 'name' => 'Input', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The source video file that you want to add a watermark to.'."\n" - ."\n" - .'> The OSS object or media asset must reside in the same region as the IMS service region.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the source file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The URL of the source file. You can specify the path of an OSS object 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" - .'where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object', - ], - ], - 'required' => true, - 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"}', - ], + 'schema' => ['description' => 'The ID of the AI agent in the conversation.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****'."\n", 'title' => ''], ], [ - 'name' => 'Output', + 'name' => 'Message', 'in' => 'query', - 'style' => 'json', + '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' => [ - 'description' => 'The URL of the output file.'."\n" - ."\n" - .'> The OSS bucket must reside in the same region as the IMS service region.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid value:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The OSS path where the output file is saved. You can specify the path in one of the following formats:'."\n" - ."\n" - .'1\\. oss://bucket/object'."\n" - ."\n" - .'2\\. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://test-bucket/output.mp4', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'."\n"], ], - 'required' => true, - 'example' => '{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"}', + 'example' => '', ], ], - [ - 'name' => 'Message', - 'in' => 'query', - 'schema' => [ - 'title' => '水印信息', - 'description' => 'The information about the watermark to be added.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Test', - ], + ], + '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' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the watermark. Unit: seconds. If you do not specify this parameter, the default value 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', + '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' => [ [ - 'name' => 'TotalTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the watermark. Unit: seconds. If you do not specify this parameter, the default value is the video duration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237311', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + ], + 'parameters' => [ [ - 'name' => 'Level', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark level, which specifies the channel to embed watermarks. Valid values: 0 specifies the 0u channel, 1 specifies the 1uv channel, and 2 specifies the 2yuv channel.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + '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' => 'Description', + 'name' => 'Text', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the watermark.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Description', - ], + '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' => 'UserData', + 'name' => 'EnableInterrupt', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom data, which can be up to 1,024 bytes in size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'Specifies whether the broadcast can interrupt the ongoing speech. Default value: true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Params', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters related to watermark jobs. The value is a JSON string. Supported parameter:'."\n" - ."\n" - .'* algoType: the algorithm type. Default value: v1.'."\n" - ."\n" - .' * v1: watermarking for long videos that last at least 3 minutes.'."\n" - .' * v2: watermarking for videos shorter than 3 minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"algoType":"v2"}', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'title' => '任务id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'bfb786c63****f4d80648792021eff90', - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3'."\n", - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - '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' => '* You can call this operation to add a copyright watermark to a video that lasts at least 3 minutes. If the video is too short, the call may fail, or no output may be returned. To add a copyright watermark to a video shorter than 3 minutes, specify the Params parameter to change the algorithm.'."\n" - .'* Each API call supports processing only one video.'."\n" - .'* This API is supported only in the China (Shanghai) and China (Beijing) regions.'."\n", - ], - 'QueryCopyrightJobList' => [ - 'summary' => 'Queries copyright watermarking jobs.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendAIAgentSpeech'], + ], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeCode' => '237311', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'CreateTimeStart', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the creation time range for the query, in UNIX timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1627357322', - ], - ], - [ - 'name' => 'CreateTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the creation time range for the query, in UNIX timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1627357325', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****cdb3e74639973036bc84****', - ], - ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark level, indicating the color channel for embedding. 0: U. 1: UV. 2: YUV.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + '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' => 'PageSize', + 'name' => 'Text', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The input to the LLM.', 'type' => 'string', 'example' => 'Hello.', 'required' => true, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => 'The creation time of the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1627357322', - ], - 'GmtModified' => [ - 'title' => '修改时间', - 'description' => 'The last modification time of the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1627357322', - ], - 'Input' => [ - 'description' => 'Information about the input video for watermarking.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The specific input information.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object', - ], - ], - ], - 'Output' => [ - 'description' => 'Information about the watermarked output video.'."\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', - ], - 'Media' => [ - 'description' => 'The specific output information.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object', - ], - ], - ], - 'JobId' => [ - 'title' => '任务id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'bfb786c639894f4d80648792021****', - ], - 'Level' => [ - 'title' => '水印强度', - 'description' => 'The watermark level.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Message' => [ - 'title' => '水印信息', - 'description' => 'The content of the embedded watermark.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Result' => [ - 'title' => '任务结果', - 'description' => 'The job result.'."\n", - 'type' => 'string', - 'example' => '{"Code":"success","Message":"ok"}', - ], - 'Status' => [ - 'title' => '状态', - 'description' => 'The status of the job.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'UserId' => [ - 'title' => '用户ID', - 'description' => 'The ID of the user who initiated the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1346693***'."\n", - ], - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******36-3C1E-4417-BDB2-1E034F******', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DB488837-3****'], ], + '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.'."\n", - ], - 'SubmitCopyrightExtractJob' => [ - 'summary' => 'Submits a job that extracts a copyright watermark.', - 'path' => '', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB488837-3****\\"\\n}","type":"json"}]', + 'title' => 'SendAIAgentText', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], - ], - 'parameters' => [ - [ - 'name' => 'Input', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The source video file from which to extract the watermark.'."\n" - ."\n" - .'> The OSS object or media asset must reside in the same region as the IMS service region.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the source file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The specific information for the input file, which can be an OSS URL or a media asset ID. OSS URL formats:'."\n" - ."\n" - .'1\\. oss://bucket/object'."\n" - ."\n" - .'2\\. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object'."\n" - ."\n" - .'where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object', - ], - ], - 'required' => true, - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom data, which can be up to 1,024 bytes in size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the snapshot job.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ - 'name' => 'Params', - 'in' => 'query', + 'name' => 'Command', + 'in' => 'formData', 'schema' => [ - 'description' => 'Additional parameters for the watermark job, provided as a JSON string. Supported parameter:'."\n" + 'description' => 'The operation command.'."\n" ."\n" - .'* algoType: The algorithm type. Defaults to v1. The extraction algorithm must match the one used for embedding.'."\n" + .'Valid values:'."\n" + ."\n" + .'- stop'."\n" ."\n" - .' * v1: Copyright watermark extraction algorithm for long videos.'."\n" - .' * v2: Copyright watermark extraction algorithm for short videos.'."\n", + .'- restart'."\n" + ."\n" + .'- start', + 'enumValueTitles' => ['stop' => '', 'restart' => '', 'start' => ''], 'type' => 'string', - 'required' => false, - 'example' => '{"algoType":"v2"}', + 'required' => true, + 'title' => '', + 'example' => 'start', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'title' => '任务id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'bfb786c63****4d80648792021eff90', - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"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' => '* This operation is supported only in the China (Shanghai) and China (Beijing) regions.'."\n", - ], - 'QueryCopyrightExtractJob' => [ - 'summary' => 'Queries a job for extracting a copyright watermark.', - 'path' => '', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], - ], + 'systemTags' => [], '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.'."\n", + '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, - 'example' => '2288c6ca184c0e47098a5b665e2a12****'."\n", + 'enum' => ['stop'], + 'example' => 'stop', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'title' => '版权水印信息', - 'description' => 'The copyright watermark information.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Message\\": \\"版权水印测试\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'QueryCopyrightExtractJob', - ], - 'SubmitTraceAbJob' => [ - 'summary' => 'Submits an A/B watermarking job.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendLiveTranscodeJobCommand'], + ], ], - 'schemes' => [ - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '237311', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'Input', + 'name' => 'SessionId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The source video file for A/B watermarking.'."\n" - ."\n" - .'> OSS object or media asset must reside in the same region as the IMS service region. This API supports only videos that last at least 3 minutes. If the video is too short, the call may fail, or no output may be returned.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the source file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The source file. The file can be an OSS object or a media asset. You can specify the path of an OSS object 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" - .'where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the session.', 'type' => 'string', 'required' => true, 'example' => 'f27f9b9be28642a88e18****', 'title' => ''], ], [ - 'name' => 'Output', + 'name' => 'AIAgentId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The output directory path.'."\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', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The output file. The file can be an OSS object or a media asset. OSS URL formats:'."\n" - ."\n" - .'1\\. oss://bucket/dir/'."\n" - ."\n" - .'2\\. http(s)://bucket.oss-\\[regionId].aliyuncs.com/dir/'."\n" - ."\n" - .'In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and dir specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/dir/', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the AI agent.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ReceiverId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start point of watermark embedding. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + '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' => 'TotalTime', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The duration of the watermark embedding. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '360', - ], + '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' => 'Level', + 'name' => 'Text', 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark level, which specifies the channel to embed watermarks. Valid values: 0 specifies the 0u channel, 1 specifies the 1uv channel, and 2 specifies the 2yuv channel.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The content of the message.', 'type' => 'string', 'example' => 'Hello.', 'required' => true, 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'Mode', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom data, which can be up to 1,024 bytes in size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + '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' => 'CipherBase64ed', + 'name' => 'NeedArchiving', 'in' => 'query', - 'schema' => [ - 'description' => 'The key that is encoded by using the Base64 algorithm.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Qh6OdgIMcliQSI1fReOw****'."\n", - ], + 'schema' => ['description' => 'Specifies whether to archive chat records. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'title' => '任务Id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'bfb786c639894f4d80648792021e****', - ], - 'TraceMediaId' => [ - 'title' => '媒体Id', - 'description' => 'The media ID.'."\n", - 'type' => 'string', - 'example' => 'bf53333264f4d80648792021e****', - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******36-3C1E-4417-BDB2-1E034F******', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"TraceMediaId\\": \\"bf53333264f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'SubmitTraceAbJob', - 'description' => '* This API supports only videos that last at least 3 minutes. If the video is too short, the call may fail, or no output may be returned.'."\n", - ], - 'QueryTraceAbJobList' => [ - 'summary' => 'Queries A/B watermarking jobs.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => 'SendMessageChatText', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'VoiceprintId', 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID. You can obtain the value of this parameter from the response of the SubmitTraceAbJob operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****d80e4e4044975745c14b****', - ], + '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' => 'TraceMediaId', + 'name' => 'Input', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The media ID for the trace watermark. You can obtain this from the response of the SubmitTraceAbJob operation.'."\n", - 'type' => 'string', + '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, - 'example' => '****437bd2b51105d07b12a9****', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'CreateTimeStart', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The start of the creation time range for the query, in UNIX timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1627357322', + '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' => [ [ - 'name' => 'CreateTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the creation time range for the query, in UNIX timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1627357325', + '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' => [ [ - 'name' => 'PageNumber', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Auto', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + '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' => 'PageSize', + 'name' => 'SaveType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of the response.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => 'The creation time of the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1627357322', - ], - 'GmtModified' => [ - 'title' => '修改时间', - 'description' => 'The last modification time of the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1627357322', - ], - 'Input' => [ - 'description' => 'Information about the input video for watermarking.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the input file. Valid values:'."\n" - ."\n" - .'1. OSS: an Object Storage Service (OSS) object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The specific input file information.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object', - ], - ], - ], - 'Output' => [ - 'description' => 'Information about the output path for the A/B stream.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid values:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n" - .'2. Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The output directory.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/dir/', - ], - ], - ], - 'JobId' => [ - 'title' => '任务id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'bfb786c639894f4d80648792021eff90', - ], - 'Level' => [ - 'title' => '水印强度', - 'description' => 'The watermark level.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TraceMediaId' => [ - 'title' => '媒体id', - 'description' => 'The media ID for the trace watermark.'."\n", - 'type' => 'string', - 'example' => '****437bd2b51105d07b12a9****', - ], - 'Result' => [ - 'title' => '任务结果', - 'description' => 'The job result.'."\n", - 'type' => 'string', - 'example' => '{"Code":"success","Message":"ok"}', - ], - 'Status' => [ - 'title' => '状态', - 'description' => 'The status of the job.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'UserId' => [ - 'title' => '用户ID', - 'description' => 'The ID of the user who initiated the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13466932****', - ], - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + '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' => '', ], ], ], - '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.'."\n", - ], - 'SubmitTraceM3u8Job' => [ - 'summary' => 'Submits a job that generates an M3U8 file containing specific trace watermark information.', - 'path' => '', - 'methods' => [ - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -55860,1520 +43013,1018 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TraceMediaId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The media ID for the trace watermark. You can obtain this from the response of the SubmitTraceAbJob operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '437bd2b516ffda105d07b12a9a82****', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****d80e4e4044975745c14b****'], ], - [ - 'name' => 'Output', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The OSS URL of the output M3U8 file.'."\n" - ."\n" - .'> The OSS bucket must reside in the same region as the service region.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the output file. Valid value:'."\n" - ."\n" - .'1. OSS: an OSS object.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The OSS path where the output file is saved. You can specify the path in one of the following formats:'."\n" - ."\n" - .'1\\. oss://bucket/object'."\n" - ."\n" - .'2\\. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object', - ], + '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'], ], - 'required' => 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' => [ [ - 'name' => 'Trace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The specific trace watermark information.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', + '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' => [ [ - 'name' => 'KeyUri', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URI of the key server.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://cipher.abc.com', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Params', + 'name' => 'StorageType', 'in' => 'query', 'schema' => [ - 'description' => 'Additional parameters for the watermark job, provided as a JSON string. Supported parameter:'."\n" + 'description' => 'Storage type:'."\n" ."\n" - .'* m3u8Type: The type of M3U8 to generate. Defaults to v1.'."\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" - .' * v1: Generates an M3U8 with absolute paths, playable directly. The signed URL for access is valid for 24 hours. If you need to use it after expiration, you must call this API again.'."\n" - .' * v2: Generates an M3U8 with relative paths. It must be placed in the same directory as the TS segment files to be playable.'."\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' => '{"m3u8Type":"v1"}'."\n", + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'title' => '任务id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'bfb786c639894f4d8064879202****', - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d8064879202****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'SubmitTraceM3u8Job', - 'description' => '* Before you call this operation, you must call SubmitTraceAbJob to get the TraceMediaId from its response.'."\n" - .'* This operation is supported only in the China (Shanghai) and China (Beijing) regions.'."\n" - .'* The M3U8 file generated by this job has a signed URL with an authentication validity period of 24 hours, starting from the moment the job is completed. Once the signature expires, you will no longer be able to trace the watermark information using that specific M3U8 file. If you need to use it after expiration, you must call this API again to generate a new M3U8 file.'."\n", - ], - 'QueryTraceM3u8JobList' => [ - 'summary' => 'Queries jobs for generating M3U8 files containing specific trace watermark information.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultStorageLocation'], + ], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ - 'name' => 'CreateTimeStart', + 'name' => 'CallbackType', 'in' => 'query', 'schema' => [ - 'description' => 'The start of the creation time range for the query, in UNIX timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The callback method. Valid values:'."\n" + ."\n" + .'- **HTTP**'."\n" + ."\n" + .'- **MNS**', + 'enumValueTitles' => ['MNS' => 'MNS', 'HTTP' => 'HTTP'], + 'type' => 'string', 'required' => false, - 'example' => '1627357322', + 'example' => 'HTTP', + 'title' => '', ], ], [ - 'name' => 'CreateTimeEnd', + 'name' => 'CallbackQueueName', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the creation time range for the query, in UNIX timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1627357325', - ], + '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' => 'JobId', + 'name' => 'CallbackURL', 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID. You can obtain the value of this parameter from the response of the SubmitTraceM3u8Job operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + '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' => 'PageNumber', + 'name' => 'AuthSwitch', 'in' => 'query', 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', + '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' => '0', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'AuthKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => 'The creation time of the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1627357322', - ], - 'GmtModified' => [ - 'title' => '修改时间', - 'description' => 'The last modification time of the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1627357322', - ], - 'JobId' => [ - 'title' => '任务id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****d718e2ff4f018ccf419a7b71****', - ], - 'TraceMediaId' => [ - 'description' => 'The media ID for the trace watermark.'."\n", - 'type' => 'string', - 'example' => '****437bd2b105d07b12a9a82****', - ], - 'Output' => [ - 'description' => 'The output video.'."\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', - ], - 'Media' => [ - 'description' => 'The specific output information.'."\n", - 'type' => 'string', - 'example' => 'oss://bucket/object', - ], - ], - ], - 'Status' => [ - 'title' => '状态', - 'description' => 'The current status of the job.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Trace' => [ - 'title' => '水印信息', - 'description' => 'The watermark information.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '112', - ], - 'UserId' => [ - 'title' => '用户ID', - 'description' => 'The ID of the user who initiated the job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1346693276****', - ], - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'SetEventCallback', + 'summary' => 'Configures a callback method for one or more events.', + 'changeSet' => [ + ['createdAt' => '2021-06-25T14:18:28.000Z', 'description' => 'OpenAPI offline'], ], - '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" - .'* 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.'."\n", - ], - 'SubmitTraceExtractJob' => [ - 'summary' => 'Submits a job to extract the trace watermark.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetEventCallback'], + ], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '236010', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'Input', + 'name' => 'AIAgentId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The source video file from which to extract the watermark.'."\n" - ."\n" - .'> The OSS object or media asset must reside in the same region as the IMS service region.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the source file. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The specific information for the source file, which can be an OSS URL or a media asset ID. OSS URL formats:'."\n" - ."\n" - .'1\\. oss://bucket/object'."\n" - ."\n" - .'2\\. http(s)://bucket.oss-\\[regionId].aliyuncs.com/object'."\n" - ."\n" - .'where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://bucket/object', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the AI Agent.', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ - 'name' => 'UserData', + 'name' => 'EnableNotify', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom data, which can be up to 1,024 bytes in size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'Specifies whether to enable or disable event notifications.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Params', + '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' => 'Additional parameters for the watermark job, provided as a JSON string. Supported parameter:'."\n" + 'description' => 'The event types. If you do not specify this parameter, all event types are subscribed to by default. Valid values:'."\n" ."\n" - .'* m3u8Type: The extraction algorithm type. Defaults to v1.'."\n" + .'- agent\\_start'."\n" ."\n" - .' * v1: Extracts from an M3U8 with absolute paths.'."\n" - .' * v2: Extracts from an M3U8 with relative paths.'."\n", + .'- agent\\_stop'."\n" + ."\n" + .'- error', + 'enumValueTitles' => ['agent_start' => 'agent\\_start', 'error' => 'error', 'agent_stop' => 'agent\\_stop'], 'type' => 'string', 'required' => false, - 'example' => '{"m3u8Type":"v1"}'."\n", + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'title' => '任务id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => 'bfb786c639894f4d80648792021e****', - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'SubmitTraceExtractJob', - 'description' => '* This operation is supported only in the China (Shanghai) and China (Beijing) regions.'."\n" - .'* The input video must be 3 minutes or longer. Jobs submitted with shorter videos will fail.'."\n", - ], - 'QueryTraceExtractJob' => [ - 'summary' => 'Queries a job for extracting a trace watermark.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'YikeUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID. You can obtain the value of this parameter from the response of the SubmitTraceExtractJob operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '31fa3c9ca8134fb4b0b0f7878301****'."\n", - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '返回数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Trace' => [ - 'title' => '溯源水印信息', - 'description' => 'The trace watermark information.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Message' => [ - 'title' => '返回信息', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'StatusCode' => [ - 'title' => '状态码', - 'description' => 'The status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + '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' => '', ], ], ], - '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.'."\n", - ], - 'DescribeMeterImsMediaConvertUHDUsage' => [ - 'methods' => [ - 'get', - 'post', + 'title' => 'SetYikeUserRole', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '146742', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236525', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'StartTs', + 'name' => 'AIAgentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1654403036', - ], + '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' => 'EndTs', + 'name' => 'RuntimeConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1656995036', - ], + 'style' => 'json', + 'schema' => ['description' => 'The configuration required for the agent at runtime.', 'required' => true, '$ref' => '#/components/schemas/AIAgentRuntimeConfig', 'title' => '', 'example' => ''], ], [ - 'name' => 'RegionId', + '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' => 'This parameter does not take effect. By default, the usage data of all regions is returned.'."\n", - 'type' => 'string', + '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, - 'example' => 'cn-shanghai', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Interval', + 'name' => 'TemplateConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => '3600'."\n", - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', - ], - 'Data' => [ - 'description' => 'The usage statistics of IMS on UHD transcoding of MPS.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => 'The beginning time of usage. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1656950400', - ], - 'Specification' => [ - 'description' => 'The transcoding specifications.'."\n", - 'type' => 'string', - 'example' => 'SuperResolution.Standard.1080P'."\n", - ], - 'Duration' => [ - 'description' => 'The usage duration, in minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '308028', - ], - ], - 'description' => '', - ], - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Meter.ParamError', - 'errorMessage' => 'Param Error:%s,Please Check Again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Meter.AuthError', - 'errorMessage' => 'Authentication Failed,Please Try Again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Meter.ServerInternalError', - 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', - ], - [ - 'errorCode' => 'Meter.DataSourceQueryError', - 'errorMessage' => 'Data Source Error:%s,Please Try Again.', - ], + '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'], ], - 502 => [ - [ - 'errorCode' => 'Meter.ReadyTsError', - 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:StartAIAgentInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"InstanceId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - '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', - ], + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '146741', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236524', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'StartTs', + 'name' => 'AIAgentId', '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1654403036', - ], + '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' => 'EndTs', + 'name' => 'CallerNumber', '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1656995036', - ], + 'schema' => ['description' => 'The caller number. Only numbers from mainland China are supported.', 'type' => 'string', 'required' => true, 'example' => '183*****333', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai'."\n", - ], + 'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => true, 'example' => '173*****533', 'title' => ''], ], [ - 'name' => 'Interval', + 'name' => 'Config', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '86400', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FBBB5210-2B78-58FB-A6FE-9DD887BB2C61', - ], - 'Data' => [ - 'description' => 'The usage statistics of IMS on VOD transcoding.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => 'The beginning time of usage. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1656950400', - ], - 'Specification' => [ - 'description' => 'The transcoding specifications.'."\n", - 'type' => 'string', - 'example' => 'H264.HD'."\n", - ], - 'Duration' => [ - 'description' => 'The usage duration, in minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - ], - 'description' => '', - ], - ], + 'InstanceId' => ['description' => 'The call instance ID.', 'type' => 'string', 'example' => '*********296014bb58670940*********', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '***********-4417-BDB2************'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Meter.ParamError', - 'errorMessage' => 'Param Error:%s,Please Check Again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Meter.AuthError', - 'errorMessage' => 'Authentication Failed,Please Try Again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Meter.ServerInternalError', - 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', - ], - [ - 'errorCode' => 'Meter.DataSourceQueryError', - 'errorMessage' => 'Data Source Error:%s,Please Try Again.', - ], - ], - 502 => [ - [ - 'errorCode' => 'Meter.ReadyTsError', - 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + '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' => '*'], + ], ], ], ], - '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', + 'translator' => 'machine', ], - 'DescribeMeterImsEditUsage' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartAIWorkflow' => [ + 'summary' => 'Initiates a workflow task for automated media processing based on a workflow template.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '146735', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'StartTs', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1654403036', - ], + 'schema' => ['description' => 'The ID of the workflow template.', 'type' => 'string', 'docRequired' => true, 'example' => '****3f44-f1f6-477e-9364-c5e6c49e****', 'title' => '', 'required' => true], ], [ - 'name' => 'EndTs', + 'name' => 'Inputs', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1656995036', - ], + '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' => 'Interval', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '86400', - ], + 'schema' => ['description' => 'A user-defined parameter for passing custom metadata.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .'"url":"https://test.com"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'DispatchTag', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The tag for the task.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7F3AE2C6-5CC6-5712-BAC5-5A735A157687', - ], - 'Data' => [ - 'description' => 'The usage statistics of IMS on VOD editing.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => 'The beginning time of usage. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1656950400', - ], - 'Duration' => [ - 'description' => 'The usage duration, in minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1.23', - ], - 'Profile' => [ - 'description' => 'The video profile.'."\n", - 'type' => 'string', - 'example' => '1080P', - ], - ], - 'description' => '', - ], - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Meter.ParamError', - 'errorMessage' => 'Param Error:%s,Please Check Again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Meter.AuthError', - 'errorMessage' => 'Authentication Failed,Please Try Again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Meter.ServerInternalError', - 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', - ], - [ - 'errorCode' => 'Meter.DataSourceQueryError', - 'errorMessage' => 'Data Source Error:%s,Please Try Again.', - ], - ], - 502 => [ - [ - 'errorCode' => 'Meter.ReadyTsError', - 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + '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' => '*'], + ], ], ], ], - '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.', + 'translator' => 'manual', ], - 'DescribeMeterImsSummary' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartChannel' => [ + 'summary' => 'Starts a channel.', + 'description' => ' ', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '146724', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'StartTs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1654403036', - ], - ], - [ - 'name' => 'EndTs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1656995036', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', - ], - 'Data' => [ - 'description' => 'The usage statistics of IMS.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MpsTranscodeDuration' => [ - 'description' => 'The duration of video-on-demand (VOD) transcoding.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17337', - ], - 'MpsTranscodeUHDDuration' => [ - 'description' => 'The duration of audio and video enhancement.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'LiveTranscodeDuration' => [ - 'description' => 'The duration of live stream transcoding.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12356', - ], - 'EditingDuration' => [ - 'description' => 'The duration of video editing.'."\n", - 'type' => 'string', - 'example' => '8722', - ], - 'MpsAiDuration' => [ - 'description' => 'The duration of AI processing.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LiveRecordDuration' => [ - 'description' => 'The duration of live stream recording.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'LiveEditDuration' => [ - 'description' => 'The duration of live editing.'."\n", - 'type' => 'string', - 'example' => '2000', - ], - 'LiveSnapshotCount' => [ - 'description' => 'The number of live stream snapshots.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - 'description' => '', - ], - ], + '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' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Meter.ParamError', - 'errorMessage' => 'Param Error:%s,Please Check Again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Meter.AuthError', - 'errorMessage' => 'Authentication Failed,Please Try Again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Meter.ServerInternalError', - 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', - ], - [ - 'errorCode' => 'Meter.DataSourceQueryError', - 'errorMessage' => 'Data Source Error:%s,Please Try Again.', - ], - ], - 502 => [ - [ - 'errorCode' => 'Meter.ReadyTsError', - 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + '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' => '*'], + ], ], ], ], - '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.', + 'translator' => 'manual', ], - 'DescribeMeterImsMpsAiUsage' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartMediaLiveChannel' => [ + 'summary' => 'Starts a MediaLive channel.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '146716', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1654403036', - ], - ], - [ - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1656995036', - ], - ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity of the query. Valid values: 3600 (hour) and 86400 (day).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '86400', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter does not take effect. By default, the usage data of all regions is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', - ], - 'Data' => [ - 'description' => 'The usage statistics of IMS on AI processing of MPS.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => 'The beginning time of usage. The value is a 10-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1656950400', - ], - 'Type' => [ - 'description' => 'The AI type. Valid values:'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Duration' => [ - 'description' => 'The usage duration, in minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '644', - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Meter.ParamError', - 'errorMessage' => 'Param Error:%s,Please Check Again.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Meter.AuthError', - 'errorMessage' => 'Authentication Failed,Please Try Again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Meter.ServerInternalError', - 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', - ], - [ - 'errorCode' => 'Meter.DataSourceQueryError', - 'errorMessage' => 'Data Source Error:%s,Please Try Again.', - ], + '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'], ], - 502 => [ - [ - 'errorCode' => 'Meter.ReadyTsError', - 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:StartMediaLiveChannel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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.', + 'translator' => 'manual', ], - 'SetEventCallback' => [ - 'summary' => 'Configures a callback method for one or more events.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228630', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'CallbackType', + 'name' => 'RobotId', 'in' => 'query', - 'schema' => [ - 'description' => 'The callback method. Valid values:'."\n" - ."\n" - .'* **HTTP**'."\n" - .'* **MNS**'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MNS' => 'MNS', - 'HTTP' => 'HTTP', - ], - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The AI agent\'s unique identifier.', 'type' => 'string', 'required' => true, 'example' => 'ca28b08ad3464ebcb42e5c0f7c6d2e89', 'title' => ''], ], [ - 'name' => 'CallbackQueueName', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Simple Message Queue (SMQ) queue in the region. The name must start with ice-callback-.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ice-callback-queue', - ], + 'schema' => ['description' => 'The RTC channel\'s unique identifier.', 'type' => 'string', 'required' => true, 'example' => 'testId', 'title' => ''], ], [ - 'name' => 'CallbackURL', + 'name' => 'UserId', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.yyy/callback', - ], + 'schema' => ['description' => 'The AI agent\'s unique identifier within the channel.', 'type' => 'string', 'required' => true, 'example' => 'my-robot', 'title' => ''], ], [ - 'name' => 'EventTypeList', + 'name' => 'UserData', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ProduceMediaComplete', - ], + 'schema' => ['description' => 'User-defined information.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'AuthSwitch', + 'name' => 'AuthToken', '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" - .'* **off**'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'on', - ], + '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' => 'AuthKey', + 'name' => 'Config', 'in' => 'query', + 'style' => 'json', '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**.'."\n", - 'type' => 'string', + '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, - 'example' => 'TestKey001', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Success' => [ - 'title' => '是否设置成功', - 'description' => 'Indicates whether the configuration was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n true\\n","errorExample":""}]', - 'title' => 'SetEventCallback', - ], - 'GetEventCallback' => [ - 'summary' => 'Queries event callback configurations.', - 'methods' => [ - 'get', - 'post', + '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'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'CallbackType' => [ - 'description' => 'The callback method. Valid values:'."\n" - ."\n" - .'* **HTTP**'."\n" - .'* **MNS**'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'MNS' => 'MNS', - 'HTTP' => 'HTTP', - ], - 'example' => 'HTTP', - ], - 'CallbackQueueName' => [ - 'description' => 'The name of the Simple Message Queue (SMQ) queue to which callback messages are sent.'."\n", - 'type' => 'string', - 'example' => 'ice-callback-queue', - ], - 'CallbackURL' => [ - 'description' => 'The callback URL to which event notifications are sent.'."\n", - 'type' => 'string', - 'example' => 'http://xxx.yyy/callback', - ], - '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', - ], - 'AuthSwitch' => [ - 'description' => 'Specifies whether callback authentication is enabled. This parameter is returned only for **HTTP** callbacks. Valid values:'."\n" - ."\n" - .'* **on**'."\n" - .'* **off**'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'on', - ], - 'AuthKey' => [ - 'description' => 'The authentication key. This parameter is returned only for HTTP callbacks.'."\n", - 'type' => 'string', - 'example' => 'TestKey001', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:StartRtcRobotInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n ice-callback-queue\\n ProduceMediaComplete\\n","errorExample":""}]', - 'title' => 'GetEventCallback', + 'translator' => 'machine', ], 'StartWorkflow' => [ - 'summary' => 'Submits a workflow task. You can submit a workflow task to implement automated media processing based on a workflow template.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => [], @@ -57385,646 +44036,312 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - '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.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '******f0e54971ecbffd472190******', - ], + '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' => [ - 'title' => '模板名称', - 'description' => 'The workflow input. Only media assets are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "Media",'."\n" - .' "Media": "******30706071edbfe290b488******"'."\n" - .'}', - ], + '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', - 'required' => false, - 'example' => '', - ], + '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' => [ - 'type' => 'boolean', - ], + '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' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******42-E8E1-4FBB-8E52-F4225C******', - ], - 'TaskId' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'example' => '******22dad741d086a50325f9******', - ], + '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' => 'StartWorkflow', - 'description' => '* Only media assets from Intelligent Media Services (IMS) or ApsaraVideo VOD can be used as the input of a workflow.'."\n" - .'* When you submit a workflow task, you must specify a workflow template. You can create a workflow template in the [IMS console](https://ims.console.aliyun.com/settings/workflow/list) or use a preset workflow template.'."\n", - ], - '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.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeCode' => '236519', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******4215e042b3966ca5441e******', - ], + '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 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data structure returned in a successful response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******0C-7870-15FE-B96F-8880BB******', - ], - 'WorkflowTask' => [ - 'description' => 'The information about the workflow task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'example' => '******4215e042b3966ca5441e******', - ], - 'Status' => [ - 'description' => 'The task state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Init: The task is being initialized.'."\n" - .'* Failed: The task failed.'."\n" - .'* Canceled: The task is canceled.'."\n" - .'* Processing: The task is in progress.'."\n" - .'* Succeed: The task is successful.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Init' => '', - 'Failed' => '', - 'Canceled' => '', - 'Processing' => '', - 'Succeed' => '', - ], - 'example' => 'Succeed', - ], - 'TaskInput' => [ - 'description' => 'The input of the workflow task.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "Type": "Media",'."\n" - .' "Media": "******30706071edbfe290b488******"'."\n" - .'}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2023-01-04T02:05:17Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2023-01-04T02:06:19Z', - ], - 'Workflow' => [ - 'description' => 'The workflow Information.'."\n", - 'type' => 'object', - 'properties' => [ - 'WorkflowId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'string', - 'example' => '******63dca94c609de02ac0d1******', - ], - 'Name' => [ - 'description' => 'The workflow name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Status' => [ - 'description' => 'The workflow state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Active'."\n" - .'* Inactive'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Active' => '', - 'Inactive' => '', - ], - 'example' => 'Active', - ], - 'Type' => [ - 'description' => 'The workflow type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Customize: custom workflow.'."\n" - .'* System: system workflow.'."\n" - .'* Common: user-created workflow.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Customize' => '', - 'System' => '', - 'Common' => '', - ], - 'example' => 'Common', - ], - 'CreateTime' => [ - 'description' => 'The time when the workflow was created.'."\n", - 'type' => 'string', - 'example' => '2022-11-27T10:02:12Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the workflow was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-11-29T02:06:19Z'."\n", - ], - ], - ], - 'ActivityResults' => [ - 'description' => 'The results for all nodes of the workflow task.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'UserData' => [ - 'description' => 'The user-defined field that was specified when the workflow task was submitted.'."\n", - 'type' => 'string', - 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], + 'example' => '', ], ], ], - '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\\": \\"超分转码工作流\\",\\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"}]', - 'title' => 'GetWorkflowTask', - ], - 'ListWorkflowTasks' => [ - 'summary' => 'Retrieves workflow tasks.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREiceL4UDD6'], ], 'parameters' => [ [ - 'name' => 'WorkflowId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workflow template.[](https://ims.console.aliyun.com/settings/workflow/list)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******b4fb044839815d4f2cd8******', - ], - ], - [ - 'name' => 'WorkflowName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the workflow template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example-workflow-****', - ], - ], - [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-07-12T00:00:00Z', - ], - ], - [ - 'name' => 'EndOfCreateTime', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '标记当前开始读取的位置，置空表示从头开始', - 'description' => 'The end of the time range for filtering tasks by their creation time. Supports querying data from the last 90 days only.'."\n", - 'type' => 'string', - 'required' => false, - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'NextToken', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '**************VRpbWUQARgBIpcBCgkA1bUtaAAAAAAKiQEDhAAAADFTMzg2NTY2NjU2MzM3NjU2NjYyMzkzMTYyMzI2MjYzNjY2**********', - ], + 'schema' => ['description' => 'The ID of the workflow task.', 'type' => 'string', 'required' => false, 'example' => '********-266c-4bb8-b20c-6faa********', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => 'The total number of entries returned. By default, this parameter is not returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C0C02296-113C-5838-8FE9-8F3A32998DDC', - ], - 'NextToken' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => 'A pagination token.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****8EqYpQbZ6Eh7+Zz8DxVYoQ==', - ], - 'TaskList' => [ - 'description' => 'The media workflow tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of a workflow task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'example' => '*****4c93d2f404f8345b16a965*****', - ], - 'TaskInput' => [ - 'description' => 'The input data for the workflow task.'."\n", - 'type' => 'string', - 'example' => '{\\"Type\\":\\"Media\\",\\"Media\\":\\"****8b40884171efb0d9e7f7f458****\\"}', - ], - 'Status' => [ - 'description' => 'The task state.'."\n" - ."\n" - .'**Valid values**:'."\n" - ."\n" - .'* Init: Initializing'."\n" - .'* Failed'."\n" - .'* Canceled'."\n" - .'* Processing'."\n" - .'* Succeed'."\n", - 'type' => 'string', - 'example' => 'Succeed', - ], - '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' => '2024-07-15T09:45:48Z', - ], - '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' => '2024-12-07T10:53:45Z', - ], - 'Workflow' => [ - 'description' => 'The information about the workflow template.'."\n", - 'type' => 'object', - 'properties' => [ - 'WorkflowId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'string', - 'example' => '******2491c84dce913da9fe65******', - ], - 'Name' => [ - 'description' => 'The name of the workflow template.'."\n", - 'type' => 'string', - 'example' => 'example-workflow-***', - ], - 'Status' => [ - 'description' => 'The status of the workflow template.'."\n", - 'type' => 'string', - 'example' => 'Active', - ], - 'Type' => [ - 'description' => 'The type of the workflow template.'."\n", - 'type' => 'string', - 'example' => 'Common', - ], - 'CreateTime' => [ - 'description' => 'The creation time of the workflow template.'."\n", - 'type' => 'string', - 'example' => '2025-03-21T01:48:49Z', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time of the workflow template.'."\n", - 'type' => 'string', - 'example' => '2025-02-23 10:19:37 +0800', - ], - 'MediaType' => [ - 'description' => 'The source of the media file. Valid values:'."\n" - ."\n" - .'* OSS: an OSS object.'."\n" - .'* Media: a media asset.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - ], - ], - 'UserData' => [ - 'description' => 'The custom data that was passed when the task was submitted.'."\n", - 'type' => 'string', - 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', - ], - ], - ], - ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned in this response.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + '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' => '', ], ], ], - '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.'."\n", - ], - 'StartAIWorkflow' => [ - 'summary' => 'Initiates a workflow task for automated media processing based on a workflow template.', - 'methods' => [ - 'post', - 'get', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'WorkflowId', - 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The ID of the workflow template.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '****3f44-f1f6-477e-9364-c5e6c49e****', - ], - ], - [ - 'name' => 'Inputs', - 'in' => 'query', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'A JSON string containing the specific input parameters, such as information about the media assets, standard live streams, or RTC streams.'."\n", - 'type' => 'string', - 'required' => false, - '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" - .'}', - ], - ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => 'A user-defined parameter for passing custom metadata.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .'"url":"https://test.com"'."\n" - .'}', - ], - ], - [ - 'name' => 'DispatchTag', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag for the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'TaskId' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'example' => "\n" - .'********-266c-4bb8-b20c-6faa********', - ], + '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' => '', ], ], ], - '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.'."\n", - '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" - .' "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" - .'* RTC subtitle translation:'."\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" - .'* Media processing:'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "TaskInput":{'."\n" - .' "Type":"OSS",'."\n" - .' "Media": "oss://sashimi-cn-shanghai/test/test.flv"'."\n" - .' }'."\n" - .' }'."\n", - ], - 'StopAIWorkflowTask' => [ - 'summary' => 'Manually stops a workflow task.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'StopChannel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -58033,237 +44350,123 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceL4UDD6', - ], + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '********-266c-4bb8-b20c-6faa********', - ], + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'TaskId' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'example' => '********-266c-4bb8-b20c-6faa********', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', '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.'."\n", - ], - 'GetAIWorkflowTask' => [ - 'summary' => 'Retrieves the details of a workflow task.', - 'methods' => [ - 'get', - 'post', + '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'], + ], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceVYUZ7L', - ], + 'abilityTreeCode' => '228874', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '********-266c-4bb8-b20c-6faa********', - ], + 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => '727dc0e296014bb58670940a3da95592', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'WorkflowTask' => [ - 'description' => 'The information about the workflow task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the workflow task.'."\n", - 'type' => 'string', - 'example' => '********-67fd-43aa-9cc1-3e7f********', - ], - 'Status' => [ - 'description' => 'The task state.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* running'."\n" - .'* stopped'."\n" - .'* failed'."\n" - .'* partial-succeeded'."\n" - .'* succeeded'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'running' => '', - 'stopped' => '', - 'failed' => '', - 'partial-succeeded' => '', - 'succeeded' => '', - ], - 'example' => 'succeeded', - ], - 'Inputs' => [ - 'description' => 'The input parameters of the workflow task.'."\n", - 'type' => 'string', - 'example' => '{\\"source_language_id\\":\\"en\\",\\"live_id\\":123,\\"live_url\\":{\\"url\\":\\"rtmp://test.com.cn/video/638d9088fe4f15ce\\"}}', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2025-07-28T02:17:26Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2025-08-19T02:28:22Z', - ], - 'Workflow' => [ - 'description' => 'The workflow template information.'."\n", - 'type' => 'object', - 'properties' => [ - 'WorkflowId' => [ - 'description' => 'The ID of the workflow template.'."\n", - 'type' => 'string', - 'example' => '****3f44-f1f6-477e-9364-c5e6c49e****', - ], - 'Name' => [ - 'description' => 'The name of the workflow template.'."\n", - 'type' => 'string', - 'example' => 'RealtimeTranslation', - ], - 'Status' => [ - 'description' => 'Workflow template status. Valid values:'."\n" - ."\n" - .'* Draft'."\n" - .'* Published'."\n" - .'* Editing'."\n", - 'type' => 'string', - 'example' => 'Draft', - ], - 'Type' => [ - 'description' => 'The scenario type of the template.'."\n", - 'type' => 'string', - 'example' => 'Live', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2025-08-20T01:35:04Z', - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2025-08-20T01:35:04Z', - ], - 'Version' => [ - 'description' => 'The template version.'."\n", - 'type' => 'string', - 'example' => '****ec0a-e3b9-40b1-abf2-6549d00e****', - ], - 'Graph' => [ - 'description' => 'The workflow\'s topological structure.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .'"nodes":[...],'."\n" - .'"edges":[...]'."\n" - .'}', - ], - ], - ], - 'NodeResults' => [ - 'description' => 'The results of the workflow nodes. The structure of this JSON varies based on the workflow\'s configuration.'."\n", - 'type' => 'string', - 'example' => '{...}', - ], - 'UserData' => [ - 'description' => 'The user-defined data.'."\n", - 'type' => 'string', - 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', - ], - 'Outputs' => [ - 'description' => 'The node output.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .'"result":"test"'."\n" - .'}', - ], - 'Version' => [ - 'description' => 'The version of the workflow template that was executed.'."\n", - 'type' => 'string', - 'example' => '****ec0a-e3b9-40b1-abf2-6549d00e****', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AC84E5DD-AB56-56C0-A992-07ECB82008CA'], ], + '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', - ], - 'CreateMediaLiveInputSecurityGroup' => [ - 'summary' => 'Creates a security group in MediaLive.', - 'methods' => [ - 'post', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -58272,84 +44475,69 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'abilityTreeNodes' => ['FEATUREiceA3ZL64'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '安全组名称', - 'description' => 'The name of the security group. Letters, digits, hyphens (-), and underscores (\\_) are supported. The maximum length is 64 characters.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysg', - ], + 'name' => 'YikeUserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID of the sub-account.', 'type' => 'string', 'required' => true, 'example' => 'id', 'title' => ''], ], [ - 'name' => 'WhitelistRules', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '安全组规则列表', - 'description' => 'The security group rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IPv4 addresses that are allowed to push content to MediaLive. Specify IP addresses as CIDR blocks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.1.1.0/24', - ], - 'required' => true, - 'example' => '["10.1.1.0/24", "11.11.11.11/0"]', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], + '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' => '', ], ], ], - '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.', - ], - 'UpdateMediaLiveInputSecurityGroup' => [ - 'summary' => 'Modifies a security group created in MediaLive.', - 'methods' => [ - 'post', + 'title' => 'SubYikeUserCredit', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + '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' => [], @@ -58358,359 +44546,470 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'abilityTreeCode' => '236524', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'SecurityGroupId', - 'in' => 'formData', + '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' => [ - 'title' => '安全组ID', - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', + '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, - 'example' => 'SEGK5KA6KYKAWQQH ', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Name', - 'in' => 'formData', + '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' => [ - 'title' => '安全组名称', - 'description' => 'The name of the security group. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysg', + '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' => 'WhitelistRules', - 'in' => 'formData', + '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' => [ - 'title' => '安全组规则列表', - 'description' => 'The security group rules.'."\n", + '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' => 'The IPv4 addresses that are allowed to push content to MediaLive. Specify IP addresses as CIDR blocks.'."\n", - 'type' => 'string', + '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, - 'example' => '10.1.1.0/24', + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + '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 \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'UpdateMediaLiveInputSecurityGroup', - 'description' => '* You can modify a security group only when it is not associated with a MediaLive input.'."\n" + '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" - .'## QPS limit'."\n" + .'#### ParameterDescription'."\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.', - ], - 'GetMediaLiveInputSecurityGroup' => [ - 'summary' => 'Queries the details of a security group in MediaLive.', - 'methods' => [ - 'post', + .'| 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' => [], ], - 'schemes' => [ - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'SecurityGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '安全组ID', - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], - 'SecurityGroup' => [ - 'description' => 'The security group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'Name' => [ - 'description' => 'The name of the security group.'."\n", - 'type' => 'string', - 'example' => 'mysg', - ], - 'WhitelistRules' => [ - 'description' => 'The security group rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The security group rule.'."\n", - 'type' => 'string', - 'example' => '10.1.1.0/24', - ], - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:31:56Z', - ], - 'InputIds' => [ - 'description' => 'The IDs of the inputs associated with the security group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input ID.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - ], - ], - ], + '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' => '', ], ], ], - '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" + '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" - .'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.', - ], - 'ListMediaLiveInputSecurityGroups' => [ - 'summary' => 'Queries the security groups in MediaLive.', - 'methods' => [ - 'post', + .'```'."\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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => [], '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + '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' => '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + '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' => '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + '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' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword of the query. You can perform a fuzzy search on security group ID or name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '123e4567-e89b-12d3-a456-426614174000', - ], - 'SecurityGroups' => [ - 'title' => '安全组配置列表', - 'description' => 'The security groups.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '安全组配置', - 'description' => 'The information about a security group.'."\n", - 'type' => 'object', - 'properties' => [ - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'Name' => [ - 'title' => '安全组名称', - 'description' => 'The security group name.'."\n", - 'type' => 'string', - 'example' => 'mysg', - ], - 'WhitelistRules' => [ - 'title' => '安全组规则列表', - 'description' => 'The security group rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IPv4 addresses that are allowed to push content to MediaLive.'."\n", - 'type' => 'string', - 'example' => '10.1.1.0/24"', - ], - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - 'InputIds' => [ - 'description' => 'The IDs of the inputs associated with the security group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input ID associated with the security group.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - ], - ], - ], - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'MaxResults' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 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' => '', ], ], ], - '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" + '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" - .'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.', - ], - 'DeleteMediaLiveInputSecurityGroup' => [ - 'summary' => 'Deletes a security group in MediaLive.', - 'methods' => [ - 'post', + .'> 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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -58718,545 +45017,389 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SecurityGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '安全组ID', - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The data returned by the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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\\": \\"******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.', - ], - 'CreateMediaLiveInput' => [ - 'summary' => 'Creates a MediaLive input.', - 'methods' => [ - 'post', + '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' => [], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '输入名称', - 'description' => 'The name of the input. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myinput', - ], + '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' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '输入类型', - 'description' => 'The input type. Valid values: RTMP_PUSH, RTMP_PULL, SRT_PUSH, SRT_PULL, and MEDIA_CONNECT.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RTMP_PUSH', - ], + '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' => 'SecurityGroupIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '绑定的安全组ID列表', - 'description' => 'The IDs of the security groups to be associated with the input. This parameter is required for PUSH inputs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'G6G4X5T4SZYPSTT5', - ], - 'required' => false, - 'example' => '["G6G4X5T4SZYPSTT5"]', - ], + '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' => 'InputSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '输入设置', - 'description' => 'The input settings. An input can have up to two sources: primary and backup sources.'."\n", - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mystream', - ], - 'SourceUrl' => [ - 'description' => 'The source URL from which the stream is pulled. This parameter is required for PULL inputs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp://domain/app/stream', - ], - 'FlowId' => [ - 'description' => 'The ID of the flow from MediaConnect. This parameter is required when Type is set to MEDIA_CONNECT.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******81-9693-40dc-bbab-db5e49******', - ], - 'FlowOutputName' => [ - 'description' => 'The output name of the MediaConnect flow. This parameter is required when Type is set to MEDIA_CONNECT.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'myFlowOutputName', - ], - 'SrtMaxBitrate' => [ - 'title' => 'SRT输入的最大码率', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SrtLatency' => [ - 'title' => 'SRT输入的延迟', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SrtPassphrase' => [ - 'title' => 'SRT输入的连接密码', - 'type' => 'string', - ], - 'SrtPbKeyLen' => [ - 'title' => 'SRT输入的密钥长度', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'InputId' => [ - 'title' => '输入ID', - 'description' => 'The ID of the input.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], + '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 \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\"\\n}","type":"json"}]', - 'title' => 'CreateMediaLiveInput', - 'description' => '## QPS limit'."\n" + '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" - .'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.', - ], - 'UpdateMediaLiveInput' => [ - 'summary' => 'Modifies an input of MediaLive.', - 'methods' => [ - 'post', + .'- 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'], + ], ], - 'schemes' => [ - 'https', + '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' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '131231', + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ - 'name' => 'InputId', + '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' => [ - 'title' => '输入ID', - 'description' => 'The ID of the input.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], + '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' => 'Name', + 'name' => 'EditingConfig', 'in' => 'formData', - 'schema' => [ - 'title' => '输入实例名称', - 'description' => 'The name of the input. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myinput', - ], + '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' => 'SecurityGroupIds', + 'name' => 'OutputConfig', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '绑定的安全组ID列表', - 'description' => 'The IDs of the security groups to be associated with the input. This parameter is required for PUSH inputs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the security group to be associated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'G6G4X5T4SZYPSTT5', - ], - 'required' => false, - 'example' => '["G6G4X5T4SZYPSTT5"]', - ], + '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' => 'InputSettings', + 'name' => 'UserData', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '输入配置', - 'description' => 'The input settings. An input can have up to two sources: primary and backup sources.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowId' => [ - 'description' => 'The ID of the flow from MediaConnect. This parameter is required when Type is set to MEDIA_CONNECT.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******81-9693-40dc-bbab-db5e49******', - ], - 'SourceUrl' => [ - 'description' => 'The source URL from which the stream is pulled. This parameter is required for PULL inputs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp://domain/app/stream', - ], - 'StreamName' => [ - 'description' => 'The name of the pushed stream. This parameter is required for PUSH inputs. It can be up to 255 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mystream', - ], - 'SrtPassphrase' => [ - 'title' => 'SRT输入的连接密码', - 'type' => 'string', - ], - 'SrtMaxBitrate' => [ - 'title' => 'SRT输入的最大码率', - 'type' => 'integer', - 'format' => 'int32', - ], - 'FlowOutputName' => [ - 'description' => 'The output name of the MediaConnect flow. This parameter is required when Type is set to MEDIA_CONNECT.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'myFlowOutputName', - ], - 'SrtLatency' => [ - 'title' => 'SRT输入的延迟', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SrtPbKeyLen' => [ - 'title' => 'SRT输入的密钥长度', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', - 'title' => 'UpdateMediaLiveInput', - 'description' => '* You can modify an input only when it is not associated with a MediaLive channel.'."\n" + '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" - .'## QPS limit'."\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" - .'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.', - ], - 'GetMediaLiveInput' => [ - 'summary' => 'Queries the details of a MediaLive input.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + .''."\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'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitBatchMediaProducingJob'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'InputId', - 'in' => 'formData', - 'schema' => [ - 'title' => '输入ID', - 'description' => 'The ID of the input.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Input' => [ - 'title' => '输入配置', - 'description' => 'The input information.'."\n", - 'type' => 'object', - 'properties' => [ - 'InputId' => [ - 'title' => '输入ID', - 'description' => 'The ID of the input.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'Name' => [ - 'title' => '输入实例名称', - 'description' => 'The name of the input.'."\n", - 'type' => 'string', - 'example' => 'myinput', - ], - 'Type' => [ - 'title' => '输入类型', - 'description' => 'The input type.'."\n", - 'type' => 'string', - 'example' => 'RTMP_PUSH', - ], - 'InputInfos' => [ - 'title' => '输入信息列表', - 'description' => 'The input configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DestHost' => [ - 'title' => 'PUSH类型推流地址', - 'description' => 'The endpoint that the stream is pushed to. This parameter is returned for PUSH inputs.'."\n", - 'type' => 'string', - 'example' => 'rtmp://domain/app/stream', - ], - 'StreamName' => [ - 'title' => '流名称', - 'description' => 'The name of the pushed stream. This parameter is returned for PUSH inputs.'."\n", - 'type' => 'string', - 'example' => 'mystream', - ], - 'SourceUrl' => [ - 'title' => 'PULL类型拉流地址', - 'description' => 'The source URL where the stream is pulled from. This parameter is returned for PULL inputs.'."\n", - 'type' => 'string', - 'example' => 'rtmp://domain/app/stream', - ], - 'MonitorUrl' => [ - 'description' => 'The URL for input monitoring.'."\n", - 'type' => 'string', - 'example' => 'rtmp://domain/app/stream_for_monitor', - ], - 'FlowId' => [ - 'description' => 'The ID of the flow from MediaConnect.'."\n", - 'type' => 'string', - 'example' => '******81-9693-40dc-bbab-db5e49******', - ], - 'FlowOutputName' => [ - 'description' => 'The output name of the MediaConnect flow.'."\n", - 'type' => 'string', - 'example' => 'myFlowOutputName', - ], - 'SrtMaxBitrate' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'SrtLatency' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'SrtPassphrase' => [ - 'type' => 'string', - ], - 'SrtPbKeyLen' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'description' => '', - ], - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - 'ChannelIds' => [ - 'description' => 'The IDs of the channels associated with the input.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - ], - 'SecurityGroupIds' => [ - 'title' => '关联的安全组ID', - 'description' => 'The IDs of the security groups associated with the input.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - ], - ], - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitBatchMediaProducingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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' => 'GetMediaLiveInput', - '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.', + 'translator' => 'machine', ], - 'ListMediaLiveInputs' => [ - 'summary' => 'Queries MediaLive inputs.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SubmitCopyrightExtractJob' => [ + 'summary' => 'Submits a copyright watermark extraction job.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -59265,243 +45408,117 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'SortOrder', - 'in' => 'formData', + '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' => '', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', + 'example' => '', ], ], [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword of the query. You can perform a fuzzy search on input ID or name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + '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' => 'Types', - 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The type of inputs you want to query. You can separate multiple input types with commas (,) in a JSON array.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["RTMP_PUSH","SRT_PULL"]', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Inputs' => [ - 'title' => '输入配置列表', - 'description' => 'The inputs.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '输入配置', - 'description' => 'The input configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '输入类型', - 'description' => 'The input type.'."\n", - 'type' => 'string', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - 'InputId' => [ - 'title' => '输入ID', - 'description' => 'The ID of the input.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'InputInfos' => [ - 'title' => '输入信息列表', - 'description' => 'The input configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowId' => [ - 'description' => 'The ID of the flow from MediaConnect.'."\n", - 'type' => 'string', - 'example' => '******81-9693-40dc-bbab-db5e49******', - ], - 'SourceUrl' => [ - 'title' => 'PULL类型拉流地址', - 'description' => 'The source URL where the stream is pulled from. This parameter is returned for PULL inputs.'."\n", - 'type' => 'string', - 'example' => 'rtmp://domain/app/stream', - ], - 'StreamName' => [ - 'title' => '流名称', - 'description' => 'The name of the pushed stream. This parameter is returned for PUSH inputs.'."\n", - 'type' => 'string', - 'example' => 'mystream', - ], - 'MonitorUrl' => [ - 'description' => 'The URL for input monitoring.'."\n", - 'type' => 'string', - 'example' => 'rtmp://domain/app/stream_for_monitor', - ], - 'SrtPassphrase' => [ - 'type' => 'string', - ], - 'SrtMaxBitrate' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'FlowOutputName' => [ - 'description' => 'The output name of the MediaConnect flow.'."\n", - 'type' => 'string', - 'example' => 'myFlowOutputName', - ], - 'SrtLatency' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DestHost' => [ - 'title' => 'PUSH类型推流地址', - 'description' => 'The endpoint that the stream is pushed to. This parameter is returned for PUSH inputs.'."\n", - 'type' => 'string', - 'example' => 'rtmp://domain/app/stream', - ], - 'SrtPbKeyLen' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'description' => '', - ], - ], - 'SecurityGroupIds' => [ - 'title' => '关联的安全组ID', - 'description' => 'The IDs of the security groups associated with the input.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - ], - 'ChannelIds' => [ - 'description' => 'The IDs of the channels associated with the input.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - ], - 'Name' => [ - 'title' => '输入实例名称', - 'description' => 'The name of the input.'."\n", - 'type' => 'string', - 'example' => 'myinput', - ], - ], + 'Data' => [ + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c63****4d80648792021eff90', 'title' => ''], ], + 'example' => '', ], - 'MaxResults' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + '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 \\"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' => 'ListMediaLiveInputs', - 'description' => '## QPS limit'."\n" + '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 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.', - ], - 'DeleteMediaLiveInput' => [ - 'summary' => 'Deletes a MediaLive input.', - 'methods' => [ - 'post', + .'- 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' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'machine', + ], + 'SubmitCopyrightJob' => [ + 'summary' => 'Submits a video copyright watermark job.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -59510,658 +45527,581 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'InputId', - 'in' => 'formData', + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '输入ID', - 'description' => 'The ID of the input.'."\n", - 'type' => 'string', + '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' => 'SEGK5KA6KYKAWQQH', + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', + '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 \\"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" + '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" - .'## QPS limit'."\n" + .'- You can submit a watermark job for only one video per API call.'."\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.', - ], - 'CreateMediaLiveChannel' => [ - 'summary' => 'Creates a MediaLive channel.', - 'methods' => [ - 'post', + .'- 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'], + ], ], - 'schemes' => [ - 'https', + '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' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '安全组名称', - 'description' => 'The name of the channel. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mych', - ], + 'name' => 'VoiceId', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier for the voice.', 'type' => 'string', 'required' => true, 'maxLength' => 32, 'minLength' => 0, 'example' => 'xiaozhuan', 'title' => ''], ], [ - 'name' => 'InputAttachments', - 'in' => 'formData', - 'style' => 'json', + '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 associated inputs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InputId' => [ - 'title' => '绑定的输入ID', - 'description' => 'The ID of the associated input.'."\n", - 'type' => 'string', - 'required' => true, - '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" - .'* Digits (0-9)'."\n" - .'* Underscore (\\_)'."\n" - .'* Hyphen (-)'."\n" - .'* Space (a space cannot be at the beginning or end)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'English', - ], - 'AudioSelectors' => [ - 'title' => '音频选择器列表', - 'description' => 'The audio selectors.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myselector', - ], - 'AudioLanguageSelection' => [ - 'title' => '语言选择器', - 'description' => 'The audio language selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'LanguageCode' => [ - 'title' => '语言代码', - 'description' => 'Enter a three-letter ISO 639-2 language code from within an audio source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'eng', - ], - ], - 'required' => false, - ], - 'AudioPidSelection' => [ - 'title' => 'PID选择器', - 'description' => 'The audio PID selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Pid' => [ - 'title' => 'PID', - 'description' => 'Enter a specific PID from within a source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'AudioTrackSelection' => [ - 'title' => '音轨选择器', - 'description' => 'The audio track selection.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TrackId' => [ - 'title' => '音轨ID', - 'description' => 'Specify one or more audio tracks from within a source using Track ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, + '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' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => true, + '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' => [ [ - 'name' => 'OutputGroups', - 'in' => 'formData', + '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' => [ - 'title' => '输出组详细配置', - 'description' => 'The output groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '输出组名称', - 'description' => 'The name of the output group. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'group1', - ], - 'Type' => [ - 'title' => '输出组类型', - 'description' => 'The output group type. Only MediaPackage is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MediaPackage', - ], - 'Outputs' => [ - 'title' => '输出列表设置', - 'description' => 'The outputs in the output group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '输出名称', - 'description' => 'The name of the output. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'output1', - ], - 'MediaType' => [ - 'title' => '输出的媒体类型。0:音视频，1:纯音频，2:纯视频。', - 'description' => 'The media type of the output. Valid values:'."\n" - ."\n" - .'* 0: Audio and Video.'."\n" - .'* 1: Audio. If you set the value to 1, you cannot reference VideoSettings.'."\n" - .'* 2: Video. If you set the value to 2, you cannot reference AudioSettings.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'MediaPackageOutputSetting' => [ - 'title' => '输出组类型为MediaPackage时的设置', - 'description' => 'The settings of the output delivered to MediaPackage.'."\n", - 'type' => 'object', - 'properties' => [ - 'NameModifier' => [ - 'title' => 'manifest后缀', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '480p', - ], - 'AudioGroupId' => [ - 'title' => 'manifest音频组id设置', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'audiogroup', - ], - ], - 'required' => false, - ], - 'VideoSettingName' => [ - 'title' => '引用的视频设置名称', - 'description' => 'The name of the referenced VideoSettings.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'myVideo1', - ], - 'AudioSettingNames' => [ - 'title' => '引用的音频设置名称', - 'description' => 'The referenced AudioSettings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the referenced AudioSettings.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'myAudio1', - 'title' => '', - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - ], - 'MediaPackageGroupSetting' => [ - 'title' => 'MediaPackage输出组设置', - 'description' => 'The MediaPackage destination.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'title' => 'MediaPackage的GroupName', - 'description' => 'GroupName in MediaPackage.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myPackageGroup', - ], - 'ChannelName' => [ - 'title' => 'MediaPackage的ChannelName', - 'description' => 'ChannelName in MediaPackage.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myPackageChannel', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', + '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' => 'AudioSettings', - 'in' => 'formData', - 'style' => 'json', + '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' => [ - 'title' => '音频设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频设置名称', - 'description' => 'The name of the audio settings. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'audio1', - ], - 'AudioSelectorName' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a1', - ], - 'LanguageCode' => [ - 'title' => '语言代码', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eng', - ], - 'LanguageName' => [ - 'title' => 'audio类型m3u8切片的名称', - '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" - .'* Digits (0-9)'."\n" - .'* Underscore (\\_)'."\n" - .'* Hyphen (-)'."\n" - .'* Space (a space cannot be at the beginning or end)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'English', - ], - 'AudioCodec' => [ - 'title' => '音频编码类型', - 'description' => 'The audio codec. If it is not specified, the source specification is used. Valid values: aac and libfdk_aac.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'libfdk_aac', - ], - 'AudioCodecSetting' => [ - 'title' => '音频编码设置', - 'description' => 'The audio encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '音频编码级别', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAC-LOW', - ], - 'Bitrate' => [ - 'title' => '音频比特率', - 'description' => 'The audio bitrate. Unit: bit/s. Valid values: 8000 to 1000000. The value must be divisible by 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200000', - ], - 'SampleRate' => [ - 'title' => '音频采样率', - 'description' => 'The audio sample rate. Unit: Hz. Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '44100', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', + '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' => ''], ], - 'required' => false, + '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' => [ [ - 'name' => 'VideoSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '视频设置', - 'description' => 'The video settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视频设置名称', - 'description' => 'The name of the video settings. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'video1', - ], - 'Width' => [ - 'title' => '分辨率宽', - '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" - .'* For Narrowband HD™ transcoding, the larger dimension cannot exceed 1920 px, and the smaller one cannot exceed 1080 px.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1280', - ], - 'Height' => [ - 'title' => '分辨率高', - '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" - .'* For Narrowband HD™ transcoding, the larger dimension cannot exceed 1920 px, and the smaller one cannot exceed 1080 px.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '720', - ], - 'VideoCodec' => [ - 'title' => '视频编码类型', - 'description' => 'The video codec. Valid values: H264 and H265.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'H264', - ], - 'VideoCodecSetting' => [ - 'title' => '视频编码设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rate' => [ - 'title' => '视频编码速率设置', - 'description' => 'The video encoding rate. If it is not specified, the source specification is used.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bitrate' => [ - 'title' => '视频比特率', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2500000', - ], - 'RateControlMode' => [ - 'title' => '视频编码码控规则', - 'description' => 'The bitrate control mode. Valid values: CBR, ABR, and VBR.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ABR', - ], - 'MaxBitrate' => [ - 'title' => '视频编码最大比特率', - 'description' => 'The maximum bitrate. Unit: bit/s. Valid values: 100000 to 6000000. The value must be divisible by 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6000000', - ], - 'BufferSize' => [ - 'title' => '视频编码缓冲区大小', - 'description' => 'The video buffer size. Unit: bit/s. Valid values: 100000 to 6000000. The value must be divisible by 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6000000', - ], - ], - 'required' => false, - ], - 'Framerate' => [ - 'title' => '视频帧率设置', - 'description' => 'The frame rate. If it is not specified, the source specification is used.'."\n", - 'type' => 'object', - 'properties' => [ - 'FramerateControl' => [ - 'title' => '视频帧率设置模式', - 'description' => 'The frame rate mode. Valid values: SPECIFIED (fixed frame rate) and FROM_SOURCE (use source specification).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SPECIFIED', - ], - 'FramerateNumerator' => [ - 'title' => '视频帧率分子', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '25', - ], - 'FramerateDenominator' => [ - 'title' => '视频帧率分母', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'Gop' => [ - 'title' => '视频GOP设置', - 'description' => 'The GOP setting. If it is not specified, the source specification is used.'."\n", - 'type' => 'object', - 'properties' => [ - 'GopSizeUnits' => [ - 'title' => '视频GOP长度单位', - 'description' => 'The GOP size unit. Valid values: FRAMES and SECONDS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FRAMES', - ], - 'GopSize' => [ - 'title' => '视频GOP大小', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - ], - 'BframesNum' => [ - 'title' => 'B帧数', - 'description' => 'The number of B frames. Valid values: 1 to 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, - ], - 'CodecDetail' => [ - 'title' => '视频编码详情设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '视频编码配置', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MAIN', - ], - 'Level' => [ - 'title' => '视频编码级别', - 'description' => 'The video encoding level. It is not supported yet.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'H264_LEVEL_AUTO', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'VideoCodecType' => [ - 'title' => '视频转码方式（普通转码、窄带高清转码等）', - 'description' => 'The video transcoding method. Valid values:'."\n" - ."\n" - .'* NORMAL: regular transcoding'."\n" - .'* NBHD: Narrowband HD™ transcoding'."\n" - ."\n" - .'If not specified, regular transcoding is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - ], - ], - 'required' => false, - 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitDNAJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'ChannelId' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], + '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' => '', ], ], ], - '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" + '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" - .'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.', - ], - 'UpdateMediaLiveChannel' => [ - 'summary' => 'Modifies a MediaLive channel.', - 'methods' => [ - 'post', + .'- 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'], + ], ], - 'schemes' => [ - 'https', + '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' => [], @@ -60169,1744 +46109,1084 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ChannelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The job name.', 'type' => 'string', 'required' => false, 'example' => 'SampleJob', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'formData', + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '安全组名称', - 'description' => 'The name of the channel. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', + '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, - 'example' => 'mych', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InputAttachments', - 'in' => 'formData', + 'name' => 'Output', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '输入绑定设置', - 'description' => 'The inputs associated with the channel.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InputId' => [ - 'title' => '绑定的输入ID', - 'description' => 'The ID of the associated input.'."\n", - 'type' => 'string', - 'required' => true, - '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" - .'* Digits (0-9)'."\n" - .'* Underscore (\\_)'."\n" - .'* Hyphen (-)'."\n" - .'* Space (a space cannot be at the beginning or end)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'English', - ], - 'AudioSelectors' => [ - 'title' => '音频选择器列表', - 'description' => 'The audio selectors.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myselector', - ], - 'AudioLanguageSelection' => [ - 'title' => '语言选择器', - 'description' => 'The audio language selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'LanguageCode' => [ - 'title' => '语言代码', - 'description' => 'Enter a three-letter ISO 639-2 language code from within an audio source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'eng', - ], - ], - 'required' => false, - ], - 'AudioPidSelection' => [ - 'title' => 'PID选择器', - 'description' => 'The audio PID selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Pid' => [ - 'title' => 'PID', - 'description' => 'Enter a specific PID from within a source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'AudioTrackSelection' => [ - 'title' => '音轨选择器', - 'description' => 'The audio track selection.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TrackId' => [ - 'title' => '音轨ID', - 'description' => 'Specify one or more audio tracks from within a source using Track ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], + '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' => '', ], - 'required' => false, - 'description' => '', + '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' => 'OutputGroups', - 'in' => 'formData', + 'name' => 'TemplateConfig', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '输出组详细配置', - 'description' => 'The output groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '输出组名称', - 'description' => 'The name of the output group. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'group1', - ], - 'Type' => [ - 'title' => '输出组类型', - 'description' => 'The output group type. Only MediaPackage is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MediaPackage', - ], - 'Outputs' => [ - 'title' => '输出列表设置', - 'description' => 'The outputs in the output group.'."\n", - 'type' => 'array', - 'items' => [ + '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' => [ - 'Name' => [ - 'title' => '输出名称', - 'description' => 'The name of the output. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'output1', - ], - 'MediaType' => [ - 'title' => '输出的媒体类型。0:音视频，1:纯音频，2:纯视频。', - 'description' => 'The media type of the output. Valid values:'."\n" - ."\n" - .'* 0: Audio and Video'."\n" - .'* 1: Audio If you set the value to 1, you cannot reference VideoSettings.'."\n" - .'* 2: Video. If you set the value to 2, you cannot reference AudioSettings.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'MediaPackageOutputSetting' => [ - 'title' => '输出组类型为MediaPackage时的设置', - 'description' => 'The settings of the output delivered to MediaPackage.'."\n", - 'type' => 'object', - 'properties' => [ - 'NameModifier' => [ - 'title' => 'manifest后缀', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '480p', - ], - 'AudioGroupId' => [ - 'title' => 'manifest音频组id设置', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'audiogroup', - ], - ], - 'required' => false, - ], - 'VideoSettingName' => [ - 'title' => '引用的视频设置名称', - 'description' => 'The name of the referenced VideoSettings.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'myVideo1', - ], - 'AudioSettingNames' => [ - 'title' => '引用的音频设置名称', - 'description' => 'The referenced AudioSettings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the referenced AudioSettings.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'myAudio1', - ], - 'required' => false, - ], + '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, - 'description' => '', - ], - 'required' => true, - ], - 'MediaPackageGroupSetting' => [ - 'title' => 'MediaPackage输出组设置', - 'description' => 'The MediaPackage destination.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'title' => 'MediaPackage的GroupName', - 'description' => 'GroupName in MediaPackage.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myPackageGroup', - ], - 'ChannelName' => [ - 'title' => 'MediaPackage的ChannelName', - 'description' => 'ChannelName in MediaPackage.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myPackageChannel', - ], + 'example' => '', ], - 'required' => false, ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AudioSettings', - 'in' => 'formData', + 'name' => 'ScheduleConfig', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '音频设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频设置名称', - 'description' => 'The name of the audio settings. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'audio1', - ], - 'AudioSelectorName' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a1', - ], - 'LanguageCode' => [ - 'title' => '语言代码', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eng', - ], - 'LanguageName' => [ - 'title' => 'audio类型m3u8切片的名称', - '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" - .'* Digits (0-9)'."\n" - .'* Underscore (\\_)'."\n" - .'* Hyphen (-)'."\n" - .'* Space (a space cannot be at the beginning or end)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'English', - ], - 'AudioCodec' => [ - 'title' => '音频编码类型', - 'description' => 'The audio codec. If it is not specified, the source specification is used. Valid values: aac and libfdk_aac.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'libfdk_aac', - ], - 'AudioCodecSetting' => [ - 'title' => '音频编码设置', - 'description' => 'The audio encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '音频编码级别', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAC-LOW', - ], - 'Bitrate' => [ - 'title' => '音频比特率', - 'description' => 'The audio bitrate. Unit: bit/s. Valid values: 8000 to 1000000. The value must be divisible by 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200000', - ], - 'SampleRate' => [ - 'title' => '音频采样率', - 'description' => 'The audio sample rate. Unit: Hz. Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '44100', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', + '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' => 'VideoSettings', + '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', - 'style' => 'json', + '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 video settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视频设置名称', - 'description' => 'The name of the video settings. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'video1', - ], - 'Width' => [ - 'title' => '分辨率宽', - '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" - .'* For Narrowband HD™ transcoding, the larger dimension cannot exceed 1920 px, and the smaller one cannot exceed 1080 px.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1280', - ], - 'Height' => [ - 'title' => '分辨率高', - '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" - .'* For Narrowband HD™ transcoding, the larger dimension cannot exceed 1920 px, and the smaller one cannot exceed 1080 px.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '720', - ], - 'VideoCodec' => [ - 'title' => '视频编码类型', - 'description' => 'The video codec. Valid values: H264 and H265.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'H264', - ], - 'VideoCodecSetting' => [ - 'title' => '视频编码设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rate' => [ - 'title' => '视频编码速率设置', - 'description' => 'The video encoding rate. If it is not specified, the source specification is used.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bitrate' => [ - 'title' => '视频比特率', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2500000', - ], - 'RateControlMode' => [ - 'title' => '视频编码码控规则', - 'description' => 'The bitrate control mode. Valid values: CBR, ABR, and VBR.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ABR', - ], - 'MaxBitrate' => [ - 'title' => '视频编码最大比特率', - 'description' => 'The maximum bitrate. Unit: bit/s. Valid values: 100000 to 6000000. The value must be divisible by 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6000000', - ], - 'BufferSize' => [ - 'title' => '视频编码缓冲区大小', - 'description' => 'The video buffer size. Unit: bit/s. Valid values: 100000 to 6000000. The value must be divisible by 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6000000', - ], - ], - 'required' => false, - ], - 'Framerate' => [ - 'title' => '视频帧率设置', - 'description' => 'The frame rate. If it is not specified, the source specification is used.'."\n", - 'type' => 'object', - 'properties' => [ - 'FramerateControl' => [ - 'title' => '视频帧率设置模式', - 'description' => 'The frame rate mode. Valid values: SPECIFIED (fixed frame rate) and FROM_SOURCE (use source specification).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SPECIFIED', - ], - 'FramerateNumerator' => [ - 'title' => '视频帧率分子', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '25', - ], - 'FramerateDenominator' => [ - 'title' => '视频帧率分母', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'Gop' => [ - 'title' => '视频GOP设置', - 'description' => 'The GOP setting. If it is not specified, the source specification is used.'."\n", - 'type' => 'object', - 'properties' => [ - 'GopSizeUnits' => [ - 'title' => '视频GOP长度单位', - 'description' => 'The GOP size unit. Valid values: FRAMES and SECONDS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FRAMES', - ], - 'GopSize' => [ - 'title' => '视频GOP大小', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - ], - 'BframesNum' => [ - 'title' => 'B帧数', - 'description' => 'The number of B frames. Valid values: 1 to 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, - ], - 'CodecDetail' => [ - 'title' => '视频编码详情设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '视频编码配置', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MAIN', - ], - 'Level' => [ - 'title' => '视频编码级别', - 'description' => 'The video encoding level. It is not supported yet.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'H264_LEVEL_AUTO', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'VideoCodecType' => [ - 'title' => '视频转码方式（普通转码、窄带高清转码等）', - 'description' => 'The video transcoding method. Valid values:'."\n" - ."\n" - .'* NORMAL: regular transcoding'."\n" - .'* NBHD: Narrowband HD™ transcoding'."\n" - ."\n" - .'If not specified, regular transcoding is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - ], + '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:///`'."\n" + ."\n" + .'2. `http(s)://.oss-.aliyuncs.com/`'."\n" + .' In these formats, `` is the name of an OSS bucket in the same region as your project, and `` is the file path.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The output destination. You can specify an OSS file path or a media asset ID.'."\n" + ."\n" + .'The output files vary by algorithm function. For more information, see the supplementary instructions.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the output media. Valid values:'."\n" + ."\n" + .'- `OSS`: An OSS file path.'."\n" + ."\n" + .'- `Media`: A media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Biz' => [ + 'description' => 'The service to which the media asset belongs.', + 'type' => 'string', + 'required' => false, + 'enum' => ['IMS', 'VOD'], + 'example' => 'IMS', + 'title' => '', ], - 'required' => false, - 'description' => '', + 'Media' => ['description' => 'The output destination. If `Type` is `OSS`, specify an OSS URL. If `Type` is `Media`, specify a media asset ID.'."\n" + ."\n" + .'The OSS URL can be in one of the following formats:'."\n" + ."\n" + .'1. `oss:///`'."\n" + ."\n" + .'2. `http(s)://.oss-.aliyuncs.com/`'."\n" + .' In these formats, `` is the name of an OSS bucket in the same region as your project, and `` is the file path.'."\n" + ."\n" + .'Media asset ID:'."\n" + ."\n" + .'- To use an existing media asset, specify its ID.'."\n" + ."\n" + .' - The `Biz` parameter is not required; the service of the source media asset will be used.'."\n" + ."\n" + .'- To create a new media asset, leave this field empty.'."\n" + ."\n" + .' - The `Biz` parameter determines whether the asset is created in IMS or VOD. If `Biz` is not specified, the system uses the service of the source asset. If the source is not a media asset, the output defaults to IMS.'."\n" + ."\n" + .'> The OSS file path supports placeholders. For example: `oss://example-****/iproduction/{source}-{timestamp}-{sequenceId}.png`. The following placeholders are supported:'."\n" + .'>'."\n" + .'> - `{source}`: The name of the input file.'."\n" + .'>'."\n" + .'> - `{timestamp}`: The Unix timestamp.'."\n" + .'>'."\n" + .'> - `{sequenceId}`: A system-generated sequence ID.'."\n" + .'>'."\n" + .'> - `{resultType}`: The type of output file, which the server determines.'."\n" + .'> Placeholders are optional. However, for algorithms that produce multiple outputs, such as `Cover`, we recommend including a placeholder like `{sequenceId}` to ensure unique file paths and prevent overwriting existing files.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object', 'title' => ''], + 'OutputUrl' => ['description' => 'If `Type` is set to `Media`, you can use this parameter to specify the OSS URL for the output file. The bucket must be registered in either IMS or VOD.', 'type' => 'string', 'required' => false, 'example' => ' '."\n" + .'http(s)://bucket.oss-[RegionId].aliyuncs.com/object', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => false, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], + ], + [ + 'name' => 'JobParams', + 'in' => 'query', + 'schema' => ['description' => 'The algorithm job parameters, specified as a JSON-formatted string. The content of the JSON object varies by algorithm function. For more information, see the supplementary instructions.', 'type' => 'string', 'required' => false, 'example' => '{"Model":"gif"}', 'title' => ''], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configuration for job scheduling.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The ID of the pipeline.', 'type' => 'string', 'required' => false, 'example' => '5246b8d12a62433ab77845074039c3dc', 'title' => ''], + 'Priority' => ['description' => 'The job priority, which can be an integer from 1 to 10. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom user data. The system passes this data through and returns it as-is in the callback or response. The length cannot exceed 256 characters.', 'type' => 'string', 'required' => false, 'example' => '{"test":1}', 'title' => ''], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the algorithm model. If you do not specify this parameter, the system uses the default model for the selected function. We recommend leaving this parameter empty unless you need to use a specific alternative model.'."\n" + ."\n" + .'The following function offers an alternative model:'."\n" + ."\n" + .'- `VideoDetext`'."\n" + ."\n" + .' - Set `ModelId` to `algo-video-detext-new` to use an advanced subtitle removal algorithm. This model provides higher quality results but is slower and more expensive than the default model.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C1849434-FC47-5DC1-92B6-F7EAAFE3851E'], + 'JobId' => ['description' => 'The ID of the job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'UpdateMediaLiveChannel', - 'description' => '* You can modify a MediaLive channel only when it is not running.'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1849434-FC47-5DC1-92B6-F7EAAFE3851E\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => 'Submit an Intelligent Production Job ', + 'description' => 'This is an [asynchronous API](~~3027141~~). When you submit a task, the API returns a task ID and queues the task for asynchronous processing. The final result is delivered via a callback. You can also query the task status by calling [QuerySmartProductionTask](~~441215~~).', + 'requestParamsDescription' => '## Input and output fields'."\n" ."\n" - .'## QPS limit'."\n" + .'### Cover'."\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.', - ], - 'GetMediaLiveChannel' => [ - 'summary' => 'Queries a MediaLive channel.', - 'methods' => [ - 'post', + .'Accepts a video file as input and outputs multiple images (three by default). You must use a placeholder to distinguish the output files. The output format is either PNG for a static image or GIF for an animated image, depending on the parameters specified in `JobParams`.'."\n" + ."\n" + .'### VideoDelogo'."\n" + ."\n" + .'Removes logos from a video file and outputs an MP4 video.'."\n" + ."\n" + .'### VideoDetext'."\n" + ."\n" + .'Removes subtitles from a video file and outputs an MP4 video.'."\n" + ."\n" + .'### CaptionExtraction'."\n" + ."\n" + .'Extracts subtitles from a video file and outputs them as an SRT file.'."\n" + ."\n" + .'### VideoGreenScreenMatting'."\n" + ."\n" + .'Takes a video file as input and outputs a video with the green screen background removed. The output format is either MP4 or WebM, depending on the parameters in `JobParams`.'."\n" + ."\n" + .'### FaceBeauty'."\n" + ."\n" + .'Takes a video file as input and outputs a video in MP4 format with face beautification effects.'."\n" + ."\n" + .'### VideoH2V'."\n" + ."\n" + .'Takes a video file as input and outputs a vertical MP4 video converted from a horizontal source.'."\n" + ."\n" + .'### MusicSegmentDetect'."\n" + ."\n" + .'Takes an audio file as input and outputs a JSON file containing chorus detection results.'."\n" + ."\n" + .'### AudioBeatDetection'."\n" + ."\n" + .'Takes an audio file as input and outputs a JSON file containing beat detection results.'."\n" + ."\n" + .'### AudioQualityAssessment'."\n" + ."\n" + .'Takes an audio file as input. No output file is generated. The audio quality assessment results are returned directly in the `QueryIProductionJob` response.'."\n" + ."\n" + .'### SpeechDenoise'."\n" + ."\n" + .'Reduces noise in an audio file and outputs the result as a WAV file.'."\n" + ."\n" + .'### AudioMixing'."\n" + ."\n" + .'Mixes the input audio file with additional tracks specified in `JobParams` and outputs the result in WAV format.'."\n" + ."\n" + .'### MusicDemix'."\n" + ."\n" + .'Separates an audio file (song) into two separate audio files: one for the vocal and one for the accompaniment. The `Output` path must include the `{resultType}` placeholder to distinguish between the two files.'."\n" + ."\n" + .'## `JobParams` JSON fields'."\n" + ."\n" + .'### Cover'."\n" + ."\n" + .'- `Model`: String. Specifies the Smart Cover model. If left empty, a static image is generated. If set to `gif`, an animated image is generated.'."\n" + ."\n" + .'### VideoDelogo'."\n" + ."\n" + .'- `LogoModel`: String. Specifies the type of logo to remove. Valid values: `tv` (television broadcast logos) and `internet` (online media logos). You can specify multiple values, separated by commas.'."\n" + ."\n" + .'- `Boxes`: String. The coordinates of the bounding boxes for the target logos. Coordinates are specified as normalized distances from the upper-left corner in the format `[xmin, ymin, width, height]`. A maximum of two bounding boxes are supported. Example: `"[[0, 0, 0.3, 0.3], [0.7, 0, 0.3, 0.3]]"`.'."\n" + ."\n" + .'### VideoDetext'."\n" + ."\n" + .'- `LimitRegion`: List. Specifies the regions for subtitle detection. Coordinates are specified as normalized distances from the upper-left corner in the format `[xmin, ymin, width, height]`. Multiple regions are supported. Example: `[[0, 0, 0.3, 0.3], [0.7, 0, 0.3, 0.3]]`. **Note: If this parameter is omitted, the service defaults to scanning the bottom 30% of the video.**'."\n" + ."\n" + .'- `Time`: List. Specifies the time ranges for subtitle removal in seconds, in the format `[start_time, end_time]`. For example, `[5, 20]` indicates that subtitles are removed only between 5 and 20 seconds into the video.'."\n" + ."\n" + .' - A one-dimensional array, such as `[5, 20]`, to specify a single time range.'."\n" + ."\n" + .' - A two-dimensional array, such as `[[5, 20], [25, 43], [51, 80]]`, to specify multiple time ranges. This format is supported only when `modelId` is `algo-video-detext-new`.'."\n" + ."\n" + .'### CaptionExtraction'."\n" + ."\n" + .'- `fps`: Integer. (Optional) The sampling frame rate. Valid range: `[2, 10]`. Default: `5`.'."\n" + ."\n" + .'- `roi`: The region of interest (ROI) for subtitle extraction. Only subtitles within this region are extracted. The format is `[[top, bottom], [left, right]]`, using normalized values. For example, `[[0.5, 1], [0, 1]]` specifies the bottom half of the video. If this parameter is omitted, the service defaults to extracting subtitles from the bottom quarter of the video.'."\n" + ."\n" + .'- `lang`: String. The language for recognition. Valid values: `ch` (Chinese), `en` (English), and `ch_ml` (mixed Chinese and English). Default: `ch`.'."\n" + ."\n" + .'- `track`: String. If set to `main`, only the main subtitle track is extracted. If this parameter is omitted, all subtitles within the specified region are extracted by default.'."\n" + ."\n" + .'### VideoGreenScreenMatting'."\n" + ."\n" + .'- `bgimage`: String. The URL of the background image to overlay on the video after matting. Example: `http://example-image-****.example-location.aliyuncs.com/example/example.jpg`. If this parameter is omitted, the service outputs a WebM video with an alpha channel.'."\n" + ."\n" + .'### FaceBeauty'."\n" + ."\n" + .'- `beauty_params`: String. The parameters for the face beautification feature. Example: `"whiten=20,smooth=50,face_thin=50"`. For more information, see [Parameter Field Descriptions](~~352026#section-2b1-xzo-9dg~~).'."\n" + ."\n" + .'### VideoH2V'."\n" + ."\n" + .'None'."\n" + ."\n" + .'### MusicSegmentDetect'."\n" + ."\n" + .'None'."\n" + ."\n" + .'### AudioBeatDetection'."\n" + ."\n" + .'None'."\n" + ."\n" + .'### AudioQualityAssessment'."\n" + ."\n" + .'None'."\n" + ."\n" + .'### SpeechDenoise'."\n" + ."\n" + .'The input audio file must be in WAV format with a sampling rate of 16 kHz or 48 kHz.'."\n" + ."\n" + .'### AudioMixing'."\n" + ."\n" + .'- `inputs`: A list containing the audio tracks to mix. Note: Currently, only one file is supported. Example: `{"file":"http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/2.mp4"}`'."\n" + ."\n" + .'### MusicDemix'."\n" + ."\n" + .'None', + 'changeSet' => [ + ['createdAt' => '2025-05-07T07:58:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-02T06:57:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-05T05:44:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-15T09:42:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-13T08:33:03.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitIProductionJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitIProductionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitLiveEditingJob' => [ + 'summary' => 'Live editing creates an output file by combining one or more segments from live streams. After you submit a live editing job, it is processed asynchronously. You can then call the GetLiveEditingJob operation with the returned JobId to query the job status, or call the GetMediaInfo operation with the MediaId to get details of the generated media asset.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ChannelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], + 'name' => 'Clips', + 'in' => 'query', + 'schema' => ['description' => 'A JSON array that specifies the clips to edit. The job creates the output file by concatenating these clips in the specified order.'."\n" + ."\n" + .'Each clip includes a start and end time. If live stream parameters are not specified for a clip, the system uses the global `LiveStreamConfig` settings. The start and end timestamps must be in UTC. For more details, see the Clip data structure below.', 'type' => 'string', 'required' => true, 'example' => '[{\\"StartTime\\": \\" 2021-06-21T08:01:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:03:00Z\\" , "AppName": "app", "DomainName": "domain.com", "StreamName": "stream"}, {\\"StartTime\\": \\" 2021-06-21T08:05:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:09:00Z\\" }]', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the live editing project. If you specify this parameter, the system uses the storage settings from the project. If left empty, the system uses the storage settings provided in the request instead.', 'type' => 'string', 'required' => false, 'example' => '****fddd7748b58bf1d47e95****', 'title' => ''], + ], + [ + 'name' => 'LiveStreamConfig', + 'in' => 'query', + 'schema' => ['description' => 'The configuration of the source live stream, specified as a JSON object. It includes the following parameters:'."\n" + ."\n" + .'- `AppName`: The name of the application to which the stream belongs.'."\n" + ."\n" + .'- `DomainName`: The domain name of the stream.'."\n" + ."\n" + .'- `StreamName`: The name of the live stream.', 'type' => 'string', 'required' => false, 'example' => '{ "AppName": "app", "DomainName": "domain.com", "StreamName": "stream" }', 'title' => ''], + ], + [ + 'name' => 'OutputMediaConfig', + 'in' => 'query', + 'schema' => ['description' => 'The destination configuration for the output file, specified as a JSON object. You can specify either a URL on OSS or a storage location in a VOD bucket.'."\n" + ."\n" + .'- To output to OSS, the `MediaURL` parameter is required.'."\n" + ."\n" + .'- To output to VOD, the `StorageLocation` and `FileName` parameters are required.', 'type' => 'string', 'example' => '{ "MediaURL": "https://ice-auto-test.oss-cn-shanghai.aliyuncs.com/testfile.mp4" }, or { "StorageLocation": "bucket.oss-cn-shanghai.aliyuncs.com", "FileName": "output.mp4" }', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'MediaProduceConfig', + 'in' => 'query', + 'schema' => ['description' => 'The production configuration for the output file, specified as a JSON object. The `Mode` parameter specifies the editing mode. Valid values are:'."\n" + ."\n" + .'- **AccurateFast** (Default): Fast and precise editing. It offers faster processing compared to the `Accurate` mode. The output file has the same resolution as the source stream. You cannot specify a custom width and height for the output file.'."\n" + ."\n" + .'- **Accurate**: Precise editing. This mode lets you specify a custom width and height for the output file.'."\n" + ."\n" + .'- **Rough**: Rough editing with a precision of a single TS segment. The output file includes all segments between the specified start and end times. You can specify a custom width and height for the output file.'."\n" + ."\n" + .'- **RoughFast**: Fast rough-cut editing, which is faster than the `Accurate` mode. It has a precision of a single TS segment, and the output file includes all segments between the specified start and end times. The output file has the same resolution as the source stream. You cannot specify a custom width and height for the output file.', 'type' => 'string', 'required' => false, 'example' => '{ "Mode": "AccurateFast"}', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom user data, provided as a JSON object. The maximum length is 512 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"key": "value"}', 'title' => ''], + ], + [ + 'name' => 'OutputMediaTarget', + 'in' => 'query', + 'schema' => ['description' => 'The destination type for the output file. Valid values:'."\n" + ."\n" + .'- `oss-object`: An object in an Alibaba Cloud OSS bucket.'."\n" + ."\n" + .'- `vod-media`: A media asset in Alibaba Cloud VOD.', 'type' => 'string', 'required' => false, 'example' => 'oss-object', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Channel' => [ - 'title' => '频道配置', - 'description' => 'The channel information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChannelId' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'Name' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'mych', - ], - 'State' => [ - 'title' => '频道状态', - 'description' => 'The state of the channel. Valid values: IDLE, STARTING, RUNNING, RECOVERING, and STOPPING.'."\n", - 'type' => 'string', - 'example' => 'IDLE', - ], - 'InputAttachments' => [ - 'title' => '输入绑定设置', - 'description' => 'The inputs associated with the channel.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InputId' => [ - 'title' => '绑定的输入ID', - 'description' => 'The ID of the associated input.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'InputName' => [ - 'title' => '输入名称', - 'description' => 'The name of the input.'."\n", - 'type' => 'string', - 'example' => 'myinput', - ], - 'LanguageName' => [ - 'title' => '仅rtmp类型输入有效，表示output使用的Name标签', - 'description' => 'The language name.'."\n", - 'type' => 'string', - 'example' => 'eng', - ], - 'AudioSelectors' => [ - 'title' => '音频选择器列表', - 'description' => 'The audio selectors.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myselector', - ], - 'AudioLanguageSelection' => [ - 'title' => '语言选择器', - 'description' => 'The audio language selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'LanguageCode' => [ - 'title' => '语言代码', - 'description' => 'A three-letter ISO 639-2 language code from within an audio source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'eng', - ], - ], - ], - 'AudioPidSelection' => [ - 'title' => 'PID选择器', - 'description' => 'The audio PID selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Pid' => [ - 'title' => 'PID', - 'description' => 'A PID from within a source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - ], - 'AudioTrackSelection' => [ - 'title' => '音轨选择器', - 'description' => 'The audio track selection.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TrackId' => [ - 'title' => '音轨ID', - 'description' => 'The track ID from within a source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => false, - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'OutputGroups' => [ - 'title' => '输出组详细设置', - 'description' => 'The output groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '输出组名称', - 'description' => 'The name of the output group.'."\n", - 'type' => 'string', - 'example' => 'group1', - ], - 'Type' => [ - 'title' => '输出组类型', - 'description' => 'The output group type.'."\n", - 'type' => 'string', - 'example' => 'MediaPackage', - ], - 'Outputs' => [ - 'title' => '输出列表设置', - 'description' => 'The outputs in the output group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '输出名称', - 'description' => 'The name of the output.'."\n", - 'type' => 'string', - 'example' => 'output1', - ], - 'MediaType' => [ - 'title' => '输出的媒体类型', - 'description' => 'The media type of the output.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MediaPackageOutputSetting' => [ - 'title' => '输出组类型为MediaPackage时的设置', - 'description' => 'The settings of the output delivered to MediaPackage.'."\n", - 'type' => 'object', - 'properties' => [ - 'NameModifier' => [ - 'title' => 'manifest后缀', - 'description' => 'The manifest name modifier. The child manifests include this modifier in their M3U8 file names.'."\n", - 'type' => 'string', - 'example' => '480p', - ], - 'AudioGroupId' => [ - 'title' => 'manifest音频组id设置', - 'description' => 'The manifest audio group ID.'."\n", - 'type' => 'string', - 'example' => 'audiogroup', - ], - ], - ], - 'VideoSettingName' => [ - 'title' => '引用的视频设置名称', - 'description' => 'The name of the referenced VideoSettings.'."\n", - 'type' => 'string', - 'example' => 'myVideo1', - ], - 'AudioSettingNames' => [ - 'title' => '引用的音频设置名称', - 'description' => 'The referenced AudioSettings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the referenced AudioSettings.'."\n", - 'type' => 'string', - 'example' => 'myAudio1', - ], - ], - ], - 'description' => '', - ], - ], - 'MediaPackageGroupSetting' => [ - 'title' => 'MediaPackage输出组设置', - 'description' => 'The MediaPackage destination.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'title' => 'MediaPackage的GroupName', - 'description' => 'GroupName in MediaPackage.'."\n", - 'type' => 'string', - 'example' => 'myPackageGroup', - ], - 'ChannelName' => [ - 'title' => 'MediaPackage的ChannelName', - 'description' => 'ChannelName in MediaPackage.'."\n", - 'type' => 'string', - 'example' => 'myPackageChannel', - ], - ], - ], - 'MonitorUrl' => [ - 'title' => '输出监看地址', - 'description' => 'The URL for monitoring the output group. The parameter is returned only when the output gourp type is MediaPackage.'."\n", - 'type' => 'string', - 'example' => 'rtmp://xxx', - ], - ], - 'description' => '', - ], - ], - 'AudioSettings' => [ - 'title' => '音频设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频设置名称', - 'description' => 'The name of the audio settings.'."\n", - 'type' => 'string', - 'example' => 'zhuanfengzhuang', - ], - 'AudioSelectorName' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector.'."\n", - 'type' => 'string', - 'example' => 'myselector', - ], - 'LanguageCode' => [ - 'title' => '语言代码', - 'description' => 'A three-letter ISO 639-2 language code.'."\n", - 'type' => 'string', - 'example' => 'eng', - ], - 'LanguageName' => [ - 'title' => 'audio类型m3u8切片的名称', - 'description' => 'The name of the language.'."\n", - 'type' => 'string', - 'example' => 'English', - ], - 'AudioCodec' => [ - 'title' => '音频编码类型', - 'description' => 'The audio codec.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'AudioCodecSetting' => [ - 'title' => '音频编码设置', - 'description' => 'The audio encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '音频编码级别', - 'description' => 'The audio codec profile.'."\n", - 'type' => 'string', - 'example' => 'AAC-LOW', - ], - 'Bitrate' => [ - 'title' => '音频比特率', - 'description' => 'The audio bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200000', - ], - 'SampleRate' => [ - 'title' => '音频采样率', - 'description' => 'The audio sample rate. Unit: Hz.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '44100', - ], - ], - ], - ], - 'description' => '', - ], - ], - 'VideoSettings' => [ - 'title' => '视频设置', - 'description' => 'The video settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视频设置名称', - 'description' => 'The name of the video settings.'."\n", - 'type' => 'string', - 'example' => 'video1', - ], - 'Width' => [ - 'title' => '分辨率宽', - 'description' => 'The width of the video in pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1280', - ], - 'Height' => [ - 'title' => '分辨率高', - 'description' => 'The height of the video in pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '720', - ], - 'VideoCodec' => [ - 'title' => '视频编码类型', - 'description' => 'The video codec.'."\n", - 'type' => 'string', - 'example' => 'H264', - ], - 'VideoCodecSetting' => [ - 'title' => '视频编码设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rate' => [ - 'title' => '视频编码速率设置', - 'description' => 'The video encoding rate.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bitrate' => [ - 'title' => '视频比特率', - 'description' => 'The video bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2500000', - ], - 'RateControlMode' => [ - 'title' => '视频编码码控规则', - 'description' => 'The bitrate control mode.'."\n", - 'type' => 'string', - 'example' => 'ABR', - ], - 'MaxBitrate' => [ - 'title' => '视频编码最大比特率', - 'description' => 'The maximum bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000000', - ], - 'BufferSize' => [ - 'title' => '视频编码缓冲区大小', - 'description' => 'The video buffer size. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000000', - ], - ], - ], - 'Framerate' => [ - 'title' => '视频帧率设置', - 'description' => 'The frame rate.'."\n", - 'type' => 'object', - 'properties' => [ - 'FramerateControl' => [ - 'title' => '视频帧率设置模式', - 'description' => 'The frame rate mode.'."\n", - 'type' => 'string', - 'example' => 'SPECIFIED', - ], - 'FramerateNumerator' => [ - 'title' => '视频帧率分子', - 'description' => 'The numerator of the fixed frame rate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'FramerateDenominator' => [ - 'title' => '视频帧率分母', - 'description' => 'The denominator of the fixed frame rate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'Gop' => [ - 'title' => '视频GOP设置', - 'description' => 'The GOP setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'GopSizeUnits' => [ - 'title' => '视频GOP长度单位', - 'description' => 'The GOP size unit.'."\n", - 'type' => 'string', - 'example' => 'FRAMES', - ], - 'GopSize' => [ - 'title' => '视频GOP大小', - 'description' => 'The GOP size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'BframesNum' => [ - 'title' => 'B帧数', - 'description' => 'The number of B frames.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - ], - 'CodecDetail' => [ - 'title' => '视频编码详情设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '视频编码配置', - 'description' => 'The H.264 profile.'."\n", - 'type' => 'string', - 'example' => 'MAIN', - ], - 'Level' => [ - 'title' => '视频编码级别', - 'description' => 'The video encoding level. It is not supported yet.'."\n", - 'type' => 'string', - 'example' => 'H264_LEVEL_AUTO', - ], - ], - ], - ], - ], - 'VideoCodecType' => [ - 'title' => '视频转码方式（普通转码、窄带高清转码等）', - 'description' => 'The video transcoding method. Valid values: NORMAL (regular transcoding) and NBHD (Narrowband HD™ transcoding).'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - ], - 'description' => '', - ], - ], - 'CreateTime' => [ - 'title' => '频道创建时间', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - 'LastStartTime' => [ - 'title' => '频道上一次启动时间', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - 'LastStopTime' => [ - 'title' => '频道上一次停止时间', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'], + 'ProjectId' => ['description' => 'The ID of the live editing project.', 'type' => 'string', 'example' => '****fddd7748b58bf1d47e95****', 'title' => ''], + 'JobId' => ['description' => 'The ID of the live editing job.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], + 'MediaId' => ['description' => 'The ID of the output media asset.', 'type' => 'string', 'example' => '****c469e944b5a856828dc2****', 'title' => ''], + 'MediaURL' => ['description' => 'The URL of the output file.', 'type' => 'string', 'example' => 'http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4', 'title' => ''], + 'VodMediaId' => ['description' => 'The ID of the VOD media asset. This parameter is returned only if the output destination is VOD.', 'type' => 'string', 'example' => '****d7578s4h75ci945c14b****', 'title' => ''], ], + '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" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"MediaURL\\": \\"http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4\\",\\n \\"VodMediaId\\": \\"****d7578s4h75ci945c14b****\\"\\n}","type":"json"}]', + 'title' => 'SubmitLiveEditingJob', + 'description' => '- This is an [asynchronous API](~~3027141~~). When you submit a job, the system returns a JobId before the job is complete. The job is then queued for asynchronous processing. You will receive a [callback notification](~~441150~~) when the job completes. Alternatively, you can query the job status by calling the [GetLiveEditingJob](~~441150~~) operation.'."\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.', - ], - 'ListMediaLiveChannels' => [ - 'summary' => 'Queries MediaLive channels.', - 'methods' => [ - 'post', + .'- You can edit live streams that are recorded to either OSS or VOD. When editing multiple live streams together, all streams must be recorded to the same service, either all to OSS or all to VOD.', + 'requestParamsDescription' => '### Clip data structure'."\n" + ."\n" + .'| Parameter | Type | Example | Description | Required |'."\n" + .'| ---------- | ------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |'."\n" + .'| StartTime | String | 2021-06-21T08:01:00Z | The start time of the clip, in UTC format. | Yes |'."\n" + .'| EndTime | String | 2021-06-21T08:05:00Z | The end time of the clip, in UTC format. | Yes |'."\n" + .'| AppName | String | app | The name of the application to which the stream belongs. If not specified, the system uses the global `LiveStreamConfig` settings. | No |'."\n" + .'| DomainName | String | domain.com | The domain name of the stream. If not specified, the system uses the global `LiveStreamConfig` settings. | No |'."\n" + .'| StreamName | String | stream | The name of the live stream. If not specified, the system uses the global `LiveStreamConfig` settings. | No |'."\n" + .'| CoverTime | String | 2021-06-21T08:03:00Z | Specifies a timestamp within the clip to use for generating a cover image for the output file. The time must be in UTC format. If multiple clips have `CoverTime` set, the system uses only the first one. The `CoverTime` must be greater than or equal to `StartTime` and less than or equal to `EndTime`. | No |'."\n" + .'| CoverUrl | String | https://test.oss-cn-shanghai.aliyuncs.com/cover.jpg | The custom URL for the output screenshot. The OSS bucket must be in the same region as the service. Only self-managed OSS buckets are supported; VOD-managed buckets are not. | No |', + 'changeSet' => [ + ['createdAt' => '2022-09-22T12:07:58.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-13T14:04:54.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveEditingJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveEditingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitLiveRecordJob' => [ + 'summary' => 'Submits a live stream recording job.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'MaxResults', + 'name' => 'NotifyUrl', + 'in' => 'formData', + 'schema' => ['description' => 'The callback URL.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'required' => false, 'example' => 'https://example.com/imsnotify'], + ], + [ + 'name' => 'StreamInput', 'in' => 'formData', + 'style' => 'json', '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" - .'* If you set a value greater than 100, the default value is 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'description' => 'The URL of the live stream.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the live stream URL. The value can only be rtmp.', + 'enumValueTitles' => ['rtmp' => 'rtmp'], + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp', + 'title' => '', + ], + 'Url' => ['description' => 'The URL of the live stream.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://example.com/live/stream1', 'title' => ''], + ], + 'deprecated' => false, + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'RecordOutput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The storage address of the recording.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the storage address.', 'type' => 'string', 'required' => true, 'example' => 'oss', 'title' => ''], + 'Bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => false, 'example' => 'imsbucket1', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint of the storage service.', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou.aliyuncs.com', 'title' => ''], + ], + 'deprecated' => false, + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the recording template.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the recording job.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'live stream record 1'], + ], + ], + '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'], + 'JobId' => ['description' => 'The ID of the recording job.', 'type' => 'string', 'title' => '', 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\"\\n}","type":"json"}]', + 'title' => 'SubmitLiveRecordJob', + 'description' => 'Record live streams of ApsaraVideo Live or third-party Real-Time Messaging Protocol (RTMP) live streams. We recommend that you ingest a stream before you call this operation to submit a recording job. If no stream is pulled from the streaming URL, the job attempts to pull a stream for 3 minutes. If the attempt times out, the recording service stops.'."\n" + ."\n" + .'Before you submit a recording job, you must prepare an Object Storage Service (OSS) or ApsaraVideo VOD bucket. We recommend that you use a storage address configured in Intelligent Media Services (IMS) to facilitate the management and processing of generated recording files.'."\n" + ."\n" + .'If the preset recording template does not meet your requirements, you can create a custom recording template.', + 'changeSet' => [ + ['createdAt' => '2022-08-18T07:45:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-17T07:09:24.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveRecordJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveRecordJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'SubmitLiveSnapshotJob' => [ + 'summary' => 'Submits a live stream snapshot job. If the job is submitted during stream ingest, it automatically starts in asynchronous mode. Otherwise, it does not start.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'Skip', + 'name' => 'JobName', '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The name of the job.'."\n" + ."\n" + .'- It cannot exceed 128 characters in length.', 'type' => 'string', 'example' => 'Screenshot task1', 'required' => true, 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'StreamInput', 'in' => 'formData', + 'style' => 'json', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'title' => '', + 'description' => 'The information about the input stream.', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The URL of the input stream.'."\n" + ."\n" + .'- It cannot exceed 255 characters in length.', 'type' => 'string', 'required' => true, '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', + 'required' => true, + 'title' => '', + 'example' => 'rtmp', + ], + ], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'SortOrder', + 'name' => 'SnapshotOutput', 'in' => 'formData', + 'style' => 'json', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', + 'title' => '', + 'description' => 'The information about the output snapshot.', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'description' => 'The storage type of the snapshot. The value can only be oss.', + 'enumValueTitles' => ['oss' => 'oss'], + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'oss', + ], + 'Endpoint' => ['description' => 'The output endpoint of the snapshot.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'oss-cn-shanghai.aliyuncs.com'], + 'Bucket' => ['description' => 'The bucket of the snapshot output endpoint.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testbucket'], + ], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'Keyword', + 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword of the query. You can perform a fuzzy search on channel ID or name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ - 'name' => 'States', + 'name' => 'CallbackUrl', 'in' => 'formData', - 'schema' => [ - 'description' => 'The state of channels you want to query. You can separate multiple states with commas (,) in a JSON array.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["IDLE","RUNNING"]', - ], + 'schema' => ['description' => 'The snapshot callback URL.'."\n" + ."\n" + .'- It cannot exceed 255 characters in length.'."\n" + ."\n" + .'- Both HTTP and HTTPS URLs are supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://www.aliyun.com/snapshot/callback'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Channels' => [ - 'title' => '频道配置列表', - 'description' => 'The channels.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ChannelId' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'Name' => [ - 'title' => '频道名称', - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'example' => 'mych', - ], - 'State' => [ - 'title' => '频道状态', - 'description' => 'The state of the channel. Valid values: IDLE, STARTING, RUNNING, RECOVERING, and STOPPING.'."\n", - 'type' => 'string', - 'example' => 'IDLE', - ], - 'InputAttachments' => [ - 'title' => '输入绑定设置', - 'description' => 'The inputs associated with the channel.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InputId' => [ - 'title' => '绑定的输入ID', - 'description' => 'The ID of the input.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], - 'InputName' => [ - 'title' => '输入名称', - 'description' => 'The name of the input.'."\n", - 'type' => 'string', - 'example' => 'myinput', - ], - 'LanguageName' => [ - 'title' => '仅rtmp类型输入有效，表示output使用的Name标签', - 'description' => 'The name of the language.'."\n", - 'type' => 'string', - 'example' => 'eng', - ], - 'AudioSelectors' => [ - 'title' => '音频选择器列表', - 'description' => 'The audio selectors.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myselector', - ], - 'AudioLanguageSelection' => [ - 'title' => '语言选择器', - 'description' => 'The audio language selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'LanguageCode' => [ - 'title' => '语言代码', - 'description' => 'A three-letter ISO 639-2 language code from within an audio source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'eng', - ], - ], - ], - 'AudioPidSelection' => [ - 'title' => 'PID选择器', - 'description' => 'The audio PID selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'Pid' => [ - 'title' => 'PID', - 'description' => 'A PID from within a source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - ], - 'AudioTrackSelection' => [ - 'title' => '音轨选择器', - 'description' => 'The audio track selection.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TrackId' => [ - 'title' => '音轨ID', - 'description' => 'The track ID from within a source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => false, - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'OutputGroups' => [ - 'title' => '输出组详细设置', - 'description' => 'The output groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '输出组名称', - 'description' => 'The name of the output group.'."\n", - 'type' => 'string', - 'example' => 'group1', - ], - 'Type' => [ - 'title' => '输出组类型', - 'description' => 'The output group type.'."\n", - 'type' => 'string', - 'example' => 'MediaPackage', - ], - 'Outputs' => [ - 'title' => '输出列表设置', - 'description' => 'The outputs in the output group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '输出名称', - 'description' => 'The name of the output.'."\n", - 'type' => 'string', - 'example' => 'output1', - ], - 'MediaType' => [ - 'title' => '输出的媒体类型', - 'description' => 'The media type of the output.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MediaPackageOutputSetting' => [ - 'title' => '输出组类型为MediaPackage时的设置', - 'description' => 'The settings of the output delivered to MediaPackage.'."\n", - 'type' => 'object', - 'properties' => [ - 'NameModifier' => [ - 'title' => 'manifest后缀', - 'description' => 'The manifest name modifier. The child manifests include this modifier in their M3U8 file names.'."\n", - 'type' => 'string', - 'example' => '480p', - ], - 'AudioGroupId' => [ - 'title' => 'manifest音频组id设置', - 'description' => 'The manifest audio group ID.'."\n", - 'type' => 'string', - 'example' => 'audiogroup', - ], - ], - ], - 'VideoSettingName' => [ - 'title' => '引用的视频设置名称', - 'description' => 'The name of the referenced VideoSettings.'."\n", - 'type' => 'string', - 'example' => 'myVideo1', - ], - 'AudioSettingNames' => [ - 'title' => '引用的音频设置名称', - 'description' => 'The referenced AudioSettings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the referenced AudioSettings.'."\n", - 'type' => 'string', - 'example' => 'myAudio1', - ], - ], - ], - 'description' => '', - ], - ], - 'MediaPackageGroupSetting' => [ - 'title' => 'MediaPackage输出组设置', - 'description' => 'The MediaPackage destination.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'title' => 'MediaPackage的GroupName', - 'description' => 'GroupName in MediaPackage.'."\n", - 'type' => 'string', - 'example' => 'myPackageGroup', - ], - 'ChannelName' => [ - 'title' => 'MediaPackage的ChannelName', - 'description' => 'ChannelName in MediaPackage.'."\n", - 'type' => 'string', - 'example' => 'myPackageChannel', - ], - ], - ], - 'MonitorUrl' => [ - 'title' => '输出监看地址', - 'description' => 'The URL for monitoring the output group. The parameter is returned only when the output gourp type is MediaPackage.'."\n", - 'type' => 'string', - 'example' => 'rtmp://xxx', - ], - ], - 'description' => '', - ], - ], - 'AudioSettings' => [ - 'title' => '音频设置', - 'description' => 'The audio settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '音频设置名称', - 'description' => 'The name of the audio settings.'."\n", - 'type' => 'string', - 'example' => 'zhuanfengzhuang', - ], - 'AudioSelectorName' => [ - 'title' => '音频选择器名称', - 'description' => 'The name of the audio selector.'."\n", - 'type' => 'string', - 'example' => 'myselector', - ], - 'LanguageCode' => [ - 'title' => '语言代码', - 'description' => 'A three-letter ISO 639-2 language code.'."\n", - 'type' => 'string', - 'example' => 'eng', - ], - 'LanguageName' => [ - 'title' => 'audio类型m3u8切片的名称', - 'description' => 'The name of the language.'."\n", - 'type' => 'string', - 'example' => 'English', - ], - 'AudioCodec' => [ - 'title' => '音频编码类型', - 'description' => 'The audio codec.'."\n", - 'type' => 'string', - 'example' => 'aac', - ], - 'AudioCodecSetting' => [ - 'title' => '音频编码设置', - 'description' => 'The audio encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '音频编码级别', - 'description' => 'The audio codec profile.'."\n", - 'type' => 'string', - 'example' => 'AAC-LOW', - ], - 'Bitrate' => [ - 'title' => '音频比特率', - 'description' => 'The audio bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200000', - ], - 'SampleRate' => [ - 'title' => '音频采样率', - 'description' => 'The audio sample rate. Unit: Hz.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '44100', - ], - ], - ], - ], - 'description' => '', - ], - ], - 'VideoSettings' => [ - 'title' => '视频设置', - 'description' => 'The video settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '视频设置名称', - 'description' => 'The name of the video settings.'."\n", - 'type' => 'string', - 'example' => 'video1', - ], - 'Width' => [ - 'title' => '分辨率宽', - 'description' => 'The width of the video in pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1280', - ], - 'Height' => [ - 'title' => '分辨率高', - 'description' => 'The height of the video in pixels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '720', - ], - 'VideoCodec' => [ - 'title' => '视频编码类型', - 'description' => 'The video codec.'."\n", - 'type' => 'string', - 'example' => 'H264', - ], - 'VideoCodecSetting' => [ - 'title' => '视频编码设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rate' => [ - 'title' => '视频编码速率设置', - 'description' => 'The video encoding rate.'."\n", - 'type' => 'object', - 'properties' => [ - 'Bitrate' => [ - 'title' => '视频比特率', - 'description' => 'The video bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2500000', - ], - 'RateControlMode' => [ - 'title' => '视频编码码控规则', - 'description' => 'The bitrate control mode.'."\n", - 'type' => 'string', - 'example' => 'ABR', - ], - 'MaxBitrate' => [ - 'title' => '视频编码最大比特率', - 'description' => 'The maximum bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000000', - ], - 'BufferSize' => [ - 'title' => '视频编码缓冲区大小', - 'description' => 'The video buffer size. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000000', - ], - ], - ], - 'Framerate' => [ - 'title' => '视频帧率设置', - 'description' => 'The frame rate.'."\n", - 'type' => 'object', - 'properties' => [ - 'FramerateControl' => [ - 'title' => '视频帧率设置模式', - 'description' => 'The frame rate mode.'."\n", - 'type' => 'string', - 'example' => 'SPECIFIED', - ], - 'FramerateNumerator' => [ - 'title' => '视频帧率分子', - 'description' => 'The numerator of the fixed frame rate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'FramerateDenominator' => [ - 'title' => '视频帧率分母', - 'description' => 'The denominator of the fixed frame rate.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'Gop' => [ - 'title' => '视频GOP设置', - 'description' => 'The GOP setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'GopSizeUnits' => [ - 'title' => '视频GOP长度单位', - 'description' => 'The GOP size unit.'."\n", - 'type' => 'string', - 'example' => 'FRAMES', - ], - 'GopSize' => [ - 'title' => '视频GOP大小', - 'description' => 'The GOP size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'BframesNum' => [ - 'title' => 'B帧数', - 'description' => 'The number of B frames.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - ], - 'CodecDetail' => [ - 'title' => '视频编码详情设置', - 'description' => 'The video encoding settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Profile' => [ - 'title' => '视频编码配置', - 'description' => 'The H.264 profile.'."\n", - 'type' => 'string', - 'example' => 'MAIN', - ], - 'Level' => [ - 'title' => '视频编码级别', - 'description' => 'The video encoding level. It is not supported yet.'."\n", - 'type' => 'string', - 'example' => 'H264_LEVEL_AUTO', - ], - ], - ], - ], - ], - 'VideoCodecType' => [ - 'title' => '视频转码方式（普通转码、窄带高清转码等）', - 'description' => 'The video transcoding method. Valid values: NORMAL (regular transcoding) and NBHD (Narrowband HD™ transcoding).'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - ], - 'description' => '', - ], - ], - 'CreateTime' => [ - 'title' => '频道创建时间', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - 'LastStartTime' => [ - 'title' => '频道上一次启动时间', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - 'LastStopTime' => [ - 'title' => '频道上一次停止时间', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-12-03T06:56:42Z', - ], - ], - 'description' => '', - ], - ], - 'MaxResults' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + '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-fb287666****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"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.', - ], - 'DeleteMediaLiveChannel' => [ - 'summary' => 'Deletes a MediaLive channel.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287666****\\"\\n}","type":"json"}]', + 'title' => 'SubmitLiveSnapshotJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveSnapshotJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitLiveTranscodeJob' => [ + 'summary' => 'Submits a live stream transcoding job.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -61914,190 +47194,392 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ChannelId', - 'in' => 'formData', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the transcoding job.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'task1', 'title' => ''], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '****96e8864746a0b6f3****', 'title' => ''], + ], + [ + 'name' => 'StartMode', + 'in' => 'query', 'schema' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', + '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.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enum' => ['0', '1'], + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'StreamInput', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the input stream.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the input stream. The value can only be rtmp.', + 'type' => 'string', + 'required' => true, + 'enum' => ['rtmp'], + 'example' => 'rtmp', + 'title' => '', + ], + 'InputUrl' => ['description' => 'The URL of the input stream.', 'type' => 'string', 'required' => true, 'example' => 'rtmp://mydomain/app/stream1', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TranscodeOutput', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the transcoding output.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the output stream. A value of LiveCenter indicates that the URL of the output stream is generated based on the domain name of ApsaraVideo Live. The value can only be LiveCenter.', 'type' => 'string', 'required' => true, 'example' => 'LiveCenter', 'title' => ''], + 'DomainName' => ['description' => 'The streaming domain name of ApsaraVideo Live.', 'type' => 'string', 'required' => false, 'example' => 'mydomain', 'title' => ''], + ], 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TimedConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configuration of a timed transcoding job. This parameter is required if you set StartMode to 1.', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The start time of the transcoding job. Note: The time span between the start time and the current time cannot exceed seven days.', 'type' => 'string', 'required' => false, 'example' => '2022-02-21T00:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The stop time of the transcoding job. Note: The time span between the stop time and the current time cannot exceed seven days.', 'type' => 'string', 'required' => false, 'example' => '2022-07-20T08:20:32Z', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], + 'JobId' => ['description' => 'The ID of the transcoding job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], ], - '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" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => 'SubmitLiveTranscodeJob', + 'description' => '- When you submit a transcoding job that immediately takes effect, make sure that the input stream can be streamed.'."\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.', - ], - 'StartMediaLiveChannel' => [ - 'summary' => 'Starts a MediaLive channel.', - 'methods' => [ - 'post', + .'- When you submit a timed transcoding job, make sure that the input stream can be streamed before the specified time.', + 'changeSet' => [ + ['createdAt' => '2022-08-24T03:10:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveTranscodeJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitMediaAiAnalysisJob' => [ + 'summary' => 'Perform structured analysis on media assets to enable speaker analysis, video translation, paragraph summarization, and other analyses on videos.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '231064', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'ChannelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', - ], + 'name' => 'Input', + 'in' => 'query', + 'schema' => ['description' => 'The media asset that you want to analyze. You can specify an Object Storage Service (OSS) URL, a media asset ID, or an external URL.', 'type' => 'string', 'example' => '{"MediaType":"video","Media":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/your_movie.mp4"}'."\n" + .'or'."\n" + .'{"Type":"Media","Media":"adbf5a778175ee757c34d0eba4******"}', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'AnalysisParams', + 'in' => 'query', + 'schema' => ['description' => 'The analysis parameters.', 'type' => 'string', 'required' => false, 'example' => '{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":false,"translationEnabled":false}}', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom settings in JSON format, with a maximum length of 512 bytes. Supports [custom webhook address configuration](~~451631~~).', 'type' => 'string', 'required' => false, 'example' => '{"NotifyAddress":"https://xx.com/xx"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], + 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '******b48fb04483915d4f2cd8******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'StartMediaLiveChannel', - 'description' => '* You can call this operation only when the channel is idle. You cannot start a channel repeatedly.'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\"\\n}","type":"json"}]', + 'title' => 'Submit an Intelligent Structured Analysis Job for a Media Asset ', + 'extraInfo' => '##### Sample Input parameter: '."\n" + .'**Input as a media asset ID:** '."\n" + .'{"Type":"Media","Media":"c90ba1c0425971efac51e7e6c66a6302"}'."\n" ."\n" - .'## QPS limit'."\n" + .'**Input as an OSS URL:** '."\n" + .'{"MediaType":"video","Media":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4"}'."\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.', - ], - 'StopMediaLiveChannel' => [ - 'summary' => 'Stops a MediaLive channel.', - 'methods' => [ - 'post', + .'**For external URL media assets:** '."\n" + .'{"MediaType":"video","Media":"https://xxx/xxx.mp4"}'."\n" + ."\n\n" + .'##### Sample AnalysisParams parameter:'."\n" + .'**Speaker diarization:** '."\n" + .'{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":false,"translationEnabled":false}} '."\n" + .' '."\n" + .'**Translation:** '."\n" + .'{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":false,"translationEnabled":true,"targetLanguages":"en"}}'."\n" + ."\n" + .'**Chapter summarization:** '."\n" + .'{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":true,"translationEnabled":false,"autoChaptersEnabled":true,"meetingAssistanceEnabled":true,"summarizationTypes":"Paragraph,Conversational,QuestionsAnswering,MindMap"}}', + 'changeSet' => [ + ['createdAt' => '2024-12-30T11:35:21.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaAiAnalysisJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + 'SubmitMediaCensorJob' => [ + 'summary' => 'Submits a media file to Intelligent Media Services for a censor job. This API automates the scanning of video, audio, or image content to detect potentially non-compliant, sensitive, or inappropriate material.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'ChannelId', - 'in' => 'formData', + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The template ID. If this parameter is left empty, the service uses the default template for the censor job.', 'type' => 'string', 'required' => false, 'example' => 'S00000001-100060', 'title' => ''], + ], + [ + 'name' => 'CoverImages', + 'in' => 'query', + 'schema' => ['description' => 'The Object Storage Service (OSS) files for the cover images, specified as a JSON array. You can specify up to five cover images.'."\n" + ."\n" + .'> If specified, this parameter overrides the cover image information in the **Media** object.', 'type' => 'string', 'required' => false, 'example' => '[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg","RoleArn":"acs:ram::1997018457688683:role/AliyunICEDefaultRole"}]', 'title' => ''], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => 'The video title. The maximum length is 64 bytes.'."\n" + ."\n" + .'> If specified, this parameter overrides the title specified in the Media object.', 'type' => 'string', 'required' => false, 'example' => 'Hello World', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The video description. The maximum length is 128 bytes.'."\n" + ."\n" + .'> If specified, this parameter overrides the description specified in the Media object.', 'type' => 'string', 'required' => false, 'example' => 'example description', 'title' => ''], + ], + [ + 'name' => 'Barrages', + 'in' => 'query', + 'schema' => ['description' => 'The video barrages (on-screen comments).'."\n" + ."\n" + .'> If specified, it overrides the barrages specified in the Media object.', 'type' => 'string', 'required' => false, 'example' => 'hello world', 'title' => ''], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'schema' => ['description' => 'The output location for screenshots. The censor job generates screenshots and a result JSON file in the OSS location specified by this parameter.'."\n" + ."\n" + .'- Example format: `oss://bucket/snapshot-{Count}.jpg`, where `bucket` is the name of an OSS bucket in the same region as the project, and `{Count}` is a placeholder for the screenshot sequence number.'."\n" + ."\n" + .'- The detailed censor results are saved to a file named `{jobId}.output` in the same OSS folder as the value of `Output`. For information about the fields in the output file, see [Media censor result file fields](~~609211~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'oss://sashimi-cn-shanghai/censor/snapshot-{Count}.jpg', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The user-defined data. The maximum length is 128 bytes.', 'type' => 'string', 'required' => false, 'example' => 'UserDatatestid-001-****', 'title' => ''], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The callback path. Both Message Service (MNS) and HTTP callbacks are supported.', 'type' => 'string', 'required' => false, 'example' => 'mns://125340688170****.oss-cn-shanghai.aliyuncs.com/queues/example-pipeline', 'title' => ''], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '频道ID', - 'description' => 'The ID of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SEGK5KA6KYKAWQQH', + 'description' => 'The input file to censor.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" + ."\n" + .'`OSS`: an OSS URL'."\n" + ."\n" + .'`Media`: a media ID', 'type' => 'string', 'required' => false, 'example' => 'Media', 'title' => ''], + 'Media' => ['description' => 'The identifier for the input file. You can specify either an OSS URL or a media ID.'."\n" + .'Valid OSS URL formats:'."\n" + ."\n" + .'1\\. `oss://bucket/object`'."\n" + ."\n" + .'2\\. `http(s)://bucket.oss-[regionId].aliyuncs.com/object`'."\n" + ."\n" + .'The `bucket` must be in the same region as the project, and `object` is the path to the file.', 'type' => 'string', 'required' => false, 'example' => '1b1b9cd148034739af413150fded****', 'title' => ''], + ], + 'required' => false, + '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' => '5246b8d12a62433ab77845074039****', 'title' => ''], + 'Priority' => ['description' => 'The task priority. A higher value indicates a higher priority. Valid values range from 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', 'title' => ''], + 'JobId' => ['description' => 'The ID of the video censor job. We recommend saving this ID for subsequent API calls.', 'type' => 'string', 'example' => '88c6ca184c0e47098a5b665e2****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'SubmitMediaCensorJob', + 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a job, the service returns a job ID and processes the job in the background. You receive the final result through a callback notification. You can also check the job status by calling the [QueryMediaCensorJob](~~444847~~) API.', + 'changeSet' => [ + ['createdAt' => '2022-07-19T11:23:57.000Z', 'description' => 'OpenAPI offline'], ], - '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.', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaCensorJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaCensorJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], 'SubmitMediaConvertJob' => [ - 'summary' => 'Submits a transcoding task.', + 'summary' => 'Submit a media processing job', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62109,582 +47591,857 @@ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceEO4QPO', - ], + 'abilityTreeNodes' => ['FEATUREiceEO4QPO'], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The idempotency key that is used to ensure repeated requests have the same effect as a single request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86f8e525-9d73-4dac-88aa-7aa4e950c00a', - ], + 'schema' => ['description' => 'A unique client token that ensures request idempotency.', 'type' => 'string', 'required' => false, 'example' => '86f8e525-9d73-4dac-88aa-7aa4e950c00a', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The configurations of the transcoding task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "Inputs": [{'."\n" - .' "InputFile": {'."\n" - .' "Type": "OSS",'."\n" - .' "Media": "http://**.oss-cn-shanghai.aliyuncs.com/input/**/60min.mp4"'."\n" - .' }'."\n" - .' }],'."\n" - .' "Outputs": [{'."\n" - .' "OutputFile": {'."\n" - .' "Type": "OSS",'."\n" - .' "Media": "http://**.oss-cn-shanghai.aliyuncs.com/output/**/360p.mp4"'."\n" - .' },'."\n" - .' "TemplateId": "S00000001-200000"'."\n" - .' }, {'."\n" - .' "OutputFile": {'."\n" - .' "Type": "OSS",'."\n" - .' "Media": "http://**.oss-cn-shanghai.aliyuncs.com/output/**/720p.mp4"'."\n" - .' },'."\n" - .' "TemplateId": "S00000001-200000"'."\n" - .' }]'."\n" - .'}', - ], + 'schema' => ['description' => 'The transcoding job configuration. For more information, see [MediaConvertJobConfig](~~2999539~~).', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "Inputs": ['."\n" + .' {'."\n" + .' "InputFile": {'."\n" + .' "Type": "OSS",'."\n" + .' "Media": "http://**.oss-cn-shanghai.aliyuncs.com/input/**/60min.mp4"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "OutputGroups": ['."\n" + .' {'."\n" + .' "GroupConfig": {'."\n" + .' "Type": "File",'."\n" + .' "OutputFileBase": {'."\n" + .' "Type": "OSS",'."\n" + .' "Media": "http://**.oss-cn-shanghai.aliyuncs.com/output/**/"'."\n" + .' }'."\n" + .' },'."\n" + .' "Outputs": ['."\n" + .' {'."\n" + .' "OutputFile": "hd.mp4",'."\n" + .' "TemplateId": "S00000001-200030"'."\n" + .' }, {'."\n" + .' "OutputFile": "sd.mp4",'."\n" + .' "TemplateId": "S00000001-200020"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], ], [ 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"videoId":"abcd"}', - ], + 'schema' => ['description' => 'Custom data to pass with the job.', 'type' => 'string', 'required' => false, 'example' => '{"videoId":"abcd"}', 'title' => ''], ], [ 'name' => 'PipelineId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the queue.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'e197ecfb103e4849922b054d3032f954', - ], + 'schema' => ['description' => 'The ID of the pipeline for the transcoding job.', 'type' => 'string', 'required' => false, 'example' => 'e197ecfb103e4849922b054d3032f954', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The result of transcoding task submission.'."\n", + 'title' => '', + 'description' => 'The result of submitting a media transcoding job.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], 'Job' => [ - 'title' => '转码作业', - 'description' => 'The transcoding task.'."\n", + 'title' => '', + 'description' => 'The media transcoding job.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A2129C9F-CE95-58B5-B8C1-07758FF6C86F', - ], - 'ClientToken' => [ - 'title' => '创建转码作业请求的幂等参数', - 'description' => 'The idempotency key of the request for creating the transcoding task.'."\n", - 'type' => 'string', - 'example' => 'FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706', - ], - 'JobId' => [ - 'title' => '转码作业 ID', - 'description' => 'The ID of the transcoding task.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A2129C9F-CE95-58B5-B8C1-07758FF6C86F', 'title' => ''], + 'ClientToken' => ['description' => 'The idempotency token for the request.', 'type' => 'string', 'title' => '', 'example' => 'FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706'], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], 'Config' => [ - 'title' => '转码作业配置', - 'description' => 'The configurations of the transcoding task.'."\n", + 'title' => '', + 'description' => 'The job configuration.', 'type' => 'object', 'properties' => [ 'Inputs' => [ - 'title' => '转码作业输入列表', - 'description' => 'The inputs of the transcoding task.'."\n", + 'title' => '', + 'description' => 'The job inputs.', 'type' => 'array', - 'items' => [ - 'title' => '转码作业输入', - 'description' => 'The input of the transcoding task.'."\n", - 'example' => '[{\\"Src\\":{\\"Type\\":\\"MAP_SERVICE\\",\\"DataId\\":\\"479f6c63f66dcc1a9a09420fee32cbdf\\",\\"ZoomLevel\\":18},\\"Idx\\":1}]', - '$ref' => '#/components/schemas/MediaConvertInput', - ], + 'items' => ['description' => 'A job input.', 'example' => '[{\\"Src\\":{\\"Type\\":\\"MAP_SERVICE\\",\\"DataId\\":\\"479f6c63f66dcc1a9a09420fee32cbdf\\",\\"ZoomLevel\\":18},\\"Idx\\":1}]', '$ref' => '#/components/schemas/MediaConvertInput', 'title' => ''], + 'example' => '', ], 'Outputs' => [ - 'title' => '转码输出配置列表', - 'description' => 'The output configurations.'."\n", + 'title' => '', + 'description' => 'The output configurations.', 'type' => 'array', - 'items' => [ - 'title' => '转码作业输出配置', - 'description' => 'The output configuration.'."\n", - 'example' => '[]', - '$ref' => '#/components/schemas/MediaConvertOutput', - ], + 'items' => ['description' => 'An output configuration.', 'example' => '[]', '$ref' => '#/components/schemas/MediaConvertOutput', 'title' => ''], + 'example' => '', ], 'OutputGroups' => [ - 'title' => '转码输出组配置列表', - 'description' => 'The output group configurations.'."\n", + 'title' => '', + 'description' => 'The output group configurations.', 'type' => 'array', - 'items' => [ - 'title' => '转码输出组配置', - 'description' => 'The output group configuration.'."\n", - '$ref' => '#/components/schemas/MediaConvertOutputGroup', - ], - ], - 'JobName' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'insx6-1310', + 'items' => ['description' => 'An output group configuration.', '$ref' => '#/components/schemas/MediaConvertOutputGroup', 'title' => '', 'example' => ''], + 'example' => '', ], + 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'Name', 'title' => ''], ], + 'example' => '', ], - 'PipelineId' => [ - 'title' => '管道ID。', - 'description' => 'The ID of the queue.'."\n", - 'type' => 'string', - 'example' => '3780049', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => '{"videoId":"abcd"}', - ], - 'Code' => [ - 'title' => '作业失败时错误码。执行成功时此参数不返回。', - 'description' => 'The error code returned when the transcoding task failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'title' => '待添加的水印信息。', - 'description' => 'The error message returned when the transcoding task failed.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'State' => [ - 'title' => '转码作业状态。'."\n" - .'● Inited : 初始化；'."\n" - .'● Running : 运行中；'."\n" - .'● Success : 转码成功；'."\n" - .'● Failed : 转码失败；'."\n" - .'● Cancelled : 已取消', - 'description' => 'The status of the transcoding task. Valid values:'."\n" - ."\n" - .'* Inited: The task is initialized.'."\n" - .'* Running'."\n" - .'* Complete'."\n" - .'* Error'."\n" - .'* Cancelled', - 'type' => 'string', - 'example' => 'Inited', - ], + 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => '***48a4edf410b908aecd91fc3b***', 'title' => ''], + 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'title' => '', 'example' => '{"videoId":"abcd"}'], + 'Code' => ['description' => 'The error code returned if the job fails.', 'type' => 'string', 'example' => 'InvalidParameter.ResourceContentBad', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the job fails.', 'type' => 'string', 'example' => 'The resource operated InputFile is bad', 'title' => ''], + 'State' => ['description' => 'The job status. Valid values:'."\n" + ."\n" + .'- Inited: The job has been initialized.'."\n" + ."\n" + .'- Running: The job is running.'."\n" + ."\n" + .'- Success: The job has completed successfully.'."\n" + ."\n" + .'- Failed: The job has failed.'."\n" + ."\n" + .'- Canceled: The job has been canceled.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'OutputDetails' => [ - 'title' => '转码输出结果列表', - 'description' => 'The details of the transcoded outputs.'."\n", + 'title' => '', + 'description' => 'The output details.', 'type' => 'array', - 'items' => [ - 'title' => '转码输出结果', - 'description' => 'The details of the transcoded output.'."\n", - '$ref' => '#/components/schemas/MediaConvertOutputDetail', - ], + 'items' => ['description' => 'The details of a single output.', '$ref' => '#/components/schemas/MediaConvertOutputDetail', 'title' => '', 'example' => ''], + 'example' => '', ], 'OutputGroupDetails' => [ - 'title' => '转码输出组结果列表', - 'description' => 'The details of the output groups.'."\n", + 'title' => '', + 'description' => 'The output group details.', 'type' => 'array', - 'items' => [ - 'title' => '转码输出组结果', - 'description' => 'The details of the output group.'."\n", - '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', - ], + 'items' => ['description' => 'The details of a single output group.', '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Job\\": {\\n \\"RequestId\\": \\"A2129C9F-CE95-58B5-B8C1-07758FF6C86F\\",\\n \\"ClientToken\\": \\"FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Config\\": {\\n \\"Inputs\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n }\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"GroupConfig\\": {\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"ManifestName\\": \\"\\",\\n \\"Type\\": \\"\\"\\n },\\n \\"Outputs\\": [\\n {\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"OutputFileName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"JobName\\": \\"Name\\"\\n },\\n \\"PipelineId\\": \\"***48a4edf410b908aecd91fc3b***\\",\\n \\"UserData\\": \\"{\\\\\\"videoId\\\\\\":\\\\\\"abcd\\\\\\"}\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"State\\": \\"Success\\",\\n \\"OutputDetails\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"OutputGroupDetails\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Outputs\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Job\\": {\\n \\"RequestId\\": \\"A2129C9F-CE95-58B5-B8C1-07758FF6C86F\\",\\n \\"ClientToken\\": \\"FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\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\\": \\"***48a4edf410b908aecd91fc3b***\\",\\n \\"UserData\\": \\"{\\\\\\"videoId\\\\\\":\\\\\\"abcd\\\\\\"}\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"State\\": \\"Success\\",\\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 }\\n}","type":"json"}]', 'title' => 'SubmitMediaConvertJob', - 'translator' => 'machine', - ], - 'GetMediaConvertJob' => [ - 'summary' => 'Obtains the details of a transcoding task.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a task, the API returns a task ID and queues the task for asynchronous processing. You will receive the final result via a callback notification, or you can poll for the task status by calling the [Query Media Transcoding Task](~~2867675~~) operation.', + 'changeSet' => [ + ['createdAt' => '2025-06-17T11:25:31.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaConvertJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitMediaInfoJob' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceEO4QPO', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job-name', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The input for the job.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the input media.'."\n" + ."\n" + .'- `OSS`: The input is an OSS file.'."\n" + ."\n" + .'- `Media`: The input is a media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The source of the input media:'."\n" + ."\n" + .'- If `Type` is `OSS`, set this parameter to the URL of the input file. You can use OSS (`oss://`), HTTP, or HTTPS URLs.'."\n" + ."\n" + .'> You must first add the OSS bucket specified in the URL to Intelligent Media Management Service (IMS) by using [Storage Management](~~609918~~).'."\n" + ."\n" + .'- If `Type` is `Media`, set this parameter to the media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + ], + 'required' => true, + 'example' => 'job-name', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The custom user data.', 'type' => 'string', 'example' => 'user-data', 'title' => '', 'required' => false], + ], + [ + 'name' => 'ScheduleConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '作业ID。', - 'description' => 'The ID of the transcoding task.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The scheduling settings.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => '', 'required' => false], + 'Priority' => ['description' => 'The job priority. A higher value means a higher priority. Valid values range from 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => '', 'required' => false], + ], 'required' => false, - 'example' => '****d80e4e4044975745c14b****', + 'example' => 'user-data', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '查询转码作业返回结果', - 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402', - ], - 'Job' => [ - 'title' => '转码作业', - 'description' => 'The transcoding task.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], + 'MediaInfoJob' => [ + 'title' => '', + 'description' => 'The media information job.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '创建转码作业的请求ID', - 'description' => 'The ID of the request for creating the transcoding task.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'ClientToken' => [ - 'title' => '创建转码作业请求的幂等参数', - 'description' => 'The idempotency key of the request for creating the transcoding task.'."\n", - 'type' => 'string', - 'example' => '780018cb-55ba-466d-8acc-946c0c319a0e ', + 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job-name', 'title' => ''], + 'TriggerSource' => ['description' => 'The source of the job. Valid values:'."\n" + ."\n" + .'- `API`: The job was submitted by calling an API operation.'."\n" + ."\n" + .'- `WorkFlow`: The job was triggered by a workflow.'."\n" + ."\n" + .'- `Console`: The job was submitted in the console.', 'type' => 'string', 'example' => 'API', 'title' => ''], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82dfa8e8', 'title' => ''], + 'Input' => [ + 'title' => '', + 'description' => 'The job input.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of input media. Valid values:'."\n" + ."\n" + .'- `OSS`: An Object Storage Service (OSS) file.'."\n" + ."\n" + .'- `Media`: A media ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The value of the media object. This value depends on the `Type` parameter.'."\n" + ."\n" + .'- If `Type` is `OSS`, this parameter is the URL of the media file. Both the `oss://` and HTTPS protocols are supported.'."\n" + ."\n" + .'- If `Type` is `Media`, this parameter is the media ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + ], + 'example' => '', ], - 'JobId' => [ - 'title' => '转码作业 ID', - 'description' => 'The ID of the transcoding task, which is a 32-bit string.'."\n", - 'type' => 'string', - 'example' => '******4579b5e748b99a27f6d6******', + 'Async' => ['description' => 'Indicates whether to process the job asynchronously.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => 'user-data', 'title' => ''], + 'ScheduleConfig' => [ + 'title' => '', + 'description' => 'The scheduling configuration.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => ''], + 'Priority' => ['description' => 'The job priority. Higher values indicate higher priority. Valid values range from 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'example' => '', ], - 'Config' => [ - 'title' => '转码作业配置', - 'description' => 'The configurations of the transcoding task.'."\n", + 'Status' => ['description' => 'The job status. Valid values:'."\n" + ."\n" + .'- `Init`: Submitted.'."\n" + ."\n" + .'- `Success`: Successful.'."\n" + ."\n" + .'- `Fail`: Failed.', 'type' => 'string', 'example' => 'Init', 'title' => ''], + 'SubmitResultJson' => ['description' => 'The job submission details.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'MediaInfoProperty' => [ + 'title' => '', + 'description' => 'Details of the media information.', 'type' => 'object', 'properties' => [ - 'Inputs' => [ - 'title' => '转码作业输入列表', - 'description' => 'The inputs of the transcoding task.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '转码作业输入', - 'description' => 'The input of the transcoding task.'."\n", - '$ref' => '#/components/schemas/MediaConvertInput', + 'FileBasicInfo' => [ + 'title' => '', + 'description' => 'Basic information about the file.', + 'type' => 'object', + 'properties' => [ + 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'title' => '', 'example' => '2b36bd19c13f4145b094c0cad80dbce5'], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'file.m3u8', 'title' => ''], + 'FileStatus' => ['description' => 'The file status.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'example' => 'source_file', 'title' => ''], + 'FileSize' => ['description' => 'The file size, in 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 where the file is stored.', '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, in seconds.', 'type' => 'string', 'example' => '403.039999', 'title' => ''], + 'Bitrate' => ['description' => 'The video bitrate, in Kbit/s.', 'type' => 'string', 'example' => '888.563', 'title' => ''], + 'Width' => ['description' => 'The width of the video, in pixels.', 'type' => 'string', 'example' => '848', 'title' => ''], + 'Height' => ['description' => 'The height of the video, in pixels.', 'type' => 'string', 'example' => '478', 'title' => ''], ], + 'example' => '', ], - 'Outputs' => [ - 'title' => '转码作业输出配置列表', - 'description' => 'The output configurations.'."\n", + 'AudioStreamInfoList' => [ + 'title' => '', + 'description' => 'A list of audio stream details.', 'type' => 'array', 'items' => [ - 'title' => '转码作业输出配置', - 'description' => 'The output configuration.'."\n", - '$ref' => '#/components/schemas/MediaConvertOutput', + 'description' => 'The audio stream information.', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => 'The stream index.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CodecName' => ['description' => 'The stream\'s codec.', 'type' => 'string', 'example' => 'aac', 'title' => ''], + 'CodecLongName' => ['description' => 'The full name of the codec.', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', 'title' => ''], + 'CodecTimeBase' => ['description' => 'The time base of the codec.', 'type' => 'string', 'example' => '1/44100', 'title' => ''], + 'CodecTagString' => ['description' => 'The codec tag string.', 'type' => 'string', 'example' => '[15][0][0][0]', 'title' => ''], + 'CodecTag' => ['description' => 'The codec tag.', 'type' => 'string', 'example' => '0x000f', 'title' => ''], + 'SampleFmt' => ['description' => 'The sample format.', 'type' => 'string', 'example' => 'fltp', 'title' => ''], + 'SampleRate' => ['description' => 'The sample rate, in Hz.', 'type' => 'string', 'example' => '44100', 'title' => ''], + 'Channels' => ['description' => 'The number of audio channels.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ChannelLayout' => ['description' => 'The channel layout.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], + 'Timebase' => ['description' => 'The stream\'s time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the stream, in seconds.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], + 'Duration' => ['description' => 'The duration of the stream, in seconds.', 'type' => 'string', 'example' => '403.039989', 'title' => ''], + 'Bitrate' => ['description' => 'The bitrate of the stream.', 'type' => 'string', 'example' => '0.f', 'title' => ''], + 'Lang' => ['description' => 'The stream\'s language.', 'type' => 'string', 'example' => 'us', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'OutputGroups' => [ - 'title' => '转码作业输出组列表', - 'description' => 'The output group configurations.'."\n", + 'VideoStreamInfoList' => [ + 'title' => '', + 'description' => 'A list of video stream details.', 'type' => 'array', 'items' => [ - 'title' => '转码作业输出组配置', - 'description' => 'The output group configuration.'."\n", - '$ref' => '#/components/schemas/MediaConvertOutputGroup', + 'description' => 'The video stream information.', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => 'The stream index.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Codec_name' => ['description' => 'The stream\'s codec.', 'type' => 'string', 'example' => 'h264', 'title' => ''], + 'Codec_long_name' => ['description' => 'The full name of the codec.', 'type' => 'string', 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', 'title' => ''], + 'Profile' => ['description' => 'The codec profile.', 'type' => 'string', 'example' => 'High', 'title' => ''], + 'Codec_time_base' => ['description' => 'The time base of the codec.', 'type' => 'string', 'example' => '1/50', 'title' => ''], + 'Codec_tag_string' => ['description' => 'The codec tag string.', 'type' => 'string', 'example' => '[27][0][0][0]', 'title' => ''], + 'Codec_tag' => ['description' => 'The codec tag.', 'type' => 'string', 'example' => '0x001b', 'title' => ''], + 'Width' => ['description' => 'The width of the video, in pixels.', 'type' => 'string', 'example' => '848', 'title' => ''], + 'Height' => ['description' => 'The height of the video, in pixels.', 'type' => 'string', 'example' => '478', 'title' => ''], + 'Has_b_frames' => ['description' => 'Indicates whether the stream contains B-frames. Valid values:'."\n" + ."\n" + .'- `0`: The stream does not contain B-frames.'."\n" + ."\n" + .'- `1`: The stream contains one B-frame.'."\n" + ."\n" + .'- `2`: The stream contains two or more consecutive B-frames.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Sar' => ['description' => 'The sample aspect ratio (SAR).', 'type' => 'string', 'example' => '478:477', 'title' => ''], + 'Dar' => ['description' => 'The display aspect ratio (DAR).', '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 stream\'s time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], + 'Start_time' => ['description' => 'The start time of the stream, in seconds.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], + 'Duration' => ['description' => 'The duration of the stream, in seconds.', 'type' => 'string', 'example' => '403.039989', 'title' => ''], + 'Bit_rate' => ['description' => 'The bitrate of the stream, in Kbit/s.', 'type' => 'string', 'example' => '888.563', 'title' => ''], + 'NumFrames' => ['description' => 'The total number of frames.', 'type' => 'string', 'example' => '10040', 'title' => ''], + 'Lang' => ['description' => 'The stream\'s language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'Rotate' => ['description' => 'The rotation angle of the video, in degrees.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'JobName' => [ - 'type' => 'string', - ], - ], - ], - 'PipelineId' => [ - 'title' => '管道ID', - 'description' => 'The ID of the queue.'."\n", - 'type' => 'string', - 'example' => '83500cb2a3b94fabb0956e38d64bd16d', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => 'The user data.'."\n", - 'type' => 'string', - 'example' => '{"videoId":"ddd333"}', - ], - 'Code' => [ - 'title' => '作业失败码', - 'description' => 'The error code returned when the transcoding task failed.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter.ResourceContentBad', - ], - 'Message' => [ - 'title' => '作业失败详细信息', - 'description' => 'The error message returned when the transcoding task failed.'."\n", - 'type' => 'string', - 'example' => 'The resource operated InputFile is bad', - ], - 'State' => [ - 'title' => '转码作业状态。'."\n" - .'● Inited : 初始化；'."\n" - .'● Running : 运行中；'."\n" - .'● Success : 转码成功；'."\n" - .'● Failed : 转码失败；'."\n" - .'● Cancelled : 已取消'."\n", - 'description' => 'The status of the transcoding task. Valid values:'."\n" - ."\n" - .'* Inited: The task is initialized.'."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Failed'."\n" - .'* Cancelled'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'OutputDetails' => [ - 'title' => '转码输出结果详情', - 'description' => 'The details of the transcoded outputs, each corresponding to an output configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '转码输出结果', - 'description' => 'The details of the transcoded output.'."\n", - '$ref' => '#/components/schemas/MediaConvertOutputDetail', - ], - ], - 'OutputGroupDetails' => [ - 'title' => '转码输出组结果列表', - 'description' => 'The details of the output groups, each corresponding to an output group configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '转码输出组结果', - 'description' => 'The details of the output group.'."\n", - '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', ], + 'example' => '', ], - 'Percent' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CreateTime' => [ - 'type' => 'string', - ], - 'FinishTime' => [ - 'type' => 'string', - ], + '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 completed.', '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"2b36bd19c13f4145b094c0cad80dbce5\\",\\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' => 'SubmitMediaInfoJob', + 'summary' => 'Creates an asynchronous job to retrieve media information.', + 'description' => '- This is an [asynchronous API](~~3027141~~). When you submit a task, the API returns a task ID and queues the task for background processing. You can retrieve the final result via a callback or by [querying media information tasks](~~441200~~).'."\n" + ."\n" + .'- Use this API to perform media analysis on input files. It is ideal for use cases that are not time-sensitive or that require high concurrency.', + 'changeSet' => [ + ['createdAt' => '2022-08-10T06:33:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-20T03:52:19.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'], ], - '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\\": \\"\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n }\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"GroupConfig\\": {\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"ManifestName\\": \\"\\",\\n \\"Type\\": \\"\\"\\n },\\n \\"Outputs\\": [\\n {\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"OutputFileName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Name\\": \\"\\"\\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 \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"OutputGroupDetails\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Outputs\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\"\\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' => 'GetMediaConvertJob', - ], - 'ListMediaConvertJobs' => [ - 'summary' => 'Retrieves MediaConvert tasks.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaInfoJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaInfoJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitMediaProducingJob' => [ + 'summary' => 'The `SubmitMediaProducingJob` API submits a media production job. This job provides automated processing for post-production tasks, such as editing and composing video and audio assets.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceHPAMBQ', - 'FEATUREice5MI8QL', - 'FEATUREiceCJ90B2', - 'FEATUREice6MQPM7', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'JobId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '88c6ca184c0e47098a5b665e2****', - ], + 'schema' => ['description' => 'The ID of the editing project. Call the [CreateEditingProject](~~441137~~) operation to create an editing project and obtain the `ProjectId` to submit a media producing job.'."\n" + .'>You must specify one of the `ProjectId`, `Timeline`, or `TemplateId` parameters. The other two parameters must be left empty.>', 'type' => 'string', 'required' => false, 'example' => 'xxxxxfb2101cb318xxxxx', 'title' => ''], ], [ - 'name' => 'StartOfCreateTime', + 'name' => 'Timeline', + 'in' => 'formData', + 'schema' => ['description' => 'The timeline for the cloud editing job. To arrange clips and design effects, manually construct the `Timeline` parameter.'."\n" + ."\n" + .'- A timeline primarily consists of three types of objects: tracks, clips, and effects. For more information, see [Timeline configuration](~~198823~~).'."\n" + ."\n" + .'- For more examples of timeline configurations, see [Best practices](~~2766669~~).'."\n" + ."\n" + .'>'."\n" + ."\n" + .'You must specify one of the `ProjectId`, `Timeline`, or `TemplateId` parameters. The other two parameters must be left empty.'."\n" + ."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', 'title' => ''], + ], + [ + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-01T00:00:00Z', - ], + 'schema' => ['description' => 'The ID of a template for quickly building a timeline. You can use basic and advanced templates for video editing.'."\n" + ."\n" + .'- When you submit a media producing job using a template ID, you must provide the `ClipsParam` parameter to adjust or replace clips in the template.'."\n" + ."\n" + .'- Call the [GetTemplate](~~441164~~) operation to obtain template information.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'You must specify one of the `ProjectId`, `Timeline`, or `TemplateId` parameters. The other two parameters must be left empty.'."\n" + ."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => '****96e8864746a0b6f3****', 'title' => ''], ], [ - 'name' => 'EndOfCreateTime', + 'name' => 'ClipsParam', 'in' => 'query', - 'schema' => [ - 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-15T00:00:00Z', - ], + 'schema' => ['description' => 'The clip parameters that correspond to the template, in JSON format. If `TemplateId` is specified, this parameter is required. For details about the format, see [Create and use basic templates](~~445399~~) and [Create and use advanced templates](~~445389~~).', 'type' => 'string', 'example' => 'See the template user guide.', 'required' => false, 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'ProjectMetadata', + 'in' => 'query', + 'schema' => ['description' => 'The metadata of the editing project, in JSON format. For details about the structure, see [ProjectMetadata](~~357745#title-yvp-81k-wff~~).', 'type' => 'string', 'example' => '{"Description":"Video editing description","Title":"Editing title test"}', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'OutputMediaTarget', + 'in' => 'query', + 'schema' => ['description' => 'The target type for the output media. Valid values:'."\n" + ."\n" + .'- `oss-object`: An object in your Alibaba Cloud OSS bucket.'."\n" + ."\n" + .'- `vod-media`: A media asset in Alibaba Cloud VOD.'."\n" + ."\n" + .'- `S3`: A destination that supports the S3 protocol.', 'type' => 'string', 'required' => false, 'example' => 'oss-object', 'title' => ''], + ], + [ + 'name' => 'OutputMediaConfig', + 'in' => 'query', + 'schema' => ['description' => 'The configuration for the output media target, in JSON format. You can set the URL for the output media in OSS or the storage location in a VOD bucket.'."\n" + ."\n" + .'- When outputting to OSS, the `MediaURL` parameter is required.'."\n" + ."\n" + .'- When outputting to VOD, both the `StorageLocation` and `FileName` parameters are required.'."\n" + ."\n" + .'For more information, see [OutputMediaConfig parameter examples](~~357745#title-4j6-ve7-g31~~).', 'type' => 'string', 'required' => true, 'example' => '{"MediaURL":"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4"}', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom user data in JSON format. The value can be up to 512 bytes in length. This parameter supports [job completion callback configuration](~~451631~~). The fields include:'."\n" + ."\n" + .'- `NotifyAddress`: The callback for job completion.'."\n" + ."\n" + .'- `RegisterMediaNotifyAddress`: The callback invoked when the analysis of the output media asset is complete.', 'type' => 'string', 'required' => false, 'example' => '{"NotifyAddress":"https://xx.com/xx","RegisterMediaNotifyAddress":"https://xxx.com/xx"}', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client-generated token that ensures request idempotence. This token must be a unique value of up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '****12e8864746a0a398****', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The source of the media producing job request. Valid values:'."\n" + ."\n" + .'- `OpenAPI`: A request initiated through an API call.'."\n" + ."\n" + .'- `AliyunConsole`: A request that originates from the Alibaba Cloud console.'."\n" + ."\n" + .'- `WebSDK`: A request sent from a front-end page that integrates the WebSDK.', 'type' => 'string', 'required' => false, 'example' => 'OPENAPI', 'title' => ''], + ], + [ + 'name' => 'EditingProduceConfig', + 'in' => 'query', + 'schema' => ['description' => 'The parameters for the media producing job. For configuration details, see [EditingProduceConfig parameter details](~~357745#section-8a4-pb2-hkv~~).'."\n" + ."\n" + .'> If a cover is not configured in `EditingProduceConfig`, the first frame of the video is used as the default cover.'."\n" + ."\n" + .'- `AutoRegisterInputVodMedia`: Specifies whether to automatically register the VOD media assets in your timeline to IMS. Default value: true.'."\n" + ."\n" + .'- `OutputWebmTransparentChannel`: Specifies whether to output a video with a transparent channel. Default value: false.'."\n" + ."\n" + .'- `CoverConfig`: The parameters for a custom cover.'."\n" + ."\n" + .'- ...', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "AutoRegisterInputVodMedia": "true",'."\n" + .' "OutputWebmTransparentChannel": "true"'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'MediaMetadata', 'in' => 'query', + 'schema' => ['description' => 'The metadata of the output video, in JSON format. For details about the structure, see [MediaMetadata](~~357745#97ff26d0e3c28~~).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "Title":"test-title",'."\n" + .' "Tags":"test-tags1,tags2"'."\n" + .'}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', - 'description' => 'The task status.'."\n" - ."\n" - .'* Inited: submitted'."\n" - .'* Running'."\n" - .'* Complete'."\n" - .'* Error'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Success', + 'title' => '', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '****b4549d46c88681030f6e****'], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'title' => '', 'example' => '****d80e4e4044975745c14b****'], + 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'title' => '', 'example' => '****c469e944b5a856828dc2****'], + 'VodMediaId' => ['description' => 'The VOD media ID. Returned if the output destination is VOD.', 'type' => 'string', 'title' => '', 'example' => '****d8s4h75ci975745c14b****'], + ], + '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 \\"ProjectId\\": \\"****b4549d46c88681030f6e****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"VodMediaId\\": \\"****d8s4h75ci975745c14b****\\"\\n}","type":"json"}]', + 'title' => 'SubmitMediaProducingJob', + 'description' => '- **Billing: Video editing is charged based on the duration of the output video. For more information, see [video editing](~~2840899~~). Failed jobs incur no charges.**'."\n" + ."\n" + .'- Flexible editing capabilities: Use this operation to arrange and design assets. It supports complex video editing through flexible [timeline](~~198823~~) configurations.'."\n" + ."\n" + .'- Asset reference rules: Assets referenced in the timeline can be media assets from your asset library or OSS objects. External URLs and CDN URLs are not supported. If an asset is an OSS object, MediaUrl must be an OSS URL, for example: https\\://your-bucket.oss-region-name.aliyuncs.com/your-object.ext.'."\n" + ."\n" + .'- Asynchronous job execution: This operation creates an [asynchronous task](~~3027141~~). After you submit a job, the operation returns a task ID and queues the job for background processing. The job is not yet complete at this stage. The system delivers the final result via a callback notification. You can also query the job status by [querying the editing and compositing job](~~441149~~).'."\n" + ."\n" + .'- Job status query:'."\n" + ."\n" + .' 1. Call [Query an editing and compositing job](~~441149~~) and pass the JobId to query the job status and result.'."\n" + ."\n" + .' 2. When you submit an editing and compositing job, you can include a callback URL in the **UserData** parameter of your request. When the job completes or fails, the system sends a notification to this callback URL. You can use the callback data to retrieve the job status.'."\n" + ."\n" + .'- Media asset registration and analysis: After video compositing completes, the system automatically registers a new media asset, which is initially in an analyzing state. After the analysis is complete, you can use the MediaId to retrieve the duration and resolution of the output video.'."\n" + ."\n" + .'## Limitations'."\n" + ."\n" + .'- The throttling limit for this operation is 30 QPS. Submitted jobs are queued and processed asynchronously.'."\n" + ."\n" + .' > If you exceed this limit, you may encounter a "Throttling.User" error. For more information, see ["Throttling.User" error when submitting editing jobs](~~453484~~).'."\n" + ."\n" + .'- When you submit a large number of jobs (for example, 1,000 or 10,000), the system scales out automatically, but you may experience queueing delays.'."\n" + ."\n" + .'- The maximum number of tracks is 100 for each type: video, image, and subtitle.'."\n" + ."\n" + .'- While there is no limit on the number of assets, their total size must not exceed 1 TB.'."\n" + ."\n" + .'- The region of the input or output OSS bucket must match the IMS region.'."\n" + ."\n" + .'- When the output is a video, the following resolution limits apply:'."\n" + ."\n" + .' - Both the width and height must be at least 128 px.'."\n" + ."\n" + .' - Neither the width nor the height can exceed 4096 px.'."\n" + ."\n" + .' - The shorter side cannot exceed 2160 px.', + 'requestParamsDescription' => '## **OutputMediaConfig parameter examples**'."\n" + ."\n" + .'**Example: Output to OSS**'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "MediaURL":"https://my-test-bucket.oss-cn-shanghai.aliyuncs.com/test/xxxxxtest001xxxxx.mp4",'."\n" + .' "Bitrate": 2000, '."\n" + .' "Width": 800, '."\n" + .' "Height": 680'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'When outputting to OSS, the `MediaURL` parameter is required. The `OutputMediaTarget` parameter defaults to `oss-object`, which sends the output to OSS. Other parameters are optional. The `bitrate` parameter sets the bitrate of the output file. A higher bitrate typically results in better quality, with a maximum value of 5000 Kbps. The `width` and `height` parameters set the resolution of the output file.'."\n" + ."\n" + .'The OSS URL format is: `https://bucketname.oss-region-name.aliyuncs.com/xxx/yyy.ext`'."\n" + ."\n" + .'`bucketname` is the name of your OSS bucket.'."\n" + ."\n" + .'`oss-region-name.aliyuncs.com` is the public endpoint for OSS files. For example, the public endpoints for the China (Shanghai), China (Beijing), and China (Hangzhou) regions are:'."\n" + ."\n" + .'```'."\n" + .'oss-cn-shanghai.aliyuncs.com'."\n" + .'oss-cn-hangzhou.aliyuncs.com '."\n" + .'oss-cn-beijing.aliyuncs.com'."\n" + .'```'."\n" + ."\n" + .'**Example: Output to ApsaraVideo for VOD**'."\n" + ."\n" + .'```'."\n" + .'{ '."\n" + .' "StorageLocation": "outin-*xxxxxx7d2a3811eb83da00163exxxxxx.oss-cn-shanghai.aliyuncs.com", '."\n" + .' "FileName": "output.mp4", '."\n" + .' "Bitrate": 2000, '."\n" + .' "Width": 800, '."\n" + .' "Height": 680'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'When outputting to ApsaraVideo for VOD, the `storageLocation` and `FileName` parameters are required. Set the `OutputMediaTarget` parameter to `vod-media` to send the output to an ApsaraVideo for VOD storage bucket. To find available storage locations, view the storage location of an uploaded media asset in the ApsaraVideo for VOD console.'."\n" + ."\n" + .'**Parameters in OutputMediaConfig**'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| :----------------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| MediaURL | String | The URL of the output media asset. When `OutputMediaTarget` is set to `oss-object`, specify the HTTP URL of the OSS object. For example: `http://xxx-bucket-name.oss-cn-shanghai.aliyuncs.com/`. The OSS bucket and the service making the call must be in the same region. |'."\n" + .'| StorageLocation | String | When `OutputMediaTarget` is set to `vod-media`, specify the storage location in ApsaraVideo for VOD for the media asset. The storage location is the file storage path in ApsaraVideo for VOD and must not include the `http://` prefix. For example: `outin-xxxxxx.oss-cn-shanghai.aliyuncs.com`. |'."\n" + .'| FileName | String | When `OutputMediaTarget` is set to `vod-media`, specify the file name for the output file. The file name must include the file extension but not the path. |'."\n" + .'| Width | Integer | The width of the output file. This parameter is optional. If not specified, the system uses the maximum width among all source materials. |'."\n" + .'| Height | Integer | The height of the output file. This parameter is optional. If not specified, the system uses the maximum height among all source materials. |'."\n" + .'| Bitrate | Integer | The bitrate of the output file, in Kbps. This parameter is optional. If not specified, the system uses the highest bitrate among all source materials, with a cap of 5000 Kbps. To retain the highest original bitrate even if it exceeds this cap, set `EditingProduceConfig.KeepOriginMaxBitrate` to `true`. For more information, see [EditingProduceConfig](~~357745#section-8a4-pb2-hkv~~). |'."\n" + .'| VodTemplateGroupId | String | When outputting to ApsaraVideo for VOD, you can specify a VOD transcoding template group. If transcoding is not required, set this parameter to `VOD_NO_TRANSCODE`. |', + 'changeSet' => [ + ['createdAt' => '2023-11-23T01:57:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-25T06:11:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-16T03:16:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-16T03:16:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-16T06:57:57.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-06-03T01:25:12.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaProducingJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaProducingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'SubmitPackageJob' => [ + 'summary' => 'Submits a packaging job.', + 'methods' => ['get', 'post'], + 'schemes' => ['https', 'http'], + 'security' => [ [ - 'name' => 'OrderBy', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'required' => false, 'example' => 'job-name', 'title' => ''], + ], + [ + 'name' => 'Inputs', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', - 'description' => 'The sorting order. Valid values: CreateTimeDesc: sorts by create time in descending order. CreateTimeAsc: sorts by create time in ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTimeDesc', + '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', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media object.'."\n" + ."\n" + .'- If Type is set to OSS, set this parameter to the URL of an OSS object. 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', 'required' => true, 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'Output', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '分页大小。范围: 0~100，默认值：20。', - 'description' => 'The number of entries per page. Valid values: 0 to 100. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + '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', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media object. If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported. If Type is set to Media, set this parameter to the ID of a media asset.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NextPageToken', + 'name' => 'ScheduleConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '连续分页查询时下一页的标记 (第一页没有)。', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", - 'type' => 'string', + 'description' => 'The scheduling settings.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => '', 'required' => false], + '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' => '', 'required' => false], + ], 'required' => false, - 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The user-defined data.', 'type' => 'string', 'required' => false, 'example' => '{"param": "value"}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'NextPageToken' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => 'Indicates the read position returned by the current call. An empty value means all data has been read.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****cdb3e74639973036bc84****'."\n", - ], - 'Jobs' => [ - 'description' => 'The tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task information without details.'."\n", - '$ref' => '#/components/schemas/MediaConvertJobWithoutDetail', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '2d705f385b704ee5b*******a36d93e0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"JobId\\": \\"2d705f385b704ee5b*******a36d93e0\\"\\n}","type":"json"}]', + 'title' => 'SubmitPackageJob', + 'changeSet' => [ + ['createdAt' => '2022-09-20T09:39:56.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"NextPageToken\\": \\"****cdb3e74639973036bc84****\\\\n\\",\\n \\"Jobs\\": [\\n {\\n \\"RequestId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"UserData\\": \\"\\",\\n \\"Config\\": {\\n \\"Outputs\\": [\\n {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"JobName\\": \\"\\",\\n \\"OutputGroups\\": [\\n {\\n \\"GroupConfig\\": {\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"ManifestName\\": \\"\\",\\n \\"Type\\": \\"\\"\\n },\\n \\"Outputs\\": [\\n {\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"OutputFileName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Inputs\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"PipelineId\\": \\"\\",\\n \\"ClientToken\\": \\"\\",\\n \\"TriggerSource\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"JobId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListMediaConvertJobs', - ], - 'GetMediaConnectAvailableRegion' => [ - 'summary' => 'Retrieves all regions where MediaConnect is available.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitPackageJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitPackageJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitProjectExportJob' => [ + 'summary' => 'Submits a project export task.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62693,77 +48450,98 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '41CB9D4C-4650-5723-BA89-D6824F706ACB', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Content' => [ - 'description' => 'The rsponse body.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionList' => [ - 'description' => 'The supported regions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The region name.'."\n", - 'type' => 'string', - 'example' => '[\'cn-shanghai\', \'cn-qingdao\']', - ], - ], - 'DefaultRegion' => [ - 'description' => 'The default region. You can ignore the parameter.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - ], - ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the online editing project.'."\n" + .'>Either ProjectId or Timeline must be provided.>', 'type' => 'string', 'required' => false, 'example' => '*****67ae06542b9b93e0d1c387*****', 'title' => ''], + ], + [ + 'name' => 'Timeline', + 'in' => 'formData', + 'schema' => ['description' => 'The timeline of the online editing job. For data structure, see [Timeline](~~198823~~).'."\n" + .'>Either ProjectId or Timeline must be provided.>', 'type' => 'string', 'required' => false, 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', 'title' => ''], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => ['description' => 'The export type. Valid values:'."\n" + ."\n" + .'- **BaseTimeline**: exports the timeline.'."\n" + ."\n" + .'- **AdobePremierePro**: exports an Adobe Premiere Pro project.', 'type' => 'string', 'required' => false, 'example' => 'BaseTimeline', 'title' => ''], + ], + [ + 'name' => 'OutputMediaConfig', + 'in' => 'query', + 'schema' => ['description' => 'The output path for the exported project and generated intermediate files, in JSON format. The export destination only supports OSS. Path fields:'."\n" + ."\n" + .'- **Bucket**: Required. The OSS bucket name.'."\n" + ."\n" + .'- **Prefix**: Optional. The path prefix. If not specified, it defaults to the root directory.'."\n" + ."\n" + .'- **Width**: Optional. The width of the output. The value must be a positive integer. If not provided, the system automatically calculates the value based on the input project or timeline.'."\n" + ."\n" + .'- **Height**: Optional. The height of the output. The value must be a positive integer. If not provided, the system automatically calculates the value based on the input project or timeline.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "Bucket": "example-bucket",'."\n" + .' "Prefix": "example_prefix",'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The user-defined data in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}'."\n", '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******'], + 'JobId' => ['description' => 'The ID of the project export task.', 'type' => 'string', 'title' => '', 'example' => '****cdb3e74639973036bc84****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\"\\n}","type":"json"}]', + 'title' => 'SubmitProjectExportJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitProjectExportJob', + '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.', + 'SubmitSceneBatchEditingJob' => [ + 'summary' => 'Submits a batch job to render multiple videos by providing a list of editing project IDs.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62772,83 +48550,74 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFFXT3K', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ProjectIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the MediaConnect flow.', - 'type' => 'string', - 'required' => false, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], + 'schema' => ['description' => 'A comma-separated list of editing project IDs. The video is rendered based on the timeline from each project.', 'type' => 'string', 'required' => true, 'example' => '****ae91539d46bb9000f74b40b80dd2,****ae91539000f74b40b80dd9d46bb', 'title' => ''], ], [ - 'name' => 'OutputName', + 'name' => 'OutputConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the output.', - 'type' => 'string', - 'required' => false, - 'example' => 'AliTestOutput', - ], + 'schema' => ['description' => 'The output configuration. The structure is the same as the [OutputConfig](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.3af86997GreVu9\\&scm=20140722.H_2863940._.OR_help-T_cn~zh-V_1#4111a373d0xbz) for batch video generation, except that Count and GeneratePreviewOnly are not supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '{'."\n" + .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}'], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom user data, including callback configurations. For more information, see [UserData](~~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' => 'Schema of Response', - 'description' => 'The response.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '1BCA0CFC-CBD4-5656-9D04-21B1FADBB92A', - ], - 'Description' => [ - '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', - ], - 'Content' => [ - 'description' => 'The response body.', - 'type' => 'string', - 'example' => '""', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****C702-41BE-467E-AF2E-883D4517****'], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****C702-41BE-467E-AF2E-883D4517****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => 'SubmitSceneBatchEditingJob', + 'description' => '- After submitting a job, you can call ListBatchMediaProducingJob to retrieve all matching jobs. To get detailed information for a specific job, including its status, output media asset IDs, and URLs, call GetBatchMediaProducingJob.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1BCA0CFC-CBD4-5656-9D04-21B1FADBB92A\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', - 'title' => 'ForbidMediaConnectFlowOutput', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitSceneBatchEditingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', ], - 'ResumeMediaConnectFlowOutput' => [ - 'summary' => 'Resumes an output of a MediaConnect flow. When resumed, the output can deliver the live stream to the destination.', + 'SubmitSceneMediaSelectionJob' => [ + 'summary' => 'Selects suitable clips based on the submitted videos, images, and voiceovers, and returns the selection results. Two scenarios are supported: image-text matching and highlight mashup.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62857,83 +48626,128 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFFXT3K', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The input configuration. Its structure and required fields depend on the value of JobType.'."\n" + ."\n" + .'- When JobType is set to Smart\\_Mix\\_Media\\_Select, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj).'."\n" + ."\n" + .'- When JobType is set to Screen\\_Media\\_Highlights\\_Media\\_Select, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE).', 'type' => 'string', 'example' => '{'."\n" + .'"BackgroundMusic": "****75c3936f3a8743850f2da942****",'."\n" + .'"MediaArray": ['."\n" + .'"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" + .'],'."\n" + .'"SpeechTextArray": ['."\n" + .'"A new Freshippo store just opened at the nearby mall, today is the first day",'."\n" + .'"The mall is quite busy, snacks and drinks are pretty affordable, come check it out"'."\n" + .']'."\n" + .'}', 'required' => true, 'docRequired' => true, 'title' => ''], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The editing configuration. Its structure depends on the value of JobType.'."\n" + ."\n" + .'- When JobType is set to Smart\\_Mix\\_Media\\_Select, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj).'."\n" + ."\n" + .'- When JobType is set to Screen\\_Media\\_Highlights\\_Media\\_Select, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE).', '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 ID of the MediaConnect flow.', - 'type' => 'string', - 'required' => false, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], + 'schema' => ['description' => 'The output configuration. Its structure and required fields depend on the value of JobType.'."\n" + ."\n" + .'- When JobType is set to Smart\\_Mix\\_Media\\_Select, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj).'."\n" + ."\n" + .'- When JobType is set to Screen\\_Media\\_Highlights\\_Media\\_Select, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n" + .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}'], ], [ - 'name' => 'OutputName', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the output.', - 'type' => 'string', - 'required' => false, - 'example' => 'AliTestOutput', - ], + 'schema' => ['description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~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' => 'JobType', + 'in' => 'query', + 'schema' => ['description' => 'The job type. Valid values:'."\n" + ."\n" + .'- Smart\\_Mix\\_Media\\_Select'."\n" + ."\n" + .'- Screen\\_Media\\_Highlights\\_Media\\_Select'."\n" + ."\n" + .'Differences:'."\n" + ."\n" + .'- Smart\\_Mix\\_Media\\_Select: Matches voiceover scripts with provided video/image materials to select the most relevant clips and returns the matching results. Two options are available: Common mode, which is suitable for general-purpose materials like lifestyle vlogs, travel videos, and marketing content; Movie collections, which is optimized for materials with a coherent plot and specific characters, such as TV series and movies.'."\n" + ."\n" + .'- Screen\\_Media\\_Highlights\\_Media\\_Select: Automatically identifies and selects clips that are exciting or represent key story points from longer video materials.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Smart_Mix_Media_Select', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', - ], - 'Description' => [ - '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', - ], - 'Content' => [ - 'description' => 'The response body.', - 'type' => 'string', - 'example' => '""', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****'], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', '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', - ], - 'GetMediaConnectFlowAllOutputName' => [ - 'summary' => 'Retrieves the names of all outputs for a MediaConnect flow.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => 'SubmitSceneMediaSelectionJob', + 'description' => '- After a job is submitted, you can call [ListBatchMediaProducingJob](~~2803751~~) to query submitted jobs, or [GetBatchMediaProducingJob](~~2693269~~) to query the job status and results.'."\n" + ."\n" + .'* The feature is in public preview and charges no fees.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitSceneMediaSelectionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitSceneTimelineOrganizationJob' => [ + 'summary' => 'Arranges media assets, including videos, images, background music, and voiceovers, into a complete timeline based on media selection results, and creates an editing project for preview. Two scenarios are supported: image-text matching and highlight mashup.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62942,77 +48756,154 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The input configuration. Its structure and required fields depend on the value of JobType.'."\n" + ."\n" + .'- When JobType is set to Smart\\_Mix\\_Timeline\\_Organize, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj).'."\n" + ."\n" + .'- When JobType is set to Screen\\_Media\\_Highlights\\_Timeline\\_Organize, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE).', 'type' => 'string', 'example' => '{'."\n" + .'"BackgroundMusic": "****75c3936f3a8743850f2da942****",'."\n" + .'"MediaArray": ['."\n" + .'"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" + .'],'."\n" + .'"SpeechTextArray": ['."\n" + .'"A new Freshippo store just opened at the nearby mall., today Yesfirst day of opening"'."\n" + .']'."\n" + .'}', 'required' => true, 'title' => ''], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The editing configuration. Its structure depends on the value of JobType.'."\n" + ."\n" + .'- When JobType is set to Smart\\_Mix\\_Timeline\\_Organize, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj).'."\n" + ."\n" + .'- When JobType is set to Screen\\_Media\\_Highlights\\_Timeline\\_Organize, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE).', '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 ID of the MediaConnect flow.', - 'type' => 'string', - 'required' => true, - 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', - ], + 'schema' => ['description' => 'The output configuration. Its structure and required fields depend on the value of JobType.'."\n" + ."\n" + .'- When JobType is set to Smart\\_Mix\\_Timeline\\_Organize, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj).'."\n" + ."\n" + .'- When JobType is set to Screen\\_Media\\_Highlights\\_Timeline\\_Organize, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '{'."\n" + .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}'], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~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' => 'JobType', + 'in' => 'query', + 'schema' => ['description' => 'The job type. Valid values:'."\n" + ."\n" + .'- Smart\\_Mix\\_Timeline\\_Organize: Image-text matching.'."\n" + ."\n" + .'- Screen\\_Media\\_Highlights\\_Timeline\\_Organize: Highlight mashup.'."\n" + ."\n" + .'Differences:'."\n" + ."\n" + .'- Image-text matching: Arranges a timeline based on the results of matching a voiceover script to media assets. Ideal for bulk marketing videos and general-purpose montages.'."\n" + ."\n" + .'- Highlight mashup: Arranges a timeline based on the results of highlight clip selection. Ideal for creating action-packed highlight reels from short-form dramas.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Smart_Mix_Timeline_Organize', 'title' => ''], + ], + [ + 'name' => 'MediaSelectResult', + 'in' => 'query', + 'schema' => ['description' => 'The media selection results from a previously run SubmitSceneMediaSelectionJob. You can retrieve this result by calling GetBatchMediaProducingJob.', 'type' => 'string', 'example' => '{'."\n" + .'"textMatchMediaOutputList": [{'."\n" + .'"textMatchMediaSentenceOutputList": [{'."\n" + .'"duration": 3.366667,'."\n" + .'"matchClipList": [{'."\n" + .'"endTime": 11.16,'."\n" + .'"mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" + .'"startTime": 8.04'."\n" + .'}],'."\n" + .'"text": "A new Hema Fresh store just opened at the nearby mall"'."\n" + .'},'."\n" + .'{'."\n" + .'"duration": 1.566667,'."\n" + .'"matchClipList": [{'."\n" + .'"endTime": 1.54,'."\n" + .'"mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" + .'"startTime": 0'."\n" + .'}],'."\n" + .'"text": "Today is the first day of business"'."\n" + .'}'."\n" + .']'."\n" + .'}]'."\n" + .'}', 'required' => true, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'Id of the request', - '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\']', - ], - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '559E9828-245D-5CBA-9C7A-4E01453F091F', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => 'SubmitSceneTimelineOrganizationJob', + 'description' => '- After submitting a job, you can call [ListBatchMediaProducingJob](~~2803751~~) to retrieve matching jobs. To get detailed information for a specific job, including its status, output media asset IDs, and URLs, call [GetBatchMediaProducingJob](~~2693269~~).'."\n" + ."\n" + .'* The feature is in public preview and does not charge fees.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitSceneTimelineOrganizationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', ], - 'CloseMediaConnectFlowFailover' => [ - 'summary' => 'Disables Source Failover for a MediaConnect flow.', + 'SubmitScreenMediaHighlightsJob' => [ + 'summary' => 'Analyzes media assets, such as short-form dramas, to automatically identify highlight clips and generate a highlight compilation.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -63021,74 +48912,93 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFFXT3K', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies the input configuration. For more information, see [InputConfig Parameter Description](~~2863940#dda38bf6ec2pk~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "MediaArray": ['."\n" + .' "****9d46c886b45481030f6e****",'."\n" + .' "****6c886b4549d481030f6e****"'."\n" + .' ]'."\n" + .'}'], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies the editing configuration. For more information, see [EditingConfig Parameter Description](~~2863940#9b05519d46e0x~~).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "MediaConfig": {'."\n" + .' "Volume": 1'."\n" + .' },'."\n" + .' "ProcessConfig": {'."\n" + .' "AllowTransition": true,'."\n" + .' "TransitionList": ["fadecolor"]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'OutputConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the MediaConnect flow.', - 'type' => 'string', - 'required' => false, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], + 'schema' => ['description' => 'Specifies the output configuration. For more information, see [OutputConfig Parameter Description](~~2863940#4111a373d0xbz~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}'], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the user data and callback configuration. For details about the structure, see [UserData Configuration](~~357745~~).', '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' => 'Schema of Response', - 'description' => 'The response.', + 'title' => '', + 'description' => 'The body of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '391DDF25-705C-5B38-9DB9-7A6B00D6065A', - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Content' => [ - 'description' => 'The response body.'."\n", - 'type' => 'string', - 'example' => '""', - ], + 'RequestId' => ['title' => '', 'description' => 'A unique ID for the request.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'], + 'JobId' => ['description' => 'The ID of the highlight compilation job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****'."\n", 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\\\n\\"\\n}","type":"json"}]', + 'title' => 'SubmitScreenMediaHighlightsJob', + 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a job, the system returns a job ID and queues the job for asynchronous processing. Once the job is complete, the system sends the final result through a callback notification.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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.'."\n", + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitScreenMediaHighlightsJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', ], - 'OpenMediaConnectFlowFailover' => [ - 'summary' => 'Enables Source Failover for a MediaConnect flow.', + 'SubmitSegmentationJob' => [ + 'summary' => 'Submits a job to segment a long video into multiple video segments. The output can be multiple video files or a new media asset.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -63099,73 +49009,100 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFFXT3K', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the MediaConnect flow.', - 'type' => 'string', - 'required' => false, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f'."\n", - ], + 'schema' => ['description' => 'A client token to ensure request idempotence.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****12e8864746a0a398****'], + ], + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The input configuration. For more information, see [InputConfig](~~2874121#cc59ad3082jbx~~).', 'type' => 'string', 'example' => '{'."\n" + .'"Type": "OSS",'."\n" + .'"Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" + .'}'."\n" + .'or {'."\n" + .'"Type": "Media",'."\n" + .'"Media": "ce49a020e****1ef81c1e6f6d5686302"'."\n" + .'}', 'title' => '', 'required' => false], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => ['description' => 'The output configuration. For more information, see [OutputConfig](~~2874121#cef23186a8d6w~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\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' => 'Custom user data in JSON format, with a maximum length of 512 bytes.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"test": "22"}'], + ], + [ + 'name' => 'JobParams', + 'in' => 'query', + 'schema' => ['description' => 'The job parameters. For more information, see [JobParams](~~2874121#a60357f2d5iix~~).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "Mode": "UserDefined",'."\n" + .' "Ranges": [{'."\n" + .' "In": 10,'."\n" + .' "Out": 20'."\n" + .' }, {'."\n" + .' "In": 35,'."\n" + .' "Out": 50'."\n" + .' }]'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.', + 'title' => '', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '11357BE8-4C54-58EA-890A-5AB646EDE4B2', - ], - 'Description' => [ - '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', - ], - 'Content' => [ - 'description' => 'The response body.', - 'type' => 'string', - 'example' => '""', - ], + 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'."\n"], + 'JobId' => ['description' => 'The ID of the segmentation job.', 'type' => 'string', 'title' => '', 'example' => '****cdb3e74639973036bc84****'."\n"], ], + '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" - .'* After Source Failover is enabled, you can add an additional source. The input type of the two sources must be identical.'."\n", - ], - 'UpdateMediaConnectFlowOutput' => [ - 'summary' => 'Modifies an output of a MediaConnect flow.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\\\n\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\\\n\\"\\n}","type":"json"}]', + 'title' => 'SubmitSegmentationJob', + 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a job, the system returns a job ID and processes the job in the background. You can get the results through a [callback notification](~~3027141~~) or by calling the [Get smart task results](~~441172~~) operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSegmentationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitSmarttagJob' => [ + 'summary' => 'Submits a smart tagging job.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -63176,695 +49113,865 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], + 'schema' => ['description' => 'The video title can contain Chinese characters, English letters, digits, and hyphens (-). It cannot start with a special character and must not exceed 256 bytes.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-title-**** '."\n", 'title' => ''], ], [ - 'name' => 'OutputName', + 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => 'The output name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AliTestOutput', - ], + 'schema' => ['description' => 'The description of the video content can contain Chinese characters, English letters, digits, and hyphens (-). It cannot start with a special character and must not exceed 1 KB.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'example content **** '."\n", 'title' => ''], ], [ - 'name' => 'Cidrs', + 'name' => 'ContentType', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '19.168.1.1/32,18.168.1.1/16', - ], + 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'SrtLatency', + 'name' => 'ContentAddr', 'in' => 'query', - 'schema' => [ - 'description' => 'The latency for the SRT stream. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'SrtPassphrase', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'description' => 'The SRT key. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FICUBPX4Q77DYHRF', - ], + 'schema' => ['description' => 'Additional request parameters, specified as a JSON string. For example: `{"needAsrData":true, "needOcrData":false}`.'."\n" + ."\n" + .'- `needAsrData`: Specifies whether to include the raw Automatic Speech Recognition (ASR) results in the analysis output. The default is `false`.'."\n" + ."\n" + .'- `needOcrData`: Specifies whether to include the raw Optical Character Recognition (OCR) results in the analysis output. The default is `false`.'."\n" + ."\n" + .'- `needMetaData`: Specifies whether to include metadata in the analysis output. The default is `false`.'."\n" + ."\n" + .'- `nlpParams`: A JSON object that specifies the input parameters for the Natural Language Processing (NLP) operator. If left empty, the operator is not used. For details, see the `nlpParams` table below.', 'type' => 'string', 'required' => false, 'example' => '{"needAsrData":true, "needOcrData":false, "nlpParams":{"sourceLanguage":"cn"}}'."\n", 'title' => ''], ], [ - 'name' => 'SrtPbkeyLen', + 'name' => 'NotifyUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The encryption key length. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['description' => 'The callback URL. Only HTTP and HTTPS URLs are supported.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/endpoint/aliyun/ai?id=76401125000***', 'title' => ''], ], [ - 'name' => 'OutputToUrl', + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom data to include in the callback. If you use Message Service (MNS) for callbacks, this data is included in the message. The maximum length is 1 KB.', 'type' => 'string', 'required' => false, 'example' => '{“a”:"test"}', 'title' => ''], + ], + [ + 'name' => 'Input', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The output URL. You can modify this parameter only when the output type is RTMP-PUSH or SRT-Caller.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The input file for the job.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the input media file. Valid values:'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- Media'."\n" + ."\n" + .'- URL', 'type' => 'string', 'required' => false, 'example' => 'Media', 'title' => ''], + 'Media' => ['description' => '- If you set the `Type` parameter to `OSS`, specify the OSS URL of the media file. Example: `OSS://test-bucket/video/202208/test.mp4`.'."\n" + ."\n" + .'- If you set the `Type` parameter to `Media`, specify the media ID. Example: `c5c62d8f0361337cab312dce8e77dc6d`.'."\n" + ."\n" + .'- If you set the `Type` parameter to `URL`, specify the HTTP or HTTPS URL of the media file. Example: `https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4`.', 'type' => 'string', 'required' => false, 'example' => 'c5c62d8f0361337cab312dce8e77dc6d', 'title' => ''], + ], 'required' => false, - 'example' => 'rtmp://push.test.alivecdn.com/live/alitest', + 'docRequired' => true, + 'example' => '', ], ], [ - 'name' => 'PlayerLimit', + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the template that specifies the analysis algorithms to use.', 'type' => 'string', 'required' => false, 'example' => '39f8e0bc005e4f309379701645f4'."\n", 'title' => ''], + ], + [ + 'name' => 'ScheduleConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The maximum number of viewers.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The scheduling configurations.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The ID of the pipeline. Pipelines separate business workloads and bind message notifications.'."\n" + ."\n" + .'If you do not specify this parameter, the default pipeline is used. The default pipeline has a concurrency of 2. To increase the concurrency, submit a ticket.', 'type' => 'string', 'required' => false, 'example' => 'acdbfe4323bcfdae', 'title' => ''], + 'Priority' => ['description' => 'The priority of the job. This feature is not yet implemented. You can leave this parameter empty or specify any value.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + ], 'required' => false, - 'example' => '5', + 'example' => '', ], ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => ['description' => 'Dynamic parameters for the job, which temporarily override or supplement the base template specified by `TemplateId`. The service merges the dynamic and template parameters to generate the final configuration for the current job and validates it before execution.'."\n" + ."\n" + .'- Merge rules:'."\n" + ."\n" + .'1. Values in the request override corresponding values in the template.'."\n" + ."\n" + .'2. Fields in the request that do not exist in the template are added to the configuration.'."\n" + ."\n" + .'- Currently supported dynamic fields:'."\n" + ."\n" + .'1. `FaceCategoryIds`: A list of face library IDs for recognition, separated by commas (,). You can include both system and custom library IDs.'."\n" + ."\n" + .'- Note: These dynamic parameters affect only the current job and do not modify the template itself.', 'type' => 'string', 'required' => false, 'example' => '{"FaceCategoryIds":"custom_face_lib1"}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", 'type' => 'object', 'properties' => [ - 'Content' => [ - 'title' => 'Id of the request', - 'description' => 'The response body.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D737D0BC-4CB5-55AA-8119-B540C95DFE6A', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], + 'JobId' => ['description' => 'The ID of the smart tagging job. Save this ID for subsequent API calls.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', + 'title' => 'SubmitSmarttagJob', + 'description' => '### Prerequisites'."\n" + ."\n" + .'Before submitting a smart tagging job, you must configure the analysis types in a template. For more information, see [CreateCustomTemplate](~~441184~~).'."\n" + ."\n" + .'### Limitations'."\n" + ."\n" + .'- The smart tagging feature is available only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.'."\n" + ."\n" + .'- The default concurrency for the smart tagging pipeline is 2. To request a higher concurrency limit, [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?spm=a2c4g.11186623.0.0.645019b6Btnu4q).'."\n" + ."\n" + .'- Smart tagging jobs and their results are retained for 180 days, after which they are automatically deleted.', + 'requestParamsDescription' => '### nlpParams'."\n" + ."\n" + .'| Feature | Parameter | Type | Required | Description | Example |'."\n" + .'| -------------------------------- | ------------------------ | ------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |'."\n" + .'| | nlpParams | object | Yes | Contains all parameters related to NLP processing. This parameter is required if the analysis types in the template include NLP. Otherwise, the job fails. | {"sourceLanguage":"cn"} |'."\n" + .'| Transcription | sourceLanguage | string | Yes | The source language model for transcription. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), `fspk` (mixed Chinese and English), and `ja` (Japanese). If the audio contains multiple languages, you can set this parameter to `multilingual` to recognize text in each language. Use this parameter with `languageHints`. Only 16 kHz audio is supported. | "cn" |'."\n" + .'| | languageHints | list[string] | No | [Specifies the languages to recognize when `sourceLanguage` is set to `multilingual`](https://help.aliyun.com/zh/tingwu/offline-transcribe-of-audio-and-video-files?spm=a2c4g.11186623.help-menu-454189.d_2_1_0.72df7a7eLXlL19&scm=20140722.H_2609582._.OR_help-T_cn~zh-V_1#c49c0bf020mpj). Valid values (multiple can be selected): `cn` (Chinese), `en` (English), `yue` (Cantonese), `ja` (Japanese), `ko` (Korean), `de` (German), `fr` (French), and `ru` (Russian). This parameter restricts the scope of language detection and prevents misidentification of irrelevant languages. It takes effect only when `sourceLanguage` is set to `multilingual`. | \\[\'cn\', \'en\', \'yue\'] |'."\n" + .'| | transcriptionModel | string | No | Specifies the transcription model to use. Valid value: `fun-asr`. This model must be used with `sourceLanguage` set to `multilingual`. | fun-asr |'."\n" + .'| | diarizationEnabled | boolean | No | Specifies whether to enable speaker diarization. The default is `false`. | true |'."\n" + .'| | speakerCount | integer | No | Configures the speaker count for speaker diarization. `0`: The number of speakers is automatically detected. `2`: Diarizes the audio for two speakers. | 2 |'."\n" + .'| Hotword | phraseId | string | No | The ID of the hotword vocabulary. | ce9c2a34b6d847bf92a77d0a196f*** |'."\n" + .'| PPT extraction and summarization | pptExtractionEnabled | boolean | No | Specifies whether to enable PPT extraction and summarization. If enabled, the service extracts PPT slides from the video and generates a summary. The default is `false`. | true |'."\n" + .'| Summarization | summarizationEnabled | boolean | No | Specifies whether to enable summarization. If enabled, the service can generate a full-text summary, speaker summary, and other results. | true |'."\n" + .'| | summarizationTypes | string | No | When summarization is enabled, you must specify the desired summarization types. Valid values: `Paragraph` (full-text summary), `Conversational` (speaker summary), `QuestionsAnswering` (Q&A summary), and `MindMap` (mind map). | "Paragraph,Conversational,QuestionsAnswering,MindMap" |'."\n" + .'| Translation | translationEnabled | boolean | No | Specifies whether to enable translation. | true |'."\n" + .'| | targetLanguages | string | No | The target languages for translation. This parameter is required if translation is enabled. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), and `fspk` (mixed Chinese and English). | "en,cn" |'."\n" + .'| Chapter detection | autoChaptersEnabled | boolean | No | Specifies whether to enable automatic chapter generation. The output includes chapter titles and summaries. | true |'."\n" + .'| Meeting assistance | meetingAssistanceEnabled | boolean | No | Specifies whether to enable the meeting assistance feature. The output includes categories, keywords, key sentences, and action items. | true |', + 'extraInfo' => '访问错误中心查看更多错误码。', + 'changeSet' => [ + ['createdAt' => '2025-11-17T14:18:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-25T12:28:16.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"D737D0BC-4CB5-55AA-8119-B540C95DFE6A\\"\\n}","type":"json"}]', - 'title' => 'UpdateMediaConnectFlowOutput', - 'description' => '* You can modify an output only when the flow is in the offline state.'."\n" - .'* The output type cannot be modified.'."\n", - ], - 'GetMediaConnectFlowOutput' => [ - 'summary' => 'Obtains information about an output of a MediaConnect flow.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmarttagJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSmarttagJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitSnapshotJob' => [ + 'summary' => 'This API submits a snapshot job. Specify a media file by its ID or URL, a time point, and the desired format. The API then generates the snapshot and saves it to the specified location.', + 'methods' => ['post', 'get'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'Name', 'in' => 'query', + 'schema' => ['description' => 'The name of the snapshot job.', 'type' => 'string', 'required' => false, 'example' => 'SampleJob', 'title' => ''], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', + 'description' => 'The input for the snapshot job.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the input. Valid values:'."\n" + ."\n" + .'- `OSS`: an OSS file URL.'."\n" + ."\n" + .'- `Media`: a media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'Media', 'title' => ''], + 'Media' => ['description' => 'The input media asset.'."\n" + ."\n" + .'- If `Type` is `OSS`, specify the OSS URL of the input file.'."\n" + ."\n" + .'- If `Type` is `Media`, specify the ID of the media asset.'."\n" + ."\n" + .'The 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" + .'
In these formats, `bucket` is the name of an OSS bucket located in the same region as the current project, and `object` is the file path.
'."\n" + ."\n" + .'> The OSS bucket specified in the URL must be added to IMS [storage management](~~609918~~) before use.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object.mp4', 'title' => ''], + ], 'required' => true, - 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OutputName', + 'name' => 'Output', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the output that you want to query.'."\n", - 'type' => 'string', + 'description' => 'The output destination for the snapshot job.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the output. Valid values:'."\n" + ."\n" + .'- `OSS`: an OSS file URL.'."\n" + ."\n" + .'- `Media`: a media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The output media asset.'."\n" + ."\n" + .'- If `Type` is `OSS`, specify the OSS URL for the output file.'."\n" + ."\n" + .'- If `Type` is `Media`, specify the ID of the output media asset.'."\n" + ."\n" + .'The 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 located in the same region as the current project, and `object` is the file path.'."\n" + ."\n" + .'- When capturing multiple static snapshots, the `object` must contain the `{Count}` placeholder.'."\n" + ."\n" + .'- When capturing a sprite, the `object` must contain the `{TileCount}` placeholder.'."\n" + ."\n" + .'- For WebVTT snapshots, the filename in the `object` path must end with `.vtt`.'."\n" + ."\n" + .'> The OSS bucket specified in the URL must be added to IMS [storage management](~~609918~~) before use.', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/output-{Count}.jpg', 'title' => ''], + ], 'required' => true, - 'example' => 'AliTestOutput', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", + 'description' => 'The snapshot template configuration.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => 'The response body.'."\n", + 'TemplateId' => ['description' => 'The snapshot template ID.', 'type' => 'string', 'required' => true, 'example' => '****96e8864746a0b6f3****'."\n", 'title' => ''], + 'OverwriteParams' => [ + 'description' => 'Parameters used to override settings in the specified template.', 'type' => 'object', 'properties' => [ - 'OutputName' => [ - 'description' => 'The output name.'."\n", - 'type' => 'string', - 'example' => 'AliTestInput', - ], - 'OutputProtocol' => [ - 'description' => 'The output type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RTMP-PUSH'."\n" - .'* SRT-Caller'."\n" - .'* RTMP-PULL'."\n" - .'* SRT-Listener'."\n" - .'* Flow'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RTMP-PUSH' => 'RTMP-PUSH', - 'SRT-Caller' => 'SRT-Caller', - 'RTMP-PULL' => 'RTMP-PULL', - 'SRT-Listener' => 'SRT-Listener', - 'Flow' => 'Flow', - ], - 'example' => 'SRT-PULL', - ], - 'Cidrs' => [ - 'description' => 'The IP address whitelist in CIDR format. CIDR blocks are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '10.211.0.0/17', - ], - 'OutputUrl' => [ - 'description' => 'The output URL.'."\n", - 'type' => 'string', - 'example' => 'srt://1.2.3.4:1025', - ], - 'SrtLatency' => [ - 'description' => 'The latency for the SRT stream. Unit: milliseconds. This parameter is returned when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'SrtPassphrase' => [ - 'description' => 'The SRT key. This parameter is returned when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'example' => 'FICUBPX4Q77DYHRF', - ], - '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" - .'* 16'."\n" - .'* 24'."\n" - .'* 32'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '0', - 16 => '16', - 24 => '24', - 32 => '32', - ], - 'example' => '32', - ], - 'PairFlowId' => [ - 'description' => 'The ID of the destination flow. This parameter is returned when the output type is Flow.'."\n", - 'type' => 'string', - 'example' => '805fbdd0-575e-4146-b35d-ec7f63937b20', - ], - 'PairInputName' => [ - 'description' => 'The source name of the destination flow. This parameter is returned when the output type is Flow.'."\n", - 'type' => 'string', - 'example' => 'AliTestInput', - ], - 'PlayerLimit' => [ - 'description' => 'The maximum number of viewers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CreateTime' => [ - 'description' => 'The time when the flow was created.'."\n", - 'type' => 'string', - 'example' => '2024-07-18T01:29:24Z', - ], - 'Forbid' => [ - 'type' => 'string', - ], - ], - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0DB23DCE-0D69-598B-AA7C-7268D55E2F89', - ], - ], - ], - ], - ], - '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' => 'GetMediaConnectFlowOutput', - 'description' => '* When the specified flow ID is not available, an error code is returned.'."\n", - ], - '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', + 'Type' => ['description' => 'The snapshot type.', 'type' => 'string', 'required' => false, 'example' => 'Sprite', 'title' => ''], + 'FrameType' => ['description' => 'The frame type.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'intra'], + 'Count' => ['description' => 'The number of snapshots to capture.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'Interval' => ['description' => 'The interval between snapshots.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'Time' => ['description' => 'The start time for capturing snapshots.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + 'Width' => ['description' => 'The output image width.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720', 'title' => ''], + 'Height' => ['description' => 'The output image height.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '480', 'title' => ''], + 'BlackLevel' => ['description' => 'The threshold for detecting and filtering black content in the first frame. This applies only to multi-frame snapshots.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'PixelBlackThreshold' => ['description' => 'The threshold for determining whether a pixel is black.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], + 'SpriteSnapshotConfig' => [ + 'title' => '', + 'description' => 'The sprite configuration.', + 'type' => 'object', + 'properties' => [ + 'CellWidth' => ['description' => 'The width of each tile. Default: the width of the output snapshot.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720', 'title' => ''], + 'CellHeight' => ['description' => 'The height of each tile. Default: the height of the output snapshot.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '480', 'title' => ''], + 'Padding' => ['description' => 'The padding between tiles, in pixels. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'Margin' => ['description' => 'The margin around the sprite, in pixels. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'Columns' => ['description' => 'The number of columns in the sprite grid.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'Lines' => ['description' => 'The number of rows in the sprite grid.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'Color' => ['description' => 'The background color.', 'type' => 'string', 'required' => false, 'example' => '#000000', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'IsSptFrag' => ['description' => 'Specifies whether to stitch snapshots into a single sprite. This applies only to WebVTT snapshots.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], ], - ], - 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ScheduleConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + 'description' => 'The scheduling configuration.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'required' => false, 'example' => '****96e8864746a0b6f3****'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OutputName', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the output that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AliTestOutput', - ], + 'schema' => ['description' => 'Custom user data, passed as a JSON-formatted string.', 'type' => 'string', 'required' => false, 'example' => '{"test parameter": "test value"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'title' => 'Id of the request', - 'description' => 'The response body.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DF73E08E-F807-50F5-A2BD-B76391EAE8FF', - ], + 'RequestId' => ['description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], + 'JobId' => ['description' => 'The ID of the submitted job.', 'type' => 'string', 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => 'SubmitSnapshotJob', + 'description' => 'This is an [asynchronous interface](~~3027141~~). Submitting a task returns a task ID and queues it for asynchronous processing. A callback delivers the final result. Alternatively, you can check the task status by [querying screenshot task details](~~441203~~).', + 'changeSet' => [ + ['createdAt' => '2022-08-10T06:33:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], - '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" - .'* When a flow is in the online state, its outputs cannot be deleted.'."\n", - ], - 'AddMediaConnectFlowOutput' => [ - 'summary' => 'Creates an output for a MediaConnect flow.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSnapshotJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitSportsHighlightsJob' => [ + 'summary' => 'Starts a job to generate a highlight video from sports footage with commentary.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'abilityTreeCode' => '235590', + 'abilityTreeNodes' => ['FEATUREiceANRKXC'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f'."\n", - ], + 'schema' => ['description' => 'A client-generated token to ensure request idempotency.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****12e8864746a0a398****'."\n"], ], [ - 'name' => 'OutputProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => 'The output type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RTMP-PUSH'."\n" - .'* SRT-Caller'."\n" - .'* RTMP-PULL'."\n" - .'* SRT-Listener'."\n" - .'* Flow'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'RTMP-PUSH' => 'RTMP-PUSH', - 'SRT-Caller' => 'SRT-Caller', - 'RTMP-PULL' => 'RTMP-PULL', - 'SRT-Listener' => 'SRT-Listener', - 'Flow' => 'Flow', - ], - 'example' => 'RTMP-PULL', - ], + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The input configuration. For more information, see [input configuration parameters](~~2843158#5cbc796a9cuu8~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "SportsCategory": "basketball",'."\n" + .' "InputMedia": "http://test-bucket.oss-cn-******.basketball-0707.mp4",'."\n" + .' "FaceRegister": ['."\n" + .' {'."\n" + .' "FaceUrls": ["http://testcdn.com/front.jpg", "http://testcdn.com/side.jpg"],'."\n" + .' "Name": "James"'."\n" + .' }'."\n" + .' ],'."\n" + .' "SlowMotionLogoRegister": {'."\n" + .' "SlowMotionLogoUrls": ["http://testcdn.com/logo1.jpg", "http://testcdn.com/logo2.jpg"]'."\n" + .' },'."\n" + .' "TransferNameRegister": ['."\n" + .' {'."\n" + .' "OriginalName": "IND",'."\n" + .' "TransferName": "印第安纳步行者"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'], ], [ - 'name' => 'OutputToUrl', + 'name' => 'OutputConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The output URL. This parameter is required when OutputProtocol is set to RTMP-PUSH or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp://push.test.alivecdn.com/live/alitest', - ], + 'schema' => ['description' => 'The output configuration. For more information, see [output configuration parameters](~~2843158#b7dad99fe5q0r~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}'], ], [ - 'name' => 'OutputName', + 'name' => 'UserData', 'in' => 'query', + 'schema' => ['description' => 'The user data, containing business and callback configurations. For more information about the structure, see [user data configuration](~~357745~~).', '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' => [ - 'description' => 'The output name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AliTestOutput', + 'title' => '', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****36-3C1E-4417-BDB2-1E034F****'."\n"], + 'JobId' => ['description' => 'The sports highlight job ID.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****'."\n", 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\\\n\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\\\n\\"\\n}","type":"json"}]', + 'title' => 'SubmitSportsHighlightsJob', + 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a job, the API immediately returns a job ID. The job is then queued for asynchronous processing. A callback delivers the final result.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Cidrs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address whitelist in CIDR format. Separate multiple CIDR blocks with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '83.17.231.31/32', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSportsHighlightsJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'SubmitStandardCustomizedVoiceJob' => [ + 'summary' => 'Submits a standard human voice cloning job. After you call this operation, the JobId is returned. The training process is asynchronous. During training, you can call the GetCustomizedVoiceJob operation to query information such as the job state.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PlayerLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of viewers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'PairInputName', + 'name' => 'VoiceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The source name of the destination flow. This parameter is required when OutputProtocol is set to Flow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AliTestInput', - ], + 'schema' => ['description' => 'The voice name.'."\n" + ."\n" + .'- The name can be up to 32 characters in length.', 'type' => 'string', 'example' => 'Basic', 'required' => false, 'title' => ''], ], [ - 'name' => 'SrtLatency', + 'name' => 'Gender', 'in' => 'query', - 'schema' => [ - 'description' => 'The latency for the SRT stream. This parameter is required when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The gender. Valid values:'."\n" + ."\n" + .'- female'."\n" + ."\n" + .'- male', 'type' => 'string', 'required' => false, 'example' => 'female', 'title' => ''], ], [ - 'name' => 'SrtPbkeyLen', + 'name' => 'Authentication', 'in' => 'query', - 'schema' => [ - 'description' => 'The encryption key length. This parameter is required when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['description' => '- The media asset ID of the authentication audio.'."\n" + ."\n" + .'- Upload an audio file for identity authentication. If the voiceprint extracted from the uploaded file differs from that of the training file, the job fails.'."\n" + ."\n" + .' \\*\\*'."\n" + ."\n" + .' **Note**: Clearly read and record the following text: I confirm to customize human voice cloning and provide audio files that contain my voice for training. I promise that I am responsible for the customized content and that the content complies with laws and regulations.', 'type' => 'string', 'required' => false, 'example' => '****571c704445f9a0ee011406c2****', 'title' => ''], ], [ - 'name' => 'SrtPassphrase', + 'name' => 'Audios', 'in' => 'query', - 'schema' => [ - 'description' => 'The SRT key. This parameter is required when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BETTERG08S01', - ], + 'schema' => ['description' => '- The material assets IDs of the materials for training.'."\n" + ."\n" + .'- Separate multiple media IDs with commas (,).'."\n" + ."\n" + .'> : The total duration of all materials must be within 15 to 30 minutes. The duration of each material must be greater than 1 minute.', 'type' => 'string', 'required' => false, 'example' => '****571c704445f9a0ee011406c2****,****571c704445f9a0ee011406c2****,****571c704445f9a0ee011406c2****', 'title' => ''], ], [ - 'name' => 'PairFlowId', + 'name' => 'DemoAudioMediaURL', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the destination flow. This parameter is required when OutputProtocol is set to Flow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8666ec062190f00e263012666319a5be', - ], + 'schema' => ['description' => 'The URL of the sample audio file.'."\n" + ."\n" + .'- If this parameter is specified, a sample audio file is generated at the specified Object Storage Service (OSS) URL after the training is complete.'."\n" + ."\n" + .'- If this parameter is not specified, no sample audio file is generated.'."\n" + ."\n" + .' \\*\\*'."\n" + ."\n" + .' **Note**: The URL must be a valid public OSS URL within your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'https://your-bucket.oss-cn-shanghai.aliyuncs.com/demo.mp3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => 'The response body.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], + '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' => [ - 'OutputUrl' => [ - 'description' => 'The output URL.'."\n", - 'type' => 'string', - 'example' => 'srt://1.2.3.4:1025', - ], + 'JobId' => ['description' => 'The ID of the human voice cloning job.', 'type' => 'string', 'example' => '****d718e2ff4f018ccf419a7b71****', 'title' => ''], ], - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '11AA9E73-FBA0-58DC-97BA-D606D847BCB6', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'title' => '', + 'example' => '', ], ], + '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" - .'* A flow can have a maximum of four outputs.'."\n" - .'* The output names in the same flow cannot be duplicated.'."\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" - .'* RTMP-PULL: An output that you can pull using the returned streaming URL over the RTMP protocol.'."\n" - .'* SRT-Caller: An output that the MediaConnect flow pushes to the server you specified over the SRT protocol.'."\n" - .'* SRT-Listener: An output that you can pull using the returned streaming URL over the SRT protocol.'."\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.'."\n", - ], - 'DeleteMediaConnectFlowInput' => [ - 'summary' => 'Deletes the source of a MediaConnect flow.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', + 'title' => 'SubmitStandardCustomizedVoiceJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitStandardCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitSyncMediaInfoJob' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'abilityTreeCode' => '139552', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job-name', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Input', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The input of the job.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the media object.'."\n" + ."\n" + .'- OSS: an Object Storage Service (OSS) object.'."\n" + ."\n" + .'- Media: a media asset.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media object.'."\n" + ."\n" + .'- If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported.'."\n" + ."\n" + .'> Before you use the OSS bucket in the URL, you must add the bucket on the [Storage Management](~~609918~~) page of the Intelligent Media Services (IMS) console.'."\n" + ."\n" + .'- If Type is set to Media, set this parameter to the ID of a media asset.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + ], 'required' => true, - 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', + 'example' => '', ], ], [ - 'name' => 'InputName', + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The user data.', 'type' => 'string', 'example' => 'user-data', 'title' => '', 'required' => false], + ], + [ + 'name' => 'ScheduleConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'title' => '', + 'description' => 'The scheduling parameters. This parameter is optional.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The ID of the MPS queue to which the job was submitted.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => '', 'required' => false], + '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' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'Id of the request', - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Content' => [ - 'description' => 'The response body.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C0C02296-113C-5838-8FE9-8F3A32998DDC', + '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 OSS object.'."\n" + ."\n" + .'- Media: a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media object. If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported. 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' => '', + ], + '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' => '999e68259c924f52a6be603cbb3f91cc'], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'file.m3u8', 'title' => ''], + 'FileStatus' => ['description' => 'The state of the file. Valid values:'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'FileType' => ['description' => 'The file type.', '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 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' => [ + '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 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 file.', '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' => ''], + ], + '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 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' => ''], + ], + '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' => ''], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + '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 \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"999e68259c924f52a6be603cbb3f91cc\\",\\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' => 'SubmitSyncMediaInfoJob', + 'summary' => 'Submits a media file in synchronous mode for media information analysis.', + 'description' => 'Analyze an input media file in synchronous mode. This operation is suitable for scenarios that require high real-time performance and low concurrency. If it takes an extended period of time to obtain the media information about the input media file, the request may time out or the obtained information may be inaccurate. We recommend that you call the [SubmitMediaInfoJob](~~441222~~) operation to obtain media information.', + 'changeSet' => [ + ['createdAt' => '2022-08-10T06:33:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-20T07:14:41.000Z', 'description' => '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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"C0C02296-113C-5838-8FE9-8F3A32998DDC\\"\\n}","type":"json"}]', - 'title' => 'DeleteMediaConnectFlowInput', - 'description' => '* When the specified flow ID is not available, an error code is returned.'."\n" - .'* When a flow is in the online state, its source cannot be deleted.'."\n" - .'* You can delete the source only after all outputs of the flow have been deleted.'."\n", - ], - 'UpdateMediaConnectFlowInput' => [ - 'summary' => 'Modifies the source of a MediaConnect flow.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSyncMediaInfoJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSyncMediaInfoJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SubmitTextGenerateJob' => [ + 'summary' => 'Generates marketing copy based on the provided keywords, text length, and number of copy variations. Due to the complexities of the Chinese language, the length of the output text may differ from the requested length. After submitting the job, call the `GetSmartHandleJob` operation with the returned job ID to query the job status and retrieve the results.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -63874,923 +49981,2467 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'abilityTreeCode' => '209430', + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ - 'name' => 'FlowId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], - ], - [ - 'name' => 'Cidrs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '19.168.1.1/32,18.168.1.1/16', - ], - ], - [ - 'name' => 'SrtLatency', - 'in' => 'query', - 'schema' => [ - 'description' => 'The latency for the SRT stream. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], - ], - [ - 'name' => 'SrtPassphrase', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'description' => 'The SRT key. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FICUBPX4Q77DYHRF', - ], + 'schema' => ['description' => 'The job title.'."\n" + ."\n" + .'\\- The maximum length is 128 bytes.'."\n" + ."\n" + .'\\- UTF-8 encoding is required.', 'type' => 'string', 'example' => 'Test title', 'required' => false, 'title' => ''], ], [ - 'name' => 'SrtPbkeyLen', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The encryption key length. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['description' => 'The job description, with a maximum length of 1,024 bytes (UTF-8 encoded).', 'type' => 'string', 'example' => 'Test description', 'required' => false, 'title' => ''], ], [ - 'name' => 'InputFromUrl', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The source URL. You can modify this parameter only when the source type is RTMP-PULL or SRT-Listener.'."\n", + 'description' => 'The job type.'."\n" + ."\n" + .'**Valid values:**'."\n" + ."\n" + .'- `MarketingCopy`: Generates marketing copy.'."\n" + ."\n" + .'- `Title`: Generates a short video title.'."\n" + ."\n" + .'- `StoryboardScript`: Generates a storyboard script from text.', + 'enumValueTitles' => ['MarketingCopy' => 'marketing copy', 'Title' => 'short video title'], 'type' => 'string', 'required' => false, - 'example' => 'rtmp://pull.test.alivecdn.com/live/alitest', + 'example' => 'MarketingCopy', + 'title' => '', ], ], [ - 'name' => 'MaxBitrate', + 'name' => 'GenerateConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2000000', - ], + 'schema' => ['description' => 'The generation configuration, in JSON format.'."\n" + ."\n" + .'If `Type` is set to `Title` or `MarketingCopy`, specify the following fields:'."\n" + ."\n" + .'- `keywords`: The keywords used to generate the title or marketing copy. This parameter is required.'."\n" + ."\n" + .'- `textLength`: The target length of the generated text, in characters. Valid values: 5 to 1,000. The actual length of the output is less than or equal to this value. This parameter is required.'."\n" + ."\n" + .'- `targetCount`: The number of copy variations to generate. Valid values: 1 to 1,000. This parameter is required.'."\n" + ."\n" + .'If `Type` is set to `StoryboardScript`, specify the following field:'."\n" + ."\n" + .'- `originText`: The original text used to generate the storyboard script. This parameter is required.', 'type' => 'string', 'example' => '{"keywords":"New cake shop, animal cream","textLength":100,"targetCount":3}'."\n" + .'or'."\n" + .'{"originText": "A new cake shop just opened on the street, selling cream cakes, fruit cakes, bread, muffins, etc. A coffee shop opened across from the cake shop, with a steady stream of customers."}', 'required' => false, 'title' => ''], ], [ - 'name' => 'InputName', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The custom settings in JSON format. The maximum length is 512 bytes. You can use this parameter to specify a [custom callback address](~~451631~~).', 'type' => 'string', 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'Id of the request', - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Content' => [ - 'description' => 'The response body.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '52451256-FFEA-5D2E-AA60-EE7053000F22', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], + 'JobId' => ['description' => 'The smart job ID.', 'type' => 'string', 'example' => '****d80e4e4044975745c14b****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"52451256-FFEA-5D2E-AA60-EE7053000F22\\"\\n}","type":"json"}]', - 'title' => 'UpdateMediaConnectFlowInput', - 'description' => '* You can modify the source only when the flow is in the offline state.'."\n" - .'* The source type cannot be modified.'."\n", - ], - 'GetMediaConnectFlowInput' => [ - 'summary' => 'Obtains information about the source of a MediaConnect flow.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', + 'title' => 'SubmitTextGenerateJob', + 'description' => '- Before you call this operation, you must purchase the enterprise subscription service to obtain the required permissions. For more information, see [subscription billing](~~439260#3285adfad70dw~~).'."\n" + ."\n" + .'- This operation is billed based on the number of tokens in the generated content. The number of tokens is positively correlated with the number of characters in the generated text. For more information, see [smart video creation](~~2840901~~). No charges are incurred for failed jobs.'."\n" + ."\n" + .'- This is an [asynchronous API](~~3027141~~). After you submit a job, the operation returns a job ID. The job is then queued for background processing. The service delivers results via a callback. You can also call [GetSmartHandleJob](~~441172~~) to actively poll for the job status.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTextGenerateJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitTextGenerateJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitTraceAbJob' => [ + 'summary' => 'Submits a job to generate A/B stream variants of a video for forensic watermarking.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'Input', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', + 'description' => 'The input video for the A/B stream forensic watermarking job.'."\n" + ."\n" + .'> - The Object Storage Service (OSS) file or media asset must be in the same region where Intelligent Media Services (IMS) is deployed.'."\n" + .'>'."\n" + .'> - This operation supports only videos that are three minutes or longer. Using a shorter video may cause the API call to fail or produce no output.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the input file. Valid values:'."\n" + ."\n" + .'1. `OSS`: The file is specified by an OSS URL.'."\n" + ."\n" + .'2. `Media`: The file is specified by a media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The location of the input file. This can be an OSS URL or a media asset ID.'."\n" + .'The supported OSS URL formats are:'."\n" + ."\n" + .'1\\. `oss:///`'."\n" + ."\n" + .'2\\. `http(s)://.oss-[regionId].aliyuncs.com/`'."\n" + ."\n" + .'In these formats, `` is the name of the OSS bucket, which must be in the same region as your project, and `` is the path to the file.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object', 'title' => ''], + ], 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", + 'description' => 'The output location for the A/B stream job. This must be an OSS directory.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'InputName' => [ - 'description' => 'The source name.'."\n", - 'type' => 'string', - 'example' => 'AliTestInput', - ], - 'InputProtocol' => [ - 'description' => 'The source type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RTMP-PUSH'."\n" - .'* SRT-Caller'."\n" - .'* RTMP-PULL'."\n" - .'* SRT-Listener'."\n" - .'* Flow'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RTMP-PUSH' => 'RTMP-PUSH', - 'SRT-Caller' => 'SRT-Caller', - 'RTMP-PULL' => 'RTMP-PULL', - 'SRT-Listener' => 'SRT-Listener', - 'Flow' => 'Flow', - ], - 'example' => 'RTMP-PUSH', - ], - 'MaxBitrate' => [ - 'description' => 'The maximum bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000000', - ], - 'Cidrs' => [ - 'description' => 'The IP address whitelist in CIDR format. CIDR blocks are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '10.211.0.0/17', - ], - 'InputUrl' => [ - 'description' => 'The source URL.'."\n", - 'type' => 'string', - 'example' => 'rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be', - ], - 'SrtLatency' => [ - 'description' => 'The latency for the SRT stream. Unit: milliseconds. This parameter is returned when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'SrtPassphrase' => [ - 'description' => 'The SRT key. This parameter is returned when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'example' => 'FICUBPX4Q77DYHRF', - ], - '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" - .'* 16'."\n" - .'* 24'."\n" - .'* 32'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '0', - 16 => '16', - 24 => '24', - 32 => '32', - ], - 'example' => '32', - ], - 'PairOutputName' => [ - 'description' => 'The output of the source flow. This parameter is returned when the source type is Flow.'."\n", - 'type' => 'string', - 'example' => 'AliTestOutput', - ], - 'PairFlowId' => [ - 'description' => 'The ID of the source flow. This parameter is returned when the source type is Flow.'."\n", - 'type' => 'string', - 'example' => '05c3adf4-aa0e-421d-a991-48ceae3e642e', - ], - 'CreateTime' => [ - 'description' => 'The time when the flow was created.'."\n", - 'type' => 'string', - 'example' => '2024-07-18T01:29:24Z', - ], - 'BackupInputName' => [ - 'type' => 'string', - ], - 'BackupCidrs' => [ - 'type' => 'string', - ], - 'BackupInputUrl' => [ - 'type' => 'string', - ], - 'BackupSrtLatency' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'BackupSrtPassphrase' => [ - 'type' => 'string', - ], - 'BackupSrtPbkeyLen' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'BackupCreateTime' => [ - 'type' => 'string', - ], - 'BackupMaxBitrate' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'InputStatus' => [ - 'type' => 'string', - ], - 'BackupInputStatus' => [ - 'type' => 'string', - ], + 'Type' => ['description' => 'The type of the output object.'."\n" + .'Valid values:'."\n" + ."\n" + .'- `OSS`: An OSS object.'."\n" + ."\n" + .'- `Media`: A media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The output path. Specify an OSS directory URL or a media asset ID. If you specify an OSS URL, use one of the following formats for the output directory:'."\n" + ."\n" + .'1\\. `oss:////`'."\n" + ."\n" + .'2\\. `http(s)://.oss-[regionId].aliyuncs.com//`'."\n" + ."\n" + .'In these formats, `` is the name of the OSS bucket, which must be in the same region as your project, and `` is the output directory path.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/dir/', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time for watermark embedding, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => ['description' => 'The total duration for watermark embedding, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '360', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The watermark level, which specifies the embedding channel. Valid values: `0` (U channel), `1` (UV channels), and `2` (YUV channels).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'User data to include in the request. The maximum length is 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'CipherBase64ed', + 'in' => 'query', + 'schema' => ['description' => 'The Base64-encoded encryption key.', 'type' => 'string', 'required' => false, 'example' => 'Qh6OdgIMcliQSI1fReOw****'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '', + 'description' => 'Contains the IDs for the submitted job and the output media asset.', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****', 'title' => ''], + 'TraceMediaId' => ['description' => 'The ID of the media asset created for tracing.', 'type' => 'string', 'example' => 'bf53333264f4d80648792021e****', 'title' => ''], ], + 'example' => '', ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D4C231DF-103A-55FF-8D09-E699552457DE', - ], + 'Message' => ['description' => 'The response message. A value of `ok` indicates a successful request.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The unique identifier for the request. If you encounter an issue, provide this ID for technical support.', 'type' => 'string', 'example' => '******36-3C1E-4417-BDB2-1E034F******'], + 'StatusCode' => ['description' => 'The HTTP status code. A value of `200` indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"TraceMediaId\\": \\"bf53333264f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'SubmitTraceAbJob', + 'description' => '- This operation supports only videos that are three minutes or longer. Submitting a job for a shorter video may cause the API call to fail or produce no output.'."\n" + ."\n" + .'- This is an [asynchronous interface](~~3027141~~). After you submit a job, the system returns a job ID and processes the job asynchronously. You can obtain the processing result through a callback or by [querying the list of A/B stream forensic watermarking jobs](~~2862133~~).', + 'changeSet' => [ + ['createdAt' => '2025-05-14T03:05:49.000Z', 'description' => 'Request parameters changed'], ], - '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 },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"D4C231DF-103A-55FF-8D09-E699552457DE\\"\\n}","type":"json"}]', - 'title' => 'GetMediaConnectFlowInput', - 'description' => '* When the specified flow ID is not available, an error code is returned.'."\n", - ], - 'AddMediaConnectFlowInput' => [ - 'summary' => 'Creates a source for a MediaConnect flow.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceAbJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitTraceAbJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'translator' => 'machine', + ], + 'SubmitTraceExtractJob' => [ + 'summary' => 'Submits a trace watermark extraction job.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'FlowId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], - ], - [ - 'name' => 'InputProtocol', + 'name' => 'Input', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The source type.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The input video from which to extract the watermark.'."\n" ."\n" - .'* RTMP-PUSH'."\n" - .'* SRT-Caller'."\n" - .'* RTMP-PULL'."\n" - .'* SRT-Listener'."\n" - .'* Flow'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'RTMP-PUSH' => 'RTMP-PUSH', - 'SRT-Caller' => 'SRT-Caller', - 'RTMP-PULL' => 'RTMP-PULL', - 'SRT-Listener' => 'SRT-Listener', - 'Flow' => 'Flow', + .'> - The OSS object or media asset must be in the same region as your IMS service.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The input type. Valid values:'."\n" + ."\n" + .'- OSS: An OSS object URL.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The input source. Specify an OSS object URL or a media asset ID.'."\n" + ."\n" + .'An OSS object URL can be in one of the following formats:'."\n" + ."\n" + .'1\\. oss\\://bucket/object'."\n" + ."\n" + .'In these formats, `bucket` is the name of an OSS bucket in the same region as your IMS service, and `object` is the path of the OSS object.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object', 'title' => ''], ], - 'example' => 'RTMP-PUSH', + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InputName', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The source name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AliTestInput', - ], + 'schema' => ['description' => 'The user-defined data. Maximum length: 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'MaxBitrate', + 'name' => 'Params', 'in' => 'query', + 'schema' => ['description' => 'Extraction job parameters, specified as a JSON string. The following parameters are supported:'."\n" + ."\n" + .'- `m3u8Type`: The algorithm type. The default value is `v1`.'."\n" + ."\n" + .' - `v1`: Extracts an m3u8 playlist with absolute paths.'."\n" + ."\n" + .' - `v2`: Extracts an m3u8 playlist with relative paths.', 'type' => 'string', 'required' => false, 'example' => '{"m3u8Type":"v1"}'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The maximum bitrate. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2000000', + 'title' => '', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d80648792021e****', 'title' => ''], + ], + 'example' => '', + ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****'], + 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'SubmitTraceExtractJob', + 'description' => '- The digital watermarking APIs are available only in the China (Shanghai) and China (Beijing) regions.'."\n" + ."\n" + .'- Trace watermark extraction is supported only for videos that are 3 minutes or longer. Jobs for shorter videos will fail.'."\n" + ."\n" + .'- This is an [asynchronous API](~~3027141~~). After you submit a job, a job ID is returned. The job is not immediately complete and is queued for asynchronous processing. You can get the final result through a callback notification or check the job status by calling the [GetTraceExtractJob](~~2862130~~) operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceExtractJob'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Cidrs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address whitelist in CIDR format. Separate multiple CIDR blocks with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '19.168.1.1/32,18.168.1.1/16', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitTraceExtractJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'translator' => 'machine', + ], + 'SubmitTraceM3u8Job' => [ + 'summary' => 'Submits a job to process an M3U8 file for video watermarking for tracing.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'InputFromUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source URL. This parameter is required when the source type is RTMP-PULL or SRT-Listener.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp://pull.test.alivecdn.com/live/alitest', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], + ], + 'parameters' => [ [ - 'name' => 'PairFlowId', + 'name' => 'TraceMediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the source flow. This parameter is required when the source type is Flow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '805fbdd0-575e-4146-b35d-ec7f63937b20', - ], + 'schema' => ['description' => 'The media ID of the processed A/B stream for video watermarking for tracing. This ID is returned in the response when you submit the A/B stream job.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '437bd2b516ffda105d07b12a9a82****', 'title' => ''], ], [ - 'name' => 'PairOutputName', + 'name' => 'Output', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The output of the source flow. This parameter is required when the source type is Flow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AliTestOutput', + 'description' => 'The OSS destination for the output M3U8 file.'."\n" + ."\n" + .'> The OSS bucket must be in the same region as your MPS service.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the output destination. Valid values:'."\n" + ."\n" + .'1. `OSS`: an OSS file location.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The output file path. Only OSS paths are supported. You can use one of the following formats:'."\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 your project, and `object` specifies the file path.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/object', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SrtLatency', + 'name' => 'Trace', 'in' => 'query', - 'schema' => [ - 'description' => 'The latency for the SRT stream. This parameter is required the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The watermark content to embed.', 'type' => 'string', 'example' => 'Trace watermark test', 'docRequired' => true, 'required' => true, 'title' => ''], ], [ - 'name' => 'SrtPassphrase', + 'name' => 'KeyUri', 'in' => 'query', - 'schema' => [ - 'description' => 'The SRT key. This parameter is required when the source type is SRT-Listener or SRT-Caller.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BETTERG08S01', - ], + 'schema' => ['description' => 'The URI of the key server.', 'type' => 'string', 'required' => false, 'example' => 'https://cipher.abc.com', 'title' => ''], ], [ - 'name' => 'SrtPbkeyLen', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'description' => 'The encryption key length. This parameter is required when the source type is SRT-Listener or SRT-Caller.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - .'* 16'."\n" - .'* 24'."\n" - .'* 32'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '0', - 16 => '16', - 24 => '24', - 32 => '32', - ], - 'example' => '32', - ], + 'schema' => ['description' => 'A JSON string that contains parameters for the watermarking job. The following parameter is supported:'."\n" + ."\n" + .'- `m3u8Type`: The algorithm type. The default value is `v1`.'."\n" + ."\n" + .' - `v1`: Generates an M3U8 file that uses an absolute path. The file can be played directly. The signature is valid for 24 hours. After expiration, you must submit a new job to get a new M3U8 file.'."\n" + ."\n" + .' - `v2`: Generates an M3U8 file that uses a relative path. This file must be stored in the same directory as the TS files.', 'type' => 'string', 'required' => false, 'example' => '{"m3u8Type":"v1"}'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => 'The response body.'."\n", + 'Data' => [ + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'InputUrl' => [ - 'description' => 'The source URL.'."\n", - 'type' => 'string', - 'example' => 'rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be', - ], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'bfb786c639894f4d8064879202****', 'title' => ''], ], + 'example' => '', ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '11357BE8-4C54-58EA-890A-5AB646EDE4B2', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"InputUrl\\": \\"rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"11357BE8-4C54-58EA-890A-5AB646EDE4B2\\"\\n}","type":"json"}]', - 'title' => 'AddMediaConnectFlowInput', - 'description' => '* When the specified flow ID is not available, an error code is returned.'."\n" - .'* A flow can have only one source.'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d8064879202****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => 'SubmitTraceM3u8Job', + 'description' => '- You must first obtain a media ID by submitting a job for an A/B stream with video watermarking for tracing. This operation uses the returned media ID for processing.'."\n" ."\n" - .'### [](#)Source type'."\n" + .'- Currently, digital watermarking-related operations are supported only in the China (Shanghai) and China (Beijing) regions.'."\n" ."\n" - .'* RTMP-PUSH: An input that you can push to the returned URL over the RTMP protocol.'."\n" - .'* RTMP-PULL: An input that the MediaConnect flow pulls from the specified server over the RTMP protocol.'."\n" - .'* SRT-Listener: An input that you can push to the returned URL over the SRT protocol.'."\n" - .'* SRT-Caller: An input that the MediaConnect flow pulls from the specified server over the SRT protocol.'."\n" - .'* Flow: An input that uses the output of another upstream flow. You must specify an upstream flow and its output. The output type of the upstream flow must be SRT-Listener or RTMP-PULL. By default, a dedicated line is used when flows are cascaded. This allows for cross-region distribution among multiple flows.'."\n", - ], - 'DeleteMediaConnectFlow' => [ - 'summary' => 'Deletes a MediaConnect flow.', - 'methods' => [ - 'post', + .'- This is an [asynchronous call](~~3027141~~). When you submit a job, the system returns a task ID and processes the job in the background. The initial response does not mean the job is complete. You can get the final result through a [callback notification](~~2862136~~) or by calling the [QueryTraceM3u8JobList](~~2862136~~) operation to check the job\'s status.'."\n" + ."\n" + .'- The signature for an M3U8 file generated by a video watermarking for tracing job is valid for 24 hours after job completion. You must query and use the watermarking information within this period. If the signature expires, you can no longer retrieve the watermarking information. To regain access, you must submit a new job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceM3u8Job'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitTraceM3u8Job', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'machine', + ], + 'SubmitTranscodeJob' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'Name', 'in' => 'query', + 'schema' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job-name', 'title' => '', 'required' => false], + ], + [ + 'name' => 'InputGroup', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The input group for the job. A single input creates a transcoding job. Multiple inputs create a media merging job.', + 'type' => 'array', + 'items' => [ + 'description' => 'The job input.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The media object type. Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media value:'."\n" + ."\n" + .'- If Type is OSS, this is a URL that supports the OSS or HTTP protocol.'."\n" + ."\n" + .'> You must add the OSS bucket in the URL to IMS [storage management](~~609918~~) before you use it.'."\n" + ."\n" + .'- If Type is Media, this is a media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + 'InputUrl' => ['description' => 'The input stream path:'."\n" + ."\n" + .'- This parameter takes effect only when Type is Media. It lets you select a specific file from the media asset as the input.'."\n" + ."\n" + .'- The system checks whether the input URL exists in the media asset.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => '', 'required' => false], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', + 'example' => 'job-name', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'OutputGroup', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'title' => 'Id of the request', - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of `0` indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Content' => [ - 'description' => 'The response body.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5AEC17BD-D80B-5F78-BE1B-F07DFA0C8622', + 'title' => '', + 'description' => 'The output group for 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 media object type. Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media value:'."\n" + ."\n" + .'- If Type is OSS, this is a URL that supports the OSS or HTTP protocol.'."\n" + ."\n" + .'> You must add the OSS bucket in the URL to IMS [storage management](~~609918~~) before you use it.'."\n" + ."\n" + .'- If Type is Media, this is a media asset ID.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + 'OutputUrl' => ['description' => 'The output stream path:
'."\n" + .'This parameter takes effect only when Type is Media. It lets you select a specific file from the media asset as the output.
'."\n" + .'Valid placeholders:

'."\n" + ."\n" + .'- {MediaId}: The media asset ID.'."\n" + ."\n" + .'- {JobId}: The sub-job ID.'."\n" + ."\n" + .'- {MediaBucket}: The bucket where the media asset resides.'."\n" + ."\n" + .'- {ExtName}: The file extension. This is the output format specified in the transcoding template.'."\n" + ."\n" + .'- {DestMd5}: The MD5 hash of the transcoded output file.'."\n" + ."\n" + .'> 1. You must include both {MediaId} and {JobId} in this parameter.'."\n" + .'>'."\n" + .'> 2. The output bucket must be the same as the bucket where the media asset resides.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4'], + ], + 'required' => true, + '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', 'required' => true, 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => '', + 'description' => 'The video settings.', + 'type' => 'object', + 'properties' => [ + 'Codec' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => 'H.264', 'title' => '', 'required' => false], + 'Profile' => ['description' => 'The encoding profile. Valid values: baseline, main, and 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' => '', 'required' => false], + 'Bitrate' => ['description' => 'The average video bitrate. Valid values: \\[10, 50000]. Unit: Kbps.', 'type' => 'string', 'example' => '3000', 'title' => '', 'required' => false], + 'Crf' => ['description' => 'The constant rate factor (CRF), which controls the trade-off between quality and bitrate. Valid values: \\[0, 51]. Default values: 23 for H.264 and 26 for H.265.'."\n" + ."\n" + .'> If you set Crf, the Bitrate setting is ignored.', 'type' => 'string', 'example' => '23', 'title' => '', 'required' => false], + 'Width' => ['description' => 'The width. Valid values: \\[128, 4096]. Unit: px. Default value: The original video width.', 'type' => 'string', 'example' => '1920', 'title' => '', 'required' => false], + 'Height' => ['description' => 'The height. Valid values: \\[128, 4096]. Unit: px. Default value: The original video height.', 'type' => 'string', 'example' => '1080', 'title' => '', 'required' => false], + 'Fps' => ['description' => 'The frame rate. Valid values: (0, 60]. Default value: The frame rate of the input file.'."\n" + ."\n" + .'> If the frame rate of the input file exceeds 60, the system uses 60.', 'type' => 'string', 'example' => '25', 'title' => '', 'required' => false], + 'Gop' => ['description' => 'The maximum number of frames between keyframes. Valid values: \\[1, 1080000]. Default value: 250.', 'type' => 'string', 'example' => '250', 'title' => '', 'required' => false], + 'Preset' => ['description' => 'The video encoder preset. Only H.264 supports this parameter. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.', 'type' => 'string', 'example' => 'medium', 'title' => '', 'required' => false], + 'ScanMode' => ['description' => 'The scan mode. Valid values: interlaced and progressive.', 'type' => 'string', 'example' => 'progressive', 'title' => '', 'required' => false], + 'PixFmt' => ['description' => 'The video color format. Valid values include yuv420p and yuvj420p.', 'type' => 'string', 'example' => 'yuv420p', 'title' => '', 'required' => false], + 'Remove' => ['description' => 'Specifies whether to remove the video.', 'type' => 'string', 'example' => 'false', 'title' => '', 'required' => false], + 'Crop' => ['description' => 'The video cropping method. Two options are available:'."\n" + ."\n" + .'- Automatically detect and crop black bars. Set this to border.'."\n" + ."\n" + .'- Custom cropping. Format: width:height:left:top. Example: 1280:800:0:140', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => '', 'required' => false], + 'Pad' => ['description' => 'The padding configuration for black bars. Format: width:height:left:top. Example: 1280:800:0:140', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => '', 'required' => false], + 'LongShortMode' => ['description' => 'Specifies whether to enable automatic rotation for portrait or landscape videos (also known as long-side/short-side mode).', 'type' => 'string', 'example' => 'false', 'title' => '', 'required' => false], + 'Bufsize' => ['description' => 'The buffer size. Valid values: \\[1000, 128000]. Default value: 6000. Unit: Kb.', 'type' => 'string', 'example' => '6000', 'title' => '', 'required' => false], + 'Maxrate' => ['description' => 'The peak video bitrate. Valid values: \\[10, 50000]. Unit: Kbps.', 'type' => 'string', 'example' => '9000', 'title' => '', 'required' => false], + 'AbrMax' => ['description' => 'The maximum bitrate for adaptive bitrate streaming (ABR). This applies only to narrow-high 1. Valid values: \\[10, 50000]. Unit: Kbps.', 'type' => 'string', 'example' => '6000', 'title' => '', 'required' => false], + ], + 'required' => false, + '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' => '', 'required' => false], + 'Profile' => ['description' => 'The audio encoding profile. When Codec is AAC, valid values are aac\\_low, aac\\_he, aac\\_he\\_v2, aac\\_ld, and aac\\_eld.', 'type' => 'string', 'example' => 'aac_low', 'title' => '', 'required' => false], + 'Samplerate' => ['description' => 'The sample rate. Default value: 44100. Valid values: 22050, 32000, 44100, 48000, and 96000. Unit: Hz.', 'type' => 'string', 'example' => '44100', 'title' => '', 'required' => false], + 'Bitrate' => ['description' => 'The audio bitrate of the output file. Valid values: \\[8, 1000]. Unit: Kbps. Default value: 128.', 'type' => 'string', 'example' => '128', 'title' => '', 'required' => false], + 'Channels' => ['description' => 'The number of sound channels. Default value: 2.', 'type' => 'string', 'example' => '2', 'title' => '', 'required' => false], + 'Remove' => ['description' => 'Specifies whether to delete the audio stream.', 'type' => 'string', 'example' => 'false', 'title' => '', 'required' => false], + 'Volume' => [ + 'title' => '', + 'description' => 'The volume control.', + 'type' => 'object', + 'properties' => [ + 'Method' => ['description' => 'The volume adjustment method.', 'type' => 'string', 'example' => 'auto', 'title' => '', 'required' => false], + 'IntegratedLoudnessTarget' => ['description' => 'The target loudness level.', 'type' => 'string', 'example' => '-6', 'title' => '', 'required' => false], + 'TruePeak' => ['description' => 'The true peak volume.', 'type' => 'string', 'example' => '-1', 'title' => '', 'required' => false], + 'LoudnessRangeTarget' => ['description' => 'The loudness range.', 'type' => 'string', 'example' => '8', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'Container' => [ + 'title' => '', + 'description' => 'The container format settings.', + 'type' => 'object', + 'properties' => [ + 'Format' => ['description' => 'The container format.', 'type' => 'string', 'example' => 'mp4', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + 'MuxConfig' => [ + 'title' => '', + 'description' => 'The multiplexing settings.', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '', + 'description' => 'The segment settings.', + 'type' => 'object', + 'properties' => [ + 'Duration' => ['description' => 'The segment duration.', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + 'ForceSegTime' => ['description' => 'The forced segment time points.', 'type' => 'string', 'example' => '2,3', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'TransConfig' => [ + 'description' => 'The conditional transcoding parameters.', + 'type' => 'object', + 'properties' => [ + 'TransMode' => ['description' => 'The video transcoding mode. Valid values:'."\n" + ."\n" + .'- onepass: Used for adaptive bitrate (ABR) streaming. Encoding is faster than twopass.'."\n" + ."\n" + .'- twopass: Used for variable bitrate (VBR) streaming. Encoding is slower than onepass.'."\n" + ."\n" + .'- CBR: Constant bitrate mode.'."\n" + ."\n" + .'Default value: onepass.', 'type' => 'string', 'required' => false, 'example' => 'onepass', 'title' => ''], + 'IsCheckReso' => ['description' => 'Specifies whether to check the video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. IsCheckResoFail has higher priority.'."\n" + ."\n" + .'- true: Check the resolution. If the input video resolution (width or height) is smaller than the output setting, transcode at the input resolution.'."\n" + ."\n" + .'- false: Do not check the resolution.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'IsCheckResoFail' => ['description' => 'Specifies whether to check the video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. IsCheckResoFail has higher priority.'."\n" + ."\n" + .'- true: Check the resolution. If the input video resolution (width or height) is smaller than the output setting, return a failure.'."\n" + ."\n" + .'- false: Do not check the resolution.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'IsCheckVideoBitrate' => ['description' => 'Specifies whether to check the video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. IsCheckVideoBitrateFail has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input video bitrate is lower than the output setting, transcode at the input bitrate.'."\n" + ."\n" + .'- false: Do not check the bitrate.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'IsCheckVideoBitrateFail' => ['description' => 'Specifies whether to check the video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. IsCheckVideoBitrateFail has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input video bitrate is lower than the output setting, return a failure.'."\n" + ."\n" + .'- false: Do not check the bitrate.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'IsCheckAudioBitrate' => ['description' => 'Specifies whether to check the audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. IsCheckAudioBitrateFail has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input audio bitrate is lower than the output setting, transcode at the input bitrate.'."\n" + ."\n" + .'- false: Do not check the bitrate.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'- Empty and the codec differs from the input source: false.'."\n" + ."\n" + .'- Empty and the codec matches the input source: true.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'IsCheckAudioBitrateFail' => ['description' => 'Specifies whether to check the audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. IsCheckAudioBitrateFail has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input audio bitrate is lower than the output setting, return a failure.'."\n" + ."\n" + .'- false: Do not check the bitrate.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'AdjDarMethod' => ['description' => 'The method used to adjust the display aspect ratio. This parameter takes effect only when both Width and Height are specified. You can use it with LongShortMode.'."\n" + ."\n" + .'Valid values: rescale, crop, pad, and none.'."\n" + ."\n" + .'Default value: none.', 'type' => 'string', 'required' => false, 'example' => 'none', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + 'ImageWatermarks' => [ + 'title' => '', + 'description' => 'The image watermark configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image watermark configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Width' => ['description' => 'The width of the image watermark on the output video. Values can be one of the following:'."\n" + ."\n" + .'- Integer: The pixel width of the watermark image.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the watermark width to the output video width.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '32', 'title' => '', 'required' => false], + 'Height' => ['description' => 'The height of the image watermark on the output video. Values can be one of the following:'."\n" + ."\n" + .'- Integer: The pixel height of the watermark image.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the watermark height to the output video height.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '32', 'title' => '', 'required' => false], + 'Dx' => ['description' => 'The horizontal offset of the image watermark relative to the output video. Default value: 0.'."\n" + ."\n" + .'Values can be one of the following:'."\n" + ."\n" + .'- Integer: The offset in pixels.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the horizontal offset to the output video width.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + 'Dy' => ['description' => 'The vertical offset of the image watermark relative to the output video. Default value: 0.'."\n" + ."\n" + .'Values can be one of the following:'."\n" + ."\n" + .'- Integer: The offset in pixels.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the vertical offset to the output video height.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + 'ReferPos' => ['description' => 'The position of the watermark.'."\n" + ."\n" + .'- Valid values: TopRight (top-right), TopLeft (top-left), BottomRight (bottom-right), and BottomLeft (bottom-left).'."\n" + ."\n" + .'- Default value: TopRight.', 'type' => 'string', 'example' => 'TopLeft', 'title' => '', 'required' => false], + 'Timeline' => [ + 'title' => '', + 'description' => 'The display time settings for a dynamic watermark.', + 'type' => 'object', + 'properties' => [ + 'Start' => ['description' => 'The start time of the watermark.'."\n" + ."\n" + .'- Unit: seconds'."\n" + ."\n" + .'- Valid values: numbers'."\n" + ."\n" + .'- Default value: 0', 'type' => 'string', 'example' => '00:00:05', 'title' => '', 'required' => false], + 'Duration' => ['description' => 'The duration of the watermark.'."\n" + ."\n" + .'- Valid values: \\[number, ToEND]'."\n" + ."\n" + .'- Default value: ToEND', 'type' => 'string', 'example' => 'ToEND', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + 'File' => [ + 'title' => '', + 'description' => 'The watermark image file.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The media object type. Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => '', 'required' => false], + 'Media' => ['description' => 'The media value:'."\n" + ."\n" + .'- If Type is OSS, this is a URL that supports the OSS or HTTP protocol.'."\n" + ."\n" + .'- If Type is Media, this is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'TextWatermarks' => [ + 'title' => '', + 'description' => 'The text watermark configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The text watermark configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The watermark text. It does not need to be Base64 encoded. The string must be UTF-8 encoded.', 'type' => 'string', 'example' => 'Test watermark', 'title' => '', 'required' => false], + 'FontName' => ['description' => 'The font. Default: SimSun.', 'type' => 'string', 'example' => 'SimSun', 'title' => '', 'required' => false], + 'FontColor' => ['description' => 'The color.', 'type' => 'string', 'example' => '#006400', 'title' => '', 'required' => false], + 'FontAlpha' => ['description' => 'The font transparency.'."\n" + ."\n" + .'- Valid values: (0, 1]'."\n" + ."\n" + .'- Default: 1.0', 'type' => 'string', 'example' => '1.0', 'title' => '', 'required' => false], + 'Top' => ['description' => 'The top margin of the text.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Valid values: \\[0, 4096]', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + 'Left' => ['description' => 'The left margin of the text.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Valid values: \\[0, 4096]', 'type' => 'string', 'example' => '10', 'title' => '', 'required' => false], + 'FontSize' => ['description' => 'The font size.'."\n" + ."\n" + .'- Default value: 16'."\n" + ."\n" + .'- Valid values: (4, 120)', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => '', 'required' => false], + 'BorderWidth' => ['description' => 'The outline width.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Valid values: (0, 4096]', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], + 'BorderColor' => ['description' => 'The outline color. Default: Black. For more values, see BorderColor.', 'type' => 'string', 'example' => '#006400', 'title' => '', 'required' => false], + 'Adaptive' => ['description' => 'Adjusts the font size based on the output video size. Valid values: true or false. Default: false.', 'type' => 'string', 'example' => 'false', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Subtitles' => [ + 'title' => '', + 'description' => 'The subtitle burn-in configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subtitle burn-in configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Format' => ['description' => 'The subtitle file format.', 'type' => 'string', 'example' => 'vtt', 'title' => '', 'required' => false], + 'CharEnc' => ['description' => 'The file encoding format.', 'type' => 'string', 'example' => 'UTF-8', 'title' => '', 'required' => false], + 'File' => [ + 'title' => '', + 'description' => 'The subtitle file.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The media object type. Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => '', 'required' => false], + 'Media' => ['description' => 'The media value:'."\n" + ."\n" + .'- If Type is OSS, this is a URL that supports the OSS or HTTP protocol.'."\n" + ."\n" + .'- If Type is Media, this is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Encryption' => [ + 'title' => '', + 'description' => 'The encryption configuration.', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => ['description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'- PrivateEncryption: Alibaba Cloud proprietary cryptography.'."\n" + ."\n" + .'- HLSEncryption: HLS standard encryption.', 'type' => 'string', 'required' => false, 'example' => 'PrivateEncryption', 'title' => ''], + 'CipherText' => ['description' => 'The ciphertext of the key for standard encryption.', 'type' => 'string', 'example' => 'MTYi00NDU0LTg5O****', 'title' => '', 'required' => false], + 'DecryptKeyUri' => ['description' => 'The decryption service endpoint for standard encryption.', 'type' => 'string', 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', 'title' => '', 'required' => false], + 'KeyServiceType' => ['description' => 'The key service type for standard encryption. Valid values:'."\n" + ."\n" + .'- KMS'."\n" + ."\n" + .'- Base64', 'type' => 'string', 'example' => 'KMS', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + 'CombineConfigs' => [ + 'title' => '', + 'description' => 'The configuration for merging multiple inputs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The merging configuration.', + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => ['description' => 'The audio stream index.', 'type' => 'string', 'example' => '0 or exclude', 'required' => true, 'title' => ''], + 'VideoIndex' => ['description' => 'The video stream index.', 'type' => 'string', 'example' => '0 or exclude', 'required' => true, 'title' => ''], + 'Start' => ['description' => 'The start time of the input stream. Default: 0.', 'type' => 'number', 'format' => 'double', 'example' => '0.0', 'title' => '', 'required' => false], + 'Duration' => ['description' => 'The duration of the input stream. Default: The video duration.', 'type' => 'number', 'format' => 'double', 'example' => '20.0', 'title' => '', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], ], + 'required' => true, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'example' => 'user-data', ], ], - ], - '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" - .'* When a flow is deleted, its source and outputs are also deleted.'."\n" - .'* When a flow is in the online state, it cannot be deleted.'."\n", - ], - 'UpdateMediaConnectFlowStatus' => [ - 'summary' => 'Modifies the state of 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', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], + 'schema' => ['description' => 'Custom settings in JSON format. The length is limited to 512 bytes. Supports [custom webhook address configuration](~~451631~~).', 'type' => 'string', 'example' => 'user-data', 'title' => '', 'required' => false], ], [ - 'name' => 'Status', + 'name' => 'ScheduleConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The flow state. Valid values:'."\n" - ."\n" - .'* online: starts the flow.'."\n" - .'* offline: stops the flow.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'offline' => 'offline', - 'online' => 'online', - ], - 'example' => 'online', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The job scheduling information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', - ], - 'Content' => [ - 'description' => 'The response body.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'PipelineId' => ['description' => 'The MPS queue ID.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => '', 'required' => false], + 'Priority' => ['description' => 'The job priority. A larger number indicates a higher priority. Valid values: 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => '', 'required' => false], ], + 'required' => false, + 'example' => 'job-name', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\",\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"ok\\",\\n \\"RetCode\\": 0\\n}","type":"json"}]', - 'title' => 'UpdateMediaConnectFlowStatus', - ], - 'GetMediaConnectFlow' => [ - 'summary' => 'Obtains information about a specific MediaConnect flow.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], - 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], + 'schema' => ['description' => 'The idempotence key. Ensures request idempotence.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****12e8864746a0a398****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => 'The response body.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], + 'TranscodeParentJob' => [ + 'title' => '', + 'description' => 'TranscodeParentJobWithSubJobDTO', 'type' => 'object', 'properties' => [ - 'FlowId' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], - 'FlowName' => [ - 'description' => 'The flow name.'."\n", - 'type' => 'string', - 'example' => 'AliTestFlow', - ], - 'FlowStatus' => [ - 'description' => 'The state of the flow.'."\n", - 'type' => 'string', - 'example' => 'online', - ], - 'CreateTime' => [ - 'description' => 'The time when the flow was created.'."\n", - 'type' => 'string', - 'example' => '2024-07-18T01:29:24Z', + 'TranscodeJobList' => [ + 'title' => '', + 'description' => 'The list of sub-jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The sub-job details.', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['description' => 'The time the job was created.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], + 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'transcode-job', 'title' => ''], + 'ParentJobId' => ['description' => 'The parent job ID.', 'type' => 'string', 'example' => '8b2198504dd340b7b3c9842a74fc9baa', 'title' => ''], + 'JobId' => ['description' => 'The sub-job ID.', 'type' => 'string', 'example' => '7d6a7e0d4db2457a8d45ff5d43e1bf0a', 'title' => ''], + 'JobIndex' => ['description' => 'The index of the sub-job within the entire job.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'InputGroup' => [ + 'title' => '', + 'description' => 'The input group for the job. A single input creates a transcoding job. Multiple inputs create a media merging job.', + 'type' => 'array', + 'items' => [ + 'description' => 'The job input.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The media object type. Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media value:'."\n" + ."\n" + .'- If Type is OSS, this is a URL that supports the OSS or HTTP protocol.'."\n" + ."\n" + .'- If Type is Media, this is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + 'InputUrl' => ['description' => 'The input stream path:'."\n" + ."\n" + .'- This parameter takes effect only when Type is Media. It lets you select a specific file from the media asset as the input.'."\n" + ."\n" + .'- The system checks whether the input URL exists in the media asset.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ProcessConfig' => [ + 'title' => '', + 'description' => 'The transcoding processing configuration.', + 'type' => 'object', + 'properties' => [ + 'Transcode' => [ + 'title' => '', + 'description' => 'The transcoding configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => '', + 'description' => 'The video settings.', + 'type' => 'object', + 'properties' => [ + 'Codec' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], + 'Profile' => ['description' => 'The encoding profile. Valid values: baseline, main, and 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' => 'The average video bitrate.'."\n" + ."\n" + .'- Valid values: \\[10, 50000].'."\n" + ."\n" + .'- Unit: Kbps.', 'type' => 'string', 'example' => '3000', 'title' => ''], + 'Crf' => ['description' => 'The constant rate factor (CRF), which controls the trade-off between quality and bitrate.'."\n" + ."\n" + .'- Valid values: \\[0, 51].'."\n" + ."\n" + .'- Default values: 23 for H.264 and 26 for H.265.'."\n" + ."\n" + .'If you set Crf, the Bitrate setting is ignored.', 'type' => 'string', 'example' => '23', 'title' => ''], + 'Width' => ['description' => 'The width.'."\n" + ."\n" + .'- Valid values: \\[128, 4096].'."\n" + ."\n" + .'- Unit: px.'."\n" + ."\n" + .'- Default value: The original video width.', 'type' => 'string', 'example' => '1920', 'title' => ''], + 'Height' => ['description' => 'The height.'."\n" + ."\n" + .'- Valid values: \\[128, 4096].'."\n" + ."\n" + .'- Unit: px.'."\n" + ."\n" + .'- Default value: The original video height.', 'type' => 'string', 'example' => '1080', 'title' => ''], + 'Fps' => ['description' => 'The frame rate.'."\n" + ."\n" + .'- Valid values: (0, 60].'."\n" + ."\n" + .'- If the frame rate of the input file exceeds 60, the system uses 60.'."\n" + ."\n" + .'- Default value: The frame rate of the input file.', 'type' => 'string', 'example' => '25', 'title' => ''], + 'Gop' => ['description' => 'The maximum number of frames between keyframes.'."\n" + ."\n" + .'- Valid values: \\[1, 1080000].'."\n" + ."\n" + .'- Default value: 250.', 'type' => 'string', 'example' => '250', 'title' => ''], + 'Preset' => ['description' => 'The video encoder preset. Only H.264 supports this parameter. 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 video color format. Valid values include yuv420p and yuvj420p.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], + 'Remove' => ['description' => 'Specifies whether to remove the video.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Crop' => ['description' => 'The video cropping method. Two options are available.'."\n" + ."\n" + .'- Automatically detect and crop black bars. Set this to border.'."\n" + ."\n" + .'- Custom cropping. Format: width:height:left:top. Example: 1280:800:0:140', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], + 'Pad' => ['description' => 'The padding configuration for 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 automatic rotation for portrait or landscape videos (also known as long-side/short-side mode).', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Bufsize' => ['description' => 'The buffer size.'."\n" + ."\n" + .'- Valid values: \\[1000, 128000]'."\n" + ."\n" + .'- Default value: 6000'."\n" + ."\n" + .'- Unit: Kb', 'type' => 'string', 'example' => '6000', 'title' => ''], + 'Maxrate' => ['description' => 'The peak video bitrate. Valid values: \\[10, 50000]. Unit: Kbps.', 'type' => 'string', 'example' => '9000', 'title' => ''], + 'AbrMax' => ['description' => 'The maximum bitrate for adaptive bitrate streaming (ABR). This applies only to narrow-high 1. Valid values: \\[10, 50000]. Unit: Kbps.', '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 profile. When Codec is AAC, valid values are 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" + .'- Default value: 44100'."\n" + ."\n" + .'- Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" + ."\n" + .'- Unit: Hz', 'type' => 'string', 'example' => '44100', 'title' => ''], + 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'- Valid values: \\[8, 1000]'."\n" + ."\n" + .'- Unit: Kbps'."\n" + ."\n" + .'- Default value: 128', 'type' => 'string', 'example' => '128', 'title' => ''], + 'Channels' => ['description' => 'The number of sound channels. Default value: 2.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Remove' => ['description' => 'Specifies whether to delete the audio stream.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Volume' => [ + 'title' => '', + 'description' => 'The volume control.', + 'type' => 'object', + 'properties' => [ + 'Method' => ['description' => 'The volume adjustment method.', 'type' => 'string', 'example' => 'auto', 'title' => ''], + 'IntegratedLoudnessTarget' => ['description' => 'The target loudness level.', 'type' => 'string', 'example' => '-6', 'title' => ''], + 'TruePeak' => ['description' => 'The true peak level.', 'type' => 'string', 'example' => '-1', 'title' => ''], + 'LoudnessRangeTarget' => ['description' => 'The 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 multiplexing settings.', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '', + 'description' => 'The segment settings.', + 'type' => 'object', + 'properties' => [ + 'Duration' => ['description' => 'The segment duration.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ForceSegTime' => ['description' => 'The forced segment time points.', 'type' => 'string', 'example' => '2,3', 'title' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'TransConfig' => [ + 'description' => 'The conditional transcoding parameters.', + 'type' => 'object', + 'properties' => [ + 'TransMode' => ['description' => 'The video transcoding mode. Valid values:'."\n" + ."\n" + .'- onepass (default): Used for ABR. Encoding is faster than twopass.'."\n" + ."\n" + .'- twopass: Used for VBR. Encoding is slower than onepass.'."\n" + ."\n" + .'- CBR: Constant bitrate mode.', 'type' => 'string', 'example' => 'onepass', 'title' => ''], + 'IsCheckReso' => ['description' => 'Specifies whether to check the video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. IsCheckResoFail has higher priority.'."\n" + ."\n" + .'- true: Check the resolution. If the input video resolution (width or height) is smaller than the output setting, transcode at the input resolution.'."\n" + ."\n" + .'- false (default): Do not check the resolution.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckResoFail' => ['description' => 'Specifies whether to check the video resolution. IsCheckReso and IsCheckResoFail are mutually exclusive. This parameter has higher priority.'."\n" + ."\n" + .'- true: Check the resolution. If the input video resolution (width or height) is smaller than the output setting, return a failure.'."\n" + ."\n" + .'- false (default): Do not check the resolution.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckVideoBitrate' => ['description' => 'Specifies whether to check the video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. IsCheckVideoBitrateFail has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input video bitrate is lower than the output setting, transcode at the input bitrate.'."\n" + ."\n" + .'- false (default): Do not check the bitrate.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckVideoBitrateFail' => ['description' => 'Specifies whether to check the video bitrate. IsCheckVideoBitrate and IsCheckVideoBitrateFail are mutually exclusive. This parameter has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input video bitrate is lower than the output setting, return a failure.'."\n" + ."\n" + .'- false (default): Do not check the bitrate.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckAudioBitrate' => ['description' => 'Specifies whether to check the audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. IsCheckAudioBitrateFail has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input audio bitrate is lower than the output setting, transcode at the input bitrate.'."\n" + ."\n" + .'- false: Do not check the bitrate.'."\n" + ."\n" + .'Default value rules:'."\n" + ."\n" + .'- Empty and the codec differs from the input source: false.'."\n" + ."\n" + .'- Empty and the codec matches the input source: true.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckAudioBitrateFail' => ['description' => 'Specifies whether to check the audio bitrate. IsCheckAudioBitrate and IsCheckAudioBitrateFail are mutually exclusive. This parameter has higher priority.'."\n" + ."\n" + .'- true: Check the bitrate. If the input audio bitrate is lower than the output setting, return a failure.'."\n" + ."\n" + .'- false (default): Do not check the bitrate.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'AdjDarMethod' => ['description' => 'The method used to adjust the display aspect ratio. This parameter takes effect only when both Width and Height are specified. You can use it with LongShortMode.'."\n" + ."\n" + .'Valid values: rescale, crop, pad, and none.'."\n" + ."\n" + .'Default value: none.', 'type' => 'string', 'example' => 'none', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'ImageWatermarks' => [ + 'title' => '', + 'description' => 'The image watermark configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image watermark configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Width' => ['description' => 'The width of the image watermark on the output video. Values can be one of the following:'."\n" + ."\n" + .'- Integer: The pixel width of the watermark image.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the watermark width to the output video width.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'Height' => ['description' => 'The height of the image watermark on the output video. Values can be one of the following:'."\n" + ."\n" + .'- Integer: The pixel height of the watermark image.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the watermark height to the output video height.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'Dx' => ['description' => 'The horizontal offset of the image watermark relative to the output video. Default value: 0.'."\n" + ."\n" + .'Values can be one of the following:'."\n" + ."\n" + .'- Integer: The offset in pixels.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the horizontal offset to the output video width.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Dy' => ['description' => 'The vertical offset of the image watermark relative to the output video. Default value: 0.'."\n" + ."\n" + .'Values can be one of the following:'."\n" + ."\n" + .'- Integer: The offset in pixels.'."\n" + ."\n" + .' - Valid values: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- Decimal: The ratio of the vertical offset to the output video height.'."\n" + ."\n" + .' - Valid values: (0, 1)'."\n" + ."\n" + .' - Up to four decimal places are supported, such as 0.9999. Extra digits are automatically discarded.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ReferPos' => ['description' => 'The position of the watermark.'."\n" + ."\n" + .'- Valid values: TopRight (top-right), TopLeft (top-left), BottomRight (bottom-right), and BottomLeft (bottom-left).'."\n" + ."\n" + .'- Default value: TopRight.', 'type' => 'string', 'example' => 'TopLeft', 'title' => ''], + 'Timeline' => [ + 'title' => '', + 'description' => 'The display time settings for a dynamic watermark.', + 'type' => 'object', + 'properties' => [ + 'Start' => ['description' => 'The start time of the watermark.'."\n" + ."\n" + .'- Unit: seconds'."\n" + ."\n" + .'- Valid values: numbers'."\n" + ."\n" + .'- Default value: 0', 'type' => 'string', 'example' => '00:00:05', 'title' => ''], + 'Duration' => ['description' => 'The duration of the watermark.'."\n" + ."\n" + .'- Valid values: \\[number, ToEND]'."\n" + ."\n" + .'- Default value: ToEND', 'type' => 'string', 'example' => 'ToEND', 'title' => ''], + ], + 'example' => '', + ], + 'File' => [ + 'title' => '', + 'description' => 'The watermark image file.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The media object type. Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The media value:'."\n" + ."\n" + .'- If Type is OSS, this is a URL that supports the OSS or HTTP protocol.'."\n" + ."\n" + .'- If Type is Media, this is a media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TextWatermarks' => [ + 'title' => '', + 'description' => 'The text watermark configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The text watermark configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The watermark text. It does not need to be Base64 encoded. The string must be UTF-8 encoded.', 'type' => 'string', 'example' => '测试水印', 'title' => ''], + 'FontName' => ['description' => 'The font. Default: SimSun.', 'type' => 'string', 'example' => 'SimSun', 'title' => ''], + 'FontColor' => ['description' => 'The color.', 'type' => 'string', 'example' => '#006400', 'title' => ''], + 'FontAlpha' => ['description' => 'The font transparency.'."\n" + ."\n" + .'- Valid values: (0, 1]'."\n" + ."\n" + .'- Default: 1.0', 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'Top' => ['description' => 'The top margin of the text.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Valid values: \\[0, 4096]', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Left' => ['description' => 'The left margin of the text.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Valid values: \\[0, 4096]', 'type' => 'string', 'example' => '10', 'title' => ''], + 'FontSize' => ['description' => 'The font size.'."\n" + ."\n" + .'- Default value: 16'."\n" + ."\n" + .'- Valid values: (4, 120)', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'BorderWidth' => ['description' => 'The outline width.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Range: (0,4096]', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BorderColor' => ['description' => 'The outline color.'."\n" + .'Default: Black.'."\n" + .'For more values, see BorderColor.', 'type' => 'string', 'example' => '#006400', 'title' => ''], + 'Adaptive' => ['description' => 'Adjusts the font size based on the output video size. The default is false.', 'type' => 'string', 'example' => 'false', 'title' => ''], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Subtitles' => [ + 'title' => '', + 'description' => 'The configuration for burning in captions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration for burning in subtitles.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'Parameters to overwrite. If you specify these, they replace the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Format' => ['description' => 'The file format of the caption.', 'type' => 'string', 'example' => 'vtt', 'title' => ''], + 'CharEnc' => ['description' => 'The encoding format of the file.', 'type' => 'string', 'example' => 'UTF-8', 'title' => ''], + 'File' => [ + 'title' => '', + 'description' => 'The subtitle file.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the media object.'."\n" + .'Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: The ID of a media asset.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The value of Media:'."\n" + ."\n" + .'- If type is OSS, the value is a URL. The URL supports the OSS and HTTP protocols.'."\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 configuration.', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => ['description' => 'The encryption type.', 'type' => 'string', 'example' => 'PrivateEncryption', 'title' => ''], + 'CipherText' => ['description' => 'The ciphertext of the key for standard encryption.', 'type' => 'string', 'example' => 'MTYi00NDU0LTg5O****', 'title' => ''], + 'DecryptKeyUri' => ['description' => 'The decryption service endpoint for standard encryption.', 'type' => 'string', 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', 'title' => ''], + 'KeyServiceType' => ['description' => 'The type of the key service. Only KMS and Base64 are supported.', 'type' => 'string', 'example' => 'KMS', 'title' => ''], + ], + 'example' => '', + ], + 'CombineConfigs' => [ + 'title' => '', + 'description' => 'The configuration for mixing multiple input streams.', + 'type' => 'array', + 'items' => [ + 'description' => 'The stream combination configuration.', + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => ['description' => 'The index of the audio stream.', 'type' => 'string', 'required' => true, 'example' => '0 或 exclude', 'title' => ''], + 'VideoIndex' => ['description' => 'The index of the video stream.', 'type' => 'string', 'required' => true, 'example' => '0 或 exclude', '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 value is the duration of the video.', 'type' => 'number', 'format' => 'double', 'example' => '20.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Output' => [ + 'title' => '', + 'description' => 'The output media configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The media object type.'."\n" + .'Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The value of the media asset:'."\n" + ."\n" + .'- If type is OSS, the value is a URL. The 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' => ''], + 'OutputUrl' => ['description' => 'The path of the output stream.
'."\n" + .'This parameter is valid only when \\`Type\\` is set to \\`Media\\`. It lets you select a specific file from the media asset for output.
'."\n" + .'The following placeholders are supported:

'."\n" + ."\n" + .'- {MediaId}: The ID of the media asset.'."\n" + ."\n" + .'- {JobId}: The ID of the transcoding subtask.'."\n" + ."\n" + .'- {MediaBucket}: The bucket where the media asset is stored.'."\n" + ."\n" + .'- {ExtName}: The file extension. The value is the output format specified in the transcoding template.'."\n" + ."\n" + .'- {DestMd5}: The MD5 hash of the output file.
'."\n" + .' Note:
'."\n" + ."\n" + .'1. This parameter must contain the {MediaId} and {JobId} placeholders.'."\n" + ."\n" + .'2. The output bucket is the same as the bucket where the media asset is stored.', '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' => 'The scheduling information for the job.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The ID of the pipeline.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', 'title' => ''], + 'Priority' => ['description' => 'The priority of the task. 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' => '', + ], + 'Status' => ['description' => 'The status of the transcoding job.'."\n" + ."\n" + .'- Init: The job is submitted.'."\n" + ."\n" + .'- Processing: The job is being transcoded.'."\n" + ."\n" + .'- Success: The transcoding is successful.'."\n" + ."\n" + .'- Fail: The transcoding failed.'."\n" + ."\n" + .'- Deleted: The job is deleted.', 'type' => 'string', 'example' => 'Init', 'title' => ''], + 'OutFileMeta' => [ + 'title' => '', + 'description' => 'The media information of the video generated by the job.', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '', + 'description' => 'Basic file information.', + 'type' => 'object', + 'properties' => [ + 'MediaId' => ['description' => 'The media asset ID.', 'type' => 'string', 'title' => '', 'example' => '73e07de0f77171eca3fc7035d0b26402'], + 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'file.m3u8', 'title' => ''], + 'FileStatus' => ['description' => 'The status 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 size of the file in 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 where the file is located.', '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 in 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 file.', 'type' => 'string', 'example' => '848', 'title' => ''], + 'Height' => ['description' => 'The height.', 'type' => 'string', 'example' => '478', 'title' => ''], + ], + 'example' => '', + ], + 'AudioStreamInfoList' => [ + 'title' => '', + 'description' => 'The audio stream information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The audio stream information.', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => 'The index 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 encoder tag name.', '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 sample rate in Hz.', 'type' => 'string', 'example' => '44100', 'title' => ''], + 'Channels' => ['description' => 'The number of sound channels.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'ChannelLayout' => ['description' => 'The channel layout.', 'type' => 'string', 'example' => 'stereo', 'title' => ''], + 'Timebase' => ['description' => 'The time base.', 'type' => 'string', 'example' => '1/90000', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], + 'Duration' => ['description' => 'The duration in seconds.', 'type' => 'string', 'example' => '403.039989', 'title' => ''], + 'Bitrate' => ['description' => 'The bitrate.', 'type' => 'string', 'example' => '0.f', 'title' => ''], + 'Lang' => ['description' => 'The language.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'VideoStreamInfoList' => [ + 'title' => '', + 'description' => 'The video stream information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The video stream information.', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => 'The index 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 preset.', 'type' => 'string', 'example' => 'High', 'title' => ''], + 'Codec_time_base' => ['description' => 'The codec time base.', 'type' => 'string', 'example' => '1/50', 'title' => ''], + 'Codec_tag_string' => ['description' => 'The text of the encoding format tag.', 'type' => 'string', 'example' => '[27][0][0][0]', 'title' => ''], + 'Codec_tag' => ['description' => 'The encoding format tag.', 'type' => 'string', 'example' => '0x001b', 'title' => ''], + 'Width' => ['description' => 'The video width.', 'type' => 'string', 'example' => '848', 'title' => ''], + 'Height' => ['description' => 'The height of the output video stream.', 'type' => 'string', 'example' => '478', 'title' => ''], + 'Has_b_frames' => ['description' => 'Indicates 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' => 'The sample aspect ratio.', 'type' => 'string', 'example' => '478:477', 'title' => ''], + 'Dar' => ['description' => 'The display aspect ratio.', 'type' => 'string', 'example' => '16:9', 'title' => ''], + 'PixFmt' => ['description' => 'The color storage format.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], + 'Level' => ['description' => 'The encoding 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.', 'type' => 'string', 'example' => '1.473556', 'title' => ''], + 'Duration' => ['description' => 'The duration in 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.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'Rotate' => ['description' => 'The rotation angle of the video. Valid values: 0, 90, 180, and 270. The default value is 0.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'SubmitResultJson' => ['description' => 'The result of the job submission.', 'type' => 'object', 'example' => '{}', 'title' => ''], + '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 finished.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request to submit the job.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'StartTime' => [ - 'description' => 'The time when the flow is started.'."\n", - 'type' => 'string', - 'example' => '2024-07-18T01:39:24Z', + 'CreateTime' => ['description' => 'The time when the job was created. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], + 'Name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'transcode-job', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', 'title' => ''], + 'ParentJobId' => ['description' => 'The ID of the parent job.', 'type' => 'string', 'example' => '8b2198504dd340b7b3c9842a74fc9baa', 'title' => ''], + 'JobCount' => ['description' => 'The number of sub-jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The status of the job. Success: At least one sub-job succeeded after all sub-jobs are complete. Fail: All sub-jobs failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'TriggerSource' => ['description' => 'The source of the job. Valid values: \\`API\\`, \\`WorkFlow\\`, and \\`Console\\`.', 'type' => 'string', 'example' => 'API', 'title' => ''], + 'Percent' => ['description' => 'The completion percentage of the job.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SubmitTime' => ['description' => 'The time when the job was submitted. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], + 'FinishTime' => ['description' => 'The time when the job finished. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2022-01-12T08:49:41Z', 'title' => ''], + 'InputGroup' => [ + 'title' => '', + 'description' => 'The input group for the job. A single input creates a transcoding job. Multiple inputs create a job to merge audio and video streams.', + 'type' => 'array', + 'items' => [ + 'description' => 'The job input.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the media object.'."\n" + .'Valid values:'."\n" + ."\n" + .'- OSS: an OSS file.'."\n" + ."\n" + .'- Media: a media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The value of the media asset:'."\n" + ."\n" + .'- If type is OSS, this is a URL. Both the OSS and HTTP protocols are supported.'."\n" + ."\n" + .'- If type is Media, this is the media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.mp4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'FlowFailover' => [ - 'type' => 'string', + '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 media object type.'."\n" + .'Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The value of the media asset:'."\n" + ."\n" + .'- If type is set to OSS, the value is a URL. The OSS and HTTP protocols are supported.'."\n" + ."\n" + .'- If type is set to Media, the value is the media asset ID.', 'type' => 'string', 'example' => 'oss://bucket/path/to/video.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' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'The overwrite parameters. If specified, these parameters overwrite the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => '', + 'description' => 'Video settings', + 'type' => 'object', + 'properties' => [ + 'Codec' => ['description' => 'The encoding format.', 'type' => 'string', 'example' => 'H.264', 'title' => ''], + 'Profile' => ['description' => 'The encoding profile.'."\n" + .'Supported values are baseline, main, and 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' => 'The average video bitrate.'."\n" + ."\n" + .'- Value range: \\[10, 50000].'."\n" + ."\n" + .'- Unit: Kbps.', 'type' => 'string', 'example' => '3000', 'title' => ''], + 'Crf' => ['description' => 'The Constant Rate Factor (CRF).'."\n" + ."\n" + .'- The value can be from 0 to 51.'."\n" + ."\n" + .'- The default value is 23 for H264 encoding and 26 for H265 encoding.'."\n" + ."\n" + .'If Crf is set, the Bitrate setting is ignored.', 'type' => 'string', 'example' => '23', 'title' => ''], + 'Width' => ['description' => 'The width of the output video.'."\n" + ."\n" + .'- Valid values: 128 to 4096.'."\n" + ."\n" + .'- Unit: px.'."\n" + ."\n" + .'- Default value: The original width of the video.', 'type' => 'string', 'example' => '1920', 'title' => ''], + 'Height' => ['description' => 'The height of the video.'."\n" + ."\n" + .'- Valid values: \\[128, 4096].'."\n" + ."\n" + .'- Unit: px.'."\n" + ."\n" + .'- Default value: The original height of the video.', 'type' => 'string', 'example' => '1080', 'title' => ''], + 'Fps' => ['description' => 'The frame rate.'."\n" + ."\n" + .'- Valid values: (0, 60].'."\n" + ."\n" + .'- If the input file has a frame rate greater than 60, the frame rate is capped at 60.'."\n" + ."\n" + .'- Default: The frame rate of the input file.', 'type' => 'string', 'example' => '25', 'title' => ''], + 'Gop' => ['description' => 'The maximum number of frames between two keyframes.'."\n" + ."\n" + .'- The value must be in the range of \\[1, 1080000].'."\n" + ."\n" + .'- The default value is 250.', 'type' => 'string', 'example' => '250', 'title' => ''], + 'Preset' => ['description' => 'The video algorithm preset. This parameter is supported only for H.264. Supported values are veryfast, fast, medium, slow, and slower. The default value is medium.', 'type' => 'string', 'example' => 'medium', 'title' => ''], + 'ScanMode' => ['description' => 'The scan mode. Valid values are interlaced and progressive.', 'type' => 'string', 'example' => 'progressive', 'title' => ''], + 'PixFmt' => ['description' => 'The pixel format of the video. Valid values include standard formats such as yuv420p and yuvj420p.', 'type' => 'string', 'example' => 'yuv420p', 'title' => ''], + 'Remove' => ['description' => 'Specifies whether to remove the video.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Crop' => ['description' => 'Crops the video frame.'."\n" + .'Two methods are available.'."\n" + ."\n" + .'- To automatically detect and crop black bars, set the parameter to "border".'."\n" + ."\n" + .'- To specify a custom crop area, use the width:height:left:top format.'."\n" + .' Example: 1280:800:0:140', 'type' => 'string', 'example' => '1280:800:0:140', 'title' => ''], + 'Pad' => ['description' => 'Adds black bars to the video.'."\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 automatic rotation for landscape and portrait orientations (long and short edge pattern).', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Bufsize' => ['description' => 'The buffer size.'."\n" + ."\n" + .'- Value range: \\[1000, 128000]'."\n" + ."\n" + .'- Default value: 6000'."\n" + ."\n" + .'- Unit: Kb', 'type' => 'string', 'example' => '6000', 'title' => ''], + 'Maxrate' => ['description' => 'The peak video bitrate.'."\n" + ."\n" + .'- Value range: \\[10, 50000]'."\n" + ."\n" + .'- Unit: Kbps', 'type' => 'string', 'example' => '9000', 'title' => ''], + 'AbrMax' => ['description' => 'The maximum bitrate for adaptive bitrate (ABR) streaming. This parameter is valid only for Narrowband HD 1.0.'."\n" + ."\n" + .'- Value range: \\[10, 50000]'."\n" + ."\n" + .'- Unit: Kbps', 'type' => 'string', 'example' => '6000', 'title' => ''], + ], + 'example' => '', + ], + 'Audio' => [ + 'title' => '', + 'description' => 'Audio settings.', + 'type' => 'object', + 'properties' => [ + 'Codec' => ['description' => 'The audio codec format. Valid values are AAC, MP3, VORBIS, and FLAC.'."\n" + .'Default value: AAC', 'type' => 'string', 'example' => 'AAC', 'title' => ''], + 'Profile' => ['description' => 'The audio encoding preset.'."\n" + .'When Codec is set to AAC, valid values are 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" + .'- Default value: 44100. Valid values: 22050, 32000, 44100, 48000, and 96000.'."\n" + ."\n" + .'- Unit: Hz', 'type' => 'string', 'example' => '44100', 'title' => ''], + 'Bitrate' => ['description' => 'The audio bitrate of the output file.'."\n" + ."\n" + .'- Value range: \\[8, 1000]'."\n" + ."\n" + .'- Unit: Kbps'."\n" + ."\n" + .'- Default value: 128', 'type' => 'string', 'example' => '128', 'title' => ''], + 'Channels' => ['description' => 'The number of sound channels.'."\n" + .'Default value: 2.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Remove' => ['description' => 'Specifies whether to remove the audio stream.', '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 volume.', 'type' => 'string', 'example' => '-6', 'title' => ''], + 'TruePeak' => ['description' => 'The true peak.', 'type' => 'string', 'example' => '-1', 'title' => ''], + 'LoudnessRangeTarget' => ['description' => 'The 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 encapsulation settings.', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '', + 'description' => 'Segment settings.', + 'type' => 'object', + 'properties' => [ + 'Duration' => ['description' => 'The segment length.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ForceSegTime' => ['description' => 'The time points for forced segmentation.', 'type' => 'string', 'example' => '2,3', 'title' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'TransConfig' => [ + 'description' => 'The conditional transcoding parameters.', + 'type' => 'object', + 'properties' => [ + 'TransMode' => ['description' => 'The video transcoding mode. Valid values:'."\n" + ."\n" + .'- onepass: Typically used for ABR. The encoding speed is faster than twopass.'."\n" + ."\n" + .'- twopass: Typically used for VBR. The encoding speed is slower than onepass.'."\n" + ."\n" + .'- CBR: Constant Bitrate mode.'."\n" + ."\n" + .'Default value: onepass.', 'type' => 'string', 'example' => 'onepass', 'title' => ''], + 'IsCheckReso' => ['description' => 'Specifies whether to check the video resolution. The IsCheckReso and IsCheckResoFail parameters are mutually exclusive. IsCheckResoFail takes precedence.'."\n" + ."\n" + .'- true: Enables the resolution check. If the resolution (width or height) of the input video is lower than the output resolution, the transcoding job uses the input resolution.'."\n" + ."\n" + .'- false: Disables the resolution check.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckResoFail' => ['description' => 'Specifies whether to check the video resolution. You can use either IsCheckReso or IsCheckResoFail, but not both. This parameter has a higher priority.'."\n" + ."\n" + .'- true: Checks the resolution. The transcoding job fails if the width or height of the input video is smaller than the output resolution.'."\n" + ."\n" + .'- false: Does not check the resolution.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckVideoBitrate' => ['description' => 'Specifies whether to check the video bitrate. You can set either IsCheckVideoBitrate or IsCheckVideoBitrateFail. IsCheckVideoBitrateFail has a higher priority.'."\n" + ."\n" + .'- true: Checks the bitrate. If the input video bitrate is lower than the output bitrate, the video is transcoded at the input bitrate.'."\n" + ."\n" + .'- false: Does not check the bitrate.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckVideoBitrateFail' => ['description' => 'Specifies whether to check the video bitrate. This parameter and IsCheckVideoBitrate are mutually exclusive. IsCheckVideoBitrateFail has a higher priority.'."\n" + ."\n" + .'- true: Enables the check. The transcoding job fails if the input video bitrate is lower than the output bitrate setting.'."\n" + ."\n" + .'- false: Disables the check.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckAudioBitrate' => ['description' => 'Specifies whether to check the audio bitrate. You can set either this parameter or IsCheckAudioBitrateFail. IsCheckAudioBitrateFail takes precedence.'."\n" + ."\n" + .'- true: Checks the audio bitrate. If the input audio bitrate is lower than the configured output bitrate, the service uses the input audio bitrate for transcoding.'."\n" + ."\n" + .'- false: Does not check the audio bitrate.'."\n" + ."\n" + .'Default value:'."\n" + ."\n" + .'- false: If this parameter is empty and the output codec is different from the input codec.'."\n" + ."\n" + .'- true: If this parameter is empty and the output codec is the same as the input codec.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IsCheckAudioBitrateFail' => ['description' => 'Specifies whether to check the audio bitrate. You can set either IsCheckAudioBitrate or IsCheckAudioBitrateFail. This parameter has a higher priority.'."\n" + ."\n" + .'- true: The transcoding job fails if the input audio bitrate is lower than the output bitrate setting.'."\n" + ."\n" + .'- false: The audio bitrate is not checked.'."\n" + ."\n" + .'Default value: false.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'AdjDarMethod' => ['description' => 'The method to adjust the resolution. This setting takes effect only when both Width and Height are specified. It can be used with LongShortMode.'."\n" + ."\n" + .'Valid values: rescale, crop, pad, and none.'."\n" + ."\n" + .'Default value: none.', 'type' => 'string', 'example' => 'none', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'ImageWatermarks' => [ + 'title' => '', + 'description' => 'The image watermark settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The image watermark configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'The parameters that, when specified, overwrite the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Width' => ['description' => 'The width of the watermark image on the output video.'."\n" + .'The value can be specified in two formats:'."\n" + ."\n" + .'- An integer that specifies the width of the watermark image in pixels.'."\n" + ."\n" + .' - Range: \\[8, 4096].'."\n" + ."\n" + .' - Unit: px.'."\n" + ."\n" + .'- A decimal that represents the width of the watermark relative to the width of the output video.'."\n" + ."\n" + .' - Range: (0, 1).'."\n" + ."\n" + .' - The value supports up to four decimal places, such as 0.9999. Digits beyond the fourth decimal place are automatically discarded.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'Height' => ['description' => 'The height of the image watermark on the output video.'."\n" + .'The value can be specified in two ways:'."\n" + ."\n" + .'- An integer that represents the watermark height in pixels.'."\n" + ."\n" + .' - Range: \\[8, 4096].'."\n" + ."\n" + .' - Unit: px.'."\n" + ."\n" + .'- A decimal that represents the watermark height as a ratio of the output video\'s height.'."\n" + ."\n" + .' - Range: (0, 1).'."\n" + ."\n" + .' - The value supports up to four decimal places, such as 0.9999. Digits beyond the fourth decimal place are automatically discarded.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'Dx' => ['description' => 'The horizontal offset of the watermark image relative to the output video.'."\n" + .'Default: 0'."\n" + ."\n" + .'The value can be specified in two formats:'."\n" + ."\n" + .'- An integer that specifies the offset in pixels.'."\n" + ."\n" + .' - Range: \\[8, 4096]'."\n" + ."\n" + .' - Unit: px'."\n" + ."\n" + .'- A decimal that specifies the ratio of the horizontal offset to the width of the output video.'."\n" + ."\n" + .' - Range: (0, 1)'."\n" + ."\n" + .' - The value can have up to four decimal places, such as 0.9999. The system automatically discards any digits beyond the fourth decimal place.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Dy' => ['description' => 'The vertical offset of the watermark image relative to the output video.'."\n" + .'Default value: 0.'."\n" + ."\n" + .'The value can be in one of the following two formats:'."\n" + ."\n" + .'- An integer that specifies the offset in pixels.'."\n" + ."\n" + .' - Range: \\[8, 4096].'."\n" + ."\n" + .' - Unit: px.'."\n" + ."\n" + .'- A decimal that specifies the ratio of the vertical offset to the output video height.'."\n" + ."\n" + .' - Range: (0, 1).'."\n" + ."\n" + .' - The value supports up to four decimal places, such as 0.9999. Any additional digits are automatically discarded.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ReferPos' => ['description' => 'The position of the watermark.'."\n" + ."\n" + .'- Valid values: TopRight, TopLeft, BottomRight, and BottomLeft.'."\n" + ."\n" + .'- Default value: TopRight.', 'type' => 'string', 'example' => 'TopLeft', 'title' => ''], + 'Timeline' => [ + 'title' => '', + 'description' => 'The display time settings for the dynamic watermark.', + 'type' => 'object', + 'properties' => [ + 'Start' => ['description' => 'The time when the watermark appears.'."\n" + ."\n" + .'- Unit: seconds'."\n" + ."\n" + .'- The value must be numeric.'."\n" + ."\n" + .'- Default value: 0', 'type' => 'string', 'example' => '00:00:05', 'title' => ''], + 'Duration' => ['description' => 'The duration of the watermark.'."\n" + ."\n" + .'- Valid values: \\[Number, ToEND]'."\n" + ."\n" + .'- Default value: ToEND', 'type' => 'string', 'example' => 'ToEND', 'title' => ''], + ], + 'example' => '', + ], + 'File' => [ + 'title' => '', + 'description' => 'The image file for the watermark.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The object type of the media asset.'."\n" + .'Valid values:'."\n" + ."\n" + .'- OSS: An OSS file.'."\n" + ."\n" + .'- Media: A media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The value of the media asset:'."\n" + ."\n" + .'- If type is OSS, the value is a URL that supports the OSS and HTTP protocols.'."\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' => '', + ], + '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' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'The overwrite parameters. If specified, these parameters overwrite the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The watermark text. The string must be UTF-8 encoded. Base64 encoding is not required.', 'type' => 'string', 'example' => '测试水印', 'title' => ''], + 'FontName' => ['description' => 'The font. Default: SimSun.', 'type' => 'string', 'example' => 'SimSun', 'title' => ''], + 'FontColor' => ['description' => 'The font color.', 'type' => 'string', 'example' => '#006400', 'title' => ''], + 'FontAlpha' => ['description' => 'The transparency of the font.'."\n" + ."\n" + .'- Range: (0, 1].'."\n" + ."\n" + .'- Default: 1.0.', 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'Top' => ['description' => 'The top margin of the text.'."\n" + ."\n" + .'- Default: 0.'."\n" + ."\n" + .'- Range: \\[0,4096].', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Left' => ['description' => 'The left margin of the text.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Range: \\[0,4096]', 'type' => 'string', 'example' => '10', 'title' => ''], + 'FontSize' => ['description' => 'The font size.'."\n" + ."\n" + .'- Default value: 16'."\n" + ."\n" + .'- Range: (4, 120)', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'BorderWidth' => ['description' => 'The width of the border.'."\n" + ."\n" + .'- Default: 0'."\n" + ."\n" + .'- Range: (0, 4096]', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BorderColor' => ['description' => 'The outline color.'."\n" + .'Default: Black'."\n" + .'For more values, see BorderColor.', 'type' => 'string', 'example' => '#006400', 'title' => ''], + 'Adaptive' => ['description' => 'Adjusts the font size based on the size of the output video.'."\n" + ."\n" + .'- Valid values: true, false'."\n" + ."\n" + .'- default: false', 'type' => 'string', 'example' => 'false', 'title' => ''], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Subtitles' => [ + 'title' => '', + 'description' => 'The caption burn-in configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The caption burn-in configuration.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', 'title' => ''], + 'OverwriteParams' => [ + 'title' => '', + 'description' => 'The overwrite parameters. If specified, these parameters overwrite the corresponding parameters in the template.', + 'type' => 'object', + 'properties' => [ + 'Format' => ['description' => 'The caption file format.', '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.'."\n" + .'Valid values:'."\n" + ."\n" + .'- OSS: an OSS file.'."\n" + ."\n" + .'- Media: a media asset ID.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'Media' => ['description' => 'The value of the media asset. If the type is OSS, the value is a URL that supports the OSS and HTTP protocols. If the 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 configuration.', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => ['description' => 'The encryption type.', 'type' => 'string', 'example' => 'PrivateEncryption', 'title' => ''], + 'CipherText' => ['description' => 'The ciphertext of the key for standard encryption.', 'type' => 'string', 'example' => 'MTYi00NDU0LTg5O****', 'title' => ''], + 'DecryptKeyUri' => ['description' => 'The decryption endpoint for standard encryption.', 'type' => 'string', 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', 'title' => ''], + 'KeyServiceType' => ['description' => 'The type of the key service. Only KMS and Base64 are supported.', 'type' => 'string', 'example' => 'KMS', 'title' => ''], + ], + 'example' => '', + ], + 'CombineConfigs' => [ + 'title' => '', + 'description' => 'The settings for combining multiple input streams.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration for combining multiple input streams.', + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => ['description' => 'The index of the audio stream.', 'type' => 'string', 'required' => true, 'example' => '0 或 exclude', 'title' => ''], + 'VideoIndex' => ['description' => 'The index of the video stream.', 'type' => 'string', 'required' => true, 'example' => '0 或 exclude', '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. By default, this is the duration of the video.', 'type' => 'number', 'format' => 'double', 'example' => '20.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'FlowRegion' => [ - 'type' => 'string', + 'UserData' => ['description' => 'The user data.', 'type' => 'string', 'example' => 'user-data', 'title' => ''], + 'ScheduleConfig' => [ + 'title' => '', + 'description' => 'The job scheduling configuration.', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'e37ebee5d98b4781897f6086e89f9c56', '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' => '', ], ], - ], - 'Description' => [ - 'description' => 'The call description.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Retcode' => [ - 'description' => 'The returned code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FB503AEF-118E-1516-89E2-7B227EA1AC20', + 'example' => '', ], ], + 'description' => '', + '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' => 'GetMediaConnectFlow', - 'description' => '* When the specified flow ID is not available, an error code is returned.'."\n" - .'* The returned StartTime is valid only when the flow is in the online state.'."\n", - ], - 'CreateMediaConnectFlow' => [ - 'summary' => 'Creates a MediaConnect flow.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\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 ],\\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\\": \\"测试水印\\",\\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 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ]\\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\\": \\"73e07de0f77171eca3fc7035d0b26402\\",\\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 },\\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\\": \\"测试水印\\",\\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 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 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' => 'SubmitTranscodeJob', + 'summary' => 'Call the SubmitTranscodeJob operation to submit a video or audio transcoding job to Intelligent Media Services. In the request, you must specify the source file to transcode, the output format, and related parameters.', + 'description' => '- This operation will be discontinued on December 31, 2025. Use [SubmitMediaConvertJob](~~2867673~~) instead.'."\n" + ."\n" + .'- This is an [asynchronous operation](~~3027141~~). After you submit a job, the system returns a job ID. The job is not completed immediately but is queued for asynchronous execution in the background. You will receive the final result through a callback notification. You can also call [QueryTranscodeJob](~~441206~~) to query the job status.', + 'changeSet' => [ + ['createdAt' => '2023-11-07T03:47:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-18T13:20:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-10-10T07:20:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-06T03:31:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-05-18T06:21:49.000Z', 'description' => 'Request parameters changed, 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' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-10T06:33:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-20T08:45:50.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-19T09:22:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-19T08:08:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTranscodeJob'], ], ], - 'parameters' => [ - [ - 'name' => 'FlowName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The flow name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AliTestFlow', - ], - ], + 'ramActions' => [ [ - 'name' => 'FlowRegion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region in which the flow resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ap-southeast-1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response content.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'FlowId' => [ - 'description' => 'The flow ID.'."\n", - 'type' => 'string', - 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', - ], - ], - ], - 'Description' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'RetCode' => [ - 'description' => 'The returned error code. A value of 0 indicates the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '86D92F9D-65E8-58A2-85D1-9DEEECC172E8', - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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" - .'* Take note of the returned flow ID. You may reference it in other API operations.'."\n", + 'translator' => 'machine', ], - 'AddAdInsertion' => [ - 'summary' => 'Adds an ad insertion configuration.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SubmitVideoCognitionJob' => [ + 'summary' => 'Submits a video cognition job.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -64801,953 +52452,355 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238117', - 'abilityTreeNodes' => [ - 'FEATUREiceN57D5I', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceVYUZ7L'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源一级ID', - '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.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_ad', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => 'The idempotency key that is used to avoid repeated submission. The value can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****0311a423d11a5f7dee713535****', - ], - ], - [ - 'name' => 'ContentUrlPrefix', - 'in' => 'formData', - 'schema' => [ - 'title' => '内容URL前缀', - 'description' => 'The URL prefix for the source content. HTTP and HTTPS are supported. The maximum length is 512 characters.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://source.com/', - ], - ], - [ - 'name' => 'SlateAdUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => 'slate广告URL', - 'description' => 'The HTTP or HTTPS URL of the slate ad. Only MP4 format is supported. The maximum length is 2,048 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://storage.com/slate1.mp4', - ], - ], - [ - 'name' => 'ConfigAliases', - 'in' => 'formData', - 'schema' => [ - 'title' => '动态配置别名', - '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}" } }'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "player_params.p1": { "1": "abc" } }', - ], - ], - [ - 'name' => 'CdnContentSegmentUrlPrefix', - 'in' => 'formData', - 'schema' => [ - 'title' => '视频内容分片的CDN前缀', - 'description' => 'The CDN prefix for content segments. HTTP and HTTPS are supported. The maximum length is 512 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://cdn.com/', - ], - ], - [ - 'name' => 'CdnAdSegmentUrlPrefix', - 'in' => 'formData', - 'schema' => [ - 'title' => '广告分片的CDN前缀', - 'description' => 'The CDN prefix for ad segments. HTTP and HTTPS are supported. The maximum length is 512 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://cdn.com/', - ], + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => 'The title of the video. The title can contain Chinese characters, English letters, digits, and hyphens (-). The title cannot start with a special character and must not exceed 256 bytes in length.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example-title-**** ', 'title' => ''], ], [ - 'name' => 'AdMarkerPassthrough', - 'in' => 'formData', - 'schema' => [ - 'title' => '内容URL前缀', - 'description' => 'Specifies whether to enable ad marker passthrough. Default value: OFF.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF: Disable.'."\n" - .'* ON: Enable.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'ON', - ], + 'name' => 'Params', + 'in' => 'query', + 'schema' => ['description' => 'A JSON string containing additional parameters for operators such as natural language processing, shot detection, custom tagging, and action recognition.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "nlpParams": {'."\n" + .' "sourceLanguage": "cn",'."\n" + .' "diarizationEnabled": true,'."\n" + .' "speakerCount": 2,'."\n" + .' "summarizationEnabled": true,'."\n" + .' "summarizationTypes": "Paragraph,Conversational,QuestionsAnswering,MindMap",'."\n" + .' "translationEnabled": true,'."\n" + .' "targetLanguages": "en",'."\n" + .' "autoChaptersEnabled": true,'."\n" + .' "meetingAssistanceEnabled": true'."\n" + .' }'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'PersonalizationThreshold', - 'in' => 'formData', - 'schema' => [ - 'title' => '个性化配置阈值', - 'description' => 'Specifies the maximum duration of underfilled time allowed in an ad break. Unit: seconds. Default value: 8 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'The user-defined data. The service returns this data unmodified in the callback notification. This parameter cannot exceed 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => '{"test":1}', 'title' => ''], ], [ - 'name' => 'AdsUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => '广告策略服务器URL', - 'description' => 'The request URL of the ad decision server (ADS). HTTP and HTTPS are supported. The maximum length is 2,048 characters.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The input media object.', 'type' => 'object', 'properties' => [ - 'Config' => [ - 'description' => 'The ad insertion configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the configuration was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the configuration was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z'."\n", - ], - 'Name' => [ - 'title' => '广告插入配置名称', - 'description' => 'The name of the ad insertion configuration.'."\n", - 'type' => 'string', - 'example' => 'my_ad', - ], - 'ContentUrlPrefix' => [ - 'title' => '内容URL前缀', - 'description' => 'The URL prefix for the source content.'."\n", - 'type' => 'string', - 'example' => 'https://source.com/'."\n", - ], - 'AdsUrl' => [ - 'title' => '广告策略服务器URL', - 'description' => 'The request URL of ADS.'."\n", - 'type' => 'string', - 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'."\n", - ], - 'ConfigAliases' => [ - 'title' => '动态配置别名', - 'description' => 'The player parameter variables and aliases.'."\n", - 'type' => 'string', - 'example' => '{ "player_params.p1": { "1": "abc" } }'."\n", - ], - 'PersonalizationThreshold' => [ - 'title' => '个性化配置阈值', - 'description' => 'The personalization threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'SlateAdUrl' => [ - 'title' => 'slate广告URL', - 'description' => 'The URL of the slate ad.'."\n", - 'type' => 'string', - 'example' => 'http://storage.com/slate1.mp4'."\n", - ], - 'CdnConfig' => [ - 'title' => 'CDN配置', - 'description' => 'The CDN configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContentSegmentUrlPrefix' => [ - 'title' => '视频内容分片的CDN前缀', - 'description' => 'The CDN prefix for content segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/'."\n", - ], - 'AdSegmentUrlPrefix' => [ - 'title' => '广告分片的CDN前缀', - 'description' => 'The CDN prefix for ad segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/'."\n", - ], - ], - ], - 'AdMarkerPassthrough' => [ - 'title' => '广告标记透传', - 'description' => 'Indicates whether ad marker passthrough is enabled.'."\n", - 'type' => 'string', - 'example' => 'ON', - ], - 'ManifestEndpointConfig' => [ - 'title' => '清单播放端点配置', - 'description' => 'The playback endpoint configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'HlsPrefix' => [ - 'title' => 'HLS清单播放端点前缀', - 'description' => 'The prefix of the playback endpoint for HLS manifests.'."\n", - 'type' => 'string', - 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'."\n", - ], - 'DashPrefix' => [ - 'title' => 'DASH清单播放端点前缀', - 'description' => 'DASH清单播放端点前缀', - 'type' => 'string', - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], + 'Type' => ['description' => 'The type of the input media. Valid values:'."\n" + ."\n" + .'- `OSS`'."\n" + ."\n" + .'- `Media`'."\n" + ."\n" + .'- `URL`', 'type' => 'string', 'required' => false, 'example' => 'Media', 'title' => ''], + 'Media' => ['description' => 'If `Type` is `OSS`, specify the Object Storage Service (OSS) URL of the media file. Example: `OSS://test-bucket/video/202208/test.mp4`'."\n" + ."\n" + .'If `Type` is `Media`, specify the media ID. Example: `c5c62d8f0361337cab312dce8e77dc6d`'."\n" + ."\n" + .'If `Type` is `URL`, specify the HTTP URL of the media file. Example: `https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4`', 'type' => 'string', 'required' => false, 'example' => 'c5c62d8f03613************c6d', 'title' => ''], ], - ], - ], - ], - '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', - ], - 'UpdateAdInsertion' => [ - 'summary' => 'Modifies an ad insertion configuration.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238117', - 'abilityTreeNodes' => [ - 'FEATUREiceN57D5I', - ], - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源一级ID', - 'description' => 'The configuration name, which cannot be modified.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_ad', - ], - ], - [ - 'name' => 'ContentUrlPrefix', - 'in' => 'formData', - 'schema' => [ - 'title' => '内容URL前缀', - 'description' => 'The URL prefix for the source content. HTTP and HTTPS are supported. The maximum length is 512 characters.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://source.com/', - ], - ], - [ - 'name' => 'SlateAdUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => 'slate广告URL', - 'description' => 'The HTTP or HTTPS URL of the slate ad. Only MP4 format is supported. The maximum length is 2,048 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://storage.com/slate1.mp4', - ], - ], - [ - 'name' => 'ConfigAliases', - 'in' => 'formData', - 'schema' => [ - 'title' => '动态配置别名', - 'description' => 'A JSON string that specifies the player parameter variables and aliases. Format: { "player_params.{name}": { "{key}": "{value}" } }. 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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "player_params.p1": { "1": "abc" } }', - ], - ], - [ - 'name' => 'CdnContentSegmentUrlPrefix', - 'in' => 'formData', - 'schema' => [ - 'title' => '视频内容分片的CDN前缀', - 'description' => 'The CDN prefix for content segments. HTTP and HTTPS are supported. The maximum length is 512 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://cdn.com/', - ], - ], - [ - 'name' => 'CdnAdSegmentUrlPrefix', - 'in' => 'formData', - 'schema' => [ - 'title' => '广告分片的CDN前缀', - 'description' => 'The CDN prefix for ad segments. HTTP and HTTPS are supported. The maximum length is 512 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://cdn.com/', - ], - ], - [ - 'name' => 'AdMarkerPassthrough', - 'in' => 'formData', - 'schema' => [ - 'title' => '内容URL前缀', - 'description' => 'Specifies whether to enable ad marker passthrough. Default value: OFF.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF: Disable.'."\n" - .'* ON: Enable.'."\n", - 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'ON', + 'docRequired' => true, + 'example' => '', ], ], [ - 'name' => 'PersonalizationThreshold', - 'in' => 'formData', - 'schema' => [ - 'title' => '个性化配置阈值', - 'description' => 'Specifies the maximum duration of underfilled time allowed in an ad break. Unit: seconds. Default value: 8 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the template that specifies the analysis algorithms to use. For more information about managing templates, see [Create Custom Template](https://help.aliyun.com/zh/ims/developer-reference/api-ice-2020-11-09-createcustomtemplate?spm=a2c4g.11186623.help-menu-193643.d_5_0_3_3_0_0.17b66afamjKySv) and [AI-powered tagging template](https://help.aliyun.com/zh/ims/user-guide/smart-tagging-template?spm=a2c4g.11186623.0.i15).', 'type' => 'string', 'required' => false, 'example' => '39f8e0bc00***************', 'title' => ''], ], [ - 'name' => 'AdsUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => '广告策略服务器URL', - 'description' => 'The request URL of the ad decision server (ADS). HTTP and HTTPS are supported. The maximum length is 2,048 characters.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'."\n", - ], + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => ['description' => 'The template configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Config' => [ - 'description' => 'The ad insertion configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the configuration was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the configuration was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z', - ], - 'Name' => [ - 'title' => '广告插入配置名称', - 'description' => 'The name of the ad insertion configuration.'."\n", - 'type' => 'string', - 'example' => 'my_ad', - ], - 'ContentUrlPrefix' => [ - 'title' => '内容URL前缀', - 'description' => 'The URL prefix for the source content.'."\n", - 'type' => 'string', - 'example' => 'https://source.com/', - ], - 'AdsUrl' => [ - 'title' => '广告策略服务器URL', - 'description' => 'The request URL of ADS.'."\n", - 'type' => 'string', - 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', - ], - 'ConfigAliases' => [ - 'title' => '动态配置别名', - 'description' => 'The player parameter variables and aliases.'."\n", - 'type' => 'string', - 'example' => '{ "player_params.p1": { "1": "abc" } }'."\n", - ], - 'PersonalizationThreshold' => [ - 'title' => '个性化配置阈值', - 'description' => 'The personalization threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'SlateAdUrl' => [ - 'title' => 'slate广告URL', - 'description' => 'The URL of the slate ad.'."\n", - 'type' => 'string', - 'example' => 'http://storage.com/slate1.mp4', - ], - 'CdnConfig' => [ - 'title' => 'CDN配置', - 'description' => 'The CDN configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContentSegmentUrlPrefix' => [ - 'title' => '视频内容分片的CDN前缀', - 'description' => 'The CDN prefix for content segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/', - ], - 'AdSegmentUrlPrefix' => [ - 'title' => '广告分片的CDN前缀', - 'description' => 'The CDN prefix for ad segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/', - ], - ], - ], - 'AdMarkerPassthrough' => [ - 'title' => '广告标记透传', - 'description' => 'Indicates whether ad marker passthrough is enabled.'."\n", - 'type' => 'string', - 'example' => 'ON', - ], - 'ManifestEndpointConfig' => [ - 'title' => '清单播放端点配置', - 'description' => 'The playback endpoint configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'HlsPrefix' => [ - 'title' => 'HLS清单播放端点前缀', - 'description' => 'The prefix of the playback endpoint for HLS manifests.'."\n", - 'type' => 'string', - 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', - ], - 'DashPrefix' => [ - 'title' => 'DASH清单播放端点前缀', - 'description' => 'DASH清单播放端点前缀', - 'type' => 'string', - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', - ], + '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' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => 'SubmitVideoCognitionJob', + 'description' => 'This is an [asynchronous API](~~3027141~~). After you submit a job, the service returns a job ID and queues it for processing. The final results are delivered via a callback notification. You can also check the job status by calling the [QueryIntelligentContentUnderstandingTask](~~2975154~~) operation.', + 'requestParamsDescription' => '### nlpParams'."\n" + ."\n" + .'| Feature | Parameter | Type | Required | Description | Example |'."\n" + .'| ------------------- | ------------------------ | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |'."\n" + .'| | nlpParams | object | Yes | Contains parameters for natural language processing (NLP). This object is required if the template\'s analysis type includes NLP; otherwise, the job fails. | {"sourceLanguage":"cn"} |'."\n" + .'| Transcription | sourceLanguage | string | Yes | The source language model for transcription. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), and `fspk` (mixed Chinese and English). | "cn" |'."\n" + .'| Speaker diarization | diarizationEnabled | boolean | No | Specifies whether to enable speaker diarization. The default value is `false`. | true |'."\n" + .'| | speakerCount | integer | No | The number of speakers for speaker diarization. If you set this to `0`, the service automatically detects the number of speakers. To specify a fixed number of speakers, set the value to that number, for example, `2`. | 2 |'."\n" + .'| Summarization | summarizationEnabled | boolean | No | Specifies whether to enable summarization. When enabled, the service generates outputs such as a full-text summary and a speaker summary. | true |'."\n" + .'| | summarizationTypes | string | No | Required if `summarizationEnabled` is `true`. Specify one or more of the following summary types: `Paragraph` (full-text summary), `Conversational` (speaker summary), `QuestionsAnswering` (Q&A summary), or `MindMap` (mind map). | "Paragraph,Conversational,QuestionsAnswering,MindMap" |'."\n" + .'| Translation | translationEnabled | boolean | No | Specifies whether to enable translation. | true |'."\n" + .'| | targetLanguages | string | No | The target languages for translation. Required if `translationEnabled` is `true`. Valid values: `cn` (Chinese), `en` (English), `yue` (Cantonese), and `fspk` (mixed Chinese and English). | "en,cn" |'."\n" + .'| Chapter detection | autoChaptersEnabled | boolean | No | Specifies whether to enable chapter detection. The results include chapter titles and summaries. | true |'."\n" + .'| Meeting assistance | meetingAssistanceEnabled | boolean | No | Specifies whether to enable meeting assistance. The results include categories, keywords, key sentences, and action items. | true |', + 'changeSet' => [ + ['createdAt' => '2025-11-17T14:18:38.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\",\\n \\"ConfigAliases\\": \\"{ \\\\\\"player_params.p1\\\\\\": { \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\" } }\\\\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\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\"\\n}","type":"json"}]', - 'title' => 'UpdateAdInsertion', - ], - 'GetAdInsertion' => [ - 'summary' => 'Obtains details of an ad insertion configuration.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitVideoCognitionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitVideoTranslationJob' => [ + 'summary' => 'Call this operation to submit a video translation job. This service can translate subtitles and spoken content, and generate lip-sync for the translated audio.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238117', - 'abilityTreeNodes' => [ - 'FEATUREiceN57D5I', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '222559', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'InputConfig', 'in' => 'query', - 'schema' => [ - 'title' => '资源一级ID', - 'description' => 'The name of the ad insertion configuration that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_ad', - ], + 'schema' => ['description' => 'The input parameters for the video translation job.'."\n" + ."\n" + .'- The input can be a video or a subtitle file.'."\n" + ."\n" + .'- The value must be a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{"Type":"Video","Video":"1628ae20c36******8f6f7c77a6302"}', 'title' => ''], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'query', + 'schema' => ['description' => 'Configuration parameters for the video translation job, specified as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{"SourceLanguage":"zh","TargetLanguage":"en","DetextArea":"Auto"}', 'title' => ''], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => ['description' => 'Output parameters for the video translation job. The output can be a video or a subtitle file.', 'type' => 'string', 'required' => false, 'example' => '{"MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.mp4"}', 'title' => ''], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => 'The job title.', 'type' => 'string', 'example' => 'Test title', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The job description.', 'type' => 'string', 'example' => 'Test description', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'User data for the job, provided as a JSON string. The string can be up to 512 bytes long.'."\n" + ."\n" + .'- Use this parameter to [configure a custom callback URL](~~451631~~).', 'type' => 'string', 'required' => false, 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request.', 'type' => 'string', 'example' => 'Test ClientToken', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SignatureMehtod', + 'in' => 'query', + 'schema' => ['description' => 'The system automatically populates this parameter. You do not need to set it.', 'type' => 'string', 'example' => 'Auto-complete, no need to write', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SignatureType', + 'in' => 'query', + 'schema' => ['description' => 'The system automatically populates this parameter. You do not need to set it.', 'type' => 'string', 'example' => 'Auto-complete, no need to write', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Config' => [ - 'description' => 'The ad insertion configuration.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the configuration was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z ', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the configuration was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z ', - ], - 'Name' => [ - 'title' => '广告插入配置名称', - 'description' => 'The name of the configuration.'."\n", - 'type' => 'string', - 'example' => 'my_ad', - ], - 'ContentUrlPrefix' => [ - 'title' => '内容URL前缀', - 'description' => 'The prefix of the source URL.'."\n", - 'type' => 'string', - 'example' => 'https://source.com/'."\n", - ], - 'AdsUrl' => [ - 'title' => '广告策略服务器URL', - 'description' => 'The URL of the ad decision server (ADS).'."\n", - 'type' => 'string', - 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', - ], - 'ConfigAliases' => [ - 'title' => '动态配置别名', - 'description' => 'The aliases for dynamic variable replacement.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "player_params.p1": {'."\n" - .' "1": "abc"'."\n" - .' }'."\n" - .'}', - ], - 'PersonalizationThreshold' => [ - 'title' => '个性化配置阈值', - 'description' => 'The personalization threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'SlateAdUrl' => [ - 'title' => 'slate广告URL', - 'description' => 'The URL of the slate ad.'."\n", - 'type' => 'string', - 'example' => 'http://storage.com/slate1.mp4', - ], - 'CdnConfig' => [ - 'title' => 'CDN配置', - 'description' => 'The CDN configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContentSegmentUrlPrefix' => [ - 'title' => '视频内容分片的CDN前缀', - 'description' => 'The CDN prefix for accessing content segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/', - ], - 'AdSegmentUrlPrefix' => [ - 'title' => '广告分片的CDN前缀', - 'description' => 'The CDN prefix for accessing ad segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/', - ], - ], - ], - 'AdMarkerPassthrough' => [ - 'title' => '广告标记透传', - 'description' => 'Indicates whether ad marker passthrough is enabled.'."\n", - 'type' => 'string', - 'example' => 'ON', - ], - 'ManifestEndpointConfig' => [ - 'title' => '清单播放端点配置', - 'description' => 'The playback endpoint prefix for accessing manifests.'."\n", - 'type' => 'object', - 'properties' => [ - 'HlsPrefix' => [ - 'title' => 'HLS清单播放端点前缀', - 'description' => 'The playback endpoint prefix for accessing HLS manifests.'."\n", - 'type' => 'string', - 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', - ], - 'DashPrefix' => [ - 'title' => 'DASH清单播放端点前缀', - 'description' => 'DASH清单播放端点前缀', - 'type' => 'string', - ], - ], - ], + 'JobId' => ['description' => 'The video translation job ID.', 'type' => 'string', 'example' => '****d718e2ff4f018ccf419a7b71****', 'title' => ''], ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Submit a Video Translation Job', + 'description' => '- The region in each media asset\'s OSS URL must match the region of the API endpoint you call.'."\n" + ."\n" + .'- This operation supports up to 30 requests per second (QPS). If you submit a large number of jobs, they are automatically queued and processed with dynamic scaling. Job concurrency is unlimited.'."\n" + ."\n" + .'- This is an [asynchronous API](~~3027141~~). After you submit a job, the operation returns a job ID and queues the job for background processing. The final result is delivered through a callback. You can also poll for the job status by calling the [GetAIJobResult](~~441172~~) operation.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'For detailed parameter descriptions and examples, see'."\n" + ."\n" + .''."\n" + ."\n" + .'[Introduction and Examples of Video Translation Parameters](https://help.aliyun.com/zh/ims/use-cases/introduction-and-examples-of-video-translation-parameters)'."\n" + ."\n" + .''."\n" + ."\n" + .''."\n" + ."\n" + .'[Introduction and Examples of Video Translation Parameters](~~2852702~~)'."\n" + ."\n" + .''."\n" + ."\n" + .'>', + 'requestParamsDescription' => 'For detailed parameter descriptions and examples, see: [Introduction and Examples of Video Translation Parameters](~~2852702~~)', + 'changeSet' => [ + ['createdAt' => '2025-02-07T02:01:27.000Z', 'description' => 'Request parameters changed'], ], - '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', - ], - 'ListAdInsertions' => [ - 'summary' => 'Obtains ad insertion configurations.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitVideoTranslationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'SubmitYikeAIAppJob' => [ + 'summary' => 'Submits a Yike AI application job.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238120', - 'abilityTreeNodes' => [ - 'FEATUREiceN57D5I', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'title' => '按广告名称查询，支持模糊匹配', - 'description' => 'The configuration name. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ad', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数，页码', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数，页宽', - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['description' => 'The AI application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_test', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数，排序方式，asc:按创建时间升序，desc:按创建时间降序', - 'description' => 'The sorting order of the configurations by creation time. asc: ascending. desc: descending.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', - ], - 'example' => 'asc', - ], + 'name' => 'AppParams', + 'in' => 'formData', + 'schema' => ['description' => 'The AI application runtime parameters, as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{"testKey":"testValue"}', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '数据抓取参数，获取后续数据的token，使用此方式获取数据时分页参数将无效', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******8EqYpQbZ6Eh7+Zz8DxVYoQ*****', - ], + 'name' => 'ProductionId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the project. If provided, the output is saved to this project.', 'type' => 'string', 'required' => false, 'example' => 'ProductionId', 'title' => ''], ], [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '数据抓取参数，获取后续数据的最大记录数，使用此方式获取数据时分页参数将无效', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '10', - ], + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the folder. If provided, the output is saved to this folder.', 'type' => 'string', 'required' => false, 'example' => 'fd-cReaEcVqQK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Configs' => [ - 'title' => '数组', - 'description' => 'Array'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'AdInsertionConifgItemType', - 'description' => 'AdInsertionConifgItemType'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the configuration was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the configuration was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-06-13T08:26:09Z'."\n", - ], - 'Name' => [ - 'title' => '广告插入配置名称', - 'description' => 'The name of the ad insertion configuration.'."\n", - 'type' => 'string', - 'example' => 'my_ad', - ], - 'ContentUrlPrefix' => [ - 'title' => '内容URL前缀', - 'description' => 'The URL prefix for the source content.'."\n", - 'type' => 'string', - 'example' => 'https://source.com/', - ], - 'AdsUrl' => [ - 'title' => '广告策略服务器URL', - 'description' => 'The request URL of the ad decision server (ADS).'."\n", - 'type' => 'string', - 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', - ], - 'ConfigAliases' => [ - 'title' => '动态配置别名', - 'description' => 'The player parameter variables and aliases.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "player_params.p1": {'."\n" - .' "1": "abc"'."\n" - .' }'."\n" - .'}', - ], - 'PersonalizationThreshold' => [ - 'title' => '个性化配置阈值', - 'description' => 'The personalization threshold that defines the maximum duration of underfilled time allowed in an ad break.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'SlateAdUrl' => [ - 'title' => 'slate广告URL', - 'description' => 'The URL of the slate ad.'."\n", - 'type' => 'string', - 'example' => 'http://storage.com/slate1.mp4', - ], - 'CdnConfig' => [ - 'title' => 'CDN配置', - 'description' => 'The CDN configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContentSegmentUrlPrefix' => [ - 'title' => '视频内容分片的CDN前缀', - 'description' => 'The CDN prefix for content segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/', - ], - 'AdSegmentUrlPrefix' => [ - 'title' => '广告分片的CDN前缀', - 'description' => 'The CDN prefix for ad segments.'."\n", - 'type' => 'string', - 'example' => 'http://cdn.com/', - ], - ], - ], - 'AdMarkerPassthrough' => [ - 'title' => '广告标记透传', - 'description' => 'Indicates whether ad marker passthrough is enabled.'."\n", - 'type' => 'string', - 'example' => 'ON', - ], - 'ManifestEndpointConfig' => [ - 'title' => '清单播放端点配置', - 'description' => 'The playback endpoint configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'HlsPrefix' => [ - 'title' => 'HLS清单播放端点前缀', - 'description' => 'The prefix of the playback endpoint for HLS manifests.'."\n", - 'type' => 'string', - 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', - ], - 'DashPrefix' => [ - 'title' => 'DASH清单播放端点前缀', - 'description' => 'DASH清单播放端点前缀', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'PageNo' => [ - 'title' => '分页参数，页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页参数，页宽', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'SortBy' => [ - 'title' => '分页参数，排序方式，asc:按创建时间升序，desc:按创建时间降序', - 'description' => 'The sorting order of the configurations by creation time. asc: ascending. desc: descending.'."\n", - 'type' => 'string', - 'example' => 'asc', - ], - 'TotalCount' => [ - 'title' => '总记录数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'NextToken' => [ - 'title' => '数据抓取参数，获取后续数据的token，使用此方式获取数据时分页参数将无效', - '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.'."\n", - 'type' => 'string', - 'example' => '******8EqYpQbZ6Eh7+Zz8DxVYoQ*****', - ], - 'MaxResults' => [ - 'title' => '数据抓取参数，获取后续数据的最大记录数，使用此方式获取数据时分页参数将无效', - 'description' => 'The maximum number of entries to retrieve in a subsequent request. If this parameter is used, the pagination parameters become invalid.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'RequestId' => ['description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', 'title' => ''], + 'JobId' => ['description' => 'The unique identifier for the submitted job.', 'type' => 'string', 'example' => 'ab4802364a2e49208c99efab82df****', 'title' => ''], ], + 'title' => '', + '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', - ], - 'DeleteAdInsertion' => [ - 'summary' => 'Deletes an ad insertion configuration.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Submit an application job ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitYikeAIAppJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82df****\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'SubmitYikeStoryboardJob' => [ + 'summary' => 'Submits a Yike AI application job.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -65756,221 +52809,319 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238117', - 'abilityTreeNodes' => [ - 'FEATUREiceN57D5I', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREiceAC7EJK'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'SourceType', 'in' => 'formData', - 'schema' => [ - 'title' => '资源一级ID', - 'description' => 'The name of the configuration that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_ad', - ], + 'schema' => ['title' => '', 'description' => 'The source type.', 'type' => 'string', 'required' => false, 'example' => 'Novel'], + ], + [ + 'name' => 'FileURL', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The OSS address of the file.', 'type' => 'string', 'example' => 'http://test.oss-cn-shanghai.aliyuncs.com/test.mp4', 'required' => false], + ], + [ + 'name' => 'ShotSplitMode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The shot split mode.', 'type' => 'string', 'example' => 'firstPersonNarration', 'required' => false], + ], + [ + 'name' => 'StyleId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The storyboard style ID.', 'type' => 'string', 'example' => 'RealisticPhotography', 'required' => false], + ], + [ + 'name' => 'AspectRatio', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The aspect ratio of the output video.', 'type' => 'string', 'example' => '4:3', 'required' => false], + ], + [ + 'name' => 'Resolution', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resolution of the output video.', 'type' => 'string', 'example' => '720P', 'required' => false], + ], + [ + 'name' => 'ShotPromptMode', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The storyboard shot generation mode.', 'type' => 'string', 'example' => 'multi', 'required' => false], + ], + [ + 'name' => 'NarrationVoiceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The narration voice ID.', 'type' => 'string', 'example' => 'sys_YoungGracefulWoman', 'required' => false], + ], + [ + 'name' => 'VideoModel', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The video model.', 'type' => 'string', 'example' => 'wan2.6-r2v-flash', 'required' => false], + ], + [ + 'name' => 'ModelParams', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Parameters for the model, in JSON format.', 'type' => 'string', 'example' => '{'."\n" + .' "AudioEnable": false'."\n" + .'}', 'required' => false], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The job title. It must be a UTF-8 encoded string of up to 128 bytes. If you do not specify a title, the system generates a default one based on the date.', 'type' => 'string', 'example' => 'test-title', 'required' => false], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Custom settings in JSON format. This parameter can contain the following field:'."\n" + ."\n" + .'- The `NotifyAddress` field specifies the callback URL that is invoked when the job is complete. Both MNS and HTTP callbacks are supported.', 'type' => 'string', 'example' => '{'."\n" + .' "NotifyAddress": "https://www.callback.com"'."\n" + .'}', 'required' => false], + ], + [ + 'name' => 'SkipFailureShot', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to skip a failed shot. The default value is `true`.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], + ], + [ + 'name' => 'ExecMode', + 'in' => 'query', + 'schema' => ['description' => 'The storyboard generation execution mode.'."\n" + ."\n" + .'- `FullPipeline`: Executes the full generation pipeline, including both storyboard creation and shot video generation.'."\n" + ."\n" + .'- `StoryboardOnly`: Generates only the storyboard.', 'type' => 'string', 'required' => false, 'example' => 'FullPipeline', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], + 'JobId' => ['title' => '', 'description' => 'The job ID.', 'type' => 'string', 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66'], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Submit a storyboard generation job ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'DeleteAdInsertion', - ], - 'GetSourceLocation' => [ - 'summary' => 'Queries a source location.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitYikeStoryboardJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'TakeoverAIAgentCall' => [ + 'summary' => 'Hands off a conversation to a human agent.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREiceMX4DML'], ], 'parameters' => [ [ - 'name' => 'SourceLocationName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourceLocation', - ], + 'schema' => ['description' => 'The ID of the AI agent that will be taken over.', 'type' => 'string', 'required' => false, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], + ], + [ + 'name' => 'HumanAgentUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the human agent that will take over the AI agent (UserId in ARTC). If you do not specify this parameter, it is automatically generated and returned.', 'type' => 'string', 'required' => false, 'example' => 'uid2', 'title' => ''], + ], + [ + 'name' => 'RequireToken', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return the ARTC token. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'SourceLocation' => [ - 'description' => 'The source location information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******'], + 'ChannelId' => ['description' => 'The ID of the ARTC channel.', 'type' => 'string', 'example' => '70f22d5784194938a7e387052f2b3208', 'title' => ''], + 'HumanAgentUserId' => ['description' => 'The ID of the human agent.', 'type' => 'string', 'example' => 'uid2', 'title' => ''], + 'Token' => ['description' => 'The ARTC token.', 'type' => 'string', 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetSourceLocation', - ], - 'UpdateSourceLocation' => [ - 'summary' => 'Modifies a source location.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\",\\n \\"HumanAgentUserId\\": \\"uid2\\",\\n \\"Token\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\"\\n}","type":"json"}]', + 'title' => 'TakeoverAIAgentCall', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:TakeoverAIAgentCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateAIAgentInstance' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '236521', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'SourceLocationName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourceLocation', - ], + 'schema' => ['description' => 'The ID of the AI agent instance.'."\n" + ."\n" + .'> This unique ID is returned after the AI agent instance starts successfully. For more information about starting an agent, see [StartAIAgentInstance](~~2846201~~) and [GenerateAIAgentCall](~~2846209~~).', 'type' => 'string', 'required' => true, 'example' => '39f8e0bc005e4f309379701645f4****', 'title' => ''], ], [ - 'name' => 'BaseUrl', + 'name' => 'AgentConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol and hostname of the source location.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.com', - ], + 'style' => 'json', + 'schema' => ['description' => 'The AI agent configuration to update. This configuration is merged with the existing configuration of the instance. For more information, see the AIAgentConfig definition. The following parameters in AIAgentConfig can be updated:'."\n" + ."\n" + .'- VoiceId'."\n" + ."\n" + .'- EnableVoiceInterrupt'."\n" + ."\n" + .'- Greeting'."\n" + ."\n" + .'- Volume'."\n" + ."\n" + .'- EnablePushToTalk'."\n" + ."\n" + .'- UseVoiceprint'."\n" + ."\n" + .'- BailianAppParams', '$ref' => '#/components/schemas/AIAgentConfig', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'EnableSegmentDelivery', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to use an independent domain name to access the segments.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Custom user data.', 'type' => 'string', 'required' => false, 'example' => '{"VoiceId":"xiaoxia"}', 'title' => ''], ], [ - 'name' => 'SegmentDeliveryUrl', + 'name' => 'TemplateConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name used to access the segments.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxxx.com', - ], + 'style' => 'json', + 'schema' => ['description' => '> The AI agent template configuration. This parameter is deprecated. Use the AgentConfig parameter instead.'."\n" + ."\n" + .'The AI agent configuration to update. This configuration is merged with the existing configuration of the instance. For more information, see the [AIAgentTemplateConfig](~~2846193~~) definition.'."\n" + .'The following parameters in AIAgentTemplateConfig can be updated:'."\n" + ."\n" + .'- VoiceId (Voice ID)'."\n" + ."\n" + .'- EnableVoiceInterrupt (Enable voice interruption)'."\n" + ."\n" + .'- Greeting (Greeting)'."\n" + ."\n" + .'- Volume (Volume)'."\n" + ."\n" + .'- EnablePushToTalk (Enable push-to-talk)'."\n" + ."\n" + .'- UseVoiceprint (Use voiceprint)'."\n" + ."\n" + .'- AsrMaxSilence (ASR maximum silence duration)', 'deprecated' => true, '$ref' => '#/components/schemas/AIAgentTemplateConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'SourceLocation' => [ - 'description' => 'The source location information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update AI Agent Instance Configuration', + 'summary' => 'Modifies the configuration of a specified AI agent instance.', + 'description' => 'This operation updates the configuration of an AI agent instance, such as its voice.', + 'changeSet' => [ + ['createdAt' => '2025-05-29T07:43:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-23T16:30:40.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpdateSourceLocation', - ], - 'DeleteSourceLocation' => [ - 'summary' => 'Deletes a source location.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:UpdateAIAgentInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateAdInsertion' => [ + 'summary' => 'Modifies an ad insertion configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -65979,219 +53130,280 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => ['FEATUREiceN57D5I'], ], 'parameters' => [ [ - 'name' => 'SourceLocationName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourceLocation', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The configuration name, which cannot be modified.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_ad'], ], [ - 'name' => 'SoftDelete', - 'in' => 'query', + '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. Format: { "player\\_params.{name}": { "{key}": "{value}" } }. 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.', '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 use delete markers.'."\n", - 'type' => 'boolean', + '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, - 'example' => 'true', + '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]'."\n"], + ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid value:'."\n" - ."\n" - .'* true: The request succeeded.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + '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 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 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' => '{ "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'], + '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' => 'The prefix of the playback endpoint for DASH manifests.', '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' => '****63E8B7C7-4812-46AD-0FA56029AC86****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\",\\n \\"ConfigAliases\\": \\"{ \\\\\\"player_params.p1\\\\\\": { \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\" } }\\\\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\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\"\\n}","type":"json"}]', + 'title' => 'UpdateAdInsertion', + 'changeSet' => [ + ['createdAt' => '2025-05-29T03:34:26.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteSourceLocation', - ], - 'ListSourceLocations' => [ - 'summary' => 'Lists source locations.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAdInsertion'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateAdInsertion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateAvatarTrainingJob' => [ + 'summary' => 'Modifies a digital human training job. You can modify the basic information or update parameters such as Video and Transparent for retraining if the training failed.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SourceLocationName', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySourceLocation', - ], + 'schema' => ['description' => 'The ID of the digital human training job.', 'type' => 'string', 'required' => true, 'example' => '****cdb3e74639973036bc84****', 'title' => ''], ], [ - 'name' => 'FilterState', + 'name' => 'AvatarName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to ignore source locations marked as deleted. A value of true means ignoring source locations marked as deleted.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '- The name of the digital human.'."\n" + ."\n" + .'- The name can be up to seven characters in length.', 'type' => 'string', 'example' => 'Decimal', 'maxLength' => 7, 'required' => false, 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'AvatarDescription', 'in' => 'query', - 'schema' => [ - 'description' => '* The page number.'."\n" - .'* Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + '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' => 1024, 'required' => false, 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Thumbnail', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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.'."\n" + ."\n" + .'- The URL cannot be updated after the digital human is trained.', 'type' => 'string', 'maxLength' => 512, 'required' => false, 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', 'title' => ''], ], [ - 'name' => 'SortByModifiedTime', + 'name' => 'Portrait', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order of the source locations based on the time when they were last modified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + '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' => 'SortBy', + 'name' => 'Video', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order. By default, the query results are sorted by creation time in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + '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' => '- Indicates whether the input video supports alpha channels.'."\n" + ."\n" + .'- You can modify this parameter only if the job is in the Init or Fail state.'."\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 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SourceLocationList' => [ - 'description' => 'The source locations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The source location information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', + '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\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SourceLocationList\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListSourceLocations', - ], - 'CreateSourceLocation' => [ - 'summary' => 'Creates a source location.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + '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' => 'UpdateAvatarTrainingJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAvatarTrainingJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateAvatarTrainingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateCategory' => [ + 'summary' => 'Updates a category.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -66199,95 +53411,70 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SourceLocationName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourcelocation', - ], - ], - [ - 'name' => 'BaseUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol and hostname of the source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'http://xxx.com', - ], - ], - [ - 'name' => 'EnableSegmentDelivery', + 'name' => 'CateName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to use an independent domain name to access the segments.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'Category 1', 'required' => true, 'title' => ''], ], [ - 'name' => 'SegmentDeliveryUrl', + 'name' => 'CateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name used to access the segments.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxxxx.com', - ], + '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' => '43', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'SourceLocation' => [ - 'description' => 'The source location information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\"\\n}","type":"json"}]', + 'title' => 'UpdateCategory', + 'description' => 'After you create a media asset category, you can call this operation to find the category based on the category ID and change the name of the category.', + 'changeSet' => [ + ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateSourceLocation', - ], - 'UpdateProgram' => [ - 'summary' => 'Modifies a program in a MediaWeaver channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCategory'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateCategory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateChannel' => [ + 'summary' => 'Modifies a MediaWeaver channel.', + 'description' => ' ', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -66299,131 +53486,92 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ - [ - 'name' => 'ProgramName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the program.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'program1', - ], - ], [ 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', - ], - ], - [ - 'name' => 'ClipRange', - 'in' => 'query', - 'schema' => [ - 'description' => 'Extracts a clip from the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ - 'name' => 'AdBreaks', + 'name' => 'AccessPolicy', 'in' => 'query', - 'schema' => [ - 'description' => 'The information about ad breaks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"MessageType":"SPLICE_INSERT","OffsetMillis":1000,"SourceLocationName":"MySourceLocation","SourceName":"MyAdSource","SpliceInsertSettings":{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}}]', - ], + 'schema' => ['description' => 'Specifies whether to enable access control.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'SourceLocationName', + 'name' => 'AccessToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySourceLcation', - ], + 'schema' => ['description' => 'The token for accessing the channel.', 'type' => 'string', 'required' => false, 'example' => 'xxxxx', 'title' => ''], ], [ - 'name' => 'SourceName', + 'name' => 'FillerSourceLocationName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySource', - ], + 'schema' => ['description' => 'The source location of the filler slate.', 'type' => 'string', 'required' => false, 'example' => 'MySourceLocation', 'title' => ''], ], [ - 'name' => 'SourceType', + 'name' => 'FillerSourceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The source type of the program. Valid values: vodSource and liveSource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vodSource', - ], + 'schema' => ['description' => 'The name of the filler slate.', 'type' => 'string', 'required' => false, 'example' => 'MySource', 'title' => ''], ], [ - 'name' => 'Transition', + 'name' => 'OutPutConfigList', 'in' => 'query', - 'schema' => [ - 'description' => 'The program transition method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', - ], + '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' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Program' => [ - 'description' => 'The information about the program.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyProgram', - ], + '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', + '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' => 'UpdateChannel', + 'changeSet' => [ + ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpdateProgram', - ], - 'GetProgram' => [ - 'summary' => 'Queries a program.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateChannel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateCustomTemplate' => [ + 'summary' => 'Updates a custom template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -66431,851 +53579,891 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProgramName', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the program.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'program1', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****96e8864746a0b6f3****'], ], [ - 'name' => 'ChannelName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', - ], + 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => false, 'example' => 'test-template', 'title' => ''], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => ['description' => 'The [template parameters](~~448291~~).', 'type' => 'string', 'required' => false, 'example' => '{"param": "sample"}', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Program' => [ - 'description' => 'The information about the program.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyProgram', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateCustomTemplate', + 'changeSet' => [ + ['createdAt' => '2022-07-11T09:38:07.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetProgram', - ], - 'DeleteChannel' => [ - 'summary' => 'Deletes a channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomTemplate'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateCustomTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateCustomizedVoice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ChannelName', + 'name' => 'VoiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', - ], + 'schema' => ['description' => 'The voice ID.', 'type' => 'string', 'required' => true, 'example' => 'xiaozhuan', 'title' => ''], + ], + [ + 'name' => 'DemoAudioMediaId', + 'in' => 'query', + 'schema' => ['description' => 'The media asset ID of the sample audio file.', 'type' => 'string', 'required' => false, 'example' => '****4d5e829d498aaf966b119348****', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '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', - ], - 'UpdateSource' => [ - 'summary' => 'Modifies a source.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateCustomizedVoice', + 'summary' => 'Updates a personalized human voice. Only the media asset ID of the sample audio file can be modified.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomizedVoice'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateCustomizedVoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateEditingProject' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'PrivateKey' => [], + ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREiceM55707'], ], 'parameters' => [ [ - 'name' => 'SourceLocationName', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourcelocation', - ], + 'schema' => ['description' => 'The project title.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testtimeline'], ], [ - 'name' => 'SourceType', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vodSource', - ], + 'schema' => ['description' => 'The project description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'testtimeline001desciption'], ], [ - 'name' => 'SourceName', + 'name' => 'Timeline', + 'in' => 'formData', + 'schema' => ['description' => 'The project timeline, in JSON format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySource', - ], + 'schema' => ['description' => 'The template ID. Use this parameter to quickly build a timeline.>You can specify only one of `ProjectId`, `Timeline`, and `TemplateId`. If you specify `TemplateId`, `ClipsParam` is required.>', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '****96e8864746a0b6f3****'], ], [ - 'name' => 'HttpPackageConfigurations', + 'name' => 'ClipsParam', 'in' => 'query', - 'schema' => [ - 'description' => 'The source configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{'."\n" - .' "sourceGroupName": "mySourceGroup-1",'."\n" - .' "relativePath": "group1/hls.m3u8",'."\n" - .' "packageType": "hls"'."\n" - .'}]', - ], + 'schema' => ['description' => 'The clip parameters for the template, in JSON format. This parameter is required if you specify `TemplateId`. For more information about the format, see [Create and use a standard template](~~328557~~) and [Create and use an advanced template](~~291418~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'See the template user guide.'], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => ['description' => 'The project cover.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'https://****.com/6AB4D0E1E1C7446888****.png'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****4ee4b97e27b525142a6b2****'], + ], + [ + 'name' => 'BusinessStatus', + 'in' => 'query', + 'schema' => ['description' => 'The business status of the project. You can typically ignore this parameter for standard cloud editing projects. Use this parameter to modify the project\'s reservation status:'."\n" + ."\n" + .'- `Reserving`: The project is being reserved.'."\n" + ."\n" + .'- `ReservationCanceled`: The reservation for the project is canceled.', 'type' => 'string', 'required' => false, 'example' => 'Reserving', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Source' => [ - 'description' => 'The source information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySource', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '****25818875-5F78-4AF6-D7393642CA58****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter \\ is not valid.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'ProjectNotFound', 'errorMessage' => 'The specified project not found', 'description' => ''], + ], + ], + 'title' => 'UpdateEditingProject', + 'summary' => 'Updates the title, timeline, cover, and other properties of a cloud editing project.', + 'changeSet' => [ + ['createdAt' => '2023-11-23T01:57:57.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpdateSource', - ], - 'StartChannel' => [ - 'summary' => 'Starts a channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEditingProject'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateEditingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****25818875-5F78-4AF6-D7393642CA58****\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateHotwordLibrary' => [ + 'summary' => 'Modifies a specified hotword library, including its name, description, and hotword list.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREice405U0J'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ChannelName', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the hotword library. It can be up to 100 characters in length.', 'type' => 'string', 'required' => false, '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' => 'Hotwords', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', + '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' => false, + 'example' => 'Lexicon containing celebrity names', ], ], + [ + 'name' => 'HotwordLibraryId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the hotword library.', 'type' => 'string', 'required' => true, 'example' => '*a0052ff71efbfd4e7e6c66*', 'title' => ''], + ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '*3B-0E1A-586A-AC29-742247*'], + 'Success' => ['description' => 'The ID of the hotword library.', 'type' => 'string', 'example' => '****96e8864746a0b6f3****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'StartChannel', - ], - 'DeleteProgram' => [ - 'summary' => 'Deletes a program from a channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*3B-0E1A-586A-AC29-742247*\\",\\n \\"Success\\": \\"****96e8864746a0b6f3****\\"\\n}","type":"json"}]', + 'title' => 'UpdateHotwordLibrary', + 'description' => '## [](#)'."\n" + ."\n" + .'- Modify a specified hotword library.'."\n" + ."\n" + .'- The hotword library ID (`HotwordLibraryId`) is required to identify the library that requires modification.'."\n" + ."\n" + .'- You can modify its name (`Name` ), description (`Description` ), and hotword list (`HotWords`).'."\n" + ."\n" + .'- Each hotword in the list can also be modified, including its content (`Text`), weight (`Weight`), language (`Language`), and translation results (`TranspositionResultList`).'."\n" + ."\n" + .'- A single account supports up to 100 hotword libraries, each containing a maximum of 300 hotword entries. In a library, the combination of `language` and `text` of an entry must be unique. The combination of `TranslatedText` and `TargetLanguage` in `TranspositionResultList` must also be unique.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateHotwordLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateLivePackageChannel' => [ + 'summary' => 'Updates the configuration of a live package channel, including the protocol, segment duration, and number of segments.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '239702', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'ProgramName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the program.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'program_name', - ], + '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' => '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' => 'Protocol', + 'in' => 'formData', + 'schema' => ['description' => 'The ingest protocol. Only HLS is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'HLS'], + ], + [ + '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' => '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' => 'query', + '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'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', + 'title' => '', + 'description' => 'The returned data including the updated channel information and request ID.', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannel' => [ + 'description' => 'The information about the live package channel.', + 'type' => 'object', + 'properties' => [ + 'ChannelName' => ['description' => 'The channel name.', 'type' => 'string', 'title' => '', 'example' => 'channel-1'], + 'CreateTime' => ['description' => 'The time when the channel was created.', 'type' => 'string', 'title' => '', 'example' => '2024-07-16T02:24:42Z'], + 'Description' => ['description' => 'The channel description. It can be up to 1,000 characters in length.', '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.', 'type' => 'string', 'title' => '', 'example' => '2024-07-16T02:24:42Z'], + 'Protocol' => ['description' => 'The ingest protocol. Only HLS is supported.', 'type' => 'string', 'title' => '', 'example' => 'HLS'], + 'SegmentCount' => ['description' => 'The number of 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' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', 'title' => ''], + ], + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'description' => '创建成功', - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2024-07-16T02:24:42Z\\",\\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\\": \\"2024-07-16T02:24:42Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n },\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', + 'title' => 'UpdateLivePackageChannel', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'You need to provide the name of the channel group to which the channel belongs, channel name, protocol, segment duration, and number of segments to update. In addition, you can choose to add or modify the description of the channel. Make sure that the provided channel group name and channel name conform to the naming conventions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateLivePackageChannel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteProgram', + 'translator' => 'manual', ], - 'DeleteSource' => [ - 'summary' => 'Deletes a source from MediaWeaver.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateLivePackageChannelCredentials' => [ + 'summary' => 'Updates the credentials of ingest endpoints associated with a live package channel.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '240167', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'SourceLocationName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourceLocation', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vodSource', - ], + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The channel group name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'group-1'], ], [ - 'name' => 'SourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyVodSource', - ], + 'name' => 'ChannelName', + 'in' => 'formData', + 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ - 'name' => 'SoftDelete', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to use delete markers.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'RotateCredentials', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to update the credentials. 1: updates the credentials of endpoint 1. 2: updates the credentials of endpoint 2. 3: updates the credentials of endpoints 1 and 2.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '3'], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'IngestEndpoints' => [ + 'description' => 'The information about the ingest endpoint.', + 'type' => 'array', + 'items' => [ + 'description' => 'The username.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ingest endpoint ID. `input1` indicates primary and `input2` indicates secondary.', 'type' => 'string', 'example' => 'input1', 'title' => ''], + 'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => 'examplePassword123', 'title' => ''], + 'Url' => ['description' => 'The ingest endpoint URL.', 'type' => 'string', 'example' => 'rtmp://example.com/live/input1', 'title' => ''], + 'Username' => ['description' => 'The username.', 'type' => 'string', 'example' => 'user1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteSource', - ], - 'StopChannel' => [ - 'summary' => 'Stops a MediaWeaver channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"input1\\",\\n \\"Password\\": \\"examplePassword123\\",\\n \\"Url\\": \\"rtmp://example.com/live/input1\\",\\n \\"Username\\": \\"user1\\"\\n }\\n ],\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', + 'title' => 'UpdateLivePackageChannelCredentials', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'You can choose to update the primary endpoint, secondary endpoint, or both. The response includes the updated ingest endpoint URL, username, and password for the ingest device to reconfigure.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateLivePackageChannelCredentials', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateLivePackageChannelGroup' => [ + 'summary' => 'Updates the information about a live package channel group including its description.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '238119', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', - ], + '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' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The channel group description. It can be up to 1,000 characters in length.', 'type' => 'string', 'example' => 'This is a channel group.', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + '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', 'title' => '', 'example' => 'Updated description of the channel group.'], + 'GroupName' => ['description' => 'The channel group name.', 'type' => 'string', 'title' => '', 'example' => 'example-group-name'], + '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-origin.com'], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864'."\n", 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'StopChannel', - ], - 'ListChannels' => [ - 'summary' => 'Lists MediaWeaver channels.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + '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\\": \\"example-group-name\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"OriginDomain\\": \\"example-origin.com\\"\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\\\n\\"\\n}","type":"json"}]', + 'title' => 'UpdateLivePackageChannelGroup', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'This API operation allows you to modify the name and description of a live package channel group. The channel group name must conform to the naming conventions and can be up to 1,000 characters. The API response includes the updated channel group details and unique identifier of the request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateLivePackageChannelGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateLivePackageOriginEndpoint' => [ + 'summary' => 'Update the real-time packaging origin endpoint configuration of a channel group, supporting protocol, time-shift settings, and access control.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '239773', + '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' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MyChannel', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'channel-1'], ], [ - 'name' => 'ChannelTier', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tier of the channel. Valid values: basic and standard.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'basic', - ], + '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' => 'PlaybackMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The playback mode. Valid values: loop and linear.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'loop', - ], + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => ['description' => 'The protocol. Only HLS is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'HLS'], ], [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'description' => 'The channel status. A value of 0 specifies stopped. A value of 1 specifies started.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'ManifestName', + 'in' => 'formData', + 'schema' => ['description' => 'The playlist name. Default value: manifest.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'manifest'], ], [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The endpoint description.', 'type' => 'string', 'example' => 'This is an origin endpoint.', 'title' => '', 'required' => false], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'TimeshiftVision', + 'in' => 'formData', + 'schema' => ['description' => 'The number of days that time-shifted content is available. Maximum value: 30.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '5'], ], [ - 'name' => 'SortByModifiedTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order by modification time. Valid values: asc and desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + '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' => 'Abc123Def456'], ], [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order by creation time. Valid values: asc and desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + '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', 'title' => '', 'required' => false, 'example' => '192.168.1.0/24,10.0.0.1'], + ], + [ + 'name' => 'IpBlacklist', + 'in' => 'formData', + 'schema' => ['description' => 'The IP address blacklist. It supports subnet masks. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '103.0.0.0/8'], + ], + [ + 'name' => 'LivePackagingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'Live stream encapsulation configuration', '$ref' => '#/components/schemas/LivePackagingConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of channels returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '180', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ChannelList' => [ - 'description' => 'The channels.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The channel information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyChannel', + 'LivePackageOriginEndpoint' => [ + 'description' => 'The information about the origin endpoint.', + '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. It supports subnet masks. Multiple IP addresses are separated by commas (,).', 'type' => 'string', 'title' => '', 'example' => '10.21.222.1/32,192.168.100.0/24'], + 'IpWhitelist' => ['description' => 'The IP address whitelist. It supports subnet masks. Multiple IP addresses are separated by commas (,).', '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. Default value: manifest.', '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' => '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', + '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,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\\": 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' => 'Modify Real-Time Packaging Origin Endpoint', + 'description' => '## Request Description'."\n" + ."\n" + .'Modify the origin endpoint configuration for the real-time packaging service under a specified channel group. You can use this API to adjust the origin protocol policy, set the time-shift duration in days, define the playlist name, and configure IP blacklists and whitelists to achieve fine-grained management of real-time streaming media delivery. Note that some parameters are required, and you must provide either an IP whitelist or an origin request header (at least one of them).', + 'changeSet' => [ + ['createdAt' => '2025-05-29T03:09:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 180,\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"ChannelList\\": [\\n {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListChannels', - ], - 'ListPrograms' => [ - 'summary' => 'Lists programs.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateLivePackageOriginEndpoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateLiveRecordTemplate' => [ + 'summary' => 'Updates the information about a live stream recording template.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProgramName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the program.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'program1', - ], - ], - [ - 'name' => 'ChannelName', - 'in' => 'query', + 'name' => 'RecordFormat', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The list of recording formats.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The recording format.', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => 'The format of recording files.'."\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 a single segment. Unit: seconds'."\n" + ."\n" + .'> This parameter takes effect only if you set Format to m3u8.'."\n" + ."\n" + .'If you do not specify this parameter, the default value 30 seconds is used. Valid values: 5 to 30.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'required' => false, 'example' => '30'], + 'OssObjectPrefix' => ['description' => 'The name of the recording that is stored in Object Storage Service (OSS).'."\n" + ."\n" + .'- The name must be less than 256 bytes in length and can contain the {JobId}, {Sequence}, {StartTime}, {EndTime}, {EscapedStartTime}, and {EscapedEndTime} variables.'."\n" + ."\n" + .'- The name must contain the {StartTime} and {EndTime} variables or the {EscapedStartTime} and {EscapedEndTime} variables.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}'], + 'SliceOssObjectPrefix' => ['description' => 'The name of the TS segment.'."\n" + ."\n" + .'> This parameter is required only if you set Format to m3u8. By default, the duration of a segment is 30 seconds. The segment name must be less than 256 bytes in length and can contain the {JobId}, {UnixTimestamp}, and {Sequence} variables.'."\n" + ."\n" + .'The segment name must contain the {UnixTimestamp} and {Sequence} variables.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'required' => false, 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}'."\n"], + 'CycleDuration' => ['description' => 'The duration of the recording cycle. Unit: seconds If you do not specify this parameter, the default value 6 hours is used.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- If a live stream is interrupted during a recording cycle but is resumed within 3 minutes, the stream is recorded in the same recording before and after the interruption.'."\n" + ."\n" + .'- If a live stream is interrupted for more than 3 minutes, a new recording is generated. To change the default stream interruption time, submit a ticket.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'required' => false, 'example' => '3600', 'title' => ''], + ], + 'deprecated' => false, + 'required' => false, + 'example' => '', + ], + 'deprecated' => false, 'required' => true, - 'example' => 'MyChannel', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'example' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66'], ], [ - '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" - .'* desc: descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The template name.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'test template'], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of programs returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Programs' => [ - 'description' => 'The programs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the program.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyProgram', - ], - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'readOnly' => true, 'default' => '', 'title' => '', 'example' => '0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"Programs\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', - 'title' => 'ListPrograms', - ], - 'GetSource' => [ - 'summary' => 'Queries a source.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3\\"\\n}","type":"json"}]', + 'title' => 'UpdateLiveRecordTemplate', + 'description' => 'Only user-created templates can be updated. The preset template cannot be updated.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveRecordTemplate'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveRecordTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateLiveSnapshotTemplate' => [ + 'summary' => 'Updates the information about a live stream snapshot template.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -67283,229 +54471,233 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SourceLocationName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourceLocation', - ], + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****a046-263c-3560-978a-fb287782****'], ], [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vodSource', - ], + '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' => 'SourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyVodSource', - ], + '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" + .'- The value 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', 'title' => '', 'required' => false, '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" + .'- The value 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 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Source' => [ - 'description' => 'The source information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySource', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetSource', - ], - 'CreateChannel' => [ - 'summary' => 'Creates a channel in MediaWeaver.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ + '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' => ''], + ], [ - 'AK' => [], + ['errorCode' => 'TemplateNotFound', 'errorMessage' => 'No such template.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => 'UpdateLiveSnapshotTemplate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveSnapshotTemplate'], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveSnapshotTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'UpdateLiveTranscodeJob' => [ + 'summary' => 'Updates the information about a live stream transcoding job.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ChannelTier', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tier of the channel. Valid values: basic and standard.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'basic', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'PlaybackMode', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The playback mode. Valid values: loop and linear.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'loop', - ], + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'minLength' => 1, 'example' => 'mytest3', 'title' => ''], ], [ - 'name' => 'AccessPolicy', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable access control.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '****20b48fb04483915d4f2cd8ac****', 'title' => ''], ], [ - 'name' => 'AccessToken', + 'name' => 'StreamInput', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The token for accessing the channel.'."\n", - 'type' => 'string', + 'description' => 'The information about the input stream.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the input stream. The value can only be rtmp.', + 'type' => 'string', + 'required' => true, + 'enum' => ['rtmp'], + 'example' => 'rtmp', + 'title' => '', + ], + 'InputUrl' => ['description' => 'The URL of the input stream.', 'type' => 'string', 'required' => true, 'example' => 'rtmp://mydomain/app/stream1', 'title' => ''], + ], 'required' => false, - 'example' => 'xxxxx', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FillerSourceLocationName', + 'name' => 'TranscodeOutput', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The source location of the filler slate.'."\n", - 'type' => 'string', + 'description' => 'The information about the transcoding output.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the output stream. A value of LiveCenter indicates that the URL of the output stream is generated based on the domain name of ApsaraVideo Live. The value can only be LiveCenter.', 'type' => 'string', 'required' => true, 'example' => 'LiveCenter', 'title' => ''], + 'DomainName' => ['description' => 'The streaming domain name of ApsaraVideo Live.', 'type' => 'string', 'required' => true, 'example' => 'mydomain', 'title' => ''], + ], 'required' => false, - 'example' => 'MySourceLocation', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FillerSourceName', + 'name' => 'TimedConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the filler slate.'."\n", - 'type' => 'string', + 'description' => 'The configuration of a timed transcoding job.', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The start time of the transcoding job. Note: The time span between the start time and the current time cannot exceed seven days.', 'type' => 'string', 'required' => false, 'example' => '2022-06-19T02:16:41Z'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The stop time of the transcoding job. Note: The time span between the stop time and the current time cannot exceed seven days.', 'type' => 'string', 'required' => false, 'example' => '2022-08-05T06:08:31Z', 'title' => ''], + ], 'required' => false, - 'example' => 'FillerSource', - ], - ], - [ - 'name' => 'OutPutConfigList', - 'in' => 'query', - 'schema' => [ - 'description' => 'The channel output configurations.'."\n", - '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' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Channel' => [ - 'description' => 'The channel information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyChannel', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => 'UpdateLiveTranscodeJob', + 'description' => '- For a non-timed transcoding job, you can modify the Name parameter of the job, regardless of the job state.'."\n" + ."\n" + .'- For a timed job, you can modify the Name, StreamInput, TranscodeOutput, and TimedConfig parameters. However, the StreamInput, TranscodeOutput, and TimedConfig parameters can be modified only when the job is not started.', + 'changeSet' => [ + ['createdAt' => '2022-08-24T03:10:25.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', - 'title' => 'CreateChannel', - ], - 'ListSchedules' => [ - 'summary' => 'Lists the program schedule of a MediaWeaver channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveTranscodeJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateLiveTranscodeTemplate' => [ + 'summary' => 'Updates the information about a live stream transcoding template.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -67513,540 +54705,468 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', - ], - ], - [ - 'name' => 'WindowDurationSeconds', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time window of the program schedule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '14400', - ], + 'schema' => ['description' => 'The template ID. To obtain the template ID, log on to the [Intelligent Media Services (IMS) console](https://ims.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, 'example' => '****96e8864746a0b6f3****', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'Template1130-2', 'required' => false, 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'TemplateConfig', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + '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', + 'enumValueTitles' => ['H.264' => 'H.264', 'H.265' => 'H.265'], + 'type' => 'string', + 'required' => false, + 'enum' => [], + 'example' => 'H.264', + 'title' => '', + ], + 'Height' => ['description' => 'The height of the output video. Valid values:'."\n" + ."\n" + .'- Height ≥ 128'."\n" + ."\n" + .'- max (Height,Width) ≤ 2560'."\n" + ."\n" + .'- min(Height,Width)≤ 1440'."\n" + ."\n" + .'> The resolution of a video transcoded by using the H.265 Narrowband HD template cannot exceed 1,280 × 720 pixels.', 'type' => 'string', 'required' => false, 'example' => '720', 'title' => ''], + 'Width' => ['description' => 'The width of the output video. Valid values:'."\n" + ."\n" + .'- Width ≥ 128'."\n" + ."\n" + .'- max (Height,Width) ≤ 2560'."\n" + ."\n" + .'- min(Height,Width)≤ 1440'."\n" + ."\n" + .'> The resolution of a video transcoded by using the H.265 Narrowband HD template cannot exceed 1,280 × 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' => '30', '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 video 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:'."\n" + ."\n" + .'- 1: baseline. This value is suitable for mobile devices.'."\n" + ."\n" + .'- 2: main. This value is suitable for standard-definition devices.'."\n" + ."\n" + .'- 3: high. This value is suitable for high-definition devices.', + 'enumValueTitles' => [1 => '1', '2', '3'], + 'type' => 'string', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AudioParams' => [ + 'description' => 'The audio parameters.', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => 'The audio codec. Valid values: AAC MP3', + 'enumValueTitles' => ['MP3' => 'MP3', 'AAC' => 'AAC'], + 'type' => 'string', + 'enum' => [], + '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 44100.', 'type' => 'string', 'required' => false, 'example' => '44100', 'title' => ''], + 'Channels' => [ + 'description' => 'The number of sound channels. Valid values: 1: mono 2: binaural', + 'enumValueTitles' => [1 => '1', '2'], + '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' => [], + 'required' => false, + 'example' => 'aac_low', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Programs' => [ - 'description' => 'The program schedule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The schedule information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyScheduleData', - ], - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam.TemplateIdInuse', 'errorMessage' => 'Parameters: templateId is inuse.', '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}","type":"json"}]', + 'title' => 'UpdateLiveTranscodeTemplate', + 'changeSet' => [ + ['createdAt' => '2022-08-23T11:40:01.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 5,\\n \\"Programs\\": [\\n {\\n \\"EntryType\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"OffsetMillis\\": \\"\\",\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ApproximateDurationSeconds\\": 0,\\n \\"ApproximateStartTime\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', - 'title' => 'ListSchedules', - ], - 'ListSources' => [ - 'summary' => 'Lists sources in MediaWeaver.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveTranscodeTemplate'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveTranscodeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaConnectFlowInput' => [ + 'summary' => 'Modify the input information of a specific MediaConnect flow', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'SourceLocationName', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySourceLocation', - ], + 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ - 'name' => 'SourceType', + 'name' => 'Cidrs', 'in' => 'query', - 'schema' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vodSource', - ], + 'schema' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => '19.168.1.1/32,18.168.1.1/16', 'title' => ''], ], [ - 'name' => 'SourceName', + 'name' => 'SrtLatency', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MyVodSource', - ], + 'schema' => ['description' => 'The latency for the SRT stream. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'FilterState', + 'name' => 'SrtPassphrase', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to ignore sources marked as deleted.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The SRT key. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => 'FICUBPX4Q77DYHRF', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'SrtPbkeyLen', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The encryption key length. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InputFromUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The source URL. You can modify this parameter only when the source type is RTMP-PULL or SRT-Listener.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://pull.test.alivecdn.com/live/alitest', 'title' => ''], ], [ - 'name' => 'SortByModifiedTime', + 'name' => 'MaxBitrate', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order by modification time. Valid values: asc and desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The maximum bitrate. Unit: bit/s.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000000', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'InputName', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'Input name. This parameter is required only when primary/standby input is enabled for the instance.', 'type' => 'string', 'required' => false, 'example' => 'input1', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'SourceList' => [ - 'description' => 'The sources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The source information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySource', - ], - ], + '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' => '52451256-FFEA-5D2E-AA60-EE7053000F22', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"52451256-FFEA-5D2E-AA60-EE7053000F22\\"\\n}","type":"json"}]', + 'title' => 'Modify MediaConnect Flow Instance Input', + 'description' => '- The input can only be modified when the Flow instance status is offline.'."\n" + ."\n" + .'- The input type cannot be modified.', + 'changeSet' => [ + ['createdAt' => '2025-04-24T06:29:32.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"SourceList\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListSources', - ], - 'ListAlerts' => [ - 'summary' => 'Lists alerts received in MediaWeaver.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaConnectFlowInput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaConnectFlowOutput' => [ + 'summary' => 'Modifies an output of a MediaConnect flow.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'OutputName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The output name.', 'type' => 'string', 'required' => true, 'example' => 'AliTestOutput', 'title' => ''], ], [ - 'name' => 'ResourceArn', + 'name' => 'Cidrs', 'in' => 'query', - 'schema' => [ - 'description' => 'The ARN of the source or program.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource', - ], + 'schema' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => '19.168.1.1/32,18.168.1.1/16', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'SrtLatency', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The latency for the SRT stream. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'SrtPassphrase', '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'The SRT key. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => 'FICUBPX4Q77DYHRF', 'title' => ''], ], [ - 'name' => 'SortByModifiedTime', + 'name' => 'SrtPbkeyLen', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order by modification time. Valid values: asc and desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'The encryption key length. You can modify this parameter only when the source type is SRT-Listener or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => '32', 'title' => ''], ], [ - 'name' => 'GmtStart', + 'name' => 'OutputToUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-21T16:10:45Z', - ], + 'schema' => ['description' => 'The output URL. You can modify this parameter only when the output type is RTMP-PUSH or SRT-Caller.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://push.test.alivecdn.com/live/alitest', 'title' => ''], ], [ - 'name' => 'GmtEnd', + 'name' => 'PlayerLimit', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-22T16:10:45Z', - ], + 'schema' => ['description' => 'The maximum number of viewers.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response content.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Alerts' => [ - 'description' => 'The alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceArn' => [ - 'description' => 'The ARN of the resource.'."\n", - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'ScheduleError', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'Category' => [ - 'description' => 'The alert type.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RelatedResourceArns' => [ - 'description' => 'The ARN of the related resource.'."\n", - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource', - ], - 'GmtCreate' => [ - 'description' => 'The time when the alert was received in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-07-16T10:03Z', - ], - 'GmtModified' => [ - 'description' => 'The time when the alert was modified in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-07-16T10:03Z', - ], - ], - ], - ], + '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' => 'D737D0BC-4CB5-55AA-8119-B540C95DFE6A', 'title' => ''], ], + '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：构建日程时出错。\\\\nPlayBack Warning：添加source时地址拉取异常。\\\\ninfo：信息。\\",\\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', - ], - 'GetChannel' => [ - 'summary' => 'Queries information about a channel in MediaWeaver.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"D737D0BC-4CB5-55AA-8119-B540C95DFE6A\\"\\n}","type":"json"}]', + 'title' => 'UpdateMediaConnectFlowOutput', + 'description' => '- You can modify an output only when the flow is in the offline state.'."\n" + ."\n" + .'- The output type cannot be modified.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaConnectFlowOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaConnectFlowStatus' => [ + 'summary' => 'Modifies the state of a MediaConnect flow.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'ChannelName', + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', 'title' => ''], + ], + [ + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the channel.'."\n", + 'description' => 'The flow state. Valid values:'."\n" + ."\n" + .'- online: starts the flow.'."\n" + ."\n" + .'- offline: stops the flow.', + 'enumValueTitles' => ['offline' => 'offline', 'online' => 'online'], 'type' => 'string', 'required' => true, - 'example' => 'MyChannel', + 'example' => 'online', + 'title' => '', ], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Channel' => [ - 'description' => 'The channel information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyChannel', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91'], + 'Content' => ['description' => 'The response body.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'Description' => ['description' => 'The call description.', 'type' => 'string', 'example' => 'ok', '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\",\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"ok\\",\\n \\"RetCode\\": 0\\n}","type":"json"}]', + 'title' => 'UpdateMediaConnectFlowStatus', + 'changeSet' => [ + ['createdAt' => '2025-02-10T05:42:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-23T06:18:57.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', - 'title' => 'GetChannel', - ], - 'CreateProgram' => [ - 'summary' => 'Creates a program in a MediaWeaver channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaConnectFlowStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaInfo' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -68055,312 +55175,163 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'ProgramName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the program.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'program1', - ], - ], - [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source type of the program.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vodSource', - ], - ], - [ - 'name' => 'SourceLocationName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source location.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySourceLcation', - ], - ], - [ - 'name' => 'SourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySource', - ], - ], - [ - 'name' => 'Transition', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'description' => 'The program transition method.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', - ], + 'schema' => ['description' => 'The ID of the media asset. If this parameter is left empty, you must specify the input URL of the media asset, which has been registered in the IMS content library.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '****20b48fb04483915d4f2cd8ac****'], ], [ - 'name' => 'ClipRange', + 'name' => 'InputURL', 'in' => 'query', - 'schema' => [ - 'description' => 'Extracts a clip from the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}', - ], + 'schema' => ['description' => 'The input URL of the media asset in another service. The URL must be bound to the ID of the media asset in IMS. The URL cannot be modified once registered.'."\n" + ."\n" + .'For a media asset from Object Storage Service (OSS), the URL may have one of the following formats:'."\n" + ."\n" + .'1\\. http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'."\n" + ."\n" + .'2\\. oss\\://example-bucket/example.mp4. This format indicates that the region in which the OSS bucket of the media asset resides is the same as the region in which OSS is activated.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'], ], [ - 'name' => 'AdBreaks', + 'name' => 'BusinessType', 'in' => 'query', - 'schema' => [ - 'description' => 'The information about ad breaks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"MessageType":"SPLICE_INSERT","OffsetMillis":1000,"SourceLocationName":"MySourceLocation","SourceName":"MyAdSource","SpliceInsertSettings":{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}}]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'description' => '创建成功', - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Program' => [ - 'description' => 'The information about the program.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyProgram', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateProgram', - ], - 'ListChannelAlerts' => [ - 'summary' => 'Lists alerts for resources in a MediaWeaver channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ + 'schema' => ['description' => 'The business type. Valid values:'."\n" + ."\n" + .'- subtitles'."\n" + ."\n" + .'- watermark'."\n" + ."\n" + .'- opening'."\n" + ."\n" + .'- ending'."\n" + ."\n" + .'- general', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'video'], + ], [ - 'AK' => [], + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => 'The title.'."\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'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The content description.'."\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'], ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The category.'."\n" + ."\n" + .'- The value can be up to 64 bytes in length.'."\n" + ."\n" + .'- The value must be encoded in UTF-8.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'defaultCategory'], ], [ - 'name' => 'PageSize', + 'name' => 'MediaTags', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The tags.'."\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' => 'updateTags1,updateTags2'], ], [ - 'name' => 'ResourceArn', + 'name' => 'CoverURL', 'in' => 'query', - 'schema' => [ - 'description' => 'The ARN of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ims:mediaweaver:::channel/myChannel', - ], + 'schema' => ['description' => 'The URL of the thumbnail.'."\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' => 'Category', + 'name' => 'UserData', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The user data. It can be up to 1,024 bytes in size.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'userData'], ], [ - 'name' => 'SortByModifiedTime', + 'name' => 'AppendTags', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order by modification time. Valid values: asc and desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'Specifies whether to append tags. Default value: false. Valid values:'."\n" + ."\n" + .'- true: updates the MediaTags parameter by appending new tags.'."\n" + ."\n" + .'- false: updates the MediaTags parameter by overwriting existing tags with new tags.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'GmtStart', + 'name' => 'CateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-21T16:10:45Z', - ], + 'schema' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3048', 'title' => ''], ], [ - 'name' => 'GmtEnd', + 'name' => 'ReferenceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-21T16:10:45Z', - ], + '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' => ''], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'TotalCount' => [ - 'description' => 'The total number of alerts returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'ProgramAlerts' => [ - 'description' => 'The alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Arn' => [ - 'description' => 'The ARN of the program.'."\n", - 'type' => 'string', - 'example' => 'acs:ims:mediaweaver:::program/myChannel/MyProgram', - ], - 'ProgramName' => [ - 'description' => 'The name of the program.'."\n", - 'type' => 'string', - 'example' => 'program_name', - ], - 'Category' => [ - 'description' => 'The alert type.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Count' => [ - 'description' => 'The number of alerts.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'GmtModified' => [ - 'description' => 'The time when the alert was last modified in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-07-16T10:03Z', - ], - ], - 'description' => '', - ], - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '******11-DB8D-4A9A-875B-275798******'], + 'MediaId' => ['description' => 'The ID of the media asset in IMS.', 'type' => 'string', 'title' => '', 'example' => '****20b48fb04483915d4f2cd8ac****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'UpdateMediaInfo', + 'summary' => 'Updates information about a media asset based on the ID of the media asset in Intelligent Media Services (IMS) or the input URL of the media asset.', + 'description' => 'If the MediaId parameter is specified, the MediaId parameter is preferentially used for the query. If the MediaId parameter is left empty, the InputURL parameter must be specified. The request ID and media asset ID are returned. You cannot modify the input URL of a media asset by specifying the ID of the media asset.', + 'changeSet' => [ + ['createdAt' => '2022-09-01T03:57:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-14T07:50:15.000Z', 'description' => 'Request parameters changed'], ], - '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：构建日程时出错。\\\\nPlayBack Warning：添加source时地址拉取异常。\\\\ninfo：信息。\\",\\n \\"Count\\": 4,\\n \\"GmtModified\\": \\"2024-07-16T10:03Z\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', - 'title' => 'ListChannelAlerts', - ], - 'CreateSource' => [ - 'summary' => 'Creates a source in MediaWeaver.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaInfo'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateMediaLiveChannel' => [ + 'summary' => 'Modifies a MediaLive channel.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -68369,98 +55340,386 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'SourceLocationName', - 'in' => 'query', + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], + ], + [ + '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' => [ - 'description' => 'The name of the source location.'."\n", - 'type' => 'string', + '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' => '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' => 'MySourceLocation', + 'example' => '', ], ], [ - 'name' => 'SourceType', - 'in' => 'query', + 'name' => 'OutputGroups', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The source type. Valid values: vodSource and liveSource.'."\n", - 'type' => 'string', + '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' => 'vodSource', + 'example' => '', ], ], [ - 'name' => 'SourceName', - 'in' => 'query', + 'name' => 'AudioSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyVodSource', + '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' => 'HttpPackageConfigurations', - 'in' => 'query', + 'name' => 'VideoSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The source configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '“[{'."\n" - .' "sourceGroupName": "mySourceGroup-1",'."\n" - .' "relativePath": "group1/hls.m3u8",'."\n" - .' "type": "hls"'."\n" - .'}]”', + '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 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Source' => [ - 'description' => 'The source information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblySource', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => 'UpdateMediaLiveChannel', + 'description' => '- You can modify a MediaLive channel only when it 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' => [ + ['createdAt' => '2025-05-14T07:43:18.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateSource', - ], - 'UpdateChannel' => [ - 'summary' => 'Modifies a MediaWeaver channel.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaLiveChannel'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaLiveChannel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaLiveInput' => [ + 'summary' => 'Update a media live input.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -68472,118 +55731,116 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the channel.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyChannel', - ], - ], - [ - 'name' => 'AccessPolicy', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable access control.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AccessToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token for accessing the channel.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxx', - ], + 'name' => 'InputId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the input.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH'], ], [ - 'name' => 'FillerSourceLocationName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source location of the filler slate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySourceLocation', - ], + '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' => 'FillerSourceName', + 'name' => 'SecurityGroupIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the filler slate.'."\n", - 'type' => 'string', + '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 to be associated.', 'type' => 'string', 'required' => false, 'example' => 'G6G4X5T4SZYPSTT5', 'title' => ''], 'required' => false, - 'example' => 'MySource', + 'example' => '["G6G4X5T4SZYPSTT5"]', ], ], [ - 'name' => 'OutPutConfigList', + 'name' => 'InputSettings', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The channel output configurations.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The input settings. An input can have up to two sources: primary and backup sources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + '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' => ''], + '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' => ''], + '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' => ''], + 'SrtPassphrase' => ['title' => '', 'description' => 'The SRT encryption configuration. The password for the SRT stream must consist of 10 to 79 visible ASCII characters. 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 streams. Otherwise, the SRT connection will be denied.', 'type' => 'string', 'required' => false, 'example' => 'srtencryption'], + 'SrtMaxBitrate' => ['title' => '', 'description' => 'Maximum bitrate of the SRT stream, in bps. Valid range: \\[100, 100000000]. Optional when Type is SRT\\_PUSH or SRT\\_PULL.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000000'], + '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' => ''], + 'SrtLatency' => ['title' => '', 'description' => 'Latency of the SRT stream, in ms. Valid range: \\[100, 10000]. Optional when Type is SRT\\_PUSH or SRT\\_PULL.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], + 'SrtPbKeyLen' => ['title' => '', 'description' => 'Encryption configuration for SRT—the key length of the SRT stream. Valid values: 0, 16, 24, 32. 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' => '[{'."\n" - .' "ManifestName": "manifest-1",'."\n" - .' "Format": "HLS",'."\n" - .' "SourceGroupName": "source-group-1",'."\n" - .' "ManifestSettings": {'."\n" - .' "WindowDuration": 60,'."\n" - .' "AdMarkType": "Daterange"'."\n" - .' }'."\n" - .'}]', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '**请求ID**'."\n", - 'description' => '**Request ID**'."\n", - 'type' => 'string', - 'example' => 'xxx-xxxx-xxxxx-xxxx', - ], - 'Channel' => [ - 'description' => 'The channel information.'."\n", - '$ref' => '#/components/schemas/ChannelAssemblyChannel', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '******3B-0E1A-586A-AC29-742247******', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => 'Update a media live input', + 'description' => '- Invoke this API to update a media live input.'."\n" + ."\n" + .'- You can update an input only when it is not attached to any media live channel. Inputs that are already attached to a channel cannot be updated.'."\n" + ."\n" + .'## Queries per second (QPS) limit'."\n" + ."\n" + .'The QPS limit for this API is 50 queries per second per user. If the limit is exceeded, Rate Limiting will be applied to your API calls, which may impact your business. Make sure to call this 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'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', - 'title' => 'UpdateChannel', - ], - 'CreateVodPackagingGroup' => [ - 'summary' => 'Creates a VOD packaging group.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaLiveInput'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaLiveInput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaLiveInputSecurityGroup' => [ + 'summary' => 'Modifies a security group created in MediaLive.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -68592,139 +55849,181 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => ['FEATUREiceQU6W9M'], ], 'parameters' => [ [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_hls', - ], + 'name' => 'SecurityGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SEGK5KA6KYKAWQQH '], ], [ - 'name' => 'Description', - 'in' => 'query', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the security group. Letters, digits, hyphens (-), and underscores (\\_) are supported. It can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mysg'], + ], + [ + 'name' => 'WhitelistRules', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '打包组描述信息。', - 'description' => 'The packaging group description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod hls packaging', + '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' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The result of creating the packaging group.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'PackagingGroup' => [ - 'description' => 'The packaging group information.'."\n", - '$ref' => '#/components/schemas/VodPackagingGroup', - ], + '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 \\"PackagingGroup\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DomainName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ApproximateAssetCount\\": 0,\\n \\"ConfigurationCount\\": 0\\n }\\n}","type":"json"}]', - 'title' => 'CreateVodPackagingGroup', - ], - 'GetVodPackagingGroup' => [ - 'summary' => 'Queries a VOD packaging group.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => 'UpdateMediaLiveInputSecurityGroup', + 'description' => '- You can modify a security group only when it is not associated with a MediaLive 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' => 'UpdateMediaLiveInputSecurityGroup'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaLiveInputSecurityGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaMarks' => [ + 'summary' => 'Modifies the marks of a media asset.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'GroupName', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'title' => '打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_hls', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '53afdf003a******6a16b5feac6402'], + ], + [ + 'name' => 'MediaMarks', + 'in' => 'query', + 'schema' => ['description' => 'The marks of the media asset.', '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" + .']', 'required' => true, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The query result.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '****36-3C1E-4417-BDB2-1E034F****', - ], - 'PackagingGroup' => [ - 'description' => 'The information about the packaging group.'."\n", - '$ref' => '#/components/schemas/VodPackagingGroup', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******11-DB8D-4A9A-875B-275798******', 'title' => ''], + 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'title' => '', 'example' => '53afdf003a******6a16b5feac6402'], + 'MediaMarkIds' => ['description' => 'The IDs of the successfully modified marks.', 'type' => 'string', 'title' => '', 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UpdateMediaMarksFailed', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"53afdf003a******6a16b5feac6402\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', + 'title' => 'UpdateMediaMarks', + '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'], ], - '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', - ], - 'ListVodPackagingGroups' => [ - 'summary' => 'Lists VOD packaging groups.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaMarks'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaMarks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateMediaToSearchLib' => [ + 'summary' => 'Update media asset information in the search library.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -68733,140 +56032,85 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREiceJQ6U8A'], ], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'SearchLibName', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询页号，默认1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the search library. Default value: ims-default-search-lib.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'MediaId', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询每页大小，默认10。', - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => true, 'example' => '****019b82e24b37a1c2958dec38****', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'MsgBody', 'in' => 'query', - 'schema' => [ - 'title' => '排序规则，默认desc，可选：'."\n" - .'- desc：按创建时间倒序排序；'."\n" - .'- asc：按创建时间正序排序。', - '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" - .'* asc: ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The message body.', 'type' => 'string', 'required' => true, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '搜索关键词，指定查询过滤GroupName 包含Keyword的打包组。', - 'description' => 'The search keyword. The names of the returned packaging groups contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hls', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'name-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The query results.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'SortBy' => [ - 'title' => '排序规则，默认desc，可选：'."\n" - .'- desc：按创建时间倒序排序；'."\n" - .'- asc：按创建时间正序排序。', - 'description' => 'The sorting order of the packaging groups based on the time when they were created. Valid values:'."\n" - ."\n" - .'* desc: descending order.'."\n" - .'* asc: ascending order.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'PageNo' => [ - 'title' => '分页查询页号，默认1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页查询每页大小，默认10。', - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PackagingGroups' => [ - 'title' => '打包组列表。', - 'description' => 'The packaging groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about packaging groups.'."\n", - '$ref' => '#/components/schemas/VodPackagingGroup', - ], - ], - 'TotalCount' => [ - 'title' => '总数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94'], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'Update Media Asset to Search Library', + 'changeSet' => [ + ['createdAt' => '2025-07-09T08:14:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-22T09:58:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-22T08:19:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - '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', - ], - 'DeleteVodPackagingGroup' => [ - 'summary' => 'Deletes a VOD packaging group.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaToSearchLib'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaToSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdatePipeline' => [ + 'summary' => 'Updates the information about an ApsaraVideo Media Processing (MPS) queue.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -68874,59 +56118,87 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'GroupName', + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the MPS queue.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '****d80e4e4044975745c14b****'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MPS queue.', 'type' => 'string', 'required' => false, 'example' => 'test-pipeline', 'title' => ''], + ], + [ + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'title' => '打包组名称。', - 'description' => 'The name of the packaging group.'."\n", + 'description' => 'The state of the MPS queue.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Active'."\n" + ."\n" + .'- Paused', + 'enumValueTitles' => ['Active' => '', 'Paused' => ''], 'type' => 'string', 'required' => false, - 'example' => 'vod_hls', + 'example' => 'Paused', + 'title' => '', ], ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => ['description' => 'The priority of the MPS queue. Valid values: 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The result of deletion.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '13cbb83e-043c-4728-ac35-*****', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdatePipeline', + 'changeSet' => [ + ['createdAt' => '2022-07-11T09:38:08.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\"\\n}","type":"json"}]', - 'title' => 'DeleteVodPackagingGroup', - ], - 'CreateVodPackagingConfiguration' => [ - 'summary' => 'Creates a VOD packaging configuration.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdatePipeline', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateProgram' => [ + 'summary' => 'Modifies a program in a MediaWeaver channel.', + 'description' => ' ', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -68935,511 +56207,261 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'GroupName', + 'name' => 'ProgramName', 'in' => 'query', - 'schema' => [ - 'title' => '打包组名称，长度128个字符，格式：[A-Za-z0-9_-]+。', - 'description' => 'The name of the packaging group. The name can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_hls', - ], + 'schema' => ['description' => 'The name of the program.', 'type' => 'string', 'required' => true, 'example' => 'program1', 'title' => ''], ], [ - 'name' => 'ConfigurationName', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'title' => '打包配置名称，长度128个字符，格式：[A-Za-z0-9_-]+，用户维度唯一。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hls_3s', - ], + 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'example' => 'MyChannel', 'title' => ''], ], [ - 'name' => 'Protocol', + 'name' => 'ClipRange', 'in' => 'query', - 'schema' => [ - 'title' => '打包类型，支持：'."\n" - .'- HLS: HLC协议播放格式；'."\n" - .'- HLS_CMAF： HLS协议的CMAF播放格式；'."\n" - .'- DASH: DASH协议播放格式。', - 'description' => 'The package type.'."\n" - ."\n" - .'* HLS: packages content into TS segments for delivery over the HLS protocol.'."\n" - .'* HLS_CMAF: packages content into CMAF segments for delivery over the HLS protocol.'."\n" - .'* DASH: packages content for delivery over the DASH protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HLS', - ], + 'schema' => ['description' => 'Extracts a clip from the source.', 'type' => 'string', 'required' => false, 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'AdBreaks', 'in' => 'query', - 'schema' => [ - 'title' => '打包配置描述信息。', - 'description' => 'The description of the packaging configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HLS 3s vod packaging', - ], + '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' => ''], ], [ - 'name' => 'PackageConfig', + 'name' => 'SourceLocationName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '打包配置。', - 'description' => 'The packaging configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'ManifestName' => [ - 'title' => 'manifest名称，[A-Za-z0-9_]+，长度不超过128。', - 'description' => 'The manifest name. The name can be up to 128 characters in length. Letters, digits, underscores (\\_), and hyphens (-) are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'index', - ], - 'SegmentDuration' => [ - 'title' => '每个片段的时长（以秒为单位）。实际片段将会被四舍五入到最接近的源片段时长的倍数。取值范围【1，30】。', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '6', - ], - 'StreamSelection' => [ - 'title' => '打包输出流选择配置。', - 'description' => 'The settings of stream selection.'."\n", - 'type' => 'object', - 'properties' => [ - 'MinVideoBitsPerSecond' => [ - 'title' => '最小视频流码率，单位bps。', - 'description' => 'The minimum bitrate of the video stream. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100000', - ], - 'MaxVideoBitsPerSecond' => [ - 'title' => '最大视频流码率，单位bps。', - 'description' => 'The maximum bitrate of the video stream. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000000000', - ], - 'StreamOrder' => [ - 'title' => '流排序规则，支持值：'."\n" - .'- ORIGINAL：保持输入序号；'."\n" - .'- VIDEO_BITRATE_ASCENDING：按视频流码率递增；'."\n" - .'- VIDEO_BITRATE_DESCENDING：按视频流码率递减。', - '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" - .'* VIDEO_BITRATE_ASCENDING: sorts the manifest files in ascending order of bitrates, from lowest to highest.'."\n" - .'* VIDEO_BITRATE_DESCENDING: sorts the manifest files in descending order of bitrates, from highest to lowest.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ORIGINAL', - ], - ], - 'required' => false, - ], - 'DrmProvider' => [ - 'title' => 'DRM加密提供商配置。', - 'description' => 'The settings of digital rights management (DRM) encryption.'."\n", - 'type' => 'object', - 'properties' => [ - 'EncryptionMethod' => [ - 'title' => '加密算法，支持值：'."\n" - .'- AES_128'."\n" - .'- SAMPLE_AES', - 'description' => 'The encryption method. Valid values:'."\n" - ."\n" - .'* AES\\_128: Advanced Encryption Standard (AES) with 128-bit key length.'."\n" - .'* SAMPLE_AES: an encryption method that encrypts individual media samples.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AES_128', - ], - 'IV' => [ - 'title' => '一个可选的128位（16字节）十六进制值，由32个字符的字符串表示，与密钥一起用于加密数据块。如果您不指定该值，则MediaPackage将创建一个常量初始化向量（IV）。默认值：空，如果填写，则透传到供应商Constant initialization vector。', - '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', - 'required' => false, - 'example' => '00001111222233334444555566667777', - ], - '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。', - '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" - .'* HLS: 1'."\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" - .'* Google Widevine: edef8ba9-79d6-4ace-a3c8-27dcd51d21e'."\n" - .'* Microsoft PlayReady: 9a04f079-9840-4286-ab92-e65be0885f95'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the DRM system.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '94ce86fb-07ff-4f43-adb8-93d2fa968ca2', - ], - 'required' => false, - ], - 'Url' => [ - 'title' => 'DRM key提供商url。', - 'description' => 'The URL of the DRM key provider.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://***drm***/getcontent', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => false, 'example' => 'MySourceLcation', 'title' => ''], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => false, 'example' => 'MySource', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'The source type of the program. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => false, 'example' => 'vodSource', 'title' => ''], + ], + [ + 'name' => 'Transition', + 'in' => 'query', + 'schema' => ['description' => 'The program transition method.', 'type' => 'string', 'required' => false, 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'PackagingConfiguration' => [ - 'title' => '打包配置。', - 'description' => 'The packaging configuration.'."\n", - '$ref' => '#/components/schemas/VodPackagingConfiguration', - ], + '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', + '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' => 'UpdateProgram', + 'changeSet' => [ + ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], - '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', - ], - 'GetVodPackagingConfiguration' => [ - 'summary' => 'Queries a packaging configuration.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateProgram', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateRtcRobotInstance' => [ + 'summary' => 'Updates the configuration of an RTC AI Agent instance, such as its voice and greeting.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'abilityTreeCode' => '230669', + 'abilityTreeNodes' => ['FEATUREice405U0J'], ], 'parameters' => [ [ - 'name' => 'ConfigurationName', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AI Agent instance to update.', 'type' => 'string', 'required' => true, 'example' => '727dc0e296014bb58670940a3da95592', 'title' => ''], + ], + [ + 'name' => 'Config', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '打包配置名称。', - 'description' => 'The name of the packaging configuration.'."\n", - 'type' => 'string', + 'description' => 'The configuration for the AI Agent instance.', + 'type' => 'object', + 'properties' => [ + 'EnableVoiceInterrupt' => ['description' => 'Controls whether voice interrupt is enabled. This change takes effect immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'Greeting' => ['description' => 'The greeting message. The greeting is not updated if it has already been played.', 'type' => 'string', 'example' => 'Hello', 'required' => false, 'title' => ''], + 'VoiceId' => ['description' => 'The ID of the voice. The new voice takes effect on the AI Agent\'s next utterance.', 'type' => 'string', 'required' => false, 'example' => 'zhixiaoxia', 'title' => ''], + ], 'required' => false, - 'example' => 'hls_3s', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The query result.'."\n", + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'PackagingConfiguration' => [ - 'description' => 'The information about the packaging configuration.'."\n", - '$ref' => '#/components/schemas/VodPackagingConfiguration', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7707F0A2-C6FD-5959-87EB-7C4D02384FD4'], ], + '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', - ], - 'ListVodPackagingConfigurations' => [ - 'summary' => 'Lists VOD packaging configurations.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7707F0A2-C6FD-5959-87EB-7C4D02384FD4\\"\\n}","type":"json"}]', + 'title' => 'Update RTC Interactive AI Agent Instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:UpdateRtcRobotInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'UpdateSource' => [ + 'summary' => 'Modifies a source.', + 'description' => ' ', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '打包组名称。', - 'description' => 'The name of the packaging group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_hls', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '分压查询每页大小，默认10。', - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourcelocation', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'title' => '分压查询当前页，默认1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The source type. Valid values: vodSource and liveSource.', 'type' => 'string', 'required' => true, 'example' => 'vodSource', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'SourceName', 'in' => 'query', - 'schema' => [ - 'title' => '列表排序，默认 desc：'."\n" - .'- desc：按创建时间倒序排序；'."\n" - .'- asc：按创建时间正序排序。', - '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" - .'* asc: ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => true, 'example' => 'MySource', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'HttpPackageConfigurations', 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword. The names of the returned packaging configurations contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hls', - ], + 'schema' => ['description' => 'The source configurations.', 'type' => 'string', 'required' => true, 'example' => '[{'."\n" + .' "sourceGroupName": "mySourceGroup-1",'."\n" + .' "relativePath": "group1/hls.m3u8",'."\n" + .' "packageType": "hls"'."\n" + .'}]', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'SortBy' => [ - 'title' => '列表排序，默认 desc：'."\n" - .'- desc：按创建时间倒序排序；'."\n" - .'- asc：按创建时间正序排序。', - 'description' => 'The sorting order of the packaging configurations based on the time when they were created. Valid values:'."\n" - ."\n" - .'* desc: descending order.'."\n" - .'* asc: ascending order.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'PageSize' => [ - 'title' => '分压查询每页大小，默认10。', - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNo' => [ - 'title' => '分压查询当前页，默认1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PackagingConfigurations' => [ - 'title' => '打包配置列表。', - 'description' => 'The packaging configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about packaging configurations.'."\n", - '$ref' => '#/components/schemas/VodPackagingConfiguration', - ], - ], - 'TotalCount' => [ - 'title' => '总数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + '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\\": \\"******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', - ], - 'DeleteVodPackagingConfiguration' => [ - 'summary' => 'Deletes a VOD packaging configuration.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + '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' => 'UpdateSource', + 'changeSet' => [ + ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'ConfigurationName', - 'in' => 'query', - 'schema' => [ - 'title' => '打包配置名称。', - 'description' => 'The name of the packaging configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hls_3s', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The result of deletion.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'DeleteVodPackagingConfiguration', + 'translator' => 'manual', ], - 'CreateVodPackagingAsset' => [ - 'summary' => 'Ingests an asset for VOD packaging.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateSourceLocation' => [ + 'summary' => 'Modifies a source location.', + 'description' => ' ', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -69448,273 +56470,206 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '打包组名称。', - 'description' => 'The name of the packaging group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_hls', - ], - ], - [ - 'name' => 'AssetName', + 'name' => 'SourceLocationName', 'in' => 'query', - 'schema' => [ - 'title' => '打包资产名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hls_3s', - ], + 'schema' => ['description' => 'The name of the source location.', 'type' => 'string', 'required' => true, 'example' => 'MySourceLocation', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'BaseUrl', 'in' => 'query', - 'schema' => [ - 'title' => '打包资产描述信息。', - 'description' => 'The asset description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HLS 3 second packaging', - ], + 'schema' => ['description' => 'The protocol and hostname of the source location.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com', 'title' => ''], ], [ - 'name' => 'Input', + 'name' => 'EnableSegmentDelivery', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '资产输入配置。', - 'description' => 'The asset input configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '输入类型，暂支持OSS。', - 'description' => 'The input type. Only Object Storage Service (OSS) is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', - 'description' => 'The URL of the media file. Only M3U8 files stored in OSS are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS://***test-bucket***/***video/input.m3u8', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to use an independent domain name to access the segments.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ContentId', + 'name' => 'SegmentDeliveryUrl', 'in' => 'query', - 'schema' => [ - 'title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', - 'description' => 'The content ID in the digital rights management (DRM) system. The maximum length is 256 characters. Letters, digits, underscores (\\_), and hyphens (-) are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'movie', - ], + 'schema' => ['description' => 'The domain name used to access the segments.', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx.com', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'description' => '创建成功', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', - ], - 'Asset' => [ - 'description' => 'The information about the asset.'."\n", - '$ref' => '#/components/schemas/VodPackagingAsset', - ], + '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', + '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' => 'UpdateSourceLocation', + 'changeSet' => [ + ['createdAt' => '2025-01-22T05:43:18.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"Asset\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\"\\n },\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ContentId\\": \\"\\",\\n \\"AssetName\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateVodPackagingAsset', - ], - 'BatchCreateVodPackagingAsset' => [ - 'summary' => 'Ingests multiple assets for VOD packaging.', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateSourceLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateTemplate' => [ + 'summary' => 'Modifies an online editing template. You can modify the template title and template configurations.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the online editing template. You can obtain the template ID in the [Intelligent Media Services (IMS) console](https://ice.console.aliyun.com/production/template/list/common) or the response parameters of the [AddTemplate](~~441161~~) operation.', 'type' => 'string', 'example' => '23923ec3318f4c359e42e1e5b296****', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the online editing template.', 'type' => 'string', 'example' => 'Cloud editing template 1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['description' => 'The template configurations. For more information, see [Config object of a regular template](~~456193~~).', 'type' => 'string', 'example' => '{'."\n" + .' "VideoTracks": ['."\n" + .' {'."\n" + .' "VideoTrackClips": ['."\n" + .' {'."\n" + .' "Sys_Type" : "ArrayItems",'."\n" + .' "Sys_ArrayObject" : "$VideoArray",'."\n" + .' "Sys_Template" : {'."\n" + .' "MediaId" : "$MediaId"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}', '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], ], - ], - 'parameters' => [ [ - 'name' => 'Assets', + 'name' => 'PreviewMedia', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '资产输入配置', - 'description' => 'The assets that you want to ingest.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '资产输入配置。', - 'description' => 'An asset that you want to ingest.'."\n", - 'type' => 'object', - 'properties' => [ - 'AssetName' => [ - 'title' => '打包资产名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30min_movie', - ], - 'ContentId' => [ - 'title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', - 'description' => 'The content ID in the digital rights management (DRM) system. The maximum length is 256 characters. Letters, digits, underscores (\\_), and hyphens (-) are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'movie', - ], - 'Input' => [ - 'title' => '资产输入配置。', - 'description' => 'The asset input configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Media' => [ - 'title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', - 'description' => 'The URL of the media file. You can only specify a M3U8 file stored in Object Storage Service (OSS).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS://***test-bucket***/***video/input.m3u8', - ], - 'Type' => [ - 'title' => '输入类型，暂支持OSS。', - 'description' => 'The input type. Only OSS is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the preview video.', 'type' => 'string', 'example' => '1ae320b48fb04483915d4f2cd8ac****', 'title' => '', 'required' => false], ], [ - 'name' => 'GroupName', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '打包组名称。', - 'description' => 'The name of the packaging group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_hls', - ], + '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" + .'> 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.', 'type' => 'string', 'example' => 'Available', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The source from which the template is modified. Default value: OpenAPI. Valid values:'."\n" + ."\n" + .'- AliyunConsole'."\n" + ."\n" + .'- OpenAPI'."\n" + ."\n" + .'- WebSDK', '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":["f64c6acc840247edb6b12f575c66****","9675dcf040ba4525bb037c29d156****"],"audio":["62a54019d9114009a5ae9bcfd70b****"],"image":["743ffbeb7e004c758cdc1fb34c04****"]}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The results of asset ingestion.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - 'GroupName' => [ - 'title' => '打包组名称。', - 'description' => 'The name of the packaging group.'."\n", - 'type' => 'string', - 'example' => 'vod_hls', - ], - 'ResultList' => [ - 'title' => '结果列表。', - 'description' => 'The results of asset ingestion.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '创建结果。', - 'description' => 'The result of ingesting an asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '创建失败码。', - 'description' => 'The error code for failed ingestion.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter.PackagingAssetAlreadyExists', - ], - 'Message' => [ - 'title' => '创建失败详细信息。', - 'description' => 'The error message for failed ingestion.'."\n", - 'type' => 'string', - 'example' => 'The specified packagingAsset "inputMovie" already exists', - ], - 'Asset' => [ - 'title' => '创建成功资产信息。', - 'description' => 'The information about the ingested asset.'."\n", - '$ref' => '#/components/schemas/VodPackagingAsset', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F8D475A5-F2EC-5755-ABD8-22D5561C****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8D475A5-F2EC-5755-ABD8-22D5561C****\\"\\n}","type":"json"}]', + 'title' => 'UpdateTemplate', + '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~~).', + 'changeSet' => [ + ['createdAt' => '2023-11-23T01:57:57.000Z', 'description' => 'Request parameters changed'], ], - '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 \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ContentId\\": \\"\\",\\n \\"AssetName\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'BatchCreateVodPackagingAsset', - ], - 'GetVodPackagingAsset' => [ - 'summary' => 'Queries a VOD packaging asset.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UploadMediaByURL' => [ + 'summary' => 'The UploadMediaByURL API uploads audio or video files from source URLs. It supports batch uploads and is ideal for uploading files from a public URL instead of a local server or device.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -69723,6536 +56678,5572 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'abilityTreeNodes' => ['FEATUREiceFEJXOS'], ], 'parameters' => [ [ - 'name' => 'AssetName', + 'name' => 'UploadURLs', 'in' => 'query', - 'schema' => [ - 'title' => '打包资产名称。', - 'description' => 'The name of the VOD packaging asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30min_movie', - ], + 'schema' => ['description' => 'The source URL of the media file.'."\n" + ."\n" + .'- The URL must include a file extension. For example, in `https://****.mp4`, mp4 is the file extension.'."\n" + ."\n" + .' - If the URL does not include a file extension, you can specify it by using the `FileExtension` parameter in `MediaMetaData`.'."\n" + ."\n" + .' - If a file extension is present in both the URL and the `FileExtension` parameter, the value of `FileExtension` takes precedence.'."\n" + ."\n" + .'- The URLs must be URL-encoded. Separate multiple URLs with commas (,). You can specify up to 20 URLs.'."\n" + ."\n" + .'- To prevent upload failures due to special characters, URL-encode each URL before concatenating them with commas.', 'type' => 'string', 'required' => false, 'example' => 'https://diffurl.mp4', 'title' => ''], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app-1000000', 'title' => ''], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => ['description' => 'Custom settings, provided as a JSON string. This parameter supports configurations such as message callbacks.', 'type' => 'string', 'required' => false, 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}', 'title' => ''], + ], + [ + 'name' => 'UploadTargetConfig', + 'in' => 'query', + 'schema' => ['description' => 'The destination storage location.'."\n" + ."\n" + .'- The only valid value for `StorageType` is `oss`.'."\n" + ."\n" + .'- `StorageLocation` supports VOD storage only and does not support 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 metadata of the media file, provided as a JSON string.'."\n" + ."\n" + .'- This metadata takes effect only when it matches a URL in `UploadURLs`.'."\n" + ."\n" + .'- The value must be a JSON array in the `[UploadMetadata, UploadMetadata, ...]` format, passed as a JSON string.'."\n" + ."\n" + .'- For more information, see the UploadMetadata table below.', 'type' => 'string', 'required' => false, 'example' => '[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]', 'title' => ''], + ], + [ + 'name' => 'PostProcessConfig', + 'in' => 'query', + 'schema' => ['description' => 'Specifies post-upload processing actions for media files of type `video` or `audio`.'."\n" + ."\n" + .'The only supported value for `ProcessType` is `Workflow`.', 'type' => 'string', 'required' => false, 'example' => '{"ProcessType": "Workflow","ProcessID":"b72a06c6beeb4dcdb898feef067b1***"}', 'title' => ''], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => ['description' => 'The entity ID. You can call the CreateEntity API to create an entity and define a custom dynamic metadata schema.', 'type' => 'string', 'required' => false, 'example' => 'd67281da3c8743b8823ad12976187***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The result of asset query.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', - ], - 'Asset' => [ - 'title' => '打包资产信息。', - 'description' => 'The information about the asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'AssetName' => [ - 'title' => '打包资产名称。', - 'description' => 'The name of the asset.'."\n", - 'type' => 'string', - 'example' => '30min_movie', - ], - 'GroupName' => [ - 'title' => '打包组名称。', - 'description' => 'The name of the packaging group.'."\n", - 'type' => 'string', - 'example' => 'vod_hls', - ], - 'Input' => [ - 'title' => '打包资产输入。', - 'description' => 'The asset input configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '输入类型，暂支持OSS。', - 'description' => 'The input type. Only Object Storage Service (OSS) is supported.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', - 'description' => 'The URL of the media file. Only M3U8 files stored in OSS are supported.'."\n", - 'type' => 'string', - 'example' => 'OSS://***test-bucket***/***video/input.m3u8', - ], - ], - ], - 'CreateTime' => [ - 'title' => '资产创建时间，格式 2024-11-21T06:45:32Z表示北京时间 2024-11-21 14:45:32', - '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.'."\n", - 'type' => 'string', - 'example' => '2024-11-21T06:45:32Z', - ], - 'EgressEndpoints' => [ - 'title' => '资产打包播放输出端点列表，一个打包配置对应一个打包播放端点。', - 'description' => 'The egress endpoints, each corresponding to a packaging configuration.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '资产打包播放端点。', - 'description' => 'The egress endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'title' => '播放URL，当资产打包失败时不返回对应的播放URL。', - 'description' => 'The playback URL. If the asset fails to be packaged, no playback URL is returned.'."\n", - 'type' => 'string', - 'example' => 'https://y92kpc.**/v1/sy9gtc0w00i0bw2q33q2a4y71oydkofm/cvtcqv3lvrftd68k7f5avfjznvv0tje4/o3cfzi6c3qxo18ascgvnz7974qy3c02o/index.m3u8', - ], - 'Status' => [ - 'title' => '状态，支持值：'."\n" - .'- Queuing：排队处理中；'."\n" - .'- Playable: 可以播放；'."\n" - .'- Failed：打包失败，无法播放。', - 'description' => 'The asset status. Valid values:'."\n" - ."\n" - .'* Queuing: The asset is waiting for packaging.'."\n" - .'* Playable: The asset is packaged and playable.'."\n" - .'* Failed: The asset fails to be packaged.'."\n", - 'type' => 'string', - 'example' => 'Playable', - ], - 'ConfigurationName' => [ - 'title' => '打包配置名称。', - 'description' => 'The name of the packaging configuration.'."\n", - 'type' => 'string', - 'example' => 'hls_3s', - ], - ], - ], - ], - 'ContentId' => [ - 'title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', - 'description' => 'The content ID in the DRM system. The maximum length is 256 characters. Letters, digits, underscores (\\_), and hyphens (-) are supported.'."\n", - 'type' => 'string', - 'example' => 'movie', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '****83B7-7F87-4792-BFE9-63CD2137****'], + 'UploadJobs' => [ + 'description' => 'An array of upload jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The upload job details.', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The upload job ID.', 'type' => 'string', 'example' => '20ce1e05dba64576b96e9683879f0***', 'title' => ''], + 'SourceURL' => ['description' => 'The source URL corresponding to the upload job.', 'type' => 'string', 'example' => 'http://example****.mp4'."\n", 'title' => ''], + 'MediaId' => ['description' => 'The media ID.', 'type' => 'string', 'example' => 'f476988629f54a7b8a4ba90d1a6c7***', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'UploadMediaByURL', + 'description' => '### Description'."\n" + ."\n" + .'- If a callback is configured, the service sends an event notification when the URL upload is complete. You can query the upload status by calling the API to retrieve URL upload information.'."\n" + ."\n" + .'- After you successfully submit an upload job, the system creates an asynchronous task in the cloud and queues it for execution. After the upload is complete, you can use the URL and media ID from the event notification (message callback) to update your records.'."\n" + ."\n" + .'### Limitations'."\n" + ."\n" + .'- This API supports uploading files to VOD storage only and does not support uploading to your own Object Storage Service (OSS) buckets. To use your own OSS storage, you must first pull the files to a local device, upload them to OSS by using the [OSS SDK](~~32006~~), and then call the [RegisterMediaInfo](~~441152~~) API to register the OSS object with the media asset library.'."\n" + ."\n" + .'- This API is currently available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.'."\n" + ."\n" + .'- This API supports uploading audio and video files only.', + 'requestParamsDescription' => '## UploadMetadata'."\n" + ."\n" + .'| Parameter | Type | Required | Description |'."\n" + .'| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" + .'| SourceURL | String | Yes | The source URL of the media file to upload. |'."\n" + .'| Title | String | Yes | The title of the media file. Maximum length: 128 bytes. Must be UTF-8 encoded. |'."\n" + .'| FileSize | String | No | The size of the file. |'."\n" + .'| Description | String | No | The description of the media file. Maximum length: 1,024 bytes. Must be UTF-8 encoded. |'."\n" + .'| CoverURL | String | No | The URL of the custom video cover. |'."\n" + .'| CateId | String | No | The category ID. |'."\n" + .'| Tags | String | No | The tags of the media file. You can specify up to 16 tags, each up to 32 bytes in length. Separate multiple tags with a comma (,). The tags must be UTF-8 encoded. |'."\n" + .'| WorkflowId | String | No | The workflow ID. |'."\n" + .'| FileExtension | String | No | The file extension of the media file. |'."\n" + .'| DynamicMetaData | String | No | Dynamic metadata. Example: `{"Uploader": "xxx"}`. |'."\n" + .'| EntityId | String | No | The entity ID. |'."\n" + ."\n" + .'> - The `WorkflowId` parameter triggers an [asynchronous task](~~3027141~~). After submission, the service queues the job for asynchronous execution, so it does not complete immediately.'."\n" + .'>'."\n" + .'> - Parameters in `UploadMetadata`, such as `Title`, `Description`, and `Tags`, cannot contain emojis.'."\n" + .'>'."\n" + .'> - li data-t-idx="277">'."\n" + .'>'."\n" + .'> When you submit a batch of jobs, the service sends a separate notification for each `SourceURL`.'."\n" + .'>'."\n" + .'> - For batch submissions, each SourceURL receives a separate notification.', + 'changeSet' => [ + ['createdAt' => '2022-06-20T09:48:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadMediaByURL'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:UploadMediaByURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"UploadJobs\\": [\\n {\\n \\"JobId\\": \\"20ce1e05dba64576b96e9683879f0***\\",\\n \\"SourceURL\\": \\"http://example****.mp4\\\\n\\",\\n \\"MediaId\\": \\"f476988629f54a7b8a4ba90d1a6c7***\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListVodPackagingAssets' => [ - 'summary' => 'Lists VOD packaging assets.', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UploadStreamByURL' => [ + 'summary' => 'Uploads a media stream file based on the URL of the source file.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'StreamURL', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '分页查询当前页，默认1。', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The URL of the transcoded stream file.'."\n" + ."\n" + .'If the URL of the transcoded stream requires authentication, you must specify the authentication parameters in the stream URL and make sure that the URL can be accessed over the Internet.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/sample-stream.mp4', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'MediaId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '分页查询每页大小，默认10。', - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'required' => false, 'example' => '411bed50018971edb60b0764a0ec6***', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'Definition', 'in' => 'query', - 'schema' => [ - 'title' => '列表排序规则，默认 desc，可选:'."\n" - .'- desc： 按创建时间倒序排列；'."\n" - .'- asc：按创建时间正序排列。', - 'description' => 'The sorting order of the assets based on the time when they were ingested. Valid values:'."\n" - ."\n" - .'* desc (default): descending order.'."\n" - .'* asc: ascending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + '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' => 'Keyword', + 'name' => 'FileExtension', 'in' => 'query', - 'schema' => [ - 'title' => '搜索关键词，指定查询过滤AssetName 以Keyword为前缀的资产列表。', - 'description' => 'The search keyword. The names of the returned assets are prefixed with this keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'movie', - ], + 'schema' => ['description' => 'The file name extension of the media stream.', 'type' => 'string', 'required' => false, 'example' => 'mp4', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'HDRType', 'in' => 'query', - 'schema' => [ - 'title' => '打包组名称。', - 'description' => 'The name of the packaging group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_hls', - ], + '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://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Assets' => [ - 'description' => 'The VOD packaging assets.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a VOD packaging asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'AssetName' => [ - 'description' => 'The name of the VOD packaging asset.'."\n", - 'type' => 'string', - 'example' => '30min_movie', - ], - 'GroupName' => [ - 'description' => 'The name of the packaging group.'."\n", - 'type' => 'string', - 'example' => 'vod_hls', - ], - 'Description' => [ - 'description' => 'The asset description.'."\n", - 'type' => 'string', - 'example' => 'movie 30min', - ], - 'Input' => [ - 'description' => 'The asset input configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The input type. Only Object Storage Service (OSS) is supported.'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'Media' => [ - 'description' => 'The URL of the media file. Only M3U8 files stored in OSS are supported.'."\n", - 'type' => 'string', - 'example' => 'OSS://***test-bucket***/***video/input.m3u8', - ], - ], - ], - '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.'."\n", - 'type' => 'string', - 'example' => '2024-11-21T06:45:32Z', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNo' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SortBy' => [ - 'description' => 'The sorting order of the assets based on the time when they were ingested. Valid values:'."\n" - ."\n" - .'* desc: descending order.'."\n" - .'* asc: ascending order.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '******89-C21D-4B78-AE24-3788B8******', 'title' => ''], + 'JobId' => ['description' => 'The ID of the upload job.', 'type' => 'string', 'example' => '****cdb3e74639973036bc84****', 'title' => ''], + 'MediaId' => ['description' => 'The ID of the media asset.', 'type' => 'string', 'example' => '411bed50018971edb60b0764a0ec6***', 'title' => ''], + 'FileURL' => ['description' => 'The OSS URL of the file.', 'type' => 'string', 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', 'title' => ''], + 'SourceURL' => ['description' => 'The URL of the source file that is uploaded in the upload job.', 'type' => 'string', 'example' => 'https://example.com/sample-stream.mp4', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******89-C21D-4B78-AE24-3788B8******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"MediaId\\": \\"411bed50018971edb60b0764a0ec6***\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4\\",\\n \\"SourceURL\\": \\"https://example.com/sample-stream.mp4\\"\\n}","type":"json"}]', + 'title' => 'UploadStreamByURL', + 'description' => '- Pull a media stream file based on a URL and upload the file. After the media stream file is uploaded, the media stream is associated with the specified media asset ID.'."\n" + ."\n" + .'- Upload media stream files only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media stream file to an OSS bucket, pull the file to a local directory, use [OSS SDK](~~32006~~) to upload the file to an OSS bucket, 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'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadStreamByURL'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:UploadStreamByURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', ], - 'DeleteVodPackagingAsset' => [ - 'summary' => 'Deletes a VOD packaging asset.', - 'path' => '', - 'methods' => [ - 'post', + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ice.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ice.ap-southeast-1.aliyuncs.com', 'vpc' => 'ice-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ice.cn-beijing.aliyuncs.com', 'endpoint' => 'ice.cn-beijing.aliyuncs.com', 'vpc' => 'ice-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ice.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ice.cn-hangzhou.aliyuncs.com', 'vpc' => 'ice-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ice.cn-shanghai.aliyuncs.com', 'endpoint' => 'ice.cn-shanghai.aliyuncs.com', 'vpc' => 'ice-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ice.cn-shenzhen.aliyuncs.com', 'endpoint' => 'ice.cn-shenzhen.aliyuncs.com', 'vpc' => 'ice-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ice.us-west-1.aliyuncs.com', 'endpoint' => 'ice.us-west-1.aliyuncs.com', 'vpc' => 'ice-vpc.us-west-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'DataAlreadyExists', 'message' => 'data already exists.', 'http_code' => 400, 'description' => 'Data already exists'], + ['code' => 'InternalError', 'message' => 'Internal error', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidParameter.Format', 'message' => 'The specified parameter format is invalid. Valid formats are XML and JSON. The default format is XML.', 'http_code' => 400, 'description' => 'The specified parameter format is invalid. Valid formats are XML and JSON. The default format is XML.'], + ['code' => 'ResourceNoAllowModify', 'message' => 'The resource can not be modified.', 'http_code' => 400, 'description' => 'Delete the associated workflow template before unbinding the bucket.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'QuerySmarttagJob'], + ], + 'createdAt' => '2025-12-23T02:18:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTemplateParams'], + ], + 'createdAt' => '2025-12-04T16:21:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ForwardAIAgentCall'], + ], + 'createdAt' => '2025-12-01T09:17:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'BatchGetMediaInfos'], + ], + 'createdAt' => '2025-11-30T06:02:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListRecognitionLibs'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListRecognitionSamples'], + ['description' => 'Request parameters changed', 'api' => 'SubmitSmarttagJob'], + ], + 'createdAt' => '2025-11-17T14:19:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ForwardAIAgentCall'], + ], + 'createdAt' => '2025-11-13T11:25:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchMedia'], + ['description' => 'Request parameters changed', 'api' => 'SearchMediaByAILabel'], + ['description' => 'Request parameters changed', 'api' => 'SearchMediaByFace'], + ['description' => 'Request parameters changed', 'api' => 'SearchMediaByHybrid'], + ['description' => 'Request parameters changed', 'api' => 'SearchMediaByMultimodal'], + ], + 'createdAt' => '2025-11-04T06:38:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SearchMedia'], + ], + 'createdAt' => '2024-08-26T06:31:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListMediaProducingJobs'], + ], + 'createdAt' => '2024-08-14T09:28:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListSmartVoiceGroups'], + ], + 'createdAt' => '2024-07-30T14:20:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDNADB'], + ], + 'createdAt' => '2024-07-23T02:08:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetBatchMediaProducingJob'], + ], + 'createdAt' => '2024-07-22T10:10:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetBatchMediaProducingJob'], + ], + 'createdAt' => '2024-07-03T11:43:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], + ], + 'createdAt' => '2024-06-04T02:25:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetBatchMediaProducingJob'], + ], + 'createdAt' => '2024-04-28T02:09:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetMediaInfo'], + ['description' => 'Request parameters changed', 'api' => 'RegisterMediaInfo'], + ], + 'createdAt' => '2024-04-24T02:23:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetSmartHandleJob'], + ], + 'createdAt' => '2024-02-27T11:53:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteLiveSnapshotFiles'], + ], + 'createdAt' => '2024-02-02T02:24:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaProducingJob'], + ['description' => 'Request parameters changed', 'api' => 'ListPublicMediaBasicInfos'], + ], + 'createdAt' => '2024-01-26T06:16:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaProducingJob'], + ], + 'createdAt' => '2024-01-03T01:15:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AlterSearchIndex'], + ['description' => 'Request parameters changed', 'api' => 'CreateSearchIndex'], + ['description' => 'Request parameters changed', 'api' => 'DeleteMediaFromSearchLib'], + ], + 'createdAt' => '2023-11-23T03:42:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddTemplate'], + ['description' => 'Request parameters changed', 'api' => 'CreateEditingProject'], + ['description' => 'Request parameters changed', 'api' => 'SubmitMediaProducingJob'], + ['description' => 'Request parameters changed', 'api' => 'UpdateEditingProject'], + ['description' => 'Request parameters changed', 'api' => 'UpdateTemplate'], + ], + 'createdAt' => '2023-11-23T01:58:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateMediaToSearchLib'], + ], + 'createdAt' => '2023-11-22T09:58:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AlterSearchIndex'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateSearchIndex'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateSearchLib'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteMediaFromSearchLib'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DropSearchIndex'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DropSearchLib'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'InsertMediaToSearchLib'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QuerySearchIndex'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QuerySearchLib'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateMediaToSearchLib'], + ], + 'createdAt' => '2023-11-22T08:25:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetCustomizedVoiceJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCustomizedVoiceJobs'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCustomizedVoices'], + ], + 'createdAt' => '2023-11-21T07:14:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SubmitAudioProduceJob'], + ], + 'createdAt' => '2023-11-15T15:22:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2023-11-07T03:47:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2023-10-18T13:20:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SearchMediaByAILabel'], + ['description' => 'Request parameters changed', 'api' => 'SearchMediaByFace'], + ['description' => 'Request parameters changed', 'api' => 'SearchMediaClipByFace'], + ], + 'createdAt' => '2023-10-12T02:53:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2023-10-10T07:21:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SearchMedia'], + ], + 'createdAt' => '2023-09-26T08:53:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetAvatar'], + ], + 'createdAt' => '2023-09-13T09:15:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAudit'], + ], + 'createdAt' => '2023-09-13T05:49:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitCustomizedVoiceJob'], + ], + 'createdAt' => '2023-09-12T06:44:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListSmartSysAvatarModels'], + ], + 'createdAt' => '2023-08-25T02:46:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPlayInfo'], + ], + 'createdAt' => '2023-08-25T02:04:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListSmartSysAvatarModels'], + ], + 'createdAt' => '2023-08-24T02:04:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAvatarTrainingJob'], + ], + 'createdAt' => '2023-08-17T08:43:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'StartWorkflow'], + ], + 'createdAt' => '2023-08-08T02:15:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSmartSysAvatarModels'], + ], + 'createdAt' => '2023-07-13T12:58:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchMedia'], + ], + 'createdAt' => '2023-06-27T07:27:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTranscodeJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2023-06-06T03:31:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CancelDNAJob'], + ['description' => 'Response parameters changed', 'api' => 'CreateDNADB'], + ['description' => 'Response parameters changed', 'api' => 'DeleteDNADB'], + ['description' => 'Response parameters changed', 'api' => 'DeleteDNAFiles'], + ['description' => 'Response parameters changed', 'api' => 'ListDNADB'], + ['description' => 'Response parameters changed', 'api' => 'ListDNAFiles'], + ['description' => 'Response parameters changed', 'api' => 'QueryDNAJobList'], + ['description' => 'Response parameters changed', 'api' => 'SubmitDNAJob'], + ], + 'createdAt' => '2023-05-25T07:23:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTranscodeJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2023-05-18T06:22:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitMediaProducingJob'], + ], + 'createdAt' => '2023-04-25T06:11:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'RegisterMediaInfo'], + ], + 'createdAt' => '2023-04-11T06:58:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetSmartHandleJob'], + ], + 'createdAt' => '2023-03-24T08:25:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEditingProject'], + ], + 'createdAt' => '2023-03-24T08:22:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetEditingProject'], + ], + 'createdAt' => '2022-12-05T04:40:28.000Z', + 'description' => '支持api timeline前端可编辑', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], + ], + 'createdAt' => '2022-12-02T09:42:16.000Z', + 'description' => 'GetMediaInfo AiRough 增加AiJobId 字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPlayInfo'], + ], + 'createdAt' => '2022-11-29T11:15:50.000Z', + 'description' => 'GetPlayInfo接口支持返回jobId', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], + ], + 'createdAt' => '2022-11-29T09:17:51.000Z', + 'description' => 'GetMediaInfo新增AI 分类字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SearchMedia'], + ], + 'createdAt' => '2022-11-29T09:17:30.000Z', + 'description' => '参数名称修改', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryMediaCensorJobList'], + ], + 'createdAt' => '2022-11-18T08:49:29.000Z', + 'description' => '新增QueryMediaCensorJobList', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetTranscodeJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTranscodeJobs'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2022-11-15T10:06:04.000Z', + 'description' => '增加内部参数', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'QueryCensorJobList'], + ], + 'createdAt' => '2022-11-15T07:31:24.000Z', + 'description' => '更新QueryCensorJobList', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetPlayInfo'], + ], + 'createdAt' => '2022-11-15T07:27:45.000Z', + 'description' => 'GetPlayInfo 增加InputURL、FileURLs 入参，增加streamTags 出参', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], + ], + 'createdAt' => '2022-11-15T06:35:16.000Z', + 'description' => 'GetMediaInfo 返回值增加AiRoughData', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchMedia'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-11-15T02:32:43.000Z', + 'description' => '新增AI返回参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RefreshUploadMedia'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-10-17T02:12:18.000Z', + 'description' => '更改fileurl为私有字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitLiveEditingJob'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice20UKYV', - ], + 'createdAt' => '2022-09-22T12:08:30.000Z', + 'description' => 'SubmitLiveEditingJob Clips 字段改为必填', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPackageJob'], + ['description' => 'Response parameters changed', 'api' => 'ListPackageJobs'], ], - 'parameters' => [ - [ - 'name' => 'AssetName', - 'in' => 'query', - 'schema' => [ - 'title' => '打包资产名称。', - 'description' => 'The name of the VOD packaging asset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30min_movie', - ], - ], + 'createdAt' => '2022-09-20T10:02:34.000Z', + 'description' => '打包部分返回参数设置为不可见。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTranscodeJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTranscodeJobs'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitPackageJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The result of asset deletion.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - ], - ], - ], + 'createdAt' => '2022-09-20T09:40:22.000Z', + 'description' => '转码支持加密、音视频合流、打包能力。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitMediaProducingJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitMediaProducingJob'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-09-16T03:17:53.000Z', + 'description' => '增加支持 MediaMarks 入参', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'AddMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'GetMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'GetMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'ListMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'ListMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateMediaMarks'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateMediaMarks'], + ], + 'createdAt' => '2022-09-15T09:32:27.000Z', + 'description' => '增加 MediaMarks 相关接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAudit'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'DeleteVodPackagingAsset', + 'createdAt' => '2022-09-08T12:04:40.000Z', + 'description' => '媒资审核接口', ], - 'CreateLivePackageChannelGroup' => [ - 'summary' => 'Creates a live package channel group with a custom name and description.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribePlayDetail'], + ['description' => 'Request parameters changed', 'api' => 'DescribePlayEventList'], + ['description' => 'Response parameters changed', 'api' => 'DescribePlayList'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-09-08T06:35:03.000Z', + 'description' => '接口优化', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], + ['description' => 'Response parameters changed', 'api' => 'ListMediaBasicInfos'], + ['description' => 'Request parameters changed', 'api' => 'RegisterMediaInfo'], + ['description' => 'Response parameters changed', 'api' => 'SearchMedia'], + ['description' => 'Request parameters changed', 'api' => 'UpdateMediaInfo'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-09-01T03:59:29.000Z', + 'description' => '新增外挂字幕相关APIAPI 支持增删改自定义ID', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QuerySmarttagJob'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitSmarttagJob'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238117', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'createdAt' => '2022-08-25T12:28:39.000Z', + 'description' => '标签接入ims', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeFilterConfigs'], + ['description' => 'OpenAPI offline', 'api' => 'DescribePlayFirstFrameDurationMetricData'], + ['description' => 'OpenAPI offline', 'api' => 'DescribePlayMetricData'], + ['description' => 'OpenAPI offline', 'api' => 'DescribePlayQoeList'], + ['description' => 'OpenAPI offline', 'api' => 'DescribePlayQosList'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeQueryConfigs'], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源一级ID', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-01', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The channel group description. It can be up to 1,000 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], + 'createdAt' => '2022-08-25T03:02:42.000Z', + 'description' => '数据ims观星台', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteLiveTranscodeJob'], + ['description' => 'OpenAPI offline', 'api' => 'GetLiveTranscodeJob'], + ['description' => 'OpenAPI offline', 'api' => 'ListLiveTranscodeJobs'], + ['description' => 'OpenAPI offline', 'api' => 'SendLiveTranscodeJobCommand'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitLiveTranscodeJob'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateLiveTranscodeJob'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannelGroup' => [ - 'description' => 'The information about the channel group.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel group was created. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The channel group description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'example-group', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the channel group was last modified. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'OriginDomain' => [ - 'title' => '源站域名', - 'description' => 'The origin domain.'."\n", - 'type' => 'string', - 'example' => 'example.com', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '123e4567-e89b-12d3-a456-426614174000', - ], - ], - ], - ], + 'createdAt' => '2022-08-24T03:10:34.000Z', + 'description' => '首次发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteLiveTranscodeTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'GetLiveTranscodeTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'ListLiveTranscodeTemplates'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateLiveTranscodeTemplate'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-08-23T11:40:11.000Z', + 'description' => '首次发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateLiveTranscodeTemplate'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroup\\": {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"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.'."\n", + 'createdAt' => '2022-08-23T07:57:37.000Z', + 'description' => '新api', ], - 'UpdateLivePackageChannelGroup' => [ - 'summary' => 'Updates the information about a live package channel group including its description.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsLiveEditUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsLiveMediaConvertUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsLiveRecordUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsLiveSnapshotUsage'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMeterImsSummary'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-08-23T07:18:35.000Z', + 'description' => 'ims 直播相关计量接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateLiveRecordTemplate'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListLiveRecordJobs'], + ['description' => 'Response parameters changed', 'api' => 'ListLiveRecordTemplates'], + ['description' => 'Request parameters changed', 'api' => 'SubmitLiveRecordJob'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-08-18T07:46:02.000Z', + 'description' => 'IMS录制API发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateLiveRecordTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'ListLiveRecordJobs'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitLiveRecordJob'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238119', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'createdAt' => '2022-08-17T07:09:53.000Z', + 'description' => 'IMS API', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteMediaInfos'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeletePlayInfo'], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源一级ID', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道组描述', - 'description' => 'The channel group description. It can be up to 1,000 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], + 'createdAt' => '2022-08-16T07:45:27.000Z', + 'description' => 'DeleteMediaInfos 和DeletePlayInfo 增加物理删除字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RegisterMediaInfo'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannelGroup' => [ - 'description' => 'The information about the channel group.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel group was created. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The channel group description.'."\n", - 'type' => 'string', - 'example' => 'Updated description of the channel group.', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'example-group-name', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the channel group was last modified. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'OriginDomain' => [ - 'title' => '源站域名', - 'description' => 'The origin domain.'."\n", - 'type' => 'string', - 'example' => 'example-origin.com', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'request-1234567890', - ], - ], - ], - ], + 'createdAt' => '2022-08-11T05:19:57.000Z', + 'description' => 'RegisterMediaInfo workflowId 置为公有', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitDynamicImageJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitMediaInfoJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitSnapshotJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitSyncMediaInfoJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitTranscodeJob'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-08-10T06:34:11.000Z', + 'description' => '发起媒体处理任务相关接口设置必填参数。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListPublicMediaBasicInfos'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroup\\": {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"Updated description of the channel group.\\",\\n \\"GroupName\\": \\"example-group-name\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"OriginDomain\\": \\"example-origin.com\\"\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\\\n\\"\\n}","type":"json"}]', - 'title' => 'UpdateLivePackageChannelGroup', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'This API operation allows you to modify the name and description of a live package channel group. The channel group name must conform to the naming conventions and can be up to 1,000 characters. The API response includes the updated channel group details and unique identifier of the request.'."\n", + 'createdAt' => '2022-08-09T01:46:49.000Z', + 'description' => 'ListPublicMediaBasicInfos pageNo 和 pageSize 设为公有', ], - 'GetLivePackageChannelGroup' => [ - 'summary' => 'Queries the details of a live package channel group by name.', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsEditUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsMediaConvertUHDUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsMediaConvertUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterImsMpsAiUsage'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-07-26T13:04:57.000Z', + 'description' => 'IMS 计量相关接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTranscodeJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTranscodeJobs'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-07-20T08:46:03.000Z', + 'description' => '更新文档', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListMediaInfoJobs'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTranscodeJobs'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238116', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'createdAt' => '2022-07-20T07:56:40.000Z', + 'description' => '更新文档', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SubmitSyncMediaInfoJob'], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', - ], - ], + 'createdAt' => '2022-07-20T07:14:51.000Z', + 'description' => '更新文档', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetMediaInfoJob'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannelGroup' => [ - 'description' => 'Details of the channel group.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel group was created. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The channel group description.'."\n", - 'type' => 'string', - 'example' => 'Updated description of the channel group.', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the channel group was last modified. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'OriginDomain' => [ - 'title' => '源站域名', - 'description' => 'The origin domain.'."\n", - 'type' => 'string', - 'example' => 'example.com', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'req-abcdefg123456', - ], - ], - ], - ], + 'createdAt' => '2022-07-20T06:52:06.000Z', + 'description' => '更新文档', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListMediaInfoJobs'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-07-20T06:27:36.000Z', + 'description' => '更新文档', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitMediaInfoJob'], ], - '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" - .'You can call this API operation to query the details of a specific channel group, including its name, description, origin domain, and creation and last modification timestamps.'."\n", + 'createdAt' => '2022-07-20T03:52:31.000Z', + 'description' => '修改文档', ], - 'ListLivePackageChannelGroups' => [ - 'summary' => 'Queries live package channel groups by page. Fuzzy search by name or description and sorting are supported.', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryCensorJobList'], + ['description' => 'OpenAPI offline', 'api' => 'QueryMediaCensorJobDetail'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitMediaCensorJob'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-07-19T11:24:17.000Z', + 'description' => '审核ice接口上线', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfoJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTranscodeJob'], + ['description' => 'Response parameters changed', 'api' => 'ListMediaInfoJobs'], + ['description' => 'Response parameters changed', 'api' => 'ListTranscodeJobs'], + ['description' => 'Response parameters changed', 'api' => 'SubmitMediaInfoJob'], + ['description' => 'Response parameters changed', 'api' => 'SubmitSyncMediaInfoJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2022-07-19T09:23:02.000Z', + 'description' => '去掉没用字段，增加文档', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfoJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTranscodeJob'], + ['description' => 'Response parameters changed', 'api' => 'ListMediaInfoJobs'], + ['description' => 'Response parameters changed', 'api' => 'ListTranscodeJobs'], + ['description' => 'Response parameters changed', 'api' => 'SubmitMediaInfoJob'], + ['description' => 'Response parameters changed', 'api' => 'SubmitSyncMediaInfoJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTranscodeJob'], + ], + 'createdAt' => '2022-07-19T08:09:29.000Z', + 'description' => '去掉实际上没有用的字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterIceMpsAiUsage'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-07-19T04:23:17.000Z', + 'description' => '计量接口发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterIceLiveMediaConvertUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterIceMediaConvertUHDUsage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMeterIceMediaConvertUsage'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238120', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'createdAt' => '2022-07-19T04:19:13.000Z', + 'description' => 'ICE计量接口发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateCustomTemplate'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreatePipeline'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetCustomTemplate'], + ['description' => 'Response parameters changed', 'api' => 'GetPipeline'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCustomTemplates'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListPipelines'], ], - 'parameters' => [ - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'title' => '描述', - 'description' => 'The channel group name or description. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'channel-group', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sort order by creation time. Default value: desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - ], + 'createdAt' => '2022-07-18T03:29:14.000Z', + 'description' => 'AppId参数先设置为不可见', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitIProductionJob'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannelGroups' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'The channel groups returned.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'LivePackageChannelGroupItemType', - 'description' => 'LivePackageChannelGroupItemType'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel group was created. It is in the `yyyy-MM-ddTHH:mm:ssZ` format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The channel group description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GroupName' => [ - 'title' => '资源一级ID', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'testChannelGroup', - ], - 'LastModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the channel group was last modified. It is in the `yyyy-MM-ddTHH:mm:ssZ` format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-02T12:00:00Z', - ], - 'OriginDomain' => [ - 'title' => '源站域名', - 'description' => 'The origin domain.'."\n", - 'type' => 'string', - 'example' => 'origin.example.com', - ], - ], - ], - ], - 'PageNo' => [ - 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', - ], - 'SortBy' => [ - 'description' => 'The sort order.'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'TotalCount' => [ - 'title' => '总记录数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - ], + 'createdAt' => '2022-07-15T09:42:55.000Z', + 'description' => '修改一些参数必填', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetCategories'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-07-15T06:48:26.000Z', + 'description' => 'grandID字段私有', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], ], - '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'."\n", + 'createdAt' => '2022-07-14T07:53:07.000Z', + 'description' => 'GetMediaInfo部分字段置为私有', ], - 'DeleteLivePackageChannelGroup' => [ - 'summary' => 'Deletes a live package channel group by name.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListMediaBasicInfos'], + ['description' => 'Request parameters changed', 'api' => 'RegisterMediaInfo'], + ['description' => 'Request parameters changed', 'api' => 'UpdateMediaInfo'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-07-14T07:50:37.000Z', + 'description' => '部分字段设置为私有', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryIProductionJob'], + ['description' => 'OpenAPI offline', 'api' => 'QueryIProductionJobList'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitIProductionJob'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-07-13T08:33:22.000Z', + 'description' => 'ICE新增3个智能生产接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetPlayInfo'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238118', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'createdAt' => '2022-07-13T06:54:05.000Z', + 'description' => '新增播放流接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateUploadStream'], + ['description' => 'OpenAPI offline', 'api' => 'RegisterMediaStream'], + ['description' => 'OpenAPI offline', 'api' => 'UploadStreamByURL'], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '资源一级ID', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'group1', - ], - ], + 'createdAt' => '2022-07-13T06:51:55.000Z', + 'description' => '新增媒体流上传api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RegisterMediaInfo'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '资源一级ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', - ], - ], - ], - ], + 'createdAt' => '2022-07-12T12:00:02.000Z', + 'description' => 'RegisterMediaInfo 新增workflowId字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddStorage'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteStorage'], + ['description' => 'OpenAPI offline', 'api' => 'GetStorageList'], + ['description' => 'OpenAPI offline', 'api' => 'SetDefaultStorage'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateStorage'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-07-12T10:55:14.000Z', + 'description' => '新增存储管理相关接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateCustomTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'CreatePipeline'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteCustomTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'DeletePipeline'], + ['description' => 'OpenAPI offline', 'api' => 'GetCustomTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'GetDynamicImageJob'], + ['description' => 'OpenAPI offline', 'api' => 'GetMediaInfoJob'], + ['description' => 'OpenAPI offline', 'api' => 'GetPipeline'], + ['description' => 'OpenAPI offline', 'api' => 'GetSnapshotJob'], + ['description' => 'OpenAPI offline', 'api' => 'GetSnapshotUrls'], + ], + 'createdAt' => '2022-07-11T09:38:31.000Z', + 'description' => 'IMS-媒体处理模块OpenAPI接口发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddCategory'], + ['description' => 'OpenAPI offline', 'api' => 'CreateUploadMedia'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteCategory'], + ['description' => 'OpenAPI offline', 'api' => 'GetCategories'], + ['description' => 'OpenAPI offline', 'api' => 'GetUrlUploadInfos'], + ['description' => 'OpenAPI offline', 'api' => 'InitializeStorage'], + ['description' => 'OpenAPI offline', 'api' => 'RefreshUploadMedia'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateCategory'], + ['description' => 'OpenAPI offline', 'api' => 'UploadMediaByURL'], + ], + 'createdAt' => '2022-06-20T09:48:57.000Z', + 'description' => '媒体服务pop api发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateEntity'], + ['description' => 'OpenAPI offline', 'api' => 'CreateEntityAttribute'], + ['description' => 'OpenAPI offline', 'api' => 'CreateEntityEnum'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteEntity'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteEntityAttribute'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteEntityEnum'], + ['description' => 'OpenAPI offline', 'api' => 'GetEntity'], + ['description' => 'OpenAPI offline', 'api' => 'GetEntityAttribute'], + ['description' => 'OpenAPI offline', 'api' => 'GetEntityEnum'], + ], + 'createdAt' => '2022-06-20T09:34:32.000Z', + 'description' => '增加实体管理接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetClientConfig'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSysTemplates'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SetClientConfig'], ], - '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.'."\n", + 'createdAt' => '2022-03-15T12:26:40.000Z', + 'description' => 'api文档变更 ', ], - 'CreateLivePackageChannel' => [ - 'summary' => 'Creates a live package channel.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetClientConfig'], + ['description' => 'Request parameters changed', 'api' => 'SetClientConfig'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-03-15T12:26:03.000Z', + 'description' => '描述字段 ', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateTrailAppLicense'], + ['description' => 'OpenAPI offline', 'api' => 'GetAppLicenseKey'], + ['description' => 'OpenAPI offline', 'api' => 'GetAppLicenseList'], + ['description' => 'OpenAPI offline', 'api' => 'GetClientConfig'], + ['description' => 'OpenAPI offline', 'api' => 'ListAllClientSdkInfos'], + ['description' => 'OpenAPI offline', 'api' => 'RenewTrailAppLicense'], + ['description' => 'OpenAPI offline', 'api' => 'SetClientConfig'], + ], + 'createdAt' => '2022-03-01T16:02:46.000Z', + 'description' => 'ice云端一体化配置接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSmartJobs'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-02-21T07:06:18.000Z', + 'description' => '更改api字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteSmartJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitH2VJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitKeyWordCutJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitMattingJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitPPTCutJob'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239700', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'createdAt' => '2022-01-25T02:14:12.000Z', + 'description' => '接口参数示例变更', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'SubmitDynamicChartJob'], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道组名称', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', - ], - ], - [ - 'name' => 'SegmentCount', - 'in' => 'formData', - 'schema' => [ - 'title' => '切片个数', - 'description' => 'The number of M3U8 segments. Valid values: 2 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道描述', - 'description' => 'The channel description. It can be up to 1,000 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'SegmentDuration', - 'in' => 'formData', - 'schema' => [ - 'title' => '切片时长', - 'description' => 'The segment duration. Valid values: 1 to 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '6', - ], - ], - [ - 'name' => 'ChannelName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道名称', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****', - ], - ], - [ - 'name' => 'Protocol', - 'in' => 'formData', - 'schema' => [ - 'title' => '协议', - 'description' => 'The ingest protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HLS', - ], - ], + 'createdAt' => '2022-01-04T03:28:05.000Z', + 'description' => '变更智能任务字段信息', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetLiveEditingJob'], + ], + 'createdAt' => '2021-12-29T07:28:40.000Z', + 'description' => 'GetLiveEditingJob 返回值MediaURL 修复', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitAudioProduceJob'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannel' => [ - 'description' => 'The information about the live package channel.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'example-channel', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel was created. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '频道描述', - 'description' => 'The channel description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IngestEndpoints' => [ - 'description' => 'The ingest endpoints.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the ingest endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ingest endpoint ID.'."\n", - 'type' => 'string', - 'example' => 'ingest1', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'example' => '2F9e******b569c8', - ], - 'Url' => [ - 'description' => 'The ingest endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', - ], - 'Username' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'us12******das', - ], - ], - ], - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the channel was last modified. It is in the yyyy-MM-ddTHH:mm:ssZ format and displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Protocol' => [ - 'title' => '协议', - 'description' => 'The ingest protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'SegmentCount' => [ - 'title' => '切片个数', - 'description' => 'The number of M3U8 segments.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'SegmentDuration' => [ - 'title' => '切片时长', - 'description' => 'The segment duration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******3B-0E1A-586A-AC29-742247******', - ], - ], - ], - ], + 'createdAt' => '2021-12-21T15:10:10.000Z', + 'description' => '新增动态图表接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddEditingProjectMaterials'], + ['description' => 'Response parameters changed', 'api' => 'GetEditingProjectMaterials'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2021-11-26T03:22:13.000Z', + 'description' => 'projectMaterials返回字段修复，从String修复为list', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddFavoritePublicMedia'], + ['description' => 'OpenAPI offline', 'api' => 'CancelFavoritePublicMedia'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeMaterialPackageInfo'], + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], + ['description' => 'OpenAPI offline', 'api' => 'GetPublicMediaInfo'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAllPublicMediaTags'], + ['description' => 'OpenAPI offline', 'api' => 'SearchPublicMediaInfo'], + ], + 'createdAt' => '2021-11-25T06:53:41.000Z', + 'description' => '新增GetPublicMediaInfo，用于获取版权公共媒资信息。新增SearchPublicMediaInfo，用于搜索版权公共媒资。新增AddFavoritePublicMedia, 用于收藏公共媒资。新增CancelFavoritePublicMedia, 用于取消收藏公共媒资。新', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMediaProducingJob'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"example-channel\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个测试频道\\",\\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" - .'* Only `HLS` is supported.'."\n" - .'* The segment duration must be from 1 to 30 seconds.'."\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.'."\n", + 'createdAt' => '2021-11-25T03:58:25.000Z', + 'description' => 'GetMediaProducingJob在剪辑工程输出至vod时，返回vod媒资id。', ], - 'UpdateLivePackageChannel' => [ - 'summary' => 'Updates the configuration of a live package channel, including the protocol, segment duration, and number of segments.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitMediaProducingJob'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2021-11-25T03:51:08.000Z', + 'description' => 'SubmitMediaProducingJob接口增加EditingProduceConfig字段，支持剪辑配置参数统一化管理。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeIceProductStatus'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2021-11-23T02:26:05.000Z', + 'description' => '增加入参commodityCode, 支持判断ice产品下的不同商品开通情况', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetLiveEditingJob'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitLiveEditingJob'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239702', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], + 'createdAt' => '2021-08-16T07:09:22.000Z', + 'description' => '新增SubmitLiveEditingJob, 提交直播剪辑任务新增GetLiveEditingJob，获取直播剪辑任务', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetEventCallback'], + ['description' => 'OpenAPI offline', 'api' => 'SetEventCallback'], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道组名称', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + 'createdAt' => '2021-06-25T14:20:12.000Z', + 'description' => 'Add API SetEventCallback which sets configuration for event callback.Add API GetEventCallback which gets configuration for event callback', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitAudioProduceJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitDelogoJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitH2VJob'], + ['description' => 'Request parameters changed', 'api' => 'SubmitMattingJob'], + ], + 'createdAt' => '2021-06-03T06:51:44.000Z', + 'description' => '智能生产接口添加overwrite功能，支持开发者控制覆盖原oss文件', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SubmitMediaProducingJob'], + ], + 'createdAt' => '2021-06-03T01:33:47.000Z', + 'description' => 'SubmitMediaProducingJob返回 内容中增加 MediaId', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListSmartJobs'], + ], + 'createdAt' => '2021-05-25T03:48:53.000Z', + 'description' => 'ListSmartJobs接口升级', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetDefaultStorageLocation'], + ['description' => 'Request parameters changed', 'api' => 'GetMediaInfo'], + ['description' => 'OpenAPI offline', 'api' => 'SetDefaultStorageLocation'], + ], + 'createdAt' => '2021-05-25T03:34:34.000Z', + 'description' => 'GetMediaInfo增加OutputType入参新增SetDefaultStorageLocation/GetDefaultStorageLocation 两个API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetTemplate'], + ], + 'createdAt' => '2021-04-25T07:55:20.000Z', + 'description' => '新增模板工厂相关OpenAPI', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'SubmitAudioProduceJob'], + ], + 'createdAt' => '2021-04-16T13:17:49.000Z', + 'description' => '新增SubmitAudioProduceJob接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetEditingProjectMaterials'], + ['description' => 'Request parameters changed', 'api' => 'RegisterMediaInfo'], + ], + 'createdAt' => '2021-04-07T12:25:00.000Z', + 'description' => 'GetEditingProjectMaterials 返回值增加雪碧图接口RegisterMediaInfo接口增加RegisterConfig字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitASRJob'], + ], + 'createdAt' => '2021-04-07T06:11:17.000Z', + 'description' => '修改参数，暂时无人使用', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitASRJob'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitCoverJob'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitDelogoJob'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitH2VJob'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitMattingJob'], + ], + 'createdAt' => '2021-04-06T06:07:29.000Z', + 'description' => '兼容变更 新增接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddEditingProjectMaterials'], + ['description' => 'Response parameters changed', 'api' => 'GetMediaInfo'], + ['description' => 'Response parameters changed', 'api' => 'ListMediaBasicInfos'], + ], + 'createdAt' => '2021-03-31T07:38:23.000Z', + 'description' => 'AddEditingProjectMaterials, ListMediaBasicInfos, GetMediaInfo API 返回值增加SpriteImages 字段展示雪碧图信息', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFavoritePublicMedia'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveTranscodeTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBatchMediaProducingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaCensorJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightExtractJob'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByMultimodal'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSystemTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceAbJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaInfo'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchIndexJobRerun'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActiveAiRtcLicense'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomizedVoice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudit'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelines'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEditingProjects'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaMarks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshUploadMedia'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomizedVoiceJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveSnapshotTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaMarks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPlayInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveSnapshotFiles'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDNAFiles'], + ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsEditUsage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDNADB'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveTranscodeJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCustomizedVoiceJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordFiles'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAvatar'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveRecordJob'], + ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsMpsAiUsage'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveRecordTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEditingProjectMaterials'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomizedVoices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveSnapshotTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveSnapshotFiles'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitIProductionJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaInfoJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSmarttagJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomizedVoiceJob'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchLib'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightExtractJob'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMediaToSearchLib'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmarttagJob'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByFace'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterMediaInfo'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetMediaInfos'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMedia'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaBasicInfos'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCategory'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitASRJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaInfo'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDynamicChartJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceExtractJob'], + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DropSearchIndex'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCopyrightJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveSnapshotJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomizedVoice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendAIAgentDataChannelMessage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartAIAgentInstance'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTranscodeJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceExtractJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetectAudioForCustomizedVoiceJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDNAFiles'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateKMSDataKey'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTextGenerateJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveTranscodeTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaProducingJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveSnapshotTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveSnapshotJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlayInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaProducingJob'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSearchLib'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveEditingIndexFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUrlUploadInfos'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDNADB'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendLiveSnapshotJobCommand'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveRecordFiles'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplateParams'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAvatarTrainingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDynamicImageJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveEditingJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordJobs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVideoList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRecordTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveSnapshotTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveTranscodeTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTraceM3u8Job'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaInfos'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSmartVoiceGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaInfoJobs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelFavoritePublicMedia'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSnapshotJob'], + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AlterSearchIndex'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveRecordTemplates'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DropSearchLib'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveRecordJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaMarks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLiveTranscodeJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DecryptKMSDataKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUploadMedia'], + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDNAJob'], + ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsMediaConvertUHDUsage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmartJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEditingProject'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySearchIndex'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPackageJobs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendLiveTranscodeJobCommand'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultStorageLocation'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCopyrightJobList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDNAJobList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCategory'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomizedVoiceJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetEventCallback'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDNADB'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMediaMarks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchPublicMediaInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMediaMarks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSnapshotJob'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaClipByFace'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTranscodeJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaProducingJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStorageList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveSnapshotTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEventCallback'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDynamicImageJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaCensorJobDetail'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiRtcAuthCodeList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSmartJobs'], + ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlayList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveTranscodeTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateAIAgentCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSmartSysAvatarModels'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshotJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDynamicImageJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetContentAnalyzeConfig'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiRtcLicenseInfoList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryIProductionJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEditingProject'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkflowTask'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAvatarTrainingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterMediaStream'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitBatchMediaProducingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadStreamByURL'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipeline'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEditingProjectMaterials'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchEditingProject'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCategories'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDemonstrationForCustomizedVoiceJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomTemplates'], + ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsSummary'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InsertMediaToSearchLib'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSnapshotUrls'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipeline'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPackageJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCategory'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLiveRecordTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceM3u8JobList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSystemTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveRecordTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAvatarVideoJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveTranscodeJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveTranscodeJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEditingProject'], + ['threshold' => '90', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMeterImsMediaConvertUsage'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSyncMediaInfoJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomizedVoiceJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadMediaByURL'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContentAnalyzeConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartWorkflow'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTranscodeJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitMediaInfoJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendAIAgentSpeech'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitLiveEditingJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLiveTranscodeTemplate'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMediaIndexJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTraceAbJobList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultStorageLocation'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvatars'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitPackageJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddEditingProjectMaterials'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByHybrid'], + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSearchIndex'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLiveSnapshotJobs'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMediaByAILabel'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySearchLib'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMediaFromSearchLib'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvatarTrainingJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultCustomTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAudioProduceJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomTemplate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLiveTranscodeJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAvatarTrainingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelDNAJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSmartHandleJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUploadStream'], + ], + ], + 'ram' => [ + 'productCode' => 'ICE', + 'productName' => 'Intelligent Media Services', + 'ramCodes' => ['ice'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateDNADB', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreateDNADB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道描述', - 'description' => 'The channel description. It can be up to 1,000 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'GetLiveSnapshotTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveSnapshotTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Protocol', - 'in' => 'formData', - 'schema' => [ - 'title' => '协议', - 'description' => 'The ingest protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HLS', + ], + [ + 'apiName' => 'SubmitLiveEditingJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveEditingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SegmentCount', - 'in' => 'formData', - 'schema' => [ - 'title' => '切片个数', - 'description' => 'The number of M3U8 segments. Valid values: 2 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', + ], + [ + 'apiName' => 'ListPipelines', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListPipelines', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SegmentDuration', - 'in' => 'formData', - 'schema' => [ - 'title' => '切片时长', - 'description' => 'The segment duration. Valid values: 1 to 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '6', + ], + [ + 'apiName' => 'StartAIWorkflow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:StartAIWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道名称', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'DeleteLiveTranscodeTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteLiveTranscodeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned data including the updated channel information and request ID.'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannel' => [ - 'description' => 'The information about the live package channel.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'channel-1', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel was created.'."\n", - 'type' => 'string', - 'example' => '2024-07-16T02:24:42Z', - ], - 'Description' => [ - 'title' => '频道描述', - 'description' => 'The channel description. It can be up to 1,000 characters in length.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IngestEndpoints' => [ - 'description' => 'The ingest endpoints.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the ingest endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ingest endpoint ID.'."\n", - 'type' => 'string', - 'example' => 'ingest1', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'example' => '2F9e******b569c8', - ], - 'Url' => [ - 'description' => 'The ingest endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', - ], - 'Username' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'us12******das', - ], - ], - ], - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the channel was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-07-16T02:24:42Z', - ], - 'Protocol' => [ - 'title' => '协议', - 'description' => 'The ingest protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'SegmentCount' => [ - 'title' => '切片个数', - 'description' => 'The number of segments.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'SegmentDuration' => [ - 'title' => '切片时长', - 'description' => 'The segment duration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', - ], - ], + [ + 'apiName' => 'UpdateLiveSnapshotTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveSnapshotTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2024-07-16T02:24:42Z\\",\\n \\"Description\\": \\"这是一个测试频道\\",\\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\\": \\"2024-07-16T02:24:42Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n },\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', - 'title' => 'UpdateLivePackageChannel', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'You need to provide the name of the channel group to which the channel belongs, channel name, protocol, segment duration, and number of segments to update. In addition, you can choose to add or modify the description of the channel. Make sure that the provided channel group name and channel name conform to the naming conventions.'."\n", - ], - 'UpdateLivePackageChannelCredentials' => [ - 'summary' => 'Updates the credentials of ingest endpoints associated with a live package channel.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DeleteLiveSnapshotTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteLiveSnapshotTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListSnapshotJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListSnapshotJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'SetContentAnalyzeConfig', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '240167', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + 'ramAction' => [ + 'action' => 'ice:SetContentAnalyzeConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'group-1', + [ + 'apiName' => 'ListDNAFiles', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListDNAFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'GetMediaMarks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetMediaMarks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RotateCredentials', - 'in' => 'formData', - 'schema' => [ - 'title' => '刷新密钥选项', - 'description' => 'Specifies whether to update the credentials. 1: updates the credentials of endpoint 1. 2: updates the credentials of endpoint 2. 3: updates the credentials of endpoints 1 and 2.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', + ], + [ + 'apiName' => 'ListAIAgentVoiceprints', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListAIAgentVoiceprints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'IngestEndpoints' => [ - 'description' => 'The information about the ingest endpoint.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ingest endpoint ID. `input1` indicates primary and `input2` indicates secondary.'."\n", - 'type' => 'string', - 'example' => 'input1', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'example' => 'examplePassword123', - ], - 'Url' => [ - 'description' => 'The ingest endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'rtmp://example.com/live/input1', - ], - 'Username' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - ], - ], - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', - ], - ], + [ + 'apiName' => 'UpdateLiveRecordTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveRecordTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"input1\\",\\n \\"Password\\": \\"examplePassword123\\",\\n \\"Url\\": \\"rtmp://example.com/live/input1\\",\\n \\"Username\\": \\"user1\\"\\n }\\n ],\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', - 'title' => 'UpdateLivePackageChannelCredentials', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'You can choose to update the primary endpoint, secondary endpoint, or both. The response includes the updated ingest endpoint URL, username, and password for the ingest device to reconfigure.'."\n", - ], - 'GetLivePackageChannel' => [ - 'summary' => 'Queries the details of a live package channel.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'SearchMediaByMultimodal', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239699', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', - ], - ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', - ], - ], - [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + 'ramAction' => [ + 'action' => 'ice:SearchMediaByMultimodal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannel' => [ - 'description' => 'Details of the live package channel.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'ch4', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel was created.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '频道描述', - 'description' => 'The channel description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IngestEndpoints' => [ - 'description' => 'The ingest endpoints.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the ingest endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ingest endpoint ID.'."\n", - 'type' => 'string', - 'example' => 'ingest1', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'example' => '2F9e******b569c8', - ], - 'Url' => [ - 'description' => 'The ingest endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest'."\n", - ], - 'Username' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'us12******das', - ], - ], - ], - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the endpoint was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Protocol' => [ - 'title' => '协议', - 'description' => 'The ingest protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'SegmentCount' => [ - 'title' => '切片个数', - 'description' => 'The number of M3U8 segments.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'SegmentDuration' => [ - 'title' => '切片时长', - 'description' => 'The segment duration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'RequestId-12345678', - ], - ], + [ + 'apiName' => 'CreateLiveSnapshotTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreateLiveSnapshotTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"ch4\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"测试频道\\",\\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.'."\n", - ], - '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', + [ + 'apiName' => 'GetCategories', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetCategories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + [ + 'apiName' => 'SubmitDynamicImageJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitDynamicImageJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'title' => '列表过滤参数', - 'description' => 'The channel name or description. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'group-1', + ], + [ + 'apiName' => 'SubmitTranscodeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'UpdateCustomTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateCustomTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'GetLiveEditingIndexFile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveEditingIndexFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sort order by creation time. Default value: desc.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* asc'."\n" - .'* desc'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', - ], - 'example' => 'desc', + ], + [ + 'apiName' => 'GetMediaInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetMediaInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageChannels' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'The live package channels.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'LivePackageChannelItemType', - 'description' => 'LivePackageChannelItemType'."\n", - 'type' => 'object', - 'properties' => [ - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'ch3', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the channel was created.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z'."\n", - ], - 'Description' => [ - 'title' => '频道描述', - 'description' => 'The channel description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IngestEndpoints' => [ - 'description' => 'The ingest endpoints.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the ingest endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ingest endpoint ID.'."\n", - 'type' => 'string', - 'example' => 'ingest1', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'example' => '2F9e9******18b569c8', - ], - 'Url' => [ - 'description' => 'The ingest endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', - ], - 'Username' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'us12******das', - ], - ], - ], - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the channel was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Protocol' => [ - 'title' => '协议', - 'description' => 'The ingest protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'SegmentCount' => [ - 'title' => '切片个数', - 'description' => 'The number of M3U8 segments.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'SegmentDuration' => [ - 'title' => '切片时长', - 'description' => 'The segment duration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - ], - 'PageNo' => [ - 'title' => '页码。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数。', - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'SortBy' => [ - 'description' => 'The sort order. Valid values: asc and desc (default).'."\n", - 'type' => 'string', - 'example' => 'asc/desc', - ], - 'TotalCount' => [ - 'title' => '总记录数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - ], + [ + 'apiName' => 'GetContentAnalyzeConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetContentAnalyzeConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannels\\": [\\n {\\n \\"ChannelName\\": \\"ch3\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\\\n\\",\\n \\"Description\\": \\"测试频道\\",\\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\\": \\"RequestId的示例值\\",\\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" - .'* **Keyword** supports fuzzy match of channel names or descriptions, which helps quickly filter desired channels.'."\n" - .'* **PageNo** and **PageSize** can help control the paging of returned results to facilitate batch processing of data.'."\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.'."\n", - ], - 'DeleteLivePackageChannel' => [ - 'summary' => 'Deletes a live package channel by GroupName and ChannelName.', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetDynamicImageJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetDynamicImageJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'QueryCopyrightExtractJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:QueryCopyrightExtractJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListSmartSysAvatarModels', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListSmartSysAvatarModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239701', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + [ + 'apiName' => 'AlterSearchLib', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:AlterSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + [ + 'apiName' => 'GetMediaInfoJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetMediaInfoJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'CreateLiveTranscodeTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreateLiveTranscodeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', - ], - ], + [ + 'apiName' => 'ListLiveSnapshotFiles', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveSnapshotFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetTranscodeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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.'."\n", - ], - 'CreateLivePackageOriginEndpoint' => [ - 'summary' => 'Creates an origin endpoint for a live package channel to deliver live streams in HLS format.', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteYikeAssetMediaInfos', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteYikeAssetMediaInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetEventCallback', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetEventCallback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CloseStreamToSearchLib', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:CloseStreamToSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239771', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + [ + 'apiName' => 'BatchGetMediaInfos', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:BatchGetMediaInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + [ + 'apiName' => 'QuerySearchLib', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QuerySearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'DeleteChannel', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteChannel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndpointName', - 'in' => 'formData', - 'schema' => [ - 'title' => '端点名称', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'endpoint-1', + ], + [ + 'apiName' => 'AddCategory', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:AddCategory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Protocol', - 'in' => 'formData', - 'schema' => [ - 'title' => '分发协议', - 'description' => 'The distribution protocol.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HLS', + ], + [ + 'apiName' => 'SubmitProjectExportJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitProjectExportJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ManifestName', - 'in' => 'formData', - 'schema' => [ - 'title' => '清单名称', - 'description' => 'The playlist name. Default value: manifest.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'manifest', + ], + [ + 'apiName' => 'GetStorageList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetStorageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '端点描述', - 'description' => 'The endpoint description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'SubmitBatchMediaProducingJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitBatchMediaProducingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TimeshiftVision', - 'in' => 'formData', - 'schema' => [ - 'title' => '时移天数', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'SetDefaultStorageLocation', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:SetDefaultStorageLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AuthorizationCode', - 'in' => 'formData', - 'schema' => [ - 'title' => '回源授权码', - '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-\\_.]+'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AbcDef123', + ], + [ + 'apiName' => 'ListLiveRecordJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveRecordJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IpWhitelist', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP白名单', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.0/24,10.0.0.1/24', + ], + [ + 'apiName' => 'CreateUploadStream', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateUploadStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IpBlacklist', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP黑名单', - '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 (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '103.21.222.1/32,192.168.100.0/24', + ], + [ + 'apiName' => 'ListYikeAssetFolders', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListYikeAssetFolders', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '****0311a423d11a5f7dee713535****', + ], + [ + 'apiName' => 'SubmitSyncMediaInfoJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSyncMediaInfoJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LivePackagingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - '$ref' => '#/components/schemas/LivePackagingConfig', + ], + [ + 'apiName' => 'CreateAudit', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:CreateAudit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageOriginEndpoint' => [ - 'description' => 'The information about the origin endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'AuthorizationCode' => [ - 'title' => '回源授权码', - 'description' => 'The authorization code.'."\n", - 'type' => 'string', - 'example' => 'Abcded123', - ], - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'channel-1', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the endpoint was created.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '端点描述', - 'description' => 'The endpoint description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'EndpointName' => [ - 'title' => '端点名称', - 'description' => 'The endpoint name.'."\n", - 'type' => 'string', - 'example' => 'endpoint-1', - ], - 'EndpointUrl' => [ - 'title' => '端点URL', - 'description' => 'The endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IpBlacklist' => [ - 'title' => 'IP黑名单', - 'description' => 'The IP address blacklist.'."\n", - 'type' => 'string', - 'example' => '103.21.222.1/32,192.168.100.0/24', - ], - 'IpWhitelist' => [ - 'title' => 'IP白名单', - 'description' => 'The IP address whitelist.'."\n", - 'type' => 'string', - 'example' => '192.168.1.0/24,10.0.0.1/24', - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the endpoint was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'ManifestName' => [ - 'title' => '清单名称', - 'description' => 'The playlist name.'."\n", - 'type' => 'string', - 'example' => 'manifest', - ], - 'Protocol' => [ - 'title' => '分发协议', - 'description' => 'The protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'TimeshiftVision' => [ - 'title' => '时移天数', - 'description' => 'The number of days that time-shifted content is available. Maximum value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LivePackagingConfig' => [ - '$ref' => '#/components/schemas/LivePackagingConfig', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - ], + [ + 'apiName' => 'CreateYikeWorkspace', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateYikeWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DetectAudioForCustomizedVoiceJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:DetectAudioForCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abcded123\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\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\\": 0,\\n \\"AdMarkers\\": \\"\\",\\n \\"MinVideoBitrate\\": 0,\\n \\"MinBufferTime\\": 0,\\n \\"PresentationDelay\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitrate\\": 0,\\n \\"DateTimeInterval\\": 0,\\n \\"SegmentTemplateFormat\\": \\"\\",\\n \\"MinUpdatePeriod\\": 0,\\n \\"ManifestDuration\\": 0\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"\\",\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n },\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', - 'title' => 'CreateLivePackageOriginEndpoint', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'This API operation is mainly used to configure origin settings, security policies including the IP address blacklist and whitelist and authorization code, and time shifting settings for channels. Before you create an origin endpoint, you must create a live package channel group and channel. After you create the endpoint, the endpoint URL and other configuration details are returned.'."\n", - ], - 'UpdateLivePackageOriginEndpoint' => [ - 'summary' => 'Updates the origin endpoint settings including the protocol, time shifting, and access control settings.', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteMediaMarks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteMediaMarks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateLiveTranscodeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListSearchLib', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239773', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + [ + 'apiName' => 'DeletePipeline', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeletePipeline', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + [ + 'apiName' => 'DeleteAvatarTrainingJob', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteAvatarTrainingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'formData', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'RegisterMediaInfo', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:RegisterMediaInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndpointName', - 'in' => 'formData', - 'schema' => [ - 'title' => '端点名称', - '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\\_-]+'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'endpoint-1', + ], + [ + 'apiName' => 'ListLiveTranscodeJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveTranscodeJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Protocol', - 'in' => 'formData', - 'schema' => [ - 'title' => '分发协议', - 'description' => 'The protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HLS', + ], + [ + 'apiName' => 'RegisterYikeAssetMediaInfo', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:RegisterYikeAssetMediaInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ManifestName', - 'in' => 'formData', - 'schema' => [ - 'title' => '清单名称', - 'description' => 'The playlist name. Default value: manifest.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'manifest', + ], + [ + 'apiName' => 'CreateHotwordLibrary', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateHotwordLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '端点描述', - 'description' => 'The endpoint description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'CreateLiveRecordTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreateLiveRecordTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TimeshiftVision', - 'in' => 'formData', - 'schema' => [ - 'title' => '时移天数', - 'description' => 'The number of days that time-shifted content is available. Maximum value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', + ], + [ + 'apiName' => 'GetAvatarTrainingJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetAvatarTrainingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AuthorizationCode', - 'in' => 'formData', - 'schema' => [ - 'title' => '回源授权码', - '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-\\_.]+'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Abc123Def456', + ], + [ + 'apiName' => 'SubmitTraceExtractJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitTraceExtractJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IpWhitelist', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP白名单', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.0/24,10.0.0.1', + ], + [ + 'apiName' => 'StartWorkflow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:StartWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IpBlacklist', - 'in' => 'formData', - 'schema' => [ - 'title' => 'IP黑名单', - 'description' => 'The IP address blacklist. It supports subnet masks. Separate multiple IP addresses with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '103.0.0.0/8', + ], + [ + 'apiName' => 'SubmitAvatarTrainingJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitAvatarTrainingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LivePackagingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - '$ref' => '#/components/schemas/LivePackagingConfig', + ], + [ + 'apiName' => 'ListMediaProducingJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListMediaProducingJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageOriginEndpoint' => [ - 'description' => 'The information about the origin endpoint.'."\n", - 'type' => 'object', - 'properties' => [ - 'AuthorizationCode' => [ - 'title' => '回源授权码', - 'description' => 'The authorization code.'."\n", - 'type' => 'string', - 'example' => 'Abc123Def456', - ], - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'channel-1', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the endpoint was created.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '端点描述', - 'description' => 'The endpoint description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'EndpointName' => [ - 'title' => '端点名称', - 'description' => 'The endpoint name.'."\n", - 'type' => 'string', - 'example' => 'endpoint-1', - ], - 'EndpointUrl' => [ - 'title' => '端点URL', - 'description' => 'The endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IpBlacklist' => [ - 'title' => 'IP黑名单', - 'description' => 'The IP address blacklist. It supports subnet masks. Multiple IP addresses are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '10.21.222.1/32,192.168.100.0/24', - ], - 'IpWhitelist' => [ - 'title' => 'IP白名单', - 'description' => 'The IP address whitelist. It supports subnet masks. Multiple IP addresses are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '192.168.1.0/24,10.0.0.1/24', - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the endpoint was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'ManifestName' => [ - 'title' => '清单名称', - 'description' => 'The playlist name. Default value: manifest.'."\n", - 'type' => 'string', - 'example' => 'manifest', - ], - 'Protocol' => [ - 'title' => '分发协议', - 'description' => 'The protocol. Only HLS is supported.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'TimeshiftVision' => [ - 'title' => '时移天数', - 'description' => 'The number of days that time-shifted content is available. Maximum value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'LivePackagingConfig' => [ - '$ref' => '#/components/schemas/LivePackagingConfig', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'b1f8d6c4-a123-4cd5-9e88-d0819e3bfa70', - ], - ], + [ + 'apiName' => 'ListCustomTemplates', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListCustomTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListRecognitionSamples', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:ListRecognitionSamples', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\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,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\\": 5,\\n \\"LivePackagingConfig\\": {\\n \\"LiveManifestConfigs\\": [\\n {\\n \\"SegmentCount\\": 0,\\n \\"AdMarkers\\": \\"\\",\\n \\"MinVideoBitrate\\": 0,\\n \\"MinBufferTime\\": 0,\\n \\"PresentationDelay\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitrate\\": 0,\\n \\"DateTimeInterval\\": 0,\\n \\"SegmentTemplateFormat\\": \\"\\",\\n \\"MinUpdatePeriod\\": 0,\\n \\"ManifestDuration\\": 0\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"\\",\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', - 'title' => 'UpdateLivePackageOriginEndpoint', - 'description' => '## [](#)Usage notes'."\n" - ."\n" - .'You can call this operation to modify the origin protocol, set the number of days that time-shifted content is available, define playlist names, and configure the IP address blacklist and whitelist, allowing for fine-grained control over streaming media distribution. Some parameters are required. You must configure IpWhitelist, AuthorizationCode, or both.'."\n", - ], - 'GetLivePackageOriginEndpoint' => [ - 'summary' => 'Queries origin endpoints associated with a live package channel.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'GetLiveTranscodeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetLiveSnapshotJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SubmitDNAJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitDNAJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239770', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + [ + 'apiName' => 'CreateRecognitionEntity', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateRecognitionEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + [ + 'apiName' => 'ListAIAgentInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListAIAgentInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'QueryMediaIndexJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:QueryMediaIndexJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndpointName', - 'in' => 'query', - 'schema' => [ - 'title' => '端点名称', - 'description' => 'The endpoint name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'endpoint-1', + ], + [ + 'apiName' => 'AlterSearchIndex', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:AlterSearchIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageOriginEndpoint' => [ - 'description' => 'The information about the origin endpoints.'."\n", - 'type' => 'object', - 'properties' => [ - 'AuthorizationCode' => [ - 'title' => '回源授权码', - 'description' => 'The authorization code.'."\n", - 'type' => 'string', - 'example' => 'Abc123Def456', - ], - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'channel-1', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the endpoint was created.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '端点描述', - 'description' => 'The endpoint description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'EndpointName' => [ - 'title' => '端点名称', - 'description' => 'The endpoint name.'."\n", - 'type' => 'string', - 'example' => 'endpoint-1', - ], - 'EndpointUrl' => [ - 'title' => '端点URL', - 'description' => 'The endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IpBlacklist' => [ - 'title' => 'IP黑名单', - 'description' => 'The IP address blacklist.'."\n", - 'type' => 'string', - 'example' => '10.21.222.1/32', - ], - 'IpWhitelist' => [ - 'title' => 'IP白名单', - 'description' => 'The IP address whitelist.'."\n", - 'type' => 'string', - 'example' => '192.168.1.0/24,10.0.0.1/24', - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the endpoint was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'ManifestName' => [ - 'title' => '清单名称', - 'description' => 'The playlist name.'."\n", - 'type' => 'string', - 'example' => 'manifest', - ], - 'Protocol' => [ - 'title' => '分发协议', - 'description' => 'The distribution protocol.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'TimeshiftVision' => [ - 'title' => '时移天数', - 'description' => 'The number of days that time-shifted content is available.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'LivePackagingConfig' => [ - '$ref' => '#/components/schemas/LivePackagingConfig', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'requestIdExample123', - ], - ], + [ + 'apiName' => 'QueryTraceAbJobList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:QueryTraceAbJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateRecognitionSample', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateRecognitionSample', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\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\\": 0,\\n \\"AdMarkers\\": \\"\\",\\n \\"MinVideoBitrate\\": 0,\\n \\"MinBufferTime\\": 0,\\n \\"PresentationDelay\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitrate\\": 0,\\n \\"DateTimeInterval\\": 0,\\n \\"SegmentTemplateFormat\\": \\"\\",\\n \\"MinUpdatePeriod\\": 0,\\n \\"ManifestDuration\\": 0\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"\\",\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', - 'title' => 'GetLivePackageOriginEndpoint', - 'description' => '## [](#)Usage notes'."\n", - ], - 'ListLivePackageOriginEndpoints' => [ - 'summary' => 'Queries origin endpoints by channel group and channel name. Paging and sorting are supported.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'SubmitASRJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitASRJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetEditingProject', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetEditingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListAIAgentPhoneNumber', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListAIAgentPhoneNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239774', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + [ + 'apiName' => 'CreatePipeline', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreatePipeline', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + [ + 'apiName' => 'GetProjectExportJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:GetProjectExportJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'ListLiveSnapshotJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveSnapshotJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The endpoint name or description. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'endpoint-', + ], + [ + 'apiName' => 'CancelIProductionJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:CancelIProductionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'AddTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:AddTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'GetLiveRecordTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveRecordTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sort order by creation time. Valid values: asc and desc (default).'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', - ], - 'example' => 'desc', + ], + [ + 'apiName' => 'CreateSource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'LivePackageOriginEndpoints' => [ - 'title' => '数组，返回示例目录。', - 'description' => 'The origin endpoints returned.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'LivePackageOriginEndpointItemType', - 'description' => 'LivePackageOriginEndpointItemType'."\n", - 'type' => 'object', - 'properties' => [ - 'AuthorizationCode' => [ - 'title' => '回源授权码', - 'description' => 'The authorization code.'."\n", - 'type' => 'string', - 'example' => 'Abc123Def456', - ], - 'ChannelName' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'example' => 'channel-1', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the endpoint was created.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'Description' => [ - 'title' => '端点描述', - 'description' => 'The endpoint description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'EndpointName' => [ - 'title' => '端点名称', - 'description' => 'The endpoint name.'."\n", - 'type' => 'string', - 'example' => 'endpoint-1', - ], - 'EndpointUrl' => [ - 'title' => '端点URL', - 'description' => 'The endpoint URL.'."\n", - 'type' => 'string', - 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest.m3u8', - ], - 'GroupName' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'example' => 'channel-group-1', - ], - 'IpBlacklist' => [ - 'title' => 'IP黑名单', - 'description' => 'The IP address blacklist.'."\n", - 'type' => 'string', - 'example' => '10.21.222.1/32,192.168.100.0/24', - ], - 'IpWhitelist' => [ - 'title' => 'IP白名单', - 'description' => 'The IP address whitelist.'."\n", - 'type' => 'string', - 'example' => '192.168.1.0/24,10.0.0.1/24', - ], - 'LastModified' => [ - 'title' => '最后修改时间', - 'description' => 'The time when the endpoint was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-04-01T12:00:00Z', - ], - 'ManifestName' => [ - 'title' => '清单名称', - 'description' => 'The playlist name.'."\n", - 'type' => 'string', - 'example' => 'manifest', - ], - 'Protocol' => [ - 'title' => '分发协议', - 'description' => 'The distribution protocol.'."\n", - 'type' => 'string', - 'example' => 'HLS', - ], - 'TimeshiftVision' => [ - 'title' => '时移天数', - 'description' => 'The number of days that time-shifted content is available.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'PageNo' => [ - 'title' => '页码。', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页记录数。', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'b9f90a7ac8904db28dc18e0c2a72c75d', - ], - 'SortBy' => [ - 'description' => 'The sort order. Valid values: `asc` and `desc` (default).'."\n", - 'type' => 'string', - 'example' => 'desc', - ], - 'TotalCount' => [ - 'title' => '总记录数。', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], + [ + 'apiName' => 'InsertMediaToSearchLib', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:InsertMediaToSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'SubmitMediaConvertJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaConvertJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoints\\": [\\n {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\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.'."\n", - ], - 'DeleteLivePackageOriginEndpoint' => [ - 'summary' => 'Deletes an origin endpoint associated with a live package channel.', - 'methods' => [ - 'post', + [ + 'apiName' => 'SubmitAvatarVideoJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitAvatarVideoJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'SubmitCustomizedVoiceJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteDNAFiles', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteDNAFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '239772', - 'abilityTreeNodes' => [ - 'FEATUREiceQU6W9M', + [ + 'apiName' => 'SearchEditingProject', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SearchEditingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道组名称', - 'description' => 'The channel group name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-group-1', + [ + 'apiName' => 'GetHotwordLibrary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetHotwordLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'title' => '频道名称', - 'description' => 'The channel name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'channel-1', + ], + [ + 'apiName' => 'DescribeRtcRobotInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DescribeRtcRobotInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndpointName', - 'in' => 'query', - 'schema' => [ - 'title' => '端点名称', - 'description' => 'The endpoint name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'endpoint-1', + ], + [ + 'apiName' => 'QueryTraceM3u8JobList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:QueryTraceM3u8JobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', - ], - ], + [ + 'apiName' => 'SearchPublicMediaInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SearchPublicMediaInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'SubmitScreenMediaHighlightsJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitScreenMediaHighlightsJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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.'."\n", - ], - 'SetContentAnalyzeConfig' => [ - 'summary' => '设置内容分析搜索配置', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DropSearchLib', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DropSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateAvatarTrainingJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateAvatarTrainingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UploadMediaByURL', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:UploadMediaByURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteLiveRecordTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteLiveRecordTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'TakeoverAIAgentCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:TakeoverAIAgentCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSystemTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetSystemTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopAIWorkflowTask', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:StopAIWorkflowTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'Auto', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + [ + 'apiName' => 'QuerySmarttagJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QuerySmarttagJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SaveType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TEXT,FACE', + ], + [ + 'apiName' => 'GetDefaultStorageLocation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetDefaultStorageLocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'S00000101-100070', + ], + [ + 'apiName' => 'DescribePlayList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DescribePlayList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '953CFD27-4A2C-54AD-857F-B79EF3A338E0', - ], - 'Success' => [ - 'title' => '是否设置成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'CreateSearchIndex', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateSearchIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"953CFD27-4A2C-54AD-857F-B79EF3A338E0\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'SetContentAnalyzeConfig', - ], - 'GetContentAnalyzeConfig' => [ - 'summary' => '获取内容分析搜索配置', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListLiveRecordTemplates', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveRecordTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteAIAgentDialogue', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DeleteAIAgentDialogue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'AddFavoritePublicMedia', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:AddFavoritePublicMedia', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + [ + 'apiName' => 'ListAlerts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListAlerts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '31FEC819-2344-5771-9366-9172DB0D26C9', - ], - 'ContentAnalyzeConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Auto' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SaveType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TEXT,FACE', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'S00000101-100070', - ], - ], - ], - ], + [ + 'apiName' => 'SendMessageChatText', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SendMessageChatText', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => 'GetContentAnalyzeConfig', - ], - 'SetDefaultStorageLocation' => [ - 'summary' => '设置默认存储路径', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'UpdateMediaInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteMediaInfos', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteMediaInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryIProductionJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QueryIProductionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + [ + 'apiName' => 'DeleteDNADB', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteDNADB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'StorageType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'user_oss_bucket' => '', - 'vod_oss_bucket' => '', - ], - 'example' => 'user_oss_bucket', + [ + 'apiName' => 'SubmitLiveRecordJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveRecordJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Bucket', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-test-bucket', + ], + [ + 'apiName' => 'ListHotwordLibraries', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListHotwordLibraries', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Path', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ims/dir', + ], + [ + 'apiName' => 'StopAIAgentInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:StopAIAgentInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '******5A-CAAC-4850-A3AF-B74606******', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'DeletePlayInfo', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeletePlayInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******5A-CAAC-4850-A3AF-B74606******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ******5A-CAAC-4850-A3AF-B74606******\\n true\\n","errorExample":""}]', - 'title' => 'SetDefaultStorageLocation', - ], - 'GetDefaultStorageLocation' => [ - 'summary' => '获取用户默认存储地址', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'SubmitAudioProduceJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitAudioProduceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetYikeStoryboardJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetYikeStoryboardJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SearchMediaByAILabel', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMediaByAILabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetTemplateParams', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetTemplateParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'StorageType' => [ - 'title' => '存储类型', - 'description' => '', - 'type' => 'string', - 'example' => 'user_oss_bucket', - ], - 'Bucket' => [ - 'title' => 'oss bucket 名称', - 'description' => '', - 'type' => 'string', - 'example' => 'oss-test-bucket', - ], - 'Path' => [ - 'title' => '路径', - 'description' => '', - 'type' => 'string', - 'example' => 'ice/dir', - ], - 'Status' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => 'normal', - ], - ], + [ + 'apiName' => 'GetEditingProjectMaterials', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetEditingProjectMaterials', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n user_oss_bucket\\n oss-test-bucket\\n ice/dir\\n normal\\n","errorExample":""}]', - 'title' => 'GetDefaultStorageLocation', - ], - 'DescribePlayList' => [ - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'SubmitVideoTranslationJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitVideoTranslationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'SearchIndexJobRerun', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:SearchIndexJobRerun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SendAIAgentSpeech', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SendAIAgentSpeech', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ForwardAIAgentCall', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '146436', - 'abilityTreeNodes' => [ - 'FEATUREiceM55707', + 'ramAction' => [ + 'action' => 'ice:ForwardAIAgentCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + [ + 'apiName' => 'GetPackageJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetPackageJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', + ], + [ + 'apiName' => 'UpdateCategory', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateCategory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TraceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The TraceId of the player.', - 'type' => 'string', - 'required' => false, - 'example' => '0bc5e70516766285805381012d271e', + ], + [ + 'apiName' => 'SubmitSegmentationJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSegmentationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMediaBasicInfos', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:ListMediaBasicInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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', + ], + [ + 'apiName' => 'GetAiRtcAuthCodeList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetAiRtcAuthCodeList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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', + ], + [ + 'apiName' => 'DeleteRecognitionLib', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteRecognitionLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OrderType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sort order. Valid values:'."\n" - ."\n" - .'- DESC: descending order.'."\n" - .'- ASC: ascending order.', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', + ], + [ + 'apiName' => 'ClearAIAgentVoiceprint', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ClearAIAgentVoiceprint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OrderName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The criteria by which the sorting is performed. Valid values:'."\n" - ."\n" - .'- FirstFrameDuration'."\n" - .'- PlayDuration'."\n" - .'- VideoDuration'."\n" - .'- StuckDuration', - 'type' => 'string', - 'required' => false, - 'example' => 'FirstFrameDuration', + ], + [ + 'apiName' => 'GetStreamTagList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:GetStreamTagList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PlayType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The playback type. Valid value: '."\n" - ."\n" - .'- vod', - 'type' => 'string', - 'required' => false, - 'example' => 'vod', + ], + [ + 'apiName' => 'UpdateMediaMarks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaMarks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The playback status. Valid values:'."\n" - ."\n" - .'- complete'."\n" - .'- playing'."\n" - .'- unusual: A playback error occurs.', - 'type' => 'string', - 'required' => false, - 'example' => 'complete', + ], + [ + 'apiName' => 'ListAIAgentDialogues', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListAIAgentDialogues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'TotalNum' => [ - 'description' => 'The total playback count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'RequestId' => [ - 'title' => 'Id', - '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', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PlayList' => [ - 'description' => 'The playback records.', - 'type' => 'array', - 'items' => [ - 'description' => 'The playback record.', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The playback status.', - 'type' => 'string', - 'example' => 'complete', - ], - 'VideoId' => [ - 'description' => 'The ID of the video.', - 'type' => 'string', - 'example' => '250314203f0171eebff17035d0b20102', - ], - 'StuckDuration' => [ - 'description' => 'The stuttering duration.', - 'type' => 'string', - 'example' => '20', - ], - 'PlayDuration' => [ - 'description' => 'The playback duration.', - 'type' => 'string', - 'example' => '1000', - ], - 'FirstFrameDuration' => [ - 'description' => 'Time to first frame.', - 'type' => 'string', - 'example' => '200', - ], - 'TraceId' => [ - 'description' => 'The TraceId of the player.', - 'type' => 'string', - 'example' => '0b736abf16724820210842673d9543', - ], - 'PlayType' => [ - 'description' => 'The playback type.', - 'type' => 'string', - 'example' => 'vod', - ], - 'SessionId' => [ - 'description' => 'The ID of the player session.', - 'type' => 'string', - 'example' => '91488be2-8381-40c9-8494-e8afe22c4a2d', - ], - 'VideoDuration' => [ - 'description' => 'The duration of the video.', - 'type' => 'string', - 'example' => '2000', - ], - 'PlayTs' => [ - 'description' => 'The timestamp when the playback started.', - 'type' => 'string', - 'example' => '1675922209572', - ], - ], - ], - ], - ], + [ + 'apiName' => 'BatchGetYikeAssetMediaInfos', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:BatchGetYikeAssetMediaInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Meter.ParamError', - 'errorMessage' => 'Param Error:%s,Please Check Again.', + [ + 'apiName' => 'CreateEditingProject', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreateEditingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'Meter.AuthError', - 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + [ + 'apiName' => 'ListRecognitionEntities', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:ListRecognitionEntities', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'Meter.ServerInternalError', - 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'apiName' => 'DeleteRecognitionSample', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteRecognitionSample', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Meter.DataSourceQueryError', - 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + [ + 'apiName' => 'CreateCustomTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CreateCustomTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 502 => [ - [ - 'errorCode' => 'Meter.ReadyTsError', - 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + [ + 'apiName' => 'SearchMediaByFace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMediaByFace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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" - .'}', - ], - 'AddFavoritePublicMedia' => [ - 'summary' => '收藏公共媒资', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'GetTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ActiveAiRtcLicense', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:ActiveAiRtcLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeMeterImsMediaConvertUHDUsage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DescribeMeterImsMediaConvertUHDUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'MediaIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'icepublic-****7213c6050cbc66750b469701****,icepublic-****0b4697017213c6050cbc6675****', + [ + 'apiName' => 'SubmitSceneBatchEditingJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitSceneBatchEditingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'IgnoredList' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'icepublic-****7213c6050cbc66750b469701****', - ], - ], - ], + [ + 'apiName' => 'DeleteRecognitionEntity', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteRecognitionEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"icepublic-****7213c6050cbc66750b469701****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n icepublic-****7213c6050cbc66750b469701****\\n","errorExample":""}]', - 'title' => 'AddFavoritePublicMedia', - ], - 'CancelFavoritePublicMedia' => [ - 'summary' => '取消收藏公共媒资', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DeleteSource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListYikeProductions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListYikeProductions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SetNotifyConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SetNotifyConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'MediaIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'icepublic-****7213c6050cbc66750b469701****,icepublic-****0b4697017213c6050cbc6675****', + [ + 'apiName' => 'ListDynamicImageJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListDynamicImageJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'IgnoredList' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'icepublic-****7213c6050cbc66750b469701****', - ], - ], - ], + [ + 'apiName' => 'SearchMedia', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMedia', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"icepublic-****7213c6050cbc66750b469701****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n icepublic-****7213c6050cbc66750b469701****\\n","errorExample":""}]', - 'title' => 'CancelFavoritePublicMedia', - ], - 'GetPublicMediaInfo' => [ - 'summary' => '获取公共媒资内容信息', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ListCustomizedVoiceJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListCustomizedVoiceJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateYikeUser', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateYikeUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'Anonymous' => [], + [ + 'apiName' => 'CreateSearchLib', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '104901', - 'abilityTreeNodes' => [ - 'FEATUREiceFEJXOS', + [ + 'apiName' => 'GenerateAIAgentCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:GenerateAIAgentCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'MediaId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'icepublic-****14e501538aeef0a3140176f6****', - 'required' => false, - 'type' => 'string', + [ + 'apiName' => 'SendAIAgentDataChannelMessage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SendAIAgentDataChannelMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => 'RequestId', - 'example' => '******11-DB8D-4A9A-875B-275798******', - 'title' => 'RequestId', - 'type' => 'string', - ], - 'MediaInfo' => [ - 'description' => '', - 'properties' => [ - 'MediaId' => [ - 'description' => '', - 'example' => 'icepublic-****14e501538aeef0a3140176f6****', - 'title' => '媒资ID', - 'type' => 'string', - ], - 'MediaBasicInfo' => [ - 'description' => 'BasicInfo', - 'properties' => [ - 'MediaId' => [ - 'description' => 'MediaId', - 'example' => 'icepublic-****14e501538aeef0a3140176f6****', - 'title' => 'MediaId', - 'type' => 'string', - ], - 'MediaType' => [ - 'description' => '', - 'example' => 'video', - 'title' => '媒资媒体类型', - 'type' => 'string', - ], - 'BusinessType' => [ - 'description' => '', - 'example' => 'general', - 'title' => '媒资业务类型', - 'type' => 'string', - ], - 'Source' => [ - 'description' => '', - 'example' => 'oss', - 'title' => '来源', - 'type' => 'string', - ], - 'Title' => [ - 'description' => '', - 'example' => 'title', - 'title' => '标题', - 'type' => 'string', - ], - 'Description' => [ - 'description' => '', - 'example' => 'description', - 'title' => '内容描述', - 'type' => 'string', - ], - 'Category' => [ - 'description' => '', - 'example' => 'category', - 'title' => '分类', - 'type' => 'string', - ], - 'MediaTags' => [ - 'description' => '', - 'example' => '', - 'title' => '标签', - 'type' => 'string', - ], - 'CoverURL' => [ - 'description' => '', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - 'title' => '封面地址', - 'type' => 'string', - ], - 'UserData' => [ - 'description' => '', - 'example' => '{"key":"value"}', - 'title' => '用户数据', - 'type' => 'string', - ], - 'Status' => [ - 'description' => '', - 'example' => 'Normal', - 'title' => '资源状态', - 'type' => 'string', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '2020-12-26T04:11:08Z', - 'title' => '媒资创建时间', - 'type' => 'string', - ], - 'ModifiedTime' => [ - 'description' => '', - 'example' => '2020-12-26T04:11:10Z', - 'title' => '媒资修改时间', - 'type' => 'string', - ], - 'DeletedTime' => [ - 'description' => '', - 'example' => '2020-12-26T04:11:15Z', - 'title' => '媒资删除时间', - 'type' => 'string', - ], - 'SpriteImages' => [ - 'description' => '', - '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' => 'string', - ], - ], - 'title' => 'BasicInfo', - 'type' => 'object', - ], - 'DynamicMetaData' => [ - 'description' => '', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'example' => 'system', - 'title' => '类型', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '{"AuditionUrl": "http://example-bucket.cdn.domain.com/example.mp4", "AuditionCount": 3}', - 'title' => '元数据json', - 'type' => 'string', - ], - ], - 'title' => '公共媒资动态元数据', - 'type' => 'object', - ], - 'FileInfoList' => [ - 'description' => 'FileInfos', - 'items' => [ - 'properties' => [ - 'FileBasicInfo' => [ - 'description' => '', - 'properties' => [ - 'FileName' => [ - 'description' => '', - 'example' => 'example.mp4', - 'title' => '文件名', - 'type' => 'string', - ], - 'FileStatus' => [ - 'description' => '', - 'example' => 'Normal', - 'title' => '文件状态', - 'type' => 'string', - ], - 'FileType' => [ - 'description' => '', - 'example' => 'source_file', - 'title' => '文件类型', - 'type' => 'string', - ], - 'FileSize' => [ - 'description' => '', - 'example' => '27007', - 'title' => '文件大小（字节）', - 'type' => 'string', - ], - 'FileUrl' => [ - 'description' => '', - 'example' => 'http://example-bucket.cdn.domain.com/example.mp4', - 'title' => '文件oss地址', - 'type' => 'string', - ], - 'Region' => [ - 'description' => '', - 'example' => 'cn-shanghai', - 'title' => '文件存储区域', - 'type' => 'string', - ], - 'FormatName' => [ - 'description' => '', - 'example' => 'mp4', - 'title' => '封装格式', - 'type' => 'string', - ], - 'Duration' => [ - 'description' => '', - 'example' => '16.2', - 'title' => '时长', - 'type' => 'string', - ], - 'Bitrate' => [ - 'description' => '', - 'example' => '192.0', - 'title' => '码率', - 'type' => 'string', - ], - 'Width' => [ - 'description' => '', - 'example' => '0', - 'title' => '宽', - 'type' => 'string', - ], - 'Height' => [ - 'description' => '', - 'example' => '0', - 'title' => '高', - 'type' => 'string', - ], - ], - 'title' => '文件基础信息，包含时长，大小等', - 'type' => 'object', - ], - 'AudioStreamInfoList' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'Index' => [ - 'description' => '', - 'example' => '1', - 'title' => '音频流序号', - 'type' => 'string', - ], - 'CodecName' => [ - 'description' => '', - 'example' => 'aac', - 'title' => '编码格式简述名', - 'type' => 'string', - ], - 'CodecLongName' => [ - 'description' => '', - 'example' => 'AAC (Advanced Audio Coding)', - 'title' => '编码格式长述名', - 'type' => 'string', - ], - 'CodecTimeBase' => [ - 'description' => '', - 'example' => '1/44100', - 'title' => '编码时基', - 'type' => 'string', - ], - 'CodecTagString' => [ - 'description' => '', - 'example' => 'mp4a', - 'title' => '编码格式标记文本', - 'type' => 'string', - ], - 'CodecTag' => [ - 'description' => '', - 'example' => '0x6134706d', - 'title' => '编码格式标记', - 'type' => 'string', - ], - 'Profile' => [ - 'description' => '', - 'example' => 'High', - 'title' => '编码预置', - 'type' => 'string', - ], - 'SampleFmt' => [ - 'description' => '', - 'example' => 'fltp', - 'title' => '采样格式', - 'type' => 'string', - ], - 'SampleRate' => [ - 'description' => '', - 'example' => '44100', - 'title' => '采样率', - 'type' => 'string', - ], - 'Channels' => [ - 'description' => '', - 'example' => '2', - 'title' => '声道数', - 'type' => 'string', - ], - 'ChannelLayout' => [ - 'description' => '', - 'example' => 'stereo', - 'title' => '声道输出样式', - 'type' => 'string', - ], - 'Timebase' => [ - 'description' => '', - 'example' => '1/44100', - 'title' => '时基', - 'type' => 'string', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '0.000000', - 'title' => '起始时间', - 'type' => 'string', - ], - 'Duration' => [ - 'description' => '', - 'example' => '16.2', - 'title' => '时长', - 'type' => 'string', - ], - 'Bitrate' => [ - 'description' => '', - 'example' => '192.0', - 'title' => '码率', - 'type' => 'string', - ], - 'Fps' => [ - 'description' => '', - 'example' => '10', - 'title' => '音频帧率', - 'type' => 'string', - ], - 'NumFrames' => [ - 'description' => '', - 'example' => '162', - 'title' => '总帧数', - 'type' => 'string', - ], - 'Lang' => [ - 'description' => '', - 'example' => 'und', - 'title' => '语言', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'title' => '音频流信息，一个媒资可能有多条音频流', - 'type' => 'array', - ], - 'VideoStreamInfoList' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'Index' => [ - 'description' => '', - 'example' => '0', - 'title' => '视频流序号', - 'type' => 'string', - ], - 'CodecName' => [ - 'description' => '', - 'example' => 'h264', - 'title' => '编码格式简述名', - 'type' => 'string', - ], - 'CodecLongName' => [ - 'description' => '', - 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', - 'title' => '编码格式长述名', - 'type' => 'string', - ], - 'Profile' => [ - 'description' => '', - 'example' => 'High', - 'title' => '编码预置', - 'type' => 'string', - ], - 'CodecTimeBase' => [ - 'description' => '', - 'example' => '1/48', - 'title' => '编码时基', - 'type' => 'string', - ], - 'CodecTagString' => [ - 'description' => '', - 'example' => '[0][0][0][0]', - 'title' => '编码格式标记文本', - 'type' => 'string', - ], - 'CodecTag' => [ - 'description' => '', - 'example' => '0x0000', - 'title' => '编码格式标记', - 'type' => 'string', - ], - 'Width' => [ - 'description' => '', - 'example' => '960', - 'title' => '宽', - 'type' => 'string', - ], - 'Height' => [ - 'description' => '', - 'example' => '540', - 'title' => '高', - 'type' => 'string', - ], - 'HasBFrames' => [ - 'description' => '', - 'example' => '2', - 'title' => '是否有B帧', - 'type' => 'string', - ], - 'Sar' => [ - 'description' => '', - 'example' => '0:1', - 'title' => '编码信号分辨率比', - 'type' => 'string', - ], - 'Dar' => [ - 'description' => '', - 'example' => '0:1', - 'title' => '编码显示分辨率比', - 'type' => 'string', - ], - 'PixFmt' => [ - 'description' => '', - 'example' => 'yuv420p', - 'title' => '像素格式', - 'type' => 'string', - ], - 'Level' => [ - 'description' => '', - 'example' => '30', - 'title' => '编码等级', - 'type' => 'string', - ], - 'Fps' => [ - 'description' => '', - 'example' => '24.0', - 'title' => '视频帧率', - 'type' => 'string', - ], - 'AvgFPS' => [ - 'description' => '', - 'example' => '24.0', - 'title' => '平均帧率', - 'type' => 'string', - ], - 'Timebase' => [ - 'description' => '', - 'example' => '1/12288', - 'title' => '时基', - 'type' => 'string', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '0.081706', - 'title' => '起始时间', - 'type' => 'string', - ], - 'Duration' => [ - 'description' => '', - 'example' => '216.206706', - 'title' => '时长', - 'type' => 'string', - ], - 'Bitrate' => [ - 'description' => '', - 'example' => '1001.594', - 'title' => '码率', - 'type' => 'string', - ], - 'NumFrames' => [ - 'description' => '', - 'example' => '5184', - 'title' => '总帧数', - 'type' => 'string', - ], - 'Lang' => [ - 'description' => '', - 'example' => 'und', - 'title' => '语言', - 'type' => 'string', - ], - 'Rotate' => [ - 'description' => '', - 'example' => '0', - 'title' => '旋转', - 'type' => 'string', - ], - 'Nb_frames' => [ - 'description' => '', - 'example' => '5184', - 'title' => '总帧数', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'title' => '视频流信息，一个媒资可能有多条视频流', - 'type' => 'array', - ], - 'SubtitleStreamInfoList' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'Index' => [ - 'description' => '', - 'example' => '1', - 'title' => '音频流序号', - 'type' => 'string', - ], - 'CodecName' => [ - 'description' => '', - 'example' => 'srt', - 'title' => '编码格式简述名', - 'type' => 'string', - ], - 'CodecLongName' => [ - 'description' => '', - 'example' => 'SubRip Text', - 'title' => '编码格式长述名', - 'type' => 'string', - ], - 'CodecTimeBase' => [ - 'description' => '', - 'example' => '29.97', - 'title' => '编码时基', - 'type' => 'string', - ], - 'CodecTagString' => [ - 'description' => '', - 'example' => 'unicode', - 'title' => '编码格式标记文本', - 'type' => 'string', - ], - 'CodecTag' => [ - 'description' => '', - 'example' => 'unicode', - 'title' => '编码格式标记', - 'type' => 'string', - ], - 'Timebase' => [ - 'description' => '', - 'example' => '30', - 'title' => '时基', - 'type' => 'string', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '0', - 'title' => '起始时间', - 'type' => 'string', - ], - 'Duration' => [ - 'description' => '', - 'example' => '1', - 'title' => '时长', - 'type' => 'string', - ], - 'Lang' => [ - 'description' => '', - 'example' => 'und', - 'title' => '语言', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'title' => '字幕流信息，一个媒资可能有多条字幕流', - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - 'title' => 'FileInfos', - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - ], - 'title' => 'Schema of Response', - 'type' => 'object', + [ + 'apiName' => 'SubYikeUserCredit', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubYikeUserCredit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeNotifyConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DescribeNotifyConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n \\n icepublic-****14e501538aeef0a3140176f6****\\n \\n icepublic-****14e501538aeef0a3140176f6****\\n video\\n general\\n oss\\n title\\n description\\n category\\n 标签,tag1\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n {\\"key\\":\\"value\\"}\\n Normal\\n 2020-12-26T04:11:08Z\\n 2020-12-26T04:11:10Z\\n 2020-12-26T04:11:15Z\\n [{\\"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 \\n system\\n {\\"AuditionUrl\\": \\"http://example-bucket.cdn.domain.com/example.mp4\\", \\"AuditionCount\\": 3}\\n \\n \\n \\n example.mp4\\n Normal\\n source_file\\n 27007\\n http://example-bucket.cdn.domain.com/example.mp4\\n cn-shanghai\\n mp4\\n 16.2\\n 192.0\\n 0\\n 0\\n \\n \\n 1\\n aac\\n AAC (Advanced Audio Coding)\\n 1/44100\\n mp4a\\n 0x6134706d\\n High\\n fltp\\n 44100\\n 2\\n stereo\\n 1/44100\\n 0.000000\\n 16.2\\n 192.0\\n 10\\n 162\\n und\\n \\n \\n 0\\n h264\\n H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\n High\\n 1/48\\n [0][0][0][0]\\n 0x0000\\n 960\\n 540\\n 2\\n 0:1\\n 0:1\\n yuv420p\\n 30\\n 24.0\\n 24.0\\n 1/12288\\n 0.081706\\n 216.206706\\n 1001.594\\n 5184\\n und\\n 0\\n 5184\\n \\n \\n 1\\n srt\\n SubRip Text\\n 29.97\\n unicode\\n unicode\\n 30\\n 0\\n 1\\n und\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'GetPublicMediaInfo', - ], - 'SearchPublicMediaInfo' => [ - 'summary' => '搜索公共媒资信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetWorkflowTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetWorkflowTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'MediaIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****', + [ + 'apiName' => 'GetSmartHandleJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetSmartHandleJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DynamicMetaDataMatchFields', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '"ApprovalStatus=\'Available\'&MaterialBags=\'boutiquemusic\'&Mood=\'Nervous\'"', + ], + [ + 'apiName' => 'ListPackageJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListPackageJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Favorite', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'GetSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Authorized', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'DeleteCustomizedVoiceJob', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'UsageCount:Desc,UnitPrice:Asc', + ], + [ + 'apiName' => 'GetAIAgentConcurrency', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:GetAIAgentConcurrency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'GetMediaConvertJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetMediaConvertJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'GetBatchMediaProducingJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetBatchMediaProducingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EntityId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Copyright_Music', + ], + [ + 'apiName' => 'GetYikeAIAppJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetYikeAIAppJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '****3CFB-2767-54FD-B311-BD15A4C1****', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PublicMediaInfos' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Authorized' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Favorite' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RemainingAuthTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'MediaInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => '媒资ID', - 'description' => '', - 'type' => 'string', - 'example' => 'icepublic-****87b921bb4a55908a72a0537e****', - ], - 'MediaBasicInfo' => [ - 'title' => 'BasicInfo', - 'description' => 'BasicInfo', - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'title' => 'MediaId', - 'description' => 'MediaId', - 'type' => 'string', - 'example' => 'icepublic-****87b921bb4a55908a72a0537e****', - ], - 'MediaType' => [ - 'title' => '媒资媒体类型', - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'BusinessType' => [ - 'title' => '媒资业务类型', - 'description' => '', - 'type' => 'string', - 'example' => 'general', - ], - 'Source' => [ - 'title' => '来源', - 'description' => '', - 'type' => 'string', - 'example' => 'oss', - ], - 'Title' => [ - 'title' => '标题', - 'description' => '', - 'type' => 'string', - 'example' => 'title', - ], - 'Description' => [ - 'title' => '内容描述', - 'description' => '', - 'type' => 'string', - 'example' => 'description', - ], - 'Category' => [ - 'title' => '分类', - 'description' => '', - 'type' => 'string', - 'example' => 'category', - ], - 'MediaTags' => [ - 'title' => '标签', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CoverURL' => [ - 'title' => '封面地址', - 'description' => '', - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=', - ], - 'UserData' => [ - 'title' => '用户数据', - 'description' => '', - 'type' => 'string', - 'example' => 'userDataTest', - ], - 'Status' => [ - 'title' => '资源状态', - 'description' => '', - 'type' => 'string', - 'example' => 'Normal', - ], - 'CreateTime' => [ - 'title' => '媒资创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2020-12-26T06:04:49Z', - ], - 'ModifiedTime' => [ - 'title' => '媒资修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2020-12-26T06:04:50Z', - ], - 'DeletedTime' => [ - 'title' => '媒资删除时间', - 'description' => '', - 'type' => 'string', - 'example' => '2020-12-29T06:04:49Z', - ], - 'SpriteImages' => [ - 'title' => '雪碧图', - 'description' => '', - '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"}]', - ], - ], - ], - 'DynamicMetaData' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"AuditionUrl\\": \\"http://xxx\\", \\"AuditionCount\\": 3...}"', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'system', - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'StartRtcRobotInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:StartRtcRobotInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ****3CFB-2767-54FD-B311-BD15A4C1****\\n 100\\n \\n true\\n true\\n 100\\n \\n icepublic-****87b921bb4a55908a72a0537e****\\n \\n icepublic-****87b921bb4a55908a72a0537e****\\n audio\\n general\\n oss\\n title\\n description\\n category\\n 标签,tag1\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\n userDataTest\\n Normal\\n 2020-12-26T06:04:49Z\\n 2020-12-26T06:04:50Z\\n 2020-12-29T06:04:49Z\\n [{\\"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 \\n \\"{\\\\\\"AuditionUrl\\\\\\": \\\\\\"http://xxx\\\\\\", \\\\\\"AuditionCount\\\\\\": 3...}\\"\\n system\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'SearchPublicMediaInfo', - ], - 'GetStorageList' => [ - 'summary' => 'Obtains storage configurations.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'SubmitAIAgentVideoAuditTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitAIAgentVideoAuditTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListSmartJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListSmartJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetMediaProducingJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetMediaProducingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-****', + [ + 'apiName' => 'QueryMediaCensorJobDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QueryMediaCensorJobDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StorageType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The storage type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vod_oss_bucket', + ], + [ + 'apiName' => 'SendLiveSnapshotJobCommand', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SendLiveSnapshotJobCommand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The OSS storage status.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', + ], + [ + 'apiName' => 'ListTemplates', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******73-8B78-5D86-A50C-49B96C******', - ], - 'StorageInfoList' => [ - 'description' => 'The storage configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'app-****', - ], - 'StorageLocation' => [ - 'description' => 'The bucket.'."\n", - 'type' => 'string', - 'example' => 'your-bucket', - ], - 'Path' => [ - 'description' => 'The file path.'."\n", - 'type' => 'string', - 'example' => 'your-path/', - ], - 'StorageType' => [ - 'description' => 'The storage type.'."\n", - 'type' => 'string', - 'example' => 'vod_oss_bucket', - ], - 'Status' => [ - 'description' => 'The OSS storage status.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'DefaultStorage' => [ - 'description' => 'Indicates whether it is the default storage location.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EditingTempFileStorage' => [ - 'description' => 'Indicates whether temporary files created during editing processes are stored in this location.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreationTime' => [ - 'description' => 'The time when the configuration was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-06T01:55:07Z', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the configuration was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-06-06T03:07:07Z', - ], - ], - 'description' => '', - ], - ], - ], + [ + 'apiName' => 'GetPlayInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetPlayInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - 'SearchEditingProject' => [ - 'summary' => 'Queries online editing projects by creation time and status.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DeleteLiveRecordFiles', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteLiveRecordFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetCustomTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetCustomTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListLiveTranscodeTemplates', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveTranscodeTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => 'CreateTime（创建时间）的开始时间', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-01-11T12:00:00Z', + [ + 'apiName' => 'SubmitMediaInfoJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaInfoJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => 'CreationTime（创建时间）的结束时间', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2017-01-11T12:00:00Z', + ], + [ + 'apiName' => 'SubmitMediaCensorJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaCensorJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '云剪辑工程状态。多个用逗号分隔', - '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'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Draft' => '', - 'Produced' => '', - 'Producing' => '', - 'ProduceFailed' => '', - ], - 'example' => 'Producing', + ], + [ + 'apiName' => 'CancelDNAJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CancelDNAJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '结果排序方式', - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CreationTime:Asc' => '', - 'CreationTime:Desc' => '', - ], - 'example' => 'CreationTime:Desc', + ], + [ + 'apiName' => 'UpdateAIAgentInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:UpdateAIAgentInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DeleteTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数', - 'description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'StopRtcRobotInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:StopRtcRobotInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CreateSource', - 'in' => 'query', - 'schema' => [ - 'title' => '创建来源', - '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" - .'* WebSDK: The project is created by using the SDK for Web.'."\n" - .'* OpenAPI: The project is created by calling API operations.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', - ], - 'example' => 'WebSDK', + ], + [ + 'apiName' => 'DeleteMediaFromSearchLib', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteMediaFromSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TemplateType', - 'in' => 'query', - 'schema' => [ - 'title' => '模板类型', - 'description' => 'The template type. Valid values:'."\n" - ."\n" - .'\\-Timeline'."\n" - ."\n" - .'\\-VETemplate'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Timeline: regular template.'."\n" - .'* VETemplate: advanced template.'."\n" - .'* None: No template is used.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Timeline' => '', - 'VETemplate' => '', - 'None' => '', - ], - 'example' => 'Timeline', + ], + [ + 'apiName' => 'RefreshUploadMedia', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:RefreshUploadMedia', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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" - .'* LiveEditingProject: a live stream editing project.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LiveEditingProject' => '', - 'EditingProject' => '', - ], - 'example' => 'EditingProject', + ], + [ + 'apiName' => 'SubmitMediaAiAnalysisJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaAiAnalysisJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', - ], - 'ProjectList' => [ - 'title' => '云剪辑工程列表', - 'description' => 'The queried online editing projects.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '云剪辑工程ID', - 'description' => 'The ID of the online editing project.'."\n", - 'type' => 'string', - 'example' => '****fddd7748b58bf1d47e95****', - ], - 'Title' => [ - 'title' => '云剪辑工程标题', - 'description' => 'The title of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'title', - ], - 'Timeline' => [ - 'title' => '云剪辑工程时间线', - 'description' => 'The timeline of the online editing project.'."\n", - 'type' => 'string', - 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', - ], - 'Description' => [ - 'title' => '云剪辑工程描述', - 'description' => 'The description of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'sample description', - ], - 'CoverURL' => [ - 'title' => '云剪辑工程封面', - 'description' => 'The thumbnail URL of the online editing project.'."\n", - 'type' => 'string', - 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg', - ], - 'CreateTime' => [ - 'title' => '云剪辑工程创建时间', - 'description' => 'The time when the online editing project was created.'."\n", - 'type' => 'string', - 'example' => '2017-01-11T12:00:00Z', - ], - 'ModifiedTime' => [ - 'title' => '云剪辑工程最新修改时间', - 'description' => 'The time when the online editing project was last modified.'."\n", - 'type' => 'string', - 'example' => '2017-01-11T12:00:00Z', - ], - 'Duration' => [ - 'title' => '云剪辑工程总时长', - 'description' => 'The total length of the online editing project. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30.100000', - ], - 'Status' => [ - 'title' => '云剪辑工程状态', - '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" - .'* Produced'."\n" - .'* Editing'."\n" - .'* Producing'."\n" - .'* ProduceFailed'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Draft' => '', - 'Produced' => '', - 'Editing' => '', - 'Producing' => '', - 'ProduceFailed' => '', - ], - 'example' => 'PRODUCE_FAILED', - ], - 'ErrorCode' => [ - 'title' => '云剪辑工程合成失败的错误码', - 'description' => 'The error code returned if the production of the online editing project failed.'."\n", - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'ErrorMessage' => [ - 'title' => '云剪辑工程合成失败的消息', - 'description' => 'The error message returned if the production of the online editing project failed.'."\n", - 'type' => 'string', - 'example' => '"EventTime":"2021-08-12T10:04:15Z","ErrorCode":"InvalidParameter","ErrorMessage":"The specified parameter \\"LiveStreamConfig\\" is not valid. specified parameter example is not valid.', - ], - 'CreateSource' => [ - 'title' => '创建来源', - '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" - .'* WebSDK: The project is created by using the SDK for Web.'."\n" - .'* OpenAPI: The project is created by calling API operations.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AliyunConsole' => '', - 'WebSDK' => '', - 'OpenAPI' => '', - ], - 'example' => 'OpenAPI', - ], - 'ModifiedSource' => [ - 'title' => '最后一次修改来源', - 'description' => 'The method used when the online editing project was last modified.'."\n", - 'type' => 'string', - 'example' => '2017-01-11T12:00:00Z', - ], - 'TemplateType' => [ - 'title' => '模板类型', - 'description' => 'The type of the template.'."\n", - 'type' => 'string', - 'example' => 'Timeline', - ], - 'ProjectType' => [ - 'description' => 'The type of the editing project.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LiveEditingProject: a live stream editing project.'."\n" - .'* EditingProject: a regular editing project.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'LiveEditingProject' => '', - 'EditingProject' => '', - ], - 'example' => 'EditingProject', - ], - 'BusinessConfig' => [ - 'description' => 'The business configuration of the project. This parameter can be ignored for general editing projects.'."\n", - 'type' => 'string', - 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', - ], - '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" - .'* ReservationCanceled'."\n" - .'* LiveFinished'."\n" - .'* LoadingFailed'."\n" - .'* Reserving'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'BroadCasting' => '', - 'ReservationCanceled' => '', - 'LiveFinished' => '', - 'LoadingFailed' => '', - 'Reserving' => '', - ], - 'example' => 'Reserving', - ], - ], - 'description' => '', - ], - ], - 'MaxResults' => [ - 'title' => '云剪辑工程总数', - '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.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'Optional. The total number of entries returned. By default, this parameter is not returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '110', - ], - '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.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - ], + [ + 'apiName' => 'GenerateMessageChatToken', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:GenerateMessageChatToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n ****9262E3DA-07FA-4862-FCBB6BC61D08*****\\n \\n ****fddd7748b58bf1d47e95****\\n title\\n {\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"},{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"}]}]}\\n sample description\\n http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg\\n 2017-01-11T12:00:00Z\\n 2017-01-11T12:00:00Z\\n PRODUCE_FAILED\\n InvalidParameter\\n \\"EventTime\\":\\"2021-08-12T10:04:15Z\\",\\"ErrorCode\\":\\"InvalidParameter\\",\\"ErrorMessage\\":\\"The specified parameter \\\\\\"LiveStreamConfig\\\\\\" is not valid. specified parameter example is not valid.\\n OpenAPI\\n 2017-01-11T12:00:00Z\\n Timeline\\n EditingProject\\n \\n 10\\n 110\\n null\\n","errorExample":""}]', - 'title' => 'SearchEditingProject', - ], - 'SubmitDynamicChartJob' => [ - 'summary' => 'Generates animated charts based on Excel datasheets, such as line, pie, and bar charts. You can modify the line color and font.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'SubmitTraceM3u8Job', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitTraceM3u8Job', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateLiveTranscodeTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateLiveTranscodeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SetEventCallback', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:SetEventCallback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ChartType', - 'in' => 'query', - 'schema' => [ - 'title' => '图表类型', - 'description' => 'The chart type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Line: line chart'."\n" - .'* Histogram: bar chart'."\n" - .'* Pie: pie chart'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Line' => 'Line', - 'Histogram' => 'Histogram', - 'Pie' => 'Pie', - ], - 'example' => 'Line', + [ + 'apiName' => 'RegisterMediaStream', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:RegisterMediaStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Input', - 'in' => 'query', - 'schema' => [ - 'title' => '图表输入数据', - 'description' => 'The input data for the chart.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"XlsFile":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.xls"}', + ], + [ + 'apiName' => 'SendAIAgentText', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SendAIAgentText', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OutputConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '输出设置', - 'description' => 'The output configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.mp4","Bitrate":2000,"Width":800,"Height":680}', + ], + [ + 'apiName' => 'QueryTraceExtractJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:QueryTraceExtractJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChartConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '图表配置', - 'description' => 'The chart configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Style":"Normal","TitleStartTime":"3000","ChartStartTime":"3000","VideoDuration":"15000"}', + ], + [ + 'apiName' => 'SubmitSportsHighlightsJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSportsHighlightsJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChartTitle', - 'in' => 'query', - 'schema' => [ - 'title' => '主标题', - 'description' => 'The chart title.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'SetDefaultCustomTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SetDefaultCustomTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Subtitle', - 'in' => 'query', - 'schema' => [ - 'title' => '副标题', - 'description' => 'The subtitle.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'SubmitLiveTranscodeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Unit', - 'in' => 'query', - 'schema' => [ - 'title' => '单位', - 'description' => 'Unit'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'AddStreamTagToSearchLib', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:AddStreamTagToSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DataSource', - 'in' => 'query', - 'schema' => [ - 'title' => '数据来源', - 'description' => 'The data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'SubmitPackageJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitPackageJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Background', - 'in' => 'query', - 'schema' => [ - 'title' => '图表背景', - 'description' => 'The chart background.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"Color":"#000000","ImageUrl":"http://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.jpg"}', + ], + [ + 'apiName' => 'QuerySearchIndex', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:QuerySearchIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AxisParams', - 'in' => 'query', - 'schema' => [ - 'title' => '坐标样式。XAxisFontInterval不传或为0则算法自动计算间距', - 'description' => 'The axis configurations. If XAxisFontInterval is set to 0 or left empty, the system automatically determines an optimal interval.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"FontFile":"Microsoft YaHei","XAxisFontSize":"30","YAxisFontSize":"30","XAxisFontInterval":"30","AxisColor":"30"}', + ], + [ + 'apiName' => 'DeleteHotwordLibrary', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteHotwordLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'title' => '任务标题', - 'description' => 'The job title.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'UpdateCustomizedVoice', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateCustomizedVoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '任务描述', - 'description' => 'The job description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'ListAvatars', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListAvatars', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义数据，JSON格式', - 'description' => 'The custom data in JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"user":"data"}', + ], + [ + 'apiName' => 'GetYikeUser', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetYikeUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'title' => '任务Id', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], + [ + 'apiName' => 'DeleteSmartJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteSmartJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ******11-DB8D-4A9A-875B-275798******\\n ****20b48fb04483915d4f2cd8ac****\\n","errorExample":""}]', - 'title' => 'SubmitDynamicChartJob', - 'description' => 'This feature is available only in the China (Shanghai) region.'."\n" - ."\n" - .'* You can add a title, subtitle, data source, and unit to a chart and specify the font and font size. For supported fonts, see [Fonts](~~449567~~).'."\n" - .'* This feature provides five styles of animated charts: normal, mystery, lively, business, and green.'."\n" - .'* You can set the background color or image.'."\n" - .'* You can set the animation duration, size, and bitrate.'."\n" - ."\n" - .'Examples'."\n" - ."\n" - .'* Line chart: [Sample datasheet](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/line.xlsx), [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/line.mp4)'."\n" - .'* Bar chart: [Sample datasheet](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/histgram.xlsx), [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/histgram.mp4)'."\n" - .'* Pie chart: [Sample datasheet](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/pie.xlsx), [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/pie.mp4)'."\n" - .'* Normal: [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Normal.mp4)'."\n" - .'* Mystery: [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Mystery.mp4)'."\n" - .'* Lively: [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Lively.mp4)'."\n" - .'* Business: [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Business.mp4)'."\n" - .'* Green: [Effect](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Green.mp4)'."\n", - 'responseParamsDescription' => 'You can call the [GetSmartHandleJob](~~441172~~) operation to query the execution details of an animated chart job based on the job ID. The following example shows the response returned by the [GetSmartHandleJob](~~441172~~) operation for a successful job.'."\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": "Sample chart 1",'."\n" - .' "EditingConfig": "null"'."\n" - .' }'."\n" - .' }', - ], - 'StopRtcRobotInstance' => [ - 'summary' => 'Stops an AI agent for real-time communication (RTC).', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListMediaConvertJobs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:ListMediaConvertJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeMeterImsEditUsage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DescribeMeterImsEditUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SubmitCopyrightExtractJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitCopyrightExtractJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CancelFavoritePublicMedia', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:CancelFavoritePublicMedia', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetUrlUploadInfos', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetUrlUploadInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitTextGenerateJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitTextGenerateJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetYikeUserRole', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SetYikeUserRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartAIAgentOutboundCall', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '228874', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + 'ramAction' => [ + 'action' => 'ice:StartAIAgentOutboundCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '727dc0e296014bb58670940a3da95592', + [ + 'apiName' => 'ListAvatarTrainingJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListAvatarTrainingJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'AC84E5DD-AB56-56C0-A992-07ECB82008CA', - ], - ], + [ + 'apiName' => 'CreateCustomizedVoiceJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeMeterImsSummary', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DescribeMeterImsSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC84E5DD-AB56-56C0-A992-07ECB82008CA\\"\\n}","type":"json"}]', - 'title' => 'StopRtcRobotInstance', - ], - 'StartRtcRobotInstance' => [ - 'summary' => 'Starts an AI agent and joins a real-time communication (RTC) call.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'SendLiveTranscodeJobCommand', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SendLiveTranscodeJobCommand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DeleteEditingProjects', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteEditingProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SetAIAgentVoiceprint', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SetAIAgentVoiceprint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListDNADB', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '228630', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + 'ramAction' => [ + 'action' => 'ice:ListDNADB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RobotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ca28b08ad3464ebcb42e5c0f7c6d2e89', + [ + 'apiName' => 'ListLiveRecordFiles', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveRecordFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ChannelId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'testId', + ], + [ + 'apiName' => 'CreateUploadMedia', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateUploadMedia', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'my-robot', + ], + [ + 'apiName' => 'GetCustomizedVoice', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:GetCustomizedVoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + ], + [ + 'apiName' => 'SubmitHighlightExtractionJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitHighlightExtractionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AuthToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '**********', + ], + [ + 'apiName' => 'SubmitYikeStoryboardJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitYikeStoryboardJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Config', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EnableVoiceInterrupt' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Greeting' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'VoiceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zhixiaoxia', - ], - 'AsrMaxSilence' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserOnlineTimeout' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserOfflineTimeout' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'VoiceprintId' => [ - 'type' => 'string', - ], - 'UseVoiceprint' => [ - 'type' => 'boolean', - ], - 'Volume' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'ListSystemTemplates', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:ListSystemTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '727dc0e296014bb58670940a3da95592', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '11DE0AB3-603B-5055-8A72-9C424854F983', - ], - ], + [ + 'apiName' => 'ListSmartVoiceGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListSmartVoiceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'SubmitTraceAbJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitTraceAbJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"727dc0e296014bb58670940a3da95592\\",\\n \\"RequestId\\": \\"11DE0AB3-603B-5055-8A72-9C424854F983\\"\\n}","type":"json"}]', - 'title' => 'StartRtcRobotInstance', - ], - 'UpdateRtcRobotInstance' => [ - 'summary' => 'Modifies an AI agent for real-time communication (RTC), such as the tone and greeting.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'GetCustomizedVoiceJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DeleteCategory', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteCategory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'PrecheckYikeAIAppJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:PrecheckYikeAIAppJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteEditingProjectMaterials', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteEditingProjectMaterials', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMediaMarks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListMediaMarks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitDynamicChartJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitDynamicChartJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCopyrightJobList', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '230669', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + 'ramAction' => [ + 'action' => 'ice:QueryCopyrightJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '727dc0e296014bb58670940a3da95592', + [ + 'apiName' => 'SubmitCopyrightJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitCopyrightJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Config', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EnableVoiceInterrupt' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Greeting' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'VoiceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zhixiaoxia', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'SubmitLiveSnapshotJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitLiveSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '7707F0A2-C6FD-5959-87EB-7C4D02384FD4', - ], - ], + [ + 'apiName' => 'UpdateHotwordLibrary', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateHotwordLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'SearchMediaClipByFace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMediaClipByFace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7707F0A2-C6FD-5959-87EB-7C4D02384FD4\\"\\n}","type":"json"}]', - 'title' => 'UpdateRtcRobotInstance', - ], - 'DescribeRtcRobotInstance' => [ - 'summary' => 'Queries the information about an AI agent for real-time communication (RTC).', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateAvatarTrainingJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateAvatarTrainingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'AddYikeUserCredit', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:AddYikeUserCredit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetAvatar', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetAvatar', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'SubmitSceneMediaSelectionJob', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '230670', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + 'ramAction' => [ + 'action' => 'ice:SubmitSceneMediaSelectionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '727dc0e296014bb58670940a3da95592', + [ + 'apiName' => 'CreateYikeProduction', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateYikeProduction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'AuthToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '**********', - ], - 'ChannelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testId', - ], - 'Config' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EnableVoiceInterrupt' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Greeting' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'VoiceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zhixiaoxia', - ], - ], - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Executing', - ], - 'UserData' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my-robot', - ], - ], + [ + 'apiName' => 'UpdateMediaToSearchLib', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ice:UpdateMediaToSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthToken\\": \\"**********\\",\\n \\"ChannelId\\": \\"testId\\",\\n \\"Config\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"Greeting\\": \\"你好\\",\\n \\"VoiceId\\": \\"zhixiaoxia\\"\\n },\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\",\\n \\"Status\\": \\"Executing\\",\\n \\"UserData\\": \\"{}\\",\\n \\"UserId\\": \\"my-robot\\"\\n}","type":"json"}]', - 'title' => 'DescribeRtcRobotInstance', - ], - 'SetNotifyConfig' => [ - 'summary' => 'Enables or disables event notifications for an AI agent and configures the callback URL and event types.', - 'methods' => [ - 'post', + [ + 'apiName' => 'DescribeMeterImsMediaConvertUsage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:DescribeMeterImsMediaConvertUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'SearchMediaByHybrid', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:SearchMediaByHybrid', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListTranscodeJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListTranscodeJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'StartAIAgentInstance', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236010', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + 'ramAction' => [ + 'action' => 'ice:StartAIAgentInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'AIAgentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AI agent.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', + [ + 'apiName' => 'SubmitSceneTimelineOrganizationJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitSceneTimelineOrganizationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EnableNotify', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable event notifications.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', + ], + [ + 'apiName' => 'UpdateRtcRobotInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:UpdateRtcRobotInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CallbackUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL for receiving callback notifications. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://customer.com/callback', + ], + [ + 'apiName' => 'SubmitYikeAIAppJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:SubmitYikeAIAppJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EventTypes', - 'in' => 'query', - 'schema' => [ - 'description' => 'The event types. If you do not specify this parameter, all event types are selected.'."\n" - ."\n" - .'* agent_start'."\n" - .'* agent_stop'."\n" - .'* error'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'agent_start' => 'agent_start', - 'error' => 'error', - 'agent_stop' => 'agent_stop', - ], - 'example' => 'agent_start,agent_stop,error', + ], + [ + 'apiName' => 'UpdateEditingProject', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdateEditingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Token', - 'in' => 'query', - 'schema' => [ - 'description' => 'The authentication token for callback. The token is carried in the Authorization header of a callback request. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + [ + 'apiName' => 'GetLiveEditingJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveEditingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AudioOssPath', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'SubmitIProductionJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitIProductionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EnableAudioRecording', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', + ], + [ + 'apiName' => 'ListWorkflowTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListWorkflowTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', - ], - ], + [ + 'apiName' => 'QueryMediaCensorJobList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QueryMediaCensorJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateRecognitionLib', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateRecognitionLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', - 'title' => 'SetNotifyConfig', - 'description' => '## [](#)Request description'."\n" - ."\n" - .'You can call this operation to configure event notifications for an AI agent. You can configure `EnableNotify` to enable or disable event notifications, configure `CallbackUrl` to specify a callback URL, and configure `EventTypes` to specify event types. You can also configure `Token` to specify an authentication token for enhanced security. The system returns a unique `RequestId` for subsequent tracing after a successful request.'."\n", - ], - 'DescribeNotifyConfig' => [ - 'summary' => 'Queries the event callback configurations of an AI agent.', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetAIWorkflowTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetAIWorkflowTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'SubmitStandardCustomizedVoiceJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitStandardCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SubmitSmarttagJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitSmarttagJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeMeterImsMpsAiUsage', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236017', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + 'ramAction' => [ + 'action' => 'ice:DescribeMeterImsMpsAiUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'AIAgentId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '39f8e0bc005e4f309379701645f4****', + [ + 'apiName' => 'DeleteLiveSnapshotFiles', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ice:DeleteLiveSnapshotFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'CallbackUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://customer.com/callback', - ], - 'EnableNotify' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EventTypes' => [ - 'description' => 'The event types. If this parameter is empty, all event types are selected.'."\n" - ."\n" - .'* agent_start: The agent is started.'."\n" - .'* agent_stop: The agent is stopped.'."\n" - .'* error: An error occurred.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'agent_start' => 'agent_start', - 'error' => 'error', - 'agent_stop' => 'agent_stop', - ], - 'example' => 'agent_start,agent_stop,error', - ], - 'Token' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', - ], - 'AudioOssPath' => [ - 'type' => 'string', - ], - 'EnableAudioRecording' => [ - 'type' => 'boolean', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', - ], - ], + [ + 'apiName' => 'ListLiveSnapshotTemplates', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListLiveSnapshotTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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\\": true,\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', - 'title' => 'DescribeNotifyConfig', - 'description' => 'You can call this operation to query the detailed callback configurations of an AI agent.'."\n", - ], - 'CancelIProductionJob' => [ - 'summary' => 'Cancels an intelligent production job.', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetLiveRecordJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveRecordJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREice405U0J', + [ + 'apiName' => 'DeleteLiveTranscodeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteLiveTranscodeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the intelligent production job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****20b48fb04483915d4f2cd8ac****', + [ + 'apiName' => 'UploadStreamByURL', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:UploadStreamByURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '****12e8864746a0a398****', + ], + [ + 'apiName' => 'GetTemplateMaterials', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetTemplateMaterials', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.'."\n", - 'type' => 'object', - 'properties' => [ - 'AuthAction' => [ - 'description' => 'The operation that failed the permission check.'."\n", - 'type' => 'string', - 'example' => 'ice:CancelIProductionJob', - ], - 'AuthPrincipalDisplayName' => [ - 'description' => 'The identity. Values:'."\n" - ."\n" - .'* RAM user: a UID'."\n" - .'* RAM role: RoleName:RoleSessionName'."\n" - .'* Federated user: ProviderType/ProviderName'."\n", - 'type' => 'string', - 'example' => '****4522705967****', - ], - 'AuthPrincipalOwnerId' => [ - 'description' => 'The account to which the principal belongs.'."\n", - 'type' => 'string', - 'example' => '****82303720****', - ], - 'AuthPrincipalType' => [ - 'description' => 'The type of identity that made the request. Valid values:'."\n" - ."\n" - .'* SubUser: RAM user'."\n" - .'* AssumedRoleUser: RAM role'."\n" - .'* Federated: SSO federated user'."\n", - 'type' => 'string', - 'example' => 'SubUser', - ], - 'EncodedDiagnosticMessage' => [ - 'description' => 'The encoded diagnostic message.'."\n", - 'type' => 'string', - 'example' => '******AAZ/h8jzNEODc5QUUyLUZCOTAtNUQyQy1BMEFBLUUzODQxODUx******==', - ], - '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" - .'* **ExplicitDeny**: The RAM policy configured by the resource holder explicitly denies the current user access to the corresponding resources.'."\n", - 'type' => 'string', - 'example' => 'ImplicitDeny', - ], - 'PolicyType' => [ - 'description' => 'The type of policy that triggered the permission failure.'."\n" - ."\n" - .'* **ControlPolicy**: control policy'."\n" - .'* **SessionPolicy**: an additional policy attached to a temporary token.'."\n" - .'* **AssumeRolePolicy**: the trust policy of a RAM role.'."\n" - .'* **AccountLevelIdentityBasedPolicy**: an identity-based policy at the account level (custom or system).'."\n" - .'* **ResourceGroupLevelIdentityBasedPolicy**: an identity-based policy scoped to a resource group.'."\n", - 'type' => 'string', - 'example' => 'AssumeRolePolicy', - ], - ], - ], - ], + [ + 'apiName' => 'DropSearchIndex', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DropSearchIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => 'CancelIProductionJob', - ], - 'SubmitSceneMediaSelectionJob' => [ - 'summary' => 'Selects suitable clips based on the submitted videos, images, and voiceovers, and returns the selection results. Two scenarios are supported: image-text matching and highlight mashup.', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetPipeline', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetPipeline', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListRecognitionLibs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:ListRecognitionLibs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', + [ + 'apiName' => 'SubmitSnapshotJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InputConfig', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户合成输出配置', - 'description' => 'The input configuration. Its structure and required fields depend on the value of JobType.'."\n" - ."\n" - .'* When JobType is set to Smart_Mix_Media_Select, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_1.7c3d6997qndkZj).'."\n" - .'* When JobType is set to Screen_Media_Highlights_Media_Select, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_3.84b5661bIcQULE).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{'."\n" - .' "BackgroundMusic": "****75c3936f3a8743850f2da942****",'."\n" - .' "MediaArray": ['."\n" - .' "https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" - .' ],'."\n" - .' "SpeechTextArray": ['."\n" - .' "Grand opening! A Freshippo store opens today at the nearby mall.",'."\n" - .' "Great deals on snacks and drinks. Stop by!"'."\n" - .' ]'."\n" - .'}', + [ + 'apiName' => 'GetLiveTranscodeTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetLiveTranscodeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EditingConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The editing configuration. Its structure depends on the value of JobType.'."\n" - ."\n" - .'* When JobType is set to Smart_Mix_Media_Select, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_1.7c3d6997qndkZj).'."\n" - .'* When JobType is set to Screen_Media_Highlights_Media_Select, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_3.84b5661bIcQULE).'."\n", - '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" - .'}', + ], + [ + 'apiName' => 'ResumeYikeStoryboardJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:ResumeYikeStoryboardJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OutputConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '任务来源', - 'description' => 'The output configuration. Its structure and required fields depend on the value of JobType.'."\n" - ."\n" - .'* When JobType is set to Smart_Mix_Media_Select, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_1.7c3d6997qndkZj).'."\n" - .'* When JobType is set to Screen_Media_Highlights_Media_Select, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_3.84b5661bIcQULE).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" - .' "Count": 1,'."\n" - .' "Width": 1080,'."\n" - .' "Height": 1920'."\n" - .'}', + ], + [ + 'apiName' => 'DecryptKMSDataKey', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DecryptKMSDataKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~357745#section-urj-v3f-0s1~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}', + ], + [ + 'apiName' => 'BatchGetYikeAIAppJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:BatchGetYikeAIAppJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'JobType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job type. Valid values:'."\n" - ."\n" - .'* Smart_Mix_Media_Select'."\n" - .'* Screen_Media_Highlights_Media_Select'."\n" - ."\n" - .'Differences:'."\n" - ."\n" - .'* Smart_Mix_Media_Select: Matches voiceover scripts with provided video/image materials to select the most relevant clips and returns the matching results. Two options are available: Common mode, which is suitable for general-purpose materials like lifestyle vlogs, travel videos, and marketing content; Movie collections, which is optimized for materials with a coherent plot and specific characters, such as TV series and movies.'."\n" - .'* Screen_Media_Highlights_Media_Select: Automatically identifies and selects clips that are exciting or represent key story points from longer video materials.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Smart_Mix_Media_Select', + ], + [ + 'apiName' => 'CreateYikeAssetUpload', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:CreateYikeAssetUpload', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], + [ + 'apiName' => 'ListCustomizedVoices', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListCustomizedVoices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetYikeAssetMediaInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetYikeAssetMediaInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitSceneMediaSelectionJob', - 'description' => '* After a job is submitted, you can call [ListBatchMediaProducingJob](~~2803751~~) to query submitted jobs, or [GetBatchMediaProducingJob](~~2693269~~) to query the job status and results.'."\n" - .'- The feature is in public preview and charges no fees.', - ], - 'SubmitSceneBatchEditingJob' => [ - 'summary' => 'Submits a batch job to render multiple videos by providing a list of editing project IDs.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'GetVideoList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetVideoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateStreamToSearchLib', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ice:CreateStreamToSearchLib', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryDNAJobList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:QueryDNAJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', + [ + 'apiName' => 'GetSnapshotUrls', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetSnapshotUrls', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ProjectIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'A comma-separated list of editing project IDs. The video is rendered based on the timeline from each project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '****ae91539d46bb9000f74b40b80dd2,****ae91539000f74b40b80dd9d46bb', + [ + 'apiName' => 'ListMediaInfoJobs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:ListMediaInfoJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OutputConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '任务输出配置', - 'description' => 'The output configuration. The structure is the same as the [OutputConfig](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_3.3af86997GreVu9\\&scm=20140722.H\\_2863940.\\_.OR_help-T_cn~zh-V\\_1#4111a373d0xbz) for batch video generation, except that Count and GeneratePreviewOnly are not supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{'."\n" - .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" - .' "Width": 1080,'."\n" - .' "Height": 1920'."\n" - .'}', + ], + [ + 'apiName' => 'AddMediaMarks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:AddMediaMarks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'Custom user data, including callback configurations. For more information, see [UserData](~~357745#section-urj-v3f-0s1~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'GetSnapshotJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GetSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '****C702-41BE-467E-AF2E-883D4517****', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], + [ + 'apiName' => 'UpdatePipeline', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:UpdatePipeline', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteCustomTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:DeleteCustomTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****C702-41BE-467E-AF2E-883D4517****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitSceneBatchEditingJob', - 'description' => '* After submitting a job, you can call ListBatchMediaProducingJob to retrieve all matching jobs. To get detailed information for a specific job, including its status, output media asset IDs, and URLs, call GetBatchMediaProducingJob.'."\n", - ], - 'SubmitSceneTimelineOrganizationJob' => [ - 'summary' => 'Arranges media assets, including videos, images, background music, and voiceovers, into a complete timeline based on media selection results, and creates an editing project for preview. Two scenarios are supported: image-text matching and highlight mashup.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ListEditingProjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListEditingProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'SubmitMediaProducingJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:SubmitMediaProducingJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetAiRtcLicenseInfoList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetAiRtcLicenseInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeAIAgentInstance', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREiceANRKXC', + 'ramAction' => [ + 'action' => 'ice:DescribeAIAgentInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InputConfig', - 'in' => 'formData', - 'schema' => [ - 'title' => '用户合成输入配置', - 'description' => 'The input configuration. Its structure and required fields depend on the value of JobType.'."\n" - ."\n" - .'* When JobType is set to Smart_Mix_Timeline_Organize, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_1.7c3d6997qndkZj).'."\n" - .'* When JobType is set to Screen_Media_Highlights_Timeline_Organize, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_3.84b5661bIcQULE).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "BackgroundMusic": "****75c3936f3a8743850f2da942****",'."\n" - .' "MediaArray": ['."\n" - .' "https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" - .' ],'."\n" - .' "SpeechTextArray": ['."\n" - .' "A new Freshippo store just opened in the nearby mall. Today is the grand opening."'."\n" - .' ]'."\n" - .'}', + [ + 'apiName' => 'SubmitVideoCognitionJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ice:SubmitVideoCognitionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EditingConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The editing configuration. Its structure depends on the value of JobType.'."\n" - ."\n" - .'* When JobType is set to Smart_Mix_Timeline_Organize, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_1.7c3d6997qndkZj).'."\n" - .'* When JobType is set to Screen_Media_Highlights_Timeline_Organize, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_3.84b5661bIcQULE).'."\n", - '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" - .'}', + ], + [ + 'apiName' => 'GenerateKMSDataKey', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:GenerateKMSDataKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OutputConfig', - 'in' => 'query', - 'schema' => [ - 'title' => '任务输出配置', - 'description' => 'The output configuration. Its structure and required fields depend on the value of JobType.'."\n" - ."\n" - .'* When JobType is set to Smart_Mix_Timeline_Organize, see [Image-text matching](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_1.7c3d6997qndkZj).'."\n" - .'* When JobType is set to Screen_Media_Highlights_Timeline_Organize, see [Highlight mashup](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d\\_3\\_2\\_0\\_3.84b5661bIcQULE).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{'."\n" - .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" - .' "Count": 1,'."\n" - .' "Width": 1080,'."\n" - .' "Height": 1920'."\n" - .'}', + ], + [ + 'apiName' => 'GetYikeUserCredit', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:GetYikeUserCredit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserData', - 'in' => 'query', - 'schema' => [ - 'title' => '用户配置UserData', - 'description' => 'The user-defined data, including the business and callback configurations. For more information, see [UserData](~~357745#section-urj-v3f-0s1~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}', + ], + [ + 'apiName' => 'GetDemonstrationForCustomizedVoiceJob', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:GetDemonstrationForCustomizedVoiceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'JobType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job type. Valid values:'."\n" - ."\n" - .'* Smart_Mix_Timeline_Organize: Image-text matching.'."\n" - .'* Screen_Media_Highlights_Timeline_Organize: Highlight mashup.'."\n" - ."\n" - .'Differences:'."\n" - ."\n" - .'* Image-text matching: Arranges a timeline based on the results of matching a voiceover script to media assets. Ideal for bulk marketing videos and general-purpose montages.'."\n" - .'* Highlight mashup: Arranges a timeline based on the results of highlight clip selection. Ideal for creating action-packed highlight reels from short-form dramas.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Smart_Mix_Timeline_Organize', + ], + [ + 'apiName' => 'AddEditingProjectMaterials', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ice:AddEditingProjectMaterials', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'MediaSelectResult', - 'in' => 'query', - 'schema' => [ - 'description' => 'The media selection results from a previously run SubmitSceneMediaSelectionJob. You can retrieve this result by calling GetBatchMediaProducingJob.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "textMatchMediaOutputList": [{'."\n" - .' "textMatchMediaSentenceOutputList": [{'."\n" - .' "duration": 3.366667,'."\n" - .' "matchClipList": [{'."\n" - .' "endTime": 11.16,'."\n" - .' "mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" - .' "startTime": 8.04'."\n" - .' }],'."\n" - .' "text": "A new Freshippo store just opened in the nearby mall"'."\n" - .' },'."\n" - .' {'."\n" - .' "duration": 1.566667,'."\n" - .' "matchClipList": [{'."\n" - .' "endTime": 1.54,'."\n" - .' "mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" - .' "startTime": 0'."\n" - .' }],'."\n" - .' "text": "Today is the grand opening"'."\n" - .' }'."\n" - .' ]'."\n" - .' }]'."\n" - .'}', + ], + [ + 'apiName' => 'QueryVideoCognitionJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ice:QueryVideoCognitionJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '******11-DB8D-4A9A-875B-275798******', - ], - 'JobId' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'example' => '****20b48fb04483915d4f2cd8ac****', - ], - ], + [ + 'apiName' => 'ListBatchMediaProducingJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ice:ListBatchMediaProducingJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ICE', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', - 'title' => 'SubmitSceneTimelineOrganizationJob', - 'description' => '* After submitting a job, you can call [ListBatchMediaProducingJob](~~2803751~~) to retrieve matching jobs. To get detailed information for a specific job, including its status, output media asset IDs, and URLs, call [GetBatchMediaProducingJob](~~2693269~~).'."\n" - ."\n" - .'- The feature is in public preview and does not charge fees.', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'ice.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'ice.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'ice.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'ice.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ice.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'ice.us-west-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; -- cgit v1.2.3